Skip to main content
GET
Error

Authorizations

​
Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Query Parameters

​
page
integer<int32>
default:1

Page number (1-based, default: 1)

​
size
integer<int32>
default:100

Number of results per page (max: 1000, default: 100)

​
skuIds
string<uuid>[]

Filter by one or more SKU IDs

​
warehouseIds
string<uuid>[]

Filter by one or more warehouse IDs

​
regionIds
string<uuid>[]

Filter by one or more region IDs

​
categories
string[]

Filter by one or more product category codes (e.g. COMPUTER, MONITOR)

​
brands
string[]

Filter by one or more vendor/brand codes

​
searchString
string

Search by product title (partial match)

​
active
boolean
default:true

Filter by active status — true returns active levels only, false returns inactive only (default: true)

Response

Paginated list of inventory level configurations with current stock details

​
id
string<uuid>
required

Unique identifier for this inventory level configuration

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
skuId
string<uuid>
required

ID of the SKU whose stock level this configuration controls

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
warehouseId
string<uuid>
required

ID of the warehouse where this inventory level applies

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
minQuantity
integer<int32>
required

Minimum quantity threshold

Example:

5

​
maxQuantity
integer<int32>
required

Maximum quantity threshold

Example:

20

​
includeUsed
boolean
required

Whether used inventory is included in stock calculations

​
autoCreate
boolean
required

Whether inventory orders are automatically created when stock is low

​
active
boolean
required

Whether this inventory level is active

​
stockDetails
object
required

Current stock details for this inventory level

​
regionId
string<uuid>

ID of the region scope for this inventory level; null means the organization's default region

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
customerPoNumber
string

Optional customer PO number copied to restock orders created from this level

Example:

"PO-12345"

​
createdInventoryOrderId
string<uuid>

Inventory order id created by autoCreate; null when no restock was triggered.

Example:

"123E4567-E89B-12D3-A456-426614174000"