Skip to main content
GET
/
inventory
/
get_item_free
Inventory - Get Item Free
curl --request GET \
  --url https://api.skulabs.com/inventory/get_item_free \
  --header 'Authorization: Bearer <token>'
{
  "free": 123,
  "on_hand": 123,
  "reserved": 123
}

Documentation Index

Fetch the complete documentation index at: https://skulabs.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
sku
string
required

Item SKU to look up free inventory for

​
warehouse_ids
string[]

Filter by warehouse IDs

Response

Free (available) inventory for the item

​
free
number
required

Free inventory quantity (on_hand - reserved)

​
on_hand
number
required

Total on-hand quantity across locations

​
reserved
number
required

Total reserved quantity from open orders