List Inventory Locations

Required permission: read_inventory

Returns inventory at bin locations. Each result represents a product stored at a location with its on-hand quantity, action-locked quantity, and available quantity.

All filter parameters are optional. When no filters are provided, all inventory locations for your organization are returned. Filters can be combined freely.

Example use cases:

  • Get all inventory across all locations: GET /inventory-locations
  • Get all inventory in a warehouse: GET /inventory-locations?warehouse_id=123
  • Get inventory at a specific bin in a warehouse: GET /inventory-locations?warehouse_id=123&location_name=J3.2
  • Get inventory at a bin name across all warehouses: GET /inventory-locations?location_name=J3.2
  • Get all locations for a specific product: GET /inventory-locations?product_id=789
Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!