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

Changes

Changed in 3 of the 13 revisions of this API.218

Mar 2, 2026fa53dd949b8e17See the full diff
- ▲
  the query request parameter sku became required
  request-parameter-became-required
- ○
  api operation id get_inventory_get_item_free was added
  api-operation-id-added
- ○
  added the media type application/json for the response with the status 200
  response-media-type-added
- ○
  added the media type application/json for the response with the status 400
  response-media-type-added
- ○
  added the media type application/json for the response with the status 401
  response-media-type-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
Apr 22, 202408cd9cfa14dd3See the full diff
- ○
  for the query request parameter warehouse_ids, the type/format was generalized from string/ to array/
  request-parameter-type-generalized
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
Apr 19, 202446ceda52800018See the full diff
- ▲
  removed the media type application/json for the response with the status 200
  response-media-type-removed
- ○
  api operation id get_inventory_get_item_free removed and replaced with
  api-operation-id-removed
- ○
  the query request parameter sku became optional
  request-parameter-became-optional
- ○
  for the query request parameter warehouse_ids, the type/format was generalized from array/ to string/
  request-parameter-type-generalized
- ○
  removed the non-success response with the status 400
  response-non-success-status-removed
- ○
  removed the non-success response with the status 401
  response-non-success-status-removed
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
- ○
  removed the non-success response with the status 429
  response-non-success-status-removed
- ○
  removed the non-success response with the status 500
  response-non-success-status-removed
This revision also has 85 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history