Skip to main content

Get Put-Away Queue

GET 
/api/v2/put-away/queue

Paginated put-away queue: stock with a positive balance sitting in put-away-from locations (staging, returns, quarantine, damaged) — plus the Unassigned location when include_unassigned is truthy (default). Each row is decorated with the product's suggested destination bin (its preferred default storage location for the warehouse, when one is set and not deprecated).

Required scope: warehouses:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Requires Bearer token.

Search: filter[search] matches product SKU, product name, and location code; narrow with search_columns.

Operator-aware filters: filter[sku], filter[name], filter[location_code] (text) and filter[quantity] (numeric). Each supports a bare implicit-is form and an operator form (filter[quantity.greater_than]=50). Text operators: is, is_not, contains, does_not_contain, starts_with, does_not_start_with, ends_with, does_not_end_with, is_one_of, is_not_one_of, is_empty, is_not_empty. Numeric operators: is, is_not, greater_than, less_than, greater_than_or_equal, less_than_or_equal, between, is_one_of, is_not_one_of, is_empty, is_not_empty.

filter[warehouse_id] filters to one warehouse (exact match). include_unassigned toggles the Unassigned location. filter_groups accepts a base64-encoded JSON tree of AND/OR advanced filter groups and takes precedence over individual filter params.

Allowed sorts: product (SKU), location (code), quantity. Default order: location code, then product SKU.

Create a location transfer with reason put_away to work rows off the queue.

Request​

Responses​

OK

Response Headers
    Content-Type