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.

LPNs (license plates): stock on an LPN (a pallet or container) is returned as its own row with a non-null lpn object. One product at one location can have a loose row (lpn is null) plus one row per LPN, so use lpn to tell them apart. Filter with lpn_id for one LPN's contents, or with has_lpn=false / has_lpn=true for loose or LPN stock only. Inventory location ids of LPN rows change when the LPN is moved (the rows are recreated at the new location), so track LPN stock by lpn.id rather than by row id.

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
• Get the contents of an LPN: GET /inventory-locations?lpn_id=55
• Get loose stock only (not on an LPN): GET /inventory-locations?has_lpn=false