List Single Order Batches

Required permission: read_single_order_batches

Returns a paginated list of single order shipping batches for the organization. Supports filtering by warehouse, completion, and assigned user. Requires an organization API key.

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

Example use cases:

  • Get all single order batches: GET /single-order-batches
  • Get single order batches in a warehouse: GET /single-order-batches?warehouse_id=123
  • Get open single order batches: GET /single-order-batches?completed=false
  • Get single order batches assigned to a user: GET /single-order-batches?assigned_user_id=45
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 order batches for the specified warehouse.

boolean

Filter by completion. true returns only completed batches, false returns only open batches.

integer
≥ 1

Filter by the ID of the user the batch is assigned to.

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