curl --request GET \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/inventory/low-stock' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"data": {
"items": [],
"page": 1,
"per_page": 50,
"total": 150
},
"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
}
Get low stock items
Low stock items
GET
/
api
/
v1
/
inventory
/
low-stock
curl --request GET \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/inventory/low-stock' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"data": {
"items": [],
"page": 1,
"per_page": 50,
"total": 150
},
"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
}
Query parameters
integer,null (int64)
integer,null (int32)
integer,null (int32)
Response
ApiResponse_InventoryListResponse
object
Show data
Show data
InventoryItem[]
required
List of inventory items
Show InventoryItem
Show InventoryItem
string,null
Item description
integer (int64)
required
Internal inventory item ID
string
required
SKU or item number
InventoryLocation[]
required
Inventory breakdown by location
integer (int64)
required
Organization ID
string,null
Unit of measure code
InventoryQuantities
required
Aggregated quantities across all locations
integer (int64)
required
Current page number
integer (int64)
required
Items per page
integer (int64)
required
Total number of items matching the query
array,null
string,null
boolean
required
Status codes
| Code | Meaning |
|---|---|
200 | Low stock items |
curl --request GET \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/inventory/low-stock' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"data": {
"items": [],
"page": 1,
"per_page": 50,
"total": 150
},
"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