List Custom Batches

Required permission: read_custom_batches

Returns a paginated list of custom batches for the organization. Supports filtering by warehouse, completion, label generation, and picking status.

Custom batches belong to the organization's warehouses, so this endpoint is only available to organization API keys.

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

Example use cases:

  • Get all custom batches: GET /custom-batches
  • Get custom batches in a warehouse: GET /custom-batches?warehouse_id=123
  • Get open custom batches: GET /custom-batches?completed=false
  • Get custom batches still being picked: GET /custom-batches?picking_status=picking
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 custom batches for the specified warehouse.

boolean

Filter by whether the custom batch has been completed.

boolean

Filter by whether shipping labels have been generated for the custom batch.

string
enum

Filter by picking status:

  • picking: Picking has started and is in progress.
  • completed: Picking has been completed.
Allowed:
string
enum

Specifies the field by which to sort the results:

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