Create an order

Creates an order from designed variants (see Variants → Design). 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.

AuthorizationbearerAuth

Authorization

bearerAuth

AuthorizationBearer <token>

OAuth2 access token — how to obtain one is described under Setup → Authentication.

In: header

Header Parameters

Accept*"application/json"

The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).

Default"application/json"

Value in

"application/json"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

items*array<>

The order positions — one entry per variant and quantity.

external_identifier?string

Your own identifier for this order — typically the order ID of your shop system. Returned in every webhook payload and filterable via ?filter[external_identifier], so you can always map a Smake order back to yours.

external_reference?string

A free additional reference of yours (e.g. invoice or project number). Also returned in webhooks and filterable via ?filter[external_reference].

customer_id?integer

ID of an existing customer — obtain it via Customers → List or from the response when the customer was created.

shipping_method?string

handle of a shipping method — the available handles come from Shipping Methods → List.

payment_method?string

handle of a payment method — the available handles come from Payment Methods → List.

Response Body

`application/json`

Request example

curl -X POST "https://example.com/orders" \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -d '{    "external_identifier": "shop-order-8842",    "external_reference": "143000",    "customer_id": 12,    "shipping_method": "dhl-standard",    "payment_method": "invoice",    "items": [      {        "variant_id": 42,        "quantity": 3      }    ]  }'

{  "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

Authorization

Header Parameters

Request Body

Response Body

201application/json

422application/json

`application/json`

`application/json`