This repository has been archived by the owner on Mar 9, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapiary.apib
2816 lines (2549 loc) · 118 KB
/
apiary.apib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
FORMAT: 1A
# Colisweb API
## Cette documentation n'est plus à jour depuis le 07/02/2019
> ***Une nouvelle documentation est disponible ici : https://colisweb.docs.stoplight.io***.
> ***Cette documentation n'est plus à jour depuis le 07/02/2019.***
-----------------------------
Ce document décrit les points d'entrées, appelés **endpoints**, de l'API.
> **ATTENTION**: Nous nous réservons le droit **d'ajouter** certains attribuLinkts tout au long du cycle de vie de cette API.
## Informations pratiques
### Authentification
***
Une clé API est nécessaire pour pouvoir échanger avec l'API.
Pour obtenir une clé API, veuillez en faire la demande à [email protected].
**L'authentification se fait via un header HTTP spécifique.**
**Chaque requête doit contenir un header HTTP dont la clé est `Api-Key` et la valeur est la clé API fournie.**
### Encodage de caractères
***
Le charset supporté pour les requêtes transmises à l'API est l' **UTF-8**.
### Environnements et URLs
***
Deux environnements sont disponibles, ***les clés API sont différentes selon les environnements***.
+ **Sandbox**: Environnement "bac à sable" pour vos tests avant mise en production.
> https://sandbox.api.colisweb.com/4/ **end_point**
+ **Production**: Après validation des tests en sandbox.
> https://api.colisweb.com/4/ **end_point**
**end_point** = Méthodes décrites dans ce document
### Certificats SSL
***
Toutes nos APIs sont sécurisées grâce à la technologie HTTPS.
Nos certificats SSL sont émis automatiquement par LetsEncrypt.
Ceci implique que ces certificats sont renouvelés automatiquement tous les 3 mois.
> **ATTENTION**:
Si vous utilisez la JVM, vérifiez que la version de votre JVM supporte LetsEncrypt.
Pour plus d'informations sur les compatibilités avec LetsEncrypt, voir : https://letsencrypt.org/docs/certificate-compatibility/
### Formats de dates
***
+ L'API accepte en paramètre d'entrée des dates au format **ISO 8601 avec timezone**.
Exemple:
`
2015-04-22T12:00:00+02:00
`
+ Toutes les dates renvoyées par l'API le sont en UTC dans le même format
Exemple:
`
2015-04-22T14:00:00Z
`
## Entités
***
### Entités en entrée
***
#### L'entité "Route"
***
Spécifie et constitue les informations sur le point de retrait et le point de livraison.
+ Une `Route` est une liste d'entités `Point`
#### L'entité "Point"
***
Spécifie la nature d'un point ainsi que les informations d'adresse.
Il peut être soit un "point de retrait" soit un "point de livraison" de la marchandise.
+ Un `Point` est un `Hash` composé des attributs suivants:
+ `type` *(required, string)*... La nature du point, les valeurs peuvent être :
+ **"pickup"** (point de retrait).
+ **"shipping"** (point de livraison).
+ `location` *(required, Location entity)*... Informations du point.
+ `calendar` *(optional, array of hashes)*... Filtre les créneaux contractualisés.
+ `starts_at` *(datetime)*... Début du créneau horaire de disponibilité.
+ `ends_at` *(datetime)*... Fin du créneau horaire de disponibilité.
+ `capacities` *(optional, array of hashes)*... Filtre les créneaux en fonction d'une capacité maximum de livraison. Cette capacité est définie dans une plage horaire.
+ `earliest_starts_at` *(datetime)*... Début de la plage horaire de capacité.
+ `latest_starts_at` *(datetime)*... Fin de la plage horaire de capacité.
+ `max_capacity` *(Integer)* ... Capacité maximum de livraison dans la plage horaire.
#### L'entité "Location"
***
Spécifie les informations d'adresse d'un point.
Une **Location** est un type abstrait décliné selon l'une de ces trois spécialisations concrètes:
+ Soit une adresse quelconque avec les attributs suivants:
+ `type` *(required, string = "address")* ... Location de type **"address"**
+ `society` *(optional, string)*... Société.
+ `first_name` *(required, string)*... Prénom.
+ `last_name` *(required, string)*... Nom.
+ `email` *(required, string)*... Email.
+ `primary_phone` *(required, string)*... Numéro de téléphone primaire.
+ `secondary_phone` *(optional, string)*... Numéro de téléphone secondaire.
+ `line1` *(required, string)*... Adresse de livraison.
+ `line2` *(optional, string)*... Complément d'adresse.
+ `additional_informations` *(optional, string)*... Informations supplémentaires (digicode, ...)
+ `postal_code` *(required, string)*... Code postal.
+ `city` *(required, string)*... Ville.
+ `country` *(required, string)*... Pays.
+ `floor` *(required dans le cas d'une Livraison dans la pièce du choix, integer)*... Etage.
+ `lift_information` *(required dans le cas d'une Livraison dans la pièce du choix, string)*... Présence d'un ascenseur ("with_lift"), Absence d'un ascenseur ("no_lift")
+ Soit un magasin/entrepôt référencé dans notre système avec les attributs suivants:
+ `type` *(required, string = "store")*... Location de type **"store"**
+ `store_code` *(required, string)*... Code magasin/entrepôt.
Nous référençons vos magasins dans notre système au moment de la signature du contrat.
+ Soit un code postal avec attributs suivants:
+ `type` *(required, string = "city")*... location de type **"city"**
+ `postal_code` *(required, string)*... Code postal.
#### L'entité "Slot"
***
Spécifie le créneau horaire souhaité pour la livraison de la marchandise.
+ Un **Slot** est composé des attributs suivants:
+ `starts_at` *(datetime)*... Début du créneau horaire.
+ `size` *(integer)*... Taille de la plage de livraison (en minutes).
#### L'entité "Packaging"
***
Spécifie les informations du conteneur et des paquets constituants la demande de livraison.
+ Un **Packaging** est composé des attributs suivants:
+ `global_description` *(optional, string)*... La description globale du packaging.
+ `packaging_ref` *(optional, string)*... Une référence permettant d'identifier spécifiquement le conteneur.
+ `packets_quantity` *(optional, integer)*... Le nombre de paquets contenu dans le packaging.
+ `length` *(optional, float)*... Longueur du volume utile (en centimètres).
+ `width` *(optional, float)*... Largeur du volume utile (en centimètres).
+ `height` *(optional, float)*... Hauteur du volume utile (en centimètres).
+ `weight` *(optional, float)*... Poids du volume utile (en centimètres).
+ `packets` *(optional, array[Packet])*... Les paquets composant le colis.
#### L'entité "Packet"
***
Spécifie les informations sur un paquet.
+ Un **Packet** est composé des attributs suivants:
+ `description` *(optional , string)*... La description / référence du paquet.
+ `sku` *(optional , string)*... Identifiant unique du paquet / produit.
+ `length` *(required, float)*... Longueur du paquet (en centimètres).
+ `width` *(required, float)*.. Largeur du paquet (en centimètres).
+ `height` *(required, float)*.. Hauteur du paquet (en centimètres).
+ `weight` *(required, float)*.. Poids du paquet (en kilos).
### Entités en sortie
#### L'entité "Delivery"
***
Spécifie les informations de la livraison commandée.
**Important :** Tous les endpoints retournent une entité `Delivery` excepté celui de récupération des options de livraisons disponibles.
+ Une `Delivery` est composée des attributs suivants:
+ `uuid` *(UUID)*... Identifiant unique de la livraison commandée.
+ `primary_order_reference` *(string)*... Référence primaire. Voir endpoint "Finaliser une commande de livraison" pour plus d'informations.
+ `secondary_order_reference` *(string)*... Référence secondaire. Voir endpoint "Finaliser une commande de livraison" pour plus d'informations.
+ `packaging` *(Packaging entity)*... Les informations sur le conteneur et les paquets à livrer.
+ `route` *(enriched Route entity)*... Les informations sur le point de retrait et le point de livraison enrichies.
+ `status` *(Status entity)*... Les informations de statuts de livraison.
+ `post_purchase_url` *(string)*... URL de la page web de suivi/modification de livraison à destination des clients finaux.
#### L'entité "Status"
***
Spécifie les informations de statuts de livraison
+ Un `status` est un `Hash` composé des attributs suivants:
+ `global` *(string)*... statut global de la commande. (voir section "Statuts de livraison")
+ `pickup_problems` *(Array of Hash)*
+ `type` *(string)*... Problèmes rencontrés au retrait (voir section "Problèmes de livraison")
+ `shipping_problems` *(Array of Hash)*
+ `type` *(string)*... Problèmes rencontrés au point de livraison (voir section "Problèmes de livraison")
## Description des dimensions
***
Un conteneur est la forme géométrique rectangulaire la plus petite étant capable de contenir les paquets qui seront livrés.
Un **conteneur** correspond à l'entité **Packaging**.
Un **paquet** correspond à l'entité **Packet**.
Afin de nous transmettre les dimensions de ce que vous voulez faire livrer, deux possibilités s'offrent à vous :
1. Décrire un "conteneur" étant capable de contenir les paquets/produits de votre client.
Dans ce cas de figure, il vous faudra impérativement remplir les champs
`packets_quantity`, `length`, `width`, `height`, `weight` de l'entité **Packaging**.
2. Décrire précisement l'ensemble des "paquets" composant la livraison, nous laissant le soin de calculer le conteneur le plus adapté.
Dans ce second cas de figure, il vous faudra impérativement **ne pas** remplir les champs
`packets_quantity`, `length`, `width`, `height`, `weight` de **Packaging**.
Il vous faudra, pour chaque paquet/produit, générer une entité **Packet** avec au moins les champs
`length`, `width`, `height`, `weight` renseignés.
Ces deux solutions sont mutuellement exclusives, la première option étant prioritaire sur la seconde.
Cela signifie que si les dimensions d'un **Packaging** sont renseignées alors les **Packets** seront ignorés.
Si aucune des deux solutions n'est choisie, la requête sera rejetée et générera une erreur `400 Bad Request`
`
## Statuts de livraison possibles
***
* `pre_ordered` = en attente de confirmation
* `confirmed` = commande confirmée
* `picked_up` = colis retiré
* `pick_up_failed` = échec de retrait colis *(état terminal)*
* `delivered` = colis livré *(état terminal)*
* `delivery_failed` = échec de livraison
* `package_returned` = colis retourné *(état terminal)*
* `canceled` = commande annulée *(état terminal)*
## Problèmes de livraison
***
Que la livraison soit un succès ou un échec, plusieurs types de problèmes peuvent être remontés par le transporteur lors du retrait ou de la livraison de la marchandise.
* `no_package` = Aucun colis trouvé(s).
* `too_many_packages` = Trop de colis.
* `missing_packages` = Colis manquants.
* `too_heavy` = Colis trop lourd(s).
* `wrong_dimensions` = Dimensions inadaptées.
* `pickup_point_closed` = Point de retrait fermé.
* `absent_customer` = Client absent.
* `unreachable_customer` = Client injoignable.
* `wrong_address` = Mauvaise adresse.
* `delivery_rejection` = Refus de réception.
* `wrong_package` = Mauvais colis.
* `other` = Autre problème.
## Codes erreurs
***
| Li name | HTTP Status | Description |
| ------------------------ | ---------------- | --------------------------------- |
| wrong_api_key | 401 Unauthorized | Clé API manquante / inconnue |
| missing_parameters | 400 Bad Request | Il manque des paramètres |
| fail_to_confirm_delivery | 400 Bad Request | Le commande de livraison a échoué |
| no_delivery_options | 404 not found | Aucune disponibilité de livraison |
| missing_delivery | 404 not found | Numéro de commande inconnue |
| delivery_has_expired | 400 Bad request | La confirmation de commande survient après le timeout (15 minutes), impossible de confirmer la commande|
| lift_information_field_is_wrong | 400 Bad request | Les informations sur l'ascenseur sont erronées|
# Group Commander une livraison
La commande d'une livraison Colisweb est réalisable en suivant ces 3 actions à la suite:
[1. Obtenir les options de livraison](#reference/commander-une-livraison/1-obtenir-les-options-de-livraison-disponibles)
|Inputs | Outputs |
| --------------------------------------------------------- | ----------------------------------- |
| - Point de retrait <br> - Point de livraison <br> - Colis |- Options de livraison |
***
[2. Précommander la livraison](#reference/commander-une-livraison/2-precommander-une-livraison)
|Inputs | Outputs |
| ------------------------------------------------------------------------------------ | ----------------------------------- |
| - Point de retrait <br> - Point de livraison <br> - Colis <br> - Option de livraison |- Livraison Colisweb (précommandée) |
***
[3. Confirmer la livraison](#reference/commander-une-livraison/3-finaliser-une-commande-de-livraison)
|Inputs | Outputs |
| ------------------------------------| ----------------------------------- |
| - Livraison Colisweb (précommandée) |- Livraison Colisweb (confirmée) |
***
## 1. Obtenir les options de livraison disponibles [POST /4/deliveries/options]
***[POST] 4/deliveries/options***
Permet de récupérer les options de livraison disponibles.
Les options de livraison dépendent:
+ De l'adresse du point de retrait (code postal)
+ De l'adresse du point de livraison (code postal)
+ Des colis à transporter (Poids et dimensions)
+ Des ouvertures du service Colisweb
+ Des horaires d'ouvertures du point de retrait dans le cas d'une intégration B2C/B2B.
### Paramètres de requête
+ `route` *(required, Route entity)*
+ `point` *(required, Point entity)*
+ `type` *(required, value = "pickup")*... Point de **retrait**
+ `location` *(required, Location entity)*... Le type de la location ne peut être que **"city"** ou **"store"**.
+ `calendar` *(optional, array of hashes)*... Si passé, filtre les créneaux contractualisés.
+ `starts_at` *(datetime)*... Début du créneau horaire de disponibilité.
+ `ends_at` *(datetime)*... Fin du créneau horaire de disponibilité.
+ `capacities` *(optional, array of hashes)*... Filtre les créneaux en fonction d'une capacité maximum de livraison pour un **magasin**. Cette capacité est définie sur une plage horaire.
+ `earliest_starts_at` *(datetime)*... Début de la plage horaire de capacité.
+ `latest_starts_at` *(datetime)*... Fin de la plage horaire de capacité.
+ `max_capacity` *(Integer)* ... Capacité maximum de livraison dans la plage horaire.
+ `point` *(required, Point entity)*
+ `type` *(required, value = "shipping")*... Point de **livraison**
+ `location` *(required, Location entity)*... Le type de la location ne peut être que **"city"** ou **"store"**.
+ `calendar` *(optional, array of hashes)*... Si passé, filtre les créneaux contractualisés.
+ `starts_at` *(datetime)*... Début du créneau horaire de disponibilité.
+ `ends_at` *(datetime)*... Fin du créneau horaire de disponibilité.
+ `packaging` *(required, Packaging entity)*
+ `global_description` *(optional)*
+ `packaging_ref` *(optional)*
+ `packets_quantity` *(optional)*
+ `length` *(optional)*
+ `width` *(optional)*
+ `height` *(optional)*
+ `weight` *(optional)*
+ `packets` *(optional)*
+ `description` *(optional)*
+ `sku` *(optional)*
+ `length` *(required)*
+ `width` *(required)*
+ `height` *(required)*
+ `weight` *(required)*
+ `slot` *(optional)*
+ `size` *(required, Integer)*... Taille des créneaux de livraison
### Contenu de la réponse
+ `delivery` *(hash)*
+ `now` *(hash)*... Disponibilité de l'offre "instantanée" (au moment de la requête). Vide si aucune disponibilité.
+ `available` *(boolean)*... Disponibilité de la livraison "instantanée".
+ `slot_size` *(integer)*... Taille du créneau horaire de la livraison "instantanée" (en minutes).
+ `price` *(float)*... Coût HT pour ce créneau (en euro).
+ `calendar` *(array of hashes)*... . Vide si aucune disponibilité.
+ `starts_at` *(datetime)*... Début du créneau horaire de livraison.
+ `ends_at` *(datetime)*... Fin du créneau horaire de livraison.
+ `slot_size` *(integer)*... Taille du créneau horaire de livraison (en minutes).
+ `price` *(float)*... Coût HT de la livraison dans ce créneau (en euro).
+ Request Exemple de requête "B2B" (application/json)
+ Headers
Api-Key: votreCléApi
+ Body
{
"route": [
{
"type": "pickup",
"location": {
"type": "store",
"store_code": "100001"
}
},
{
"type": "shipping",
"location": {
"type": "store",
"store_code": "100002"
}
}
],
"packaging": {
"global_description": "Ensemble set cuisine",
"packets": [
{
"description": "micro-onde",
"height": 60,
"length": 80,
"width": 30,
"weight": 2.5
},
{
"description": "Cafetière",
"height": 60,
"length": 80,
"width": 30,
"weight": 1.0
}
]
}
}
+ Request Exemple de requête "B2C" (application/json)
+ Headers
Api-Key: votreCléApi
+ Body
{
"route": [
{
"type": "pickup",
"location": {
"type": "store",
"store_code": "100001"
}
},
{
"type": "shipping",
"location": {
"type": "city",
"postal_code": "75001"
}
}
],
"packaging": {
"global_description": "Ensemble set cuisine",
"packets": [
{
"description": "micro-onde",
"height": 60,
"length": 80,
"width": 30,
"weight": 2.5
},
{
"description": "Cafetière",
"height": 60,
"length": 80,
"width": 30,
"weight": 1.0
}
]
}
}
+ Request Exemple de requête "C2B" (application/json)
+ Headers
Api-Key: votreCléApi
+ Body
{
"route": [
{
"type": "pickup",
"location": {
"type": "city",
"postal_code": "75001"
}
},
{
"type": "shipping",
"location": {
"type": "store",
"store_code": "100001"
}
}
],
"packaging": {
"global_description": "Ensemble set cuisine",
"packets": [
{
"description": "micro-onde",
"height": 60,
"length": 80,
"width": 30,
"weight": 2.5
},
{
"description": "Cafetière",
"height": 60,
"length": 80,
"width": 30,
"weight": 1.0
}
]
}
}
+ Request Exemple de requête "C2C" (application/json)
+ Headers
Api-Key: votreCléApi
+ Body
{
"route": [
{
"type": "pickup",
"location": {
"type": "city",
"postal_code": "75008"
}
},
{
"type": "shipping",
"location": {
"type": "city",
"postal_code": "75001"
}
}
],
"packaging": {
"global_description": "Ensemble set cuisine",
"packets": [
{
"description": "micro-onde",
"height": 60,
"length": 80,
"width": 30,
"weight": 2.5
},
{
"description": "Cafetière",
"height": 60,
"length": 80,
"width": 30,
"weight": 1.0
}
]
}
}
+ Response 201 (application/json)
+ Body
{
"delivery": {
"now": {
"available": true,
"slot_size": 120,
"price": 16.00
},
"calendar": [
{
"starts_at": "2015-04-22T10:00:00+00:00",
"ends_at": "2015-04-22T12:00:00+00:00",
"slot_size": 120,
"price": 16.00
},
{
"starts_at": "2015-04-22T12:00:00+00:00",
"ends_at": "2015-04-22T14:00:00+00:00",
"slot_size": 120,
"price": 8.00
},
{
"starts_at": "2015-04-22T14:00:00+00:00",
"ends_at": "2015-04-22T17:00:00+00:00",
"slot_size": 180,
"price": 10.00
},
{
"starts_at": "2015-04-23T10:00:00+00:00",
"ends_at": "2015-04-23T12:00:00+00:00",
"slot_size": 120,
"price": 16.00
},
{
"starts_at": "2015-04-23T12:00:00+00:00",
"ends_at": "2015-04-23T14:00:00+00:00",
"slot_size": 120,
"price": 8.00
},
{
"starts_at": "2015-04-23T14:00:00+00:00",
"ends_at": "2015-04-23T17:00:00+00:00",
"slot_size": 180,
"price": 10.00
}
]
}
}
## 2. Précommander une livraison [POST /4/deliveries/book]
***[POST] 4/deliveries/book***
Permet de précommander une livraison.
Une livraison précommandée n'est pas prise en charge par Colisweb, il est nécessaire de la confirmer avec la méthode [Finaliser une commande de livraison](#reference/commander-une-livraison/finaliser-une-commande-de-livraison).
***Remarque:*** Dans le cas d'une **intégration e-commerce**, il faut précommander la livraison **avant le paiement**.
### Paramètres de requête
+ `slot` *(required, Slot entity)*... Créneau de livraison demandé.
+ `starts_at` *(required, datetime)*... Date et heure de début de la plage de livraison.
Pour passer une demande en mode "Instantané", passez la date / heure actuelle.
Vous pouvez passer la valeur que vous souhaitez, cependant seuls les valeurs fournies par le endpoint **[options de livraison](#reference/commander-une-livraison/obtenir-les-options-de-livraison-disponibles)** garantissent une réponse positive de l'API.
+ `size` *(required, integer)*... Taille de la plage de livraison demandée (en minutes).
Vous pouvez passer la valeur que vous souhaitez, cependant seuls les valeurs fournies par le endpoint **[options de livraison](#reference/commander-une-livraison/obtenir-les-options-de-livraison-disponibles)** garantissent une réponse positive de l'API.
+ `route` *(required, Route entity)*
+ `point` *(required, Point entity)*
+ `type` *(required, value = "pickup")*... Point de **retrait**
+ `location` *(required, Location entity)*... Le type de la location ne peut être que **"address"** ou **"store"**
+ `point` *(required, Point entity)*
+ `type` *(required, value = "shipping")*... Point de **livraison**
+ `location` *(required, Location entity)*... Le type de la location ne peut être que **"address"** ou **"store"**
+ `authorize_address_update` *(optional, default_value = "true")*... Booléen pour autoriser ou non la **modification de d'adresse** via le lien POST-ACHAT.
+ `authorize_slot_update` *(optional, default_value = "true")*... Booléen pour autoriser ou non la **modification de de créneau horaire** via le lien POST-ACHAT.
+ `packaging` *(required, packaging entity)*
+ `global_description` *(optional)*
+ `packaging_ref` *(optional)*
+ `packets_quantity` *(optional)*
+ `length` *(optional)*
+ `width` *(optional)*
+ `height` *(optional)*
+ `weight` *(optional)*
+ `packets` *(optional)*
+ `description` *(optional)*
+ `sku` *(optional)*
+ `length` *(required)*
+ `width` *(required)*
+ `height` *(required)*
+ `weight` *(required)*
+ `webhook_url` *(optional, string)*... URL de suivi de commande.
Pour plus d'informations, voir [Suivi de commande](#reference/commander-une-livraison/suivi-de-commande)
**Remarque:** Si le `pickup` et le `shipping` sont tous deux de type `store`, au moins un des deux `store_code` doit être renseigné.
### Contenu de la réponse
La réponse contient une entité `Delivery`.
+ Request Exemple de requête "B2B" (application/json)
+ Headers
Api-Key: votreCléApi
+ Body
{
"slot": {
"starts_at": "2015-04-22T08:00:00+00:00",
"size": 120
},
"route": [
{
"type": "pickup",
"location": {
"type": "store",
"store_code": "100001"
}
},
{
"type": "shipping",
"location": {
"type": "store",
"store_code": "100002"
}
}
],
"packaging": {
"global_description": "Ensemble set cuisine",
"packets": [
{
"description": "micro-onde",
"height": 60,
"length": 80,
"width": 30,
"weight": 2.5
},
{
"description": "Cafetière",
"height": 60,
"length": 80,
"width": 30,
"weight": 1.0
}
]
},
"webhook_url": "https://your-webhook-url.com"
}
+ Response 201 (application/json)
+ Body
{
"delivery": {
"uuid": "fb869236-1090-4019-8c88-2a2be4d45f65",
"primary_order_reference": "",
"secondary_order_reference": "",
"packaging": {
"global_description": "Ensemble set cuisine",
"packaging_ref": "",
"width": 60.0,
"length": 80.0,
"height": 60.0,
"weight": 3.5,
"packets_quantity": 2,
"packets": [
{
"description": "micro-onde",
"sku": "",
"width": 60.0,
"length": 80.0,
"height": 30.0,
"weight": 2.5
},
{
"description": "Cafetière",
"sku": "",
"width": 60.0,
"length": 80.0,
"height": 30.0,
"weight": 1.0
}
]
},
"route": [
{
"type": "pickup",
"location": {
"type": "store",
"society": "",
"name": "Welshoo center",
"first_name": "Yann",
"last_name": "Marzack",
"line1": "286 bis Rue Solférino",
"line2": "",
"postal_code": "59000",
"city": "Lille",
"country": "France",
"additional_informations": "Auberge du Temps Jadis",
"primary_phone": "0685868586",
"secondary_phone": "",
"email": "[email protected]",
"store_code": "100001"
},
"calendar": {
"starts_at": "2015-04-22T08:00:00Z",
"ends_at": "2015-04-22T10:00:00Z"
}
},
{
"type": "shipping",
"location": {
"type": "store",
"society": "",
"name": "Welshoo kitchen",
"first_name": "Jules",
"last_name": "Ivanic",
"line1": "106 Rue de l'Hôpital Militaire",
"line2": "",
"postal_code": "59000",
"city": "Lille",
"country": "",
"additional_informations": "Pulp Kitchen",
"primary_phone": "0785868586",
"secondary_phone": "",
"email": "[email protected]",
"store_code": "100002"
},
"calendar": {
"starts_at": "2015-04-22T08:00:00Z",
"ends_at": "2015-04-22T10:00:00Z"
}
}
],
"status": {
"global": "pre_ordered",
"pickup_problems": [],
"shipping_problems": []
}
}
}
+ Request Exemple de requête "B2C" (application/json)
+ Headers
Api-Key: votreCléApi
+ Body
{
"slot": {
"starts_at": "2015-04-22T08:00:00+00:00",
"size": 120
},
"route": [
{
"type": "pickup",
"location": {
"type": "store",
"store_code": "100001"
}
},
{
"type": "shipping",
"location": {
"type": "address",
"society": "Twelve factors & C",
"first_name": "Helmout",
"last_name": "Ardelpik",
"email": "[email protected]",
"primary_phone": "0685898585",
"secondary_phone": "",
"line1": "165, avenue des champs Elysées",
"line2": "Batiment Leblanc",
"additional_informations": "Digicode B345, 3 éme etage",
"postal_code": "59800",
"city": "Lille",
"country": "France",
"floor": 4,
"lift_information": "with_lift"
}
}
],
"packaging": {
"global_description": "Ensemble set cuisine",
"packets": [
{
"description": "micro-onde",
"height": 60,
"length": 80,
"width": 30,
"weight": 2.5
},
{
"description": "Cafetière",
"height": 60,
"length": 80,
"width": 30,
"weight": 1.0
}
]
},
"webhook_url": "https://your-webhook-url.com"
}
+ Response 201 (application/json)
+ Body
{
"delivery": {
"uuid": "fb869236-1090-4019-8c88-2a2be4d45f65",
"primary_order_reference": "",
"secondary_order_reference": "",
"packaging": {
"global_description": "Ensemble set cuisine",
"packaging_ref": "",
"width": 60.0,
"length": 80.0,
"height": 60.0,
"weight": 3.5,
"packets_quantity": 2,
"packets": [
{
"description": "micro-onde",
"sku": "",
"width": 60.0,
"length": 80.0,
"height": 30.0,
"weight": 2.5
},
{
"description": "Cafetière",
"sku": "",
"width": 60.0,
"length": 80.0,
"height": 30.0,
"weight": 1.0
}
]
},
"route": [
{
"type": "pickup",
"location": {
"type": "store",
"name": "Welshoo center",
"first_name": "Yann",
"last_name": "Marzack",
"line1": "286 bis Rue Solférino",
"line2": "",
"postal_code": "59000",
"city": "Lille",
"country": "France",
"additional_informations": "Auberge du Temps Jadis",
"primary_phone": "0685868586",
"secondary_phone": "",
"email": "[email protected]",
"store_code": "100001"
},
"calendar": {
"starts_at": "2015-04-22T08:00:00Z",
"ends_at": "2015-04-22T10:00:00Z"
}
},
{
"type": "shipping",
"location": {
"type": "address",
"society": "Twelve factors & C",
"name": "Helmout Ardelpik",
"first_name": "Helmout",
"last_name": "Ardelpik",
"line1": "165, avenue des champs Elysées",
"line2": "Batiment Leblanc",
"postal_code": "59800",
"city": "Lille",
"country": "France",
"additional_informations": "Digicode B345, 3 éme etage",
"primary_phone": "0685898585",
"secondary_phone": "",
"email": "[email protected]",
"floor": 4,
"lift_information": "with_lift"
},
"calendar": {
"starts_at": "2015-04-22T08:00:00Z",
"ends_at": "2015-04-22T10:00:00Z"
}
}
],
"status": {
"global": "pre_ordered",
"pickup_problems": [],
"shipping_problems": []
}
}
}
+ Request Exemple de requête "C2B" (application/json)
+ Headers
Api-Key: votreCléApi
+ Body
{
"slot": {
"starts_at": "2015-04-22T08:00:00+00:00",
"size": 120
},
"route": [
{
"type": "pickup",
"location": {
"type": "address",
"society": "Twelve factors & C",
"first_name": "Helmout",
"last_name": "Ardelpik",
"email": "[email protected]",
"primary_phone": "0685898585",
"secondary_phone": "",
"line1": "165, avenue des champs Elysées",
"line2": "Batiment Leblanc",
"additional_informations": "Digicode B345, 3 éme etage",
"postal_code": "59800",
"city": "Lille",
"country": "France",
"floor": 4,
"lift_information": "with_lift"
}
},
{
"type": "shipping",
"location": {
"type": "store",
"store_code": "100001"
}
}
],
"packaging": {
"global_description": "Ensemble set cuisine",
"packets": [
{
"description": "micro-onde",
"height": 60,
"length": 80,
"width": 30,
"weight": 2.5
},
{
"description": "Cafetière",
"height": 60,
"length": 80,
"width": 30,
"weight": 1.0
}
]
},
"webhook_url": "https://your-webhook-url.com"
}
+ Response 201 (application/json)
+ Body
{