inventory

Inventory - Get Item Free

Changed on

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

get/inventory/get_item_free

Request

  • Base URL
    https://api.skulabs.com
  • URL
    https://api.skulabs.com/inventory/get_item_free
  • Auth
    HTTP bearer

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

  • fa53dd949b8eRevision changes
    • breaking

      the query request parameter sku became required

    • info

      api operation id get_inventory_get_item_free was added

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 08cd9cfa14ddRevision changes
    • info

      for the query request parameter warehouse_ids, the type was generalized from string to array

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status