Orders

Commande buyer qui structure les lignes commerciales avant facture, paiement ou fulfillment.

Objet métier

Vue d’ensemble

Les endpoints orders couvrent la création, les transitions commerciales et les liens avec les invoices. Ils exposent les line items comme ressource rattachée.

Voir aussi la page du modèle métier order pour la sémantique, les relations et le cycle de vie fonctionnel.

Contrat JSON

Objet order

Les réponses utilisent l’identifiant préfixé ord_ et le champ object pour rendre le type explicite.

buyer_idstring

Identifiant de la company de l’acheteur.

statusenum

draft, created, confirmed, fulfilled, completed ou cancelled.

amount_excluding_tax / amount_tax / amount_including_taxnumber

Montants de la commande. amount_including_tax doit égaler amount_excluding_tax + amount_tax.

currencystring

Devise ISO du montant.

checkout_session_idstring

Checkout session source, si applicable.

line_itemsarray

Lignes commerciales rattachées.

REST

Endpoints

MéthodeEndpointUsage
POST/v1/ordersCréer une commande.
GET/v1/ordersLister les commandes, avec filtres merchant_id, buyer_id, contact_id, checkout_session_id ou status.
GET/v1/orders/{id}Récupérer une commande.
POST/v1/orders/{id}Mettre à jour une commande.
POST/v1/orders/{id}/confirmConfirmer une commande created.
POST/v1/orders/{id}/fulfillMarquer une commande confirmed comme fulfilled.
POST/v1/orders/{id}/completeMarquer une commande fulfilled comme completed.
POST/v1/orders/{id}/cancelAnnuler une commande draft, created ou confirmed.
GET/v1/orders/{id}/invoicesLister les factures liées.
POST/v1/orders/{id}/invoicesCréer une facture depuis la commande.
GET/v1/orders/{id}/line-itemsLister les lignes de commande.

Événements

Événements associés

Ces événements peuvent être consommés via les webhooks plateforme lorsque le compte est configuré pour les recevoir.

order.createdorder.updatedorder.confirmedorder.fulfilledorder.completedorder.cancelled

Comportement

Points d’attention

  • Les transitions d’état sont strictes et retournent une erreur si la commande n’est pas dans le statut attendu.
  • Les liens invoice/order référencent les factures et commandes par leurs identifiants.