Commandes - Vue d'ensemble
Les commandes sont le flux principal d’EzyConnect. Elles représentent des ordres de préparation envoyés au WMS pour expédition.
Workflow complet
Section intitulée « Workflow complet »-
Prérequis : référentiels
- Les articles référencés doivent exister (
POST /articles) - Le client doit exister si
config.CheckCustomerest activé (POST /customers)
- Les articles référencés doivent exister (
-
Envoi de la commande —
POST /orders- La commande contient l’adresse de livraison, le transport et les lignes (articles + quantités)
- L’API valide et transmet au WMS
-
Traitement WMS (asynchrone)
- Le WMS prend en charge la préparation physique
-
Récupération du compte-rendu —
GET /orders/reports- Pollez avec
afterIdouafterDate - Le rapport contient : quantités préparées, détails colis, numéros de tracking
- Pollez avec
Structure d’une commande
Section intitulée « Structure d’une commande »Une commande peut contenir ses lignes de deux manières exclusives :
Option 1 : Lignes directes (orderEntries)
Section intitulée « Option 1 : Lignes directes (orderEntries) »{ "orderUniqueID": "CMD-001", "orderEntries": [ { "orderLineID": "1", "articleReference": "ART-001", "quantityToPrepare": 2 }, { "orderLineID": "2", "articleReference": "ART-002", "quantityToPrepare": 1 } ]}Option 2 : Sous-commandes (orderSubOrders)
Section intitulée « Option 2 : Sous-commandes (orderSubOrders) »{ "orderUniqueID": "CMD-001", "orderSubOrders": [ { "clientOrderID": "SC-001", "orderEntries": [ { "orderLineID": "1", "articleReference": "ART-001", "quantityToPrepare": 2 } ] }, { "clientOrderID": "SC-002", "orderEntries": [ { "orderLineID": "2", "articleReference": "ART-002", "quantityToPrepare": 1 } ] } ]}Validations conditionnelles
Section intitulée « Validations conditionnelles »Commandes internationales (hors UE)
Section intitulée « Commandes internationales (hors UE) »Si le pays de livraison n’est pas dans l’Union Européenne, des champs supplémentaires deviennent obligatoires :
| Champ commande | Champ ligne |
|---|---|
totalInvoiceHT | articleOriginCountry |
shippingCost | unitPriceHT |
paymentCurrency | articleCN23CustomsCode |
Validation d’adresse française
Section intitulée « Validation d’adresse française »Pour les livraisons en France (deliveryAddressCountry = "FR"), l’adresse est validée via l’API gouvernementale. Erreur 802 si le code postal et la ville ne correspondent pas.
Cas Monaco
Section intitulée « Cas Monaco »Monaco doit utiliser le code pays "FR" avec le code postal "98000". Le code "MC" n’est pas accepté (erreur 802).
Validation du téléphone
Section intitulée « Validation du téléphone »Si configuré pour votre activité (BusinessRulePhoneNumberValidation), le numéro de téléphone est validé et reformaté au format E.164 (ex: +33612345678).
Endpoints
Section intitulée « Endpoints »| Méthode | Endpoint | Description |
|---|---|---|
| POST | /orders | Créer des commandes |
| GET | /orders | Lister les commandes |
| GET | /orders/reports | Comptes-rendus de préparation |
| GET | /orders/{uniqueOrderID}/reports | Compte-rendu d’une commande |
| POST | /orders/{orderId}/docs/{docSlug} | Joindre un document |