Inventory - Get Item Free

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

GET /inventory/get_item_free

Inventory - Get Item Free

cURL

curl --request GET \
  --url https://api.skulabs.com/inventory/get_item_free \
  --header 'Authorization: Bearer <token>'

200

{
  "free": 123,
  "on_hand": 123,
  "reserved": 123
}

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

200

application/json

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