v1

latestOpenAPI 3.0.32026-07-13149852.3 MB
inventory

Inventory - Get Item Free

Retrieve the available (free) inventory quantity for an item, excluding reserved stock.

get/inventory/get_item_free

Query parameters

skustring required

Item SKU to look up free inventory for

warehouse_idsstring[]

Filter by warehouse IDs

Response

Free (available) inventory for the item

freenumber required

Free inventory quantity (on_hand - reserved)

on_handnumber required

Total on-hand quantity across locations

reservednumber required

Total reserved quantity from open orders