Reserve a cart from one merchant at catalog prices
Stock is reserved for each line (unless the variant does not track inventory or allows backorder) until the order is paid, canceled or expires.
/v1/ordersStock is reserved for each line (unless the variant does not track inventory or allows backorder) until the order is paid, canceled or expires. 422 insufficient_stock names the line that cannot be promised.
Authorization
bearerAuth A tenant API key (sk_{env}_{id}_{secret}), a wallet user token, or an IdP access token. Which principal the credential resolves to decides the scopes it carries; see the authentication guide.
In: header
Header Parameters
1 <= length <= 200Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Lines from one merchant. Prices come from the catalog; the buyer never sends an amount.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/v1/orders" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "lines": [ { "variant_id": "8a2d415d-59aa-4132-bef3-011f97c4a0f6", "quantity": 1 } ] }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643", "merchant_id": "500924a8-3f5e-4c00-beb8-2efcde988aea", "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "status": "open", "subtotal": 0, "commission": 0, "total": 0, "payment_id": "d43b87f9-9e28-4802-8eaa-6ee91a40ea71", "expires_at": "2019-08-24T14:15:22Z", "restocked_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "lines": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "offering_id": "a7d124b6-6a8c-44d1-9d46-4636e3f8c04e", "variant_id": "8a2d415d-59aa-4132-bef3-011f97c4a0f6", "title": "string", "variant_title": "string", "sku": "string", "unit_amount": 0, "quantity": 0, "line_amount": 0, "commission": 0 } ]}