Reserve inventory for an order

Inventory reservation result

POST /v1/tenants/{tenant_id}/inventory/reservations

cURL

curl --request POST \
  --url 'https://api.sync.stateset.com/v1/tenants/{tenant_id}/inventory/reservations' \
  --header "x-stateset-api-key: $STATESET_SYNC_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "sku": "SKU-TENT-2P-GRN",
  "quantity": 2,
  "location": "string",
  "referenceId": "string"
}'

200

{
  "orderId": "string",
  "reserved": 1,
  "failed": 1,
  "reservationExpiresAt": "2026-08-31T14:22:05Z"
}

Path parameters

tenant_id · string · required

Tenant identifier

Request body

object

sku · string · required

Product SKU

quantity · integer · required

Quantity to reserve

location · string · required

Location code

referenceId · string · required

Reference ID (e.g., order ID)

Response

object

orderId · string · required

reserved · integer · required

failed · integer · required

reservationExpiresAt · string (date-time)

Status codes

Code	Meaning
200	Inventory reservation result
401	Unauthorized
422	Insufficient inventory

cURL

curl --request POST \
  --url 'https://api.sync.stateset.com/v1/tenants/{tenant_id}/inventory/reservations' \
  --header "x-stateset-api-key: $STATESET_SYNC_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "sku": "SKU-TENT-2P-GRN",
  "quantity": 2,
  "location": "string",
  "referenceId": "string"
}'

200

{
  "orderId": "string",
  "reserved": 1,
  "failed": 1,
  "reservationExpiresAt": "2026-08-31T14:22:05Z"
}