List Batches

Required permission: read_batches

Returns a paginated list of batches (from Batch Shipping) in your organization's warehouses. Only organization API keys can list batches.

All filter parameters are optional and can be combined.

Example use cases:

  • Get all batches: GET /batches
  • Get open batches in a warehouse: GET /batches?warehouse_id=123&completed=false
  • Get batches with a client's orders: GET /batches?client_id=45
  • Get batches that are printed but not packed: GET /batches?printed=true&packed=false
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 batches created in the specified warehouse.

integer
≥ 1

Filter by client ID. Only returns batches that contain orders for the specified client.

integer
≥ 1

Filter by store ID. Only returns batches that contain orders from the specified store.

boolean

Filter by whether the batch has been completed.

boolean

Filter by whether the batch labels have been printed.

boolean

Filter by whether the batch has been marked packed.

string
enum

Specifies the field by which to sort the results:

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