Update an inventory level

{ "id": "123e4567-e89b-12d3-a456-426614174000", "skuId": "123e4567-e89b-12d3-a456-426614174000", "warehouseId": "123e4567-e89b-12d3-a456-426614174000", "minQuantity": 5, "maxQuantity": 20, "includeUsed": true, "autoCreate": true, "active": true, "stockDetails": { "newInventories": 12, "usedInventories": 3, "pendingInventoryOrders": 2, "totalAvailable": 14, "totalItemsToOrder": 6 }, "regionId": "123e4567-e89b-12d3-a456-426614174000", "customerPoNumber": "PO-12345", "createdInventoryOrderId": "123E4567-E89B-12D3-A456-426614174000" }

Authorizations

Authorization

string

header

required

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

Path Parameters

string<uuid>

required

Body

application/json

Partial update for an inventory level. Only the fields listed in this schema are accepted.

    IMPORTANT: This endpoint does NOT accept skuId, warehouseId, or regionId — these are
    immutable after creation. Sending any of them returns 400 with a per-field error
    (Cannot change <field> after creation). Sending any other field name returns 400
    with detail Unknown field: <name>. Sending an empty body returns 400 At least one
    modifiable field must be provided. Fields skuId, warehouseId, and regionId are
    not editable after the inventory level has been created.

    Setting active to false soft-deletes the inventory level. Reactivating via PATCH
    (active=true on an inactive level) is not supported; use POST /api/inventory-levels.
    Sending active=true on an already-active level is a 200 no-op (no state change).

    NOTE: Sending a wrong type for a numeric field (e.g. minQuantity: "foo") returns 400
    with detail "Field \"<field>\" is missing or has an invalid value" — this is the global
    deserialization error shape, not the per-field aggregated shape described above.

unknownFields

object

required

Show child attributes

minQuantity

integer<int32>

New minimum quantity threshold (>= 1).

Example:

5

maxQuantity

integer<int32>

New maximum quantity threshold (>= 1; must be > minQuantity unless both equal 1).

Example:

20

includeUsed

boolean

Whether to include used inventory in stock calculations.

Example:

false

autoCreate

boolean

Whether to automatically create restock orders when stock is low.

Example:

false

active

boolean

Set to false to soft-delete the inventory level. Setting true on an inactive level is rejected.

Example:

false

customerPoNumber

string

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

Example:

"PO-12345"

Response

Inventory level updated

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

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

Show child attributes

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"

People

Shipment Notices V1

Returns

Replacements

People — Lifecycle

Packages

Orders

New Joiners

ITAD

Inventory

Inventory Orders

Inventory Levels

Assets

Return Orders

Offices

Warehouses V1

Shipment

Regions V1

Categories

Catalog

Brands

Update an inventory level

Authorizations

Path Parameters

Body

Response