Show an order
AuthorizationbearerAuth
Authorization
bearerAuth OAuth2 access token — how to obtain one is described under Setup → Authentication.
In: header
Path Parameters
Query Parameters
Header Parameters
The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).
"application/json"Value in
- "application/json"
Response Body
application/json
application/json
curl -X GET "https://example.com/orders/0" \ -H "Accept: application/json"{ "data": { "id": 0, "state": "open", "external_identifier": "string", "external_reference": "string", "customer_id": 0, "items": [ { "id": 0, "variant_id": 0, "quantity": 0, "id_tags": [ { "id": 0, "code": "string" } ] } ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}Create an order POST
Creates an order from designed variants (see [Variants → Design](/docs/checkout/2022-02-01/endpoints/variants/designVariant)). Variants must be in state `completed` before they can be ordered; orders with pending designs are rejected with a validation error. Use `external_identifier` / `external_reference` to link the order to your shop system — both are returned in every webhook payload.
Cancel an order POST
Cancels an order that has not entered production yet. Once production has started the order can no longer be cancelled and this endpoint returns a validation error. Subscribe to `order.cancelled` ([Basic Usage → Webhooks](/docs/checkout/2022-02-01/basic/webhooks)) to be notified when the cancellation is completed.