Skip to content

Place a new order

POST
/orders

Submits a new order for processing.

X-Api-Key<token>

API key provided on the Custom API Connector 'Integrations' page.

In: header

Header Parameters

X-Bolt-Hmac-Sha256*string

HMAC SHA256 hash of the request body, encoded in Base64.

Idempotency-Key*string

A key that ensures POST and PATCH requests are only performed once.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

An order submitted by a shopper.

Response Body

application/json

application/json

curl -X POST "https://example.com/orders" \  -H "X-Bolt-Hmac-Sha256: string" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string"}