Skip to main content
POST
Error

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request to create an inventory level configuration

​
skuId
string<uuid>
required

ID of the SKU to set inventory levels for

Example:

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

​
warehouseId
string<uuid>
required

ID of the warehouse

Example:

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

​
minQuantity
integer<int32>
required

Minimum quantity threshold

Required range: x >= 1
Example:

5

​
maxQuantity
integer<int32>
required

Maximum quantity threshold

Required range: x >= 1
Example:

20

​
includeUsed
boolean
required

Whether to include used inventory in stock calculations

Example:

false

​
autoCreate
boolean
required

Whether to automatically create inventory orders when stock is low

Example:

false

​
regionId
string<uuid>

ID of the region (optional; uses org default when not provided)

Example:

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

​
customerPoNumber
string

Customer purchase order number to apply to restock orders created from this level

Example:

"PO-12345"

Response

Inventory level created successfully

Inventory level configuration with current stock details for a specific SKU, warehouse, and region

​
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"