Obtenir — Commandes

Consultez les données de « Commandes ». Le résultat dépend des paramètres de cette opération.

GET`/api/v1/orders/{order_id}`

Authentification: Bearer
Disponible à partir de: BASIC
Autorisations requises: orders.order:read

Exemple de requête

cURL

: "${SHOPENTLY_SHOP_URL:?}"

curl --disable --globoff --fail-with-body --silent --show-error \
  --proto '=https' --connect-timeout 5 --max-time 30 \
  --request GET \
  --header "Authorization: Bearer ${SHOPENTLY_ACCESS_TOKEN:?}" \
  --url "${SHOPENTLY_SHOP_URL%/}"/api/v1/orders/example

PHP

<?php
declare(strict_types=1);

$baseUrl = rtrim(getenv('SHOPENTLY_SHOP_URL') ?: '', '/');
$origin = parse_url($baseUrl);
if (!$origin || ($origin['scheme'] ?? '') !== 'https' || empty($origin['host']) ||
    isset($origin['user'], $origin['pass']) || isset($origin['user']) || isset($origin['path']) ||
    isset($origin['query']) || isset($origin['fragment'])) {
    throw new RuntimeException('SHOPENTLY_SHOP_URL must be an HTTPS origin');
}
$credential = getenv('SHOPENTLY_ACCESS_TOKEN') ?: '';
if ($credential === '' || strpbrk($credential, "\r\n") !== false) {
    throw new RuntimeException('Invalid credential');
}
$headers = [];
$headers[] = 'Authorization: Bearer ' . $credential;
$responseHeaders = [];
$handle = curl_init($baseUrl . '/api/v1/orders/example');
curl_setopt_array($handle, [
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => $headers,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_FOLLOWLOCATION => false,
    CURLOPT_PROTOCOLS => CURLPROTO_HTTPS,
    CURLOPT_SSL_VERIFYPEER => true,
    CURLOPT_SSL_VERIFYHOST => 2,
    CURLOPT_CONNECTTIMEOUT => 5,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HEADERFUNCTION => static function ($handle, string $line) use (&$responseHeaders): int {
        if (str_contains($line, ':')) {
            [$name, $value] = explode(':', $line, 2);
            $responseHeaders[strtolower(trim($name))] = trim($value);
        }
        return strlen($line);
    },
]);
$raw = curl_exec($handle);
$status = curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
$error = curl_error($handle);
curl_close($handle);
if ($raw === false) {
    throw new RuntimeException('Transport error: ' . $error);
}
if ($status < 200 || $status >= 300) {
    throw new RuntimeException('HTTP ' . $status . '; request_id=' .
        ($responseHeaders['x-request-id'] ?? '') . '; retry_after=' . ($responseHeaders['retry-after'] ?? ''));
}
$result = $raw === '' ? null : json_decode($raw, true, 512, JSON_THROW_ON_ERROR | JSON_BIGINT_AS_STRING);
echo json_encode($result, JSON_THROW_ON_ERROR | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE), PHP_EOL;

Python

from contextlib import ExitStack
import json
import os
from urllib.parse import urlsplit

import requests  # python -m pip install requests

base_url = os.environ["SHOPENTLY_SHOP_URL"].rstrip("/")
origin = urlsplit(base_url)
if origin.scheme != "https" or not origin.hostname or origin.username or origin.password or origin.path or origin.query or origin.fragment:
    raise ValueError("SHOPENTLY_SHOP_URL must be an HTTPS origin")
credential = os.environ['SHOPENTLY_ACCESS_TOKEN']
if not credential or "\r" in credential or "\n" in credential:
    raise ValueError("Invalid credential")
headers = {}
headers["Authorization"] = 'Bearer' + " " + credential
body = None
if body is not None:
    headers["Content-Type"] = "application/json"

with ExitStack() as stack:
    session = stack.enter_context(requests.Session())
    files = None
    if False:
        image = stack.enter_context(open(os.environ["SHOPENTLY_IMAGE_FILE"], "rb"))
        if os.fstat(image.fileno()).st_size > 5242880:
            raise ValueError("Image exceeds 5 MiB")
        files = {"file": ("article.png", image, "image/png")}
    response = session.request(
        'GET', base_url + '/api/v1/orders/example', headers=headers,
        data=body.encode("utf-8") if body is not None else None, files=files,
        timeout=(5, 30), allow_redirects=False,
    )
    if not 200 <= response.status_code < 300:
        raise RuntimeError(f"HTTP {response.status_code}; request_id={response.headers.get('X-Request-ID', '')}; retry_after={response.headers.get('Retry-After', '')}")
    if False:
        if response.headers.get("Content-Type") != "image/webp" or len(response.content) > 5242880:
            raise ValueError("Unexpected image response")
        with open(os.environ["SHOPENTLY_OUTPUT_FILE"], "xb") as output:
            output.write(response.content)
    else:
        result = response.json() if response.content else None
        print(json.dumps(result, ensure_ascii=False, indent=2))

Exemple de réponse 200

JSON

{
  "data": {
    "created_at": "2026-10-19T10:00:00Z",
    "customer": {
      "email": "customer@example.invalid",
      "first_name": "Example",
      "last_name": "Example",
      "phone": null
    },
    "delivery": {
      "amount": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "dates": {
        "dispatch_timezone": "Europe/Warsaw",
        "estimated_delivery_from": "2026-10-20",
        "estimated_delivery_to": "2026-10-21",
        "planned_dispatch_on": "2026-10-19"
      },
      "discount_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "discount_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "discounts": [
        {
          "amount": {
            "amount": "24.60",
            "currency": "PLN",
            "minor_units": 2
          },
          "campaign_id": "saved-coupon",
          "code": "SAVE",
          "kind": "coupon",
          "name": "Saved coupon",
          "sequence": 1,
          "version": 3
        }
      ],
      "gross": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "method_code": "shipping-old",
      "method_name": "Historic carrier",
      "net": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_gross": {
        "amount": "24.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_net": {
        "amount": "20.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "original_tax": {
        "amount": "4.60",
        "currency": "PLN",
        "minor_units": 2
      },
      "pickup_point": null,
      "recipient_mode": "full_address",
      "tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      },
      "tax_category_id": "standard",
      "tax_category_name": "VAT 23%",
      "tax_rate": "0.23"
    },
    "discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "discounts": [
      {
        "amount": {
          "amount": "12.30",
          "currency": "PLN",
          "minor_units": 2
        },
        "campaign_id": "saved-coupon",
        "code": "SAVE",
        "kind": "coupon",
        "name": "Saved coupon",
        "sequence": 1,
        "shipping_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "version": 3
      }
    ],
    "id": "order-0000",
    "invoice": null,
    "invoice_requested": false,
    "lifecycle_state": "placed",
    "lines": [
      {
        "discount_amount": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [
          {
            "amount": {
              "amount": "12.30",
              "currency": "PLN",
              "minor_units": 2
            },
            "campaign_id": "saved-coupon",
            "code": "SAVE",
            "kind": "coupon",
            "name": "Saved coupon",
            "sequence": 1,
            "shipping_amount": null,
            "version": 3
          }
        ],
        "identifiers": {},
        "image": null,
        "line_id": "saved-line-a",
        "manual_discount": {
          "amount": {
            "amount": "12.30",
            "currency": "PLN",
            "minor_units": 2
          },
          "kind": "fixed",
          "value": "12.30"
        },
        "name": "Saved A",
        "original_total": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "246.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "200.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "46.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 1,
        "product_id": "product-api",
        "quantity": 2,
        "sku": "A",
        "tax": {
          "amount": "20.70",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax_category_id": "standard",
        "tax_category_name": "VAT 23%",
        "tax_rate": "0.23",
        "total": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "221.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "180.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "41.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "123.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "23.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      },
      {
        "discount_amount": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discount_tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "discounts": [],
        "identifiers": {},
        "image": null,
        "line_id": "b548a171-c331-505f-98f8-db3a06070998",
        "manual_discount": null,
        "name": "Saved B",
        "original_total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "original_total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "position": 2,
        "product_id": "deleted-product",
        "quantity": 1,
        "sku": "B",
        "tax": null,
        "tax_category_id": "reduced",
        "tax_category_name": "VAT 8%",
        "tax_rate": "0.08",
        "total": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "total_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_gross": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_net": {
          "amount": "100.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_price": {
          "amount": "108.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "unit_tax": {
          "amount": "8.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "variant_id": null,
        "variant_options": []
      }
    ],
    "locale": "pl",
    "market_id": "market-pl",
    "number": "0001",
    "payment": {
      "amount": {
        "amount": "329.40",
        "currency": "PLN",
        "minor_units": 2
      },
      "environment": "live",
      "method_code": "payment-old",
      "method_name": "Historic method",
      "paid_at": null,
      "status": "unpaid",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 0
    },
    "pickup_point": null,
    "prices_include_tax": true,
    "shipping_address": null,
    "shipping_discount_amount": {
      "amount": "24.60",
      "currency": "PLN",
      "minor_units": 2
    },
    "status": {
      "id": "status-0",
      "name": "Status 0",
      "updated_at": "2026-10-19T10:00:00Z",
      "version": 1
    },
    "subtotal": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax": {
      "amount": "49.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "tax_breakdown": {
      "groups": [
        {
          "gross": {
            "amount": "221.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "180.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "41.40",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        },
        {
          "gross": {
            "amount": "108.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "100.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "products",
          "tax": {
            "amount": "8.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.08"
        },
        {
          "gross": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "net": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "source": "shipping",
          "tax": {
            "amount": "0.00",
            "currency": "PLN",
            "minor_units": 2
          },
          "tax_rate": "0.23"
        }
      ],
      "unallocated_tax": {
        "amount": "0.00",
        "currency": "PLN",
        "minor_units": 2
      }
    },
    "tax_country_code": "PL",
    "total": {
      "amount": "329.40",
      "currency": "PLN",
      "minor_units": 2
    },
    "totals": {
      "before_discounts": {
        "gross": {
          "amount": "378.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "320.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "58.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "discounts": {
        "gross": {
          "amount": "49.20",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "40.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "9.20",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "order": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "product_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products": {
        "gross": {
          "amount": "329.40",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "280.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "49.40",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "products_before_discounts": {
        "gross": {
          "amount": "354.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "300.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "54.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping": {
        "gross": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "0.00",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_before_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      },
      "shipping_discounts": {
        "gross": {
          "amount": "24.60",
          "currency": "PLN",
          "minor_units": 2
        },
        "net": {
          "amount": "20.00",
          "currency": "PLN",
          "minor_units": 2
        },
        "tax": {
          "amount": "4.60",
          "currency": "PLN",
          "minor_units": 2
        }
      }
    }
  },
  "meta": {
    "request_id": "example-request"
  }
}

Fonctionnement

La collection fournit des résumés et des filtres par numéro, statut, statut de paiement et date de création.
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

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.

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.

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; ±.

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.

Paramètres

Paramètres de chemin

order_idChaîneObligatoire

Identifiant de la commande associée.

Contraintes

pattern: "^[a-z0-9][a-z0-9_-]{0,62}$"

Exemple: "example"

Cette opération n'accepte pas de corps JSON.

Réponses

Réponse 200

Modèle complet: ApiResponse_OrderDetailData_

dataOrderDetailData Obligatoire

Données d'une réponse réussie.

Champs · data

Modèle complet: OrderDetailData

created_atChaîneObligatoire

Date et heure de création.

format: "date-time"

customerCustomerData Obligatoire

Données du client enregistrées pour cette ressource.

Champs · customer

Modèle complet: CustomerData

emailChaîneObligatoire: Adresse e-mail.
first_nameChaîne nullObligatoire: Prénom.
last_nameChaîne nullObligatoire: Nom de famille.
phoneChaîne nullObligatoire: Numéro de téléphone.

deliveryShippingDetailData Obligatoire

Mode de livraison et informations associées.

Champs · delivery

Modèle complet: ShippingDetailData

amountMoneyData Obligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

datesDeliveryDatesData Obligatoire

Dates d’expédition et de livraison

discount_grossMoneyData Obligatoire

Montant brut · Remises; Inconnu : null ; zéro connu : 0.

discount_netMoneyData nullObligatoire

Montant net · Remises; Inconnu : null ; zéro connu : 0.

discount_taxMoneyData nullObligatoire

Montant de taxe · Remises; Inconnu : null ; zéro connu : 0.

discountsTableau <OrderDeliveryDiscountData > nullObligatoire

Réductions

grossMoneyData Obligatoire

Montant brut · Après remises; Inconnu : null ; zéro connu : 0.

method_codeChaîne nullObligatoire

Code du mode de livraison ou de paiement.

method_nameChaîne nullObligatoire

Nom du mode de livraison ou de paiement.

netMoneyData nullObligatoire

Montant net · Après remises; Inconnu : null ; zéro connu : 0.

original_grossMoneyData Obligatoire

Montant brut · Livraison · Avant remises; Inconnu : null ; zéro connu : 0.

original_netMoneyData nullObligatoire

Montant net · Livraison · Avant remises; Inconnu : null ; zéro connu : 0.

original_taxMoneyData nullObligatoire

Montant de taxe · Livraison · Avant remises; Inconnu : null ; zéro connu : 0.

pickup_pointDeliveryPickupPointData nullObligatoire

Point de retrait

recipient_modeChaîneObligatoire

Variante de la structure de données définie par les valeurs autorisées.

Contraintes

enum: ["full_address", "pickup_contact"]

taxMoneyData nullObligatoire

Informations sur les taxes.

tax_category_idChaîne nullObligatoire

Identifiant de la catégorie fiscale.

tax_category_nameChaîne nullObligatoire

Nom enregistré de la catégorie fiscale; null.

tax_rateChaîne nullObligatoire

tax_rate · Données enregistrées de la commande: "0.23" = 23%; "0" ≠ null.

discount_amountMoneyData Obligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Champs · discount_amount

Modèle complet: MoneyData

amountChaîneObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

pattern: "^[A-Z]{3}$"

minor_unitsEntierObligatoire

Nombre de décimales utilisées par la devise.

minimum: 0maximum: 4

discountsTableau <OrderDiscountData > Obligatoire

Réductions

Champs · discounts

OrderDiscountData

Modèle complet: OrderDiscountData

idChaîneObligatoire

Identifiant de ressource ; conserver la valeur renvoyée.

invoiceInvoiceData nullObligatoire

Informations de facturation.

Champs · invoice

InvoiceData

Modèle complet: InvoiceData

null

invoice_requestedBooléenObligatoire

Indique si une facture a été demandée.

lifecycle_stateOrderLifecycleState Obligatoire

État du cycle de vie métier.

linesTableau <OrderLineData > Obligatoire

Instantanés des lignes de commande.

Champs · lines

OrderLineData

Modèle complet: OrderLineData

localeChaîneObligatoire

Langue sélectionnée pour cette requête.

market_idChaîneObligatoire

Identifiant de marché renvoyé par le point d'accès au contexte.

numberChaîneObligatoire

Numéro de commande ou de demande visible par l'utilisateur.

paymentPaymentData Obligatoire

Détails du paiement enregistrés pour la commande.

Champs · payment

Modèle complet: PaymentData

amountMoneyData Obligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

environmentChaîneObligatoire

Informations d'environnement associées à l'enregistrement.

Contraintes

enum: ["live", "sandbox"]

method_codeChaîne nullObligatoire

Code du mode de livraison ou de paiement.

method_nameChaîne nullObligatoire

Nom du mode de livraison ou de paiement.

paid_atChaîne nullObligatoire

Date et heure du passage au statut payé.

Chaîne:format: "date-time"

statusOrderPaymentStatus Obligatoire

Statut accepté par cette opération précise.

updated_atChaîneObligatoire

Date et heure de la dernière modification.

format: "date-time"

versionEntierObligatoire

Version de ressource utilisée pour le contrôle de concurrence.

pickup_pointPickupPointData nullObligatoire

Point de retrait

Champs · pickup_point

PickupPointData

Modèle complet: PickupPointData

null

prices_include_taxBooléenObligatoire

Indique si les prix de la liste comprennent les taxes.

shipping_addressAddressData nullObligatoire

Adresse de livraison.

Champs · shipping_address

AddressData

Modèle complet: AddressData

null

shipping_discount_amountMoneyData Obligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

Champs · shipping_discount_amount

Modèle complet: MoneyData

amountChaîneObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

pattern: "^[A-Z]{3}$"

minor_unitsEntierObligatoire

Nombre de décimales utilisées par la devise.

minimum: 0maximum: 4

statusOrderStatusData Obligatoire

Statut accepté par cette opération précise.

Champs · status

Modèle complet: OrderStatusData

idChaîneObligatoire: Identifiant de ressource ; conserver la valeur renvoyée.
nameChaîneObligatoire: Nom de la ressource dans le contexte concerné.
updated_atChaîneObligatoire: Date et heure de la dernière modification.
format: "date-time"
versionEntierObligatoire: Version de ressource utilisée pour le contrôle de concurrence.

subtotalMoneyData Obligatoire

Montant avant les composantes supplémentaires indiquées dans la réponse.

Champs · subtotal

Modèle complet: MoneyData

amountChaîneObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

pattern: "^[A-Z]{3}$"

minor_unitsEntierObligatoire

Nombre de décimales utilisées par la devise.

minimum: 0maximum: 4

taxMoneyData Obligatoire

Informations sur les taxes.

Champs · tax

Modèle complet: MoneyData

amountChaîneObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

pattern: "^[A-Z]{3}$"

minor_unitsEntierObligatoire

Nombre de décimales utilisées par la devise.

minimum: 0maximum: 4

tax_breakdownOrderTaxBreakdownData Obligatoire

Groupes de taxes · source + tax_rate; unallocated_tax.

Champs · tax_breakdown

Modèle complet: OrderTaxBreakdownData

groupsTableau <OrderTaxGroupData > Obligatoire: Groupes de taxes · source + tax_rate; Inconnu : null ; zéro connu : 0.
unallocated_taxMoneyData Obligatoire: Taxe non affectée = order.tax − Σ groups.tax; ±.

tax_country_codeChaîne nullObligatoire

Pays fiscal · Données enregistrées de la commande · ISO 3166-1 alpha-2; null.

totalMoneyData Obligatoire

Montant total.

Champs · total

Modèle complet: MoneyData

amountChaîneObligatoire

Montant décimal sous forme de chaîne JSON ; null uniquement lorsque cela est autorisé.

currencyChaîneObligatoire

Code de la devise du montant.

Contraintes

pattern: "^[A-Z]{3}$"

minor_unitsEntierObligatoire

Nombre de décimales utilisées par la devise.

minimum: 0maximum: 4

totalsOrderTotalsData Obligatoire

Totaux · net / tax / gross; Avant remises / Après remises.

Champs · totals

Modèle complet: OrderTotalsData

before_discountsOrderAmountBreakdownData Obligatoire: Commande · Avant remises · net / tax / gross.
discountsOrderAmountBreakdownData Obligatoire: Réductions
orderOrderAmountBreakdownData Obligatoire: Commande · Après remises · net / tax / gross.
product_discountsOrderAmountBreakdownData Obligatoire: Produits · Remises · net / tax / gross.
productsOrderAmountBreakdownData Obligatoire: Produits · Après remises · net / tax / gross.
products_before_discountsOrderAmountBreakdownData Obligatoire: Produits · Avant remises · net / tax / gross.
shippingOrderAmountBreakdownData Obligatoire: Livraison · Après remises · net / tax / gross.
shipping_before_discountsOrderAmountBreakdownData Obligatoire: Livraison · Avant remises · net / tax / gross.
shipping_discountsOrderAmountBreakdownData Obligatoire: Livraison · Remises · net / tax / gross.

metaContextPageMeta ContextMeta PageMeta RequestMeta Obligatoire

Métadonnées de la réponse.

Champs · meta

ContextPageMeta

Modèle complet: ContextPageMeta

localeChaîneObligatoire: Langue sélectionnée pour cette requête.
market_codeChaîneObligatoire: Code de marché renvoyé par le point d'accès au contexte.
market_idChaîneObligatoire: Identifiant de marché renvoyé par le point d'accès au contexte.
paginationPagination Obligatoire: Métadonnées de pagination par curseur.
request_idChaîneObligatoire: Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.
minLength: 1maxLength: 100

ContextMeta

Modèle complet: ContextMeta

localeChaîneObligatoire: Langue sélectionnée pour cette requête.
market_codeChaîneObligatoire: Code de marché renvoyé par le point d'accès au contexte.
market_idChaîneObligatoire: Identifiant de marché renvoyé par le point d'accès au contexte.
request_idChaîneObligatoire: Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.
minLength: 1maxLength: 100

PageMeta

Modèle complet: PageMeta

paginationPagination Obligatoire: Métadonnées de pagination par curseur.
request_idChaîneObligatoire: Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.
minLength: 1maxLength: 100

RequestMeta

Modèle complet: RequestMeta

request_idChaîneObligatoire: Identifiant de demande ; dans les métadonnées, identifiant de la requête HTTP.
minLength: 1maxLength: 100

Exemple de réponse

Statut HTTP

200: Réponse réussie Schéma
400: Requête invalide
401: Authentification requise
403: Accès refusé
404: Ressource introuvable
409: Conflit de version
422: Échec de validation
429: Limite de requêtes dépassée

Autres statuts HTTP (7)

405: Méthode non autorisée
413: Requête trop volumineuse
415: Format non pris en charge
500: Erreur du serveur
502: Erreur de passerelle API
503: Service indisponible
504: Délai de passerelle dépassé

Catalogue des erreurs: ErrorResponse

En-têtes

401

WWW-AuthenticateChaîneFacultatif: Schéma d'authentification exigé par le serveur.

405

AllowChaîneFacultatif: Méthodes HTTP prises en charge par cette ressource.

429, 503

Retry-AfterEntierFacultatif: Délai minimal avant une nouvelle tentative, en secondes.

minimum: 0

Catalogue des erreurs · En savoir plus

GET/api/v1/orders/{order_id}

Exemples de code

Exemple de requête

cURL

PHP

Python

Exemple de réponse 200

Fonctionnement

Commande · Totaux

Paramètres

Paramètres de chemin

Réponses

Réponse 200

Statut HTTP

GET`/api/v1/orders/{order_id}`