curl --request POST \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/inventory/{id}/release' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"location_id": 1,
"quantity": 5
}'
{
"data": {
"location_id": 1,
"location_name": "Main Warehouse",
"quantities": {
"allocated": "30",
"available": "270",
"on_hand": "300"
},
"updated_at": "2024-12-09T10:30:00Z",
"version": 5
},
"errors": [
"string"
],
"message": "Two-person tent, green — replacement for damaged pole set.",
"meta": {
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"timestamp": "2026-08-31T14:22:05Z"
},
"success": true
}
Release an inventory
Release an inventory
POST
/
api
/
v1
/
inventory
/
{id}
/
release
curl --request POST \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/inventory/{id}/release' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"location_id": 1,
"quantity": 5
}'
{
"data": {
"location_id": 1,
"location_name": "Main Warehouse",
"quantities": {
"allocated": "30",
"available": "270",
"on_hand": "300"
},
"updated_at": "2024-12-09T10:30:00Z",
"version": 5
},
"errors": [
"string"
],
"message": "Two-person tent, green — replacement for damaged pole set.",
"meta": {
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"timestamp": "2026-08-31T14:22:05Z"
},
"success": true
}
Path parameters
string
required
Inventory item id or item number
Request body
ReleaseInventoryRequest
integer (int32)
required
Location ID (must be positive)
integer (int64)
required
Quantity to release (must be at least 1)
Response
ApiResponse_InventoryLocation
object
API representation of inventory at a specific location.
Show data
Show data
integer (int32)
required
Location identifier
string,null
Human-readable location name
InventoryQuantities
required
string
required
Last update timestamp (RFC3339)
integer (int32)
required
Version number for optimistic locking. Include this in update requests to prevent lost updates.
array,null
string,null
boolean
required
Status codes
| Code | Meaning |
|---|---|
200 | Inventory released |
curl --request POST \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/inventory/{id}/release' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
"location_id": 1,
"quantity": 5
}'
{
"data": {
"location_id": 1,
"location_name": "Main Warehouse",
"quantities": {
"allocated": "30",
"available": "270",
"on_hand": "300"
},
"updated_at": "2024-12-09T10:30:00Z",
"version": 5
},
"errors": [
"string"
],
"message": "Two-person tent, green — replacement for damaged pole set.",
"meta": {
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"timestamp": "2026-08-31T14:22:05Z"
},
"success": true
}
Last modified on August 31, 2026