curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/inventory/{sku}/reservations' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"expires_in_seconds": 250,
"quantity": "2",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference_type": "string"
}'
{
"created_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"item_id": 1001,
"location_id": 1001,
"quantity": "2",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference_type": "string",
"status": "pending"
}
Create a reservation
Stock held
POST
/
api
/
v1
/
inventory
/
{sku}
/
reservations
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/inventory/{sku}/reservations' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"expires_in_seconds": 250,
"quantity": "2",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference_type": "string"
}'
{
"created_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"item_id": 1001,
"location_id": 1001,
"quantity": "2",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference_type": "string",
"status": "pending"
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Path parameters
string
required
Product SKU
Request body
CreateReservationRequest
integer,null (int64)
Time-box the hold; omit for an open-ended one.
string
required
Units to hold. Must be positive and available.
string
required
Id of that thing.
string
required
What the hold is for (
order, cart, …).Response
ReservationResponse
string (date-time)
required
When the hold was taken.
string,null (date-time)
When the hold lapses, if it is time-boxed.
string (uuid)
required
Reservation id.
integer (int64)
required
Inventory item the hold is against.
integer (int32)
required
Location the units are held at.
string
required
Units held.
string
required
Id of that thing.
string
required
What the hold is for (
order, cart, backorder, …).string
required
pending, confirmed, allocated, released, expired or cancelled.Status codes
| Code | Meaning |
|---|---|
201 | Stock held |
404 | SKU not found |
409 | Insufficient stock |
422 | Validation error |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.stateset.com/api/v1/inventory/{sku}/reservations' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"expires_in_seconds": 250,
"quantity": "2",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference_type": "string"
}'
{
"created_at": "2026-08-31T14:22:05Z",
"expires_at": "2026-08-31T14:22:05Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"item_id": 1001,
"location_id": 1001,
"quantity": "2",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference_type": "string",
"status": "pending"
}
Last modified on October 20, 2026