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.
Identifiant de la company de l’acheteur.
draft, created, confirmed, fulfilled, completed ou cancelled.
Montants de la commande. amount_including_tax doit égaler amount_excluding_tax + amount_tax.
Devise ISO du montant.
Checkout session source, si applicable.
Lignes commerciales rattachées.
REST
Endpoints
| Méthode | Endpoint | Usage |
|---|---|---|
| POST | /v1/orders | Créer une commande. |
| GET | /v1/orders | Lister 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}/confirm | Confirmer une commande created. |
| POST | /v1/orders/{id}/fulfill | Marquer une commande confirmed comme fulfilled. |
| POST | /v1/orders/{id}/complete | Marquer une commande fulfilled comme completed. |
| POST | /v1/orders/{id}/cancel | Annuler une commande draft, created ou confirmed. |
| GET | /v1/orders/{id}/invoices | Lister les factures liées. |
| POST | /v1/orders/{id}/invoices | Créer une facture depuis la commande. |
| GET | /v1/orders/{id}/line-items | Lister 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.
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.