List Pick Sessions

Required permission: read_pick_sessions

Returns a paginated list of pick sessions for the organization, including cancelled pick sessions. Supports filtering by warehouse, picker, order, status, and creation date.

Only organization API keys can list pick sessions.

Example use cases:

  • Get all pick sessions: GET /pick-sessions
  • Get in-progress pick sessions in a warehouse: GET /pick-sessions?warehouse_id=123&status=in_progress
  • Find the pick sessions an order is on: GET /pick-sessions?order_id=1001
  • Get a picker's sessions: GET /pick-sessions?user_id=5
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 pick sessions for the specified warehouse.

integer
≥ 1

Filter by the ID of the user picking the session.

integer
≥ 1

Filter to pick sessions the order is currently on. Orders removed from a session do not match.

string
enum

Filter by pick session status:

  • in_progress: Pick sessions that are still being picked.
  • completed: Pick sessions where picking has been completed.
  • cancelled: Pick sessions that were cancelled.
Allowed:
date-time

Filters items by the specified created_at start date.

date-time

Filters items by the specified created_at end date.

string
enum

Specifies the field by which to sort the results:

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