Aller au contenu
ShopentlyLearn
Français

Commandes

Consultez les résumés et détails des commandes et modifiez leur statut ou celui du paiement.

Opérations

GETLister · Statuts — Commandes/api/v1/order-statuses

Exemple de requêteExemple de réponse

GETLister — Commandes/api/v1/orders

Exemple de requêteExemple de réponse

GETObtenir — Commandes/api/v1/orders/{order_id}

Exemple de requêteExemple de réponse

PATCHModifier · Statut du paiement — Commandes/api/v1/orders/{order_id}/payment-status

Exemple de requêteExemple de réponse

PATCHModifier · Statut — Commandes/api/v1/orders/{order_id}/status

Exemple de requêteExemple de réponse

Fonctionnement

La liste et le détail des commandes incluent delivery.dates. Les dates YYYY-MM-DD sont prévues et ne confirment pas l’expédition. Les dates actuelles sont prioritaires ; les anciennes commandes utilisent l’estimation enregistrée. Les valeurs effacées ou inconnues sont null. Le détail inclut aussi toutes les lignes et images des produits.

Obtenez les identifiants de statut valides via /api/v1/order-statuses. Le statut de commande et celui du paiement ont des opérations PATCH et des autorisations distinctes. Modifier le statut de paiement enregistré ne débite pas de carte et ne déclenche pas de remboursement chez un prestataire de paiement.

Écritures sûres

Autorisations et forfaits

delivery.dates: planned_dispatch_on, dispatch_timezone, estimated_delivery_from, estimated_delivery_to. Dates d’expédition et de livraison: YYYY-MM-DD; null. Fuseau horaire d’expédition: IANA.

Commande · Totaux

Les montants et taux proviennent de la commande enregistrée, corrections de lignes comprises. Les données historiques manquantes valent null et ne sont pas remplacées par les taux actuels du catalogue. Les montants restent des chaînes décimales.

  • tax_country_code · Pays fiscal · Données enregistrées de la commande · ISO 3166-1 alpha-2; null.
  • lines[].unit_* · Une unité · Avant remises; lines[].original_total_* · Avant remises; lines[].total_* · Après remises.
  • lines[].discount_* · Remises; manual_discount · Remise manuelle; percentage "10" = 10%.
  • delivery.net / tax / gross · Après remises; delivery.original_* · Avant remises; delivery.discount_* · Remises.
  • tax_rate: "0.23" = 23%; "0" ≠ null. Inconnu : null ; zéro connu : 0.
  • totals · Totaux; tax_breakdown.groups · Groupes de taxes; Taxe non affectée = order.tax − Σ groups.tax; ±.

La liste fournit des résumés. Appelez GET /api/v1/orders/{order_id} pour chaque résultat afin d’exporter les détails financiers. Les nouvelles tentatives GET sont limitées et respectent Retry-After. Un export par date de création ne synchronise pas les corrections ultérieures.

payment.amount est le total de la commande. Le statut du paiement ne détermine pas les montants payés, remboursés ou restant dus.

Schémas de données

Guides

Exporter les commandes