Aller au contenu

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.

  1. Prérequis : référentiels

    • Les articles référencés doivent exister (POST /articles)
    • Le client doit exister si config.CheckCustomer est activé (POST /customers)
  2. Envoi de la commandePOST /orders

    • La commande contient l’adresse de livraison, le transport et les lignes (articles + quantités)
    • L’API valide et transmet au WMS
  3. Traitement WMS (asynchrone)

    • Le WMS prend en charge la préparation physique
  4. Récupération du compte-renduGET /orders/reports

    • Pollez avec afterId ou afterDate
    • Le rapport contient : quantités préparées, détails colis, numéros de tracking

Une commande peut contenir ses lignes de deux manières exclusives :

{
"orderUniqueID": "CMD-001",
"orderEntries": [
{ "orderLineID": "1", "articleReference": "ART-001", "quantityToPrepare": 2 },
{ "orderLineID": "2", "articleReference": "ART-002", "quantityToPrepare": 1 }
]
}
{
"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 }
]
}
]
}

Si le pays de livraison n’est pas dans l’Union Européenne, des champs supplémentaires deviennent obligatoires :

Champ commandeChamp ligne
totalInvoiceHTarticleOriginCountry
shippingCostunitPriceHT
paymentCurrencyarticleCN23CustomsCode

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.

Monaco doit utiliser le code pays "FR" avec le code postal "98000". Le code "MC" n’est pas accepté (erreur 802).

Si configuré pour votre activité (BusinessRulePhoneNumberValidation), le numéro de téléphone est validé et reformaté au format E.164 (ex: +33612345678).

MéthodeEndpointDescription
POST/ordersCréer des commandes
GET/ordersLister les commandes
GET/orders/reportsComptes-rendus de préparation
GET/orders/{uniqueOrderID}/reportsCompte-rendu d’une commande
POST/orders/{orderId}/docs/{docSlug}Joindre un document