List Single Item Batches

Required permission: read_single_item_batches

Returns a paginated list of single item batches for the organization. Supports filtering by warehouse, status, and pick mode. Requires an organization API key.

All filter parameters are optional. When no filters are provided, all single item batches for the organization are returned. Filters can be combined freely.

Example use cases:

  • Get all single item batches: GET /single-item-batches
  • Get single item batches in a warehouse: GET /single-item-batches?warehouse_id=123
  • Get single item batches ready to ship: GET /single-item-batches?status=ready_to_ship
  • Get tote-per-SKU single item batches: GET /single-item-batches?pick_mode=tote_per_sku
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1

Filter by warehouse ID. Only returns single item batches for the specified warehouse.

string
enum

Filter by single item batch status:

  • picking: Items are still being picked.
  • ready_to_ship: Picking is complete and the batch is ready to ship.
  • shipping_in_progress: Labels are being purchased for the batch.
  • completed: Shipping is complete.
  • cancelled: The batch was cancelled.
Allowed:
string
enum

Filter by pick mode:

  • single_tote: Every item is picked into one shared tote.
  • tote_per_sku: Each SKU is picked into its own tote.
Allowed:
string
enum

Specifies the field by which to sort the results:

  • created_at: Sort by when the single item batch was created.
  • updated_at: Sort by when the single item batch was last updated.
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.

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