Create order

Orders are deduplicated per connection. Send an `Idempotency-Key` header, or an `externalOrderId`, and retrying the same request returns that order, as it stands now, with `200` instead of creating a second one.

Orders are deduplicated per connection. Send an Idempotency-Key header, or an externalOrderId, and retrying the same request returns that order, as it stands now, with 200 instead of creating a second one.

Authorization

apiKey

AuthorizationBearer <token>

An API connection key, sent as Authorization: Bearer <key>. The x-api-key header is accepted as an alternative.

In: header

Header Parameters

idempotency-key?string

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

externalOrderId?string

Your own identifier for the order. Used as the idempotency key when the Idempotency-Key header is absent.

Length1 <= length <= 200

shippingAddress*

lines*array<>

The order carries no retail price, so an international parcel declares the merchant's cost for each product as its customs value.

Items1 <= items <= 100

testMode?boolean

Create a throwaway order instead of a real one. It is validated the same way, kept for two hours, never charged and never fulfilled, and its id is prefixed test_. You move it through its lifecycle yourself, with POST /v1/test/orders/{orderId}/transitions. Omitting this field creates a real, charged order.

Response Body

`application/json`

`application/problem+json`

curl -X POST "https://example.com/v1/orders" \  -H "Content-Type: application/json" \  -d '{    "shippingAddress": {      "firstName": "string",      "lastName": "string",      "address1": "string",      "city": "string",      "zip": "string",      "countryCode": "st"    },    "lines": [      {        "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",        "quantity": 1      }    ]  }'

{  "id": "string",  "testMode": true,  "status": "string",  "createdAt": "2019-08-24T14:15:22Z",  "externalOrderId": "string",  "lines": [    {      "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",      "quantity": 0    }  ]}

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

201application/json

400application/problem+json

401application/problem+json

403application/problem+json

409application/problem+json

422application/problem+json

429application/problem+json

Authorization

Header Parameters

Request Body

Response Body

`application/json`

`application/json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`

`application/problem+json`