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
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Filter by location ID.

string

Filter by location name (e.g. J3.2). Performs an exact match against the location name. If multiple warehouses have a location with the same name, results from all matching warehouses are returned. Combine with warehouse_id to narrow to a specific warehouse.

integer
≥ 1

Filter by warehouse ID. Required when using location_name to disambiguate locations with the same name across warehouses. Optional when using location_id.

integer
≥ 1

Filter to a specific product at the location(s).

string
enum

Specifies the field by which to sort the results:

  • created_at: Sort by when the inventory was placed at the location.
  • updated_at: Sort by when the inventory location was last updated.
  • quantity: Sort by the on-hand quantity.
  • location_name: Sort by the location name.
Allowed:
integer
1 to 100
Defaults to 25

The maximum number of items to return in the response. Used for pagination. Must be between 1 and 100.

integer
≥ 0
Defaults to 0
deprecated

Deprecated. Use cursor instead. Offset pagination will be removed on November 9, 2026. See Pagination.

The number of items to skip before starting to return results. Cannot be used together with the cursor parameter.

string

A cursor for pagination. Omit it for the first page, then pass the next_cursor value from the previous response to fetch the next page. Keep the same filters and sort on every page. See Pagination.

string
enum
Defaults to asc

Specifies the sort direction of the returned items:

  • asc: Ascending order. For dates, this means from oldest to newest. For numbers, this means from smallest to largest.
  • desc: Descending order. For dates, this means from newest to oldest. For numbers, this means from largest to smallest.
Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json