FulfillmentPicking Sessions

Get many picking sessions

Get Many Picking Sessions

Retrieves a paginated list of picking sessions with optional filtering and search.

GET
/shipos/v1/picking-sessions
x-access-token<token>

In: header

Query Parameters

page?number

Page number for pagination (starting from 0)

Formatdouble
Default0
limit?number

Number of items per page (default: 10)

Formatdouble
Default10
search?string

Search term to filter by user name or warehouse name

Default""
warehouse_id?string

Filter by warehouse IDs (comma-separated for multiple)

Default""
type?string

Filter by session type (comma-separated for multiple)

Default""
status?string

Filter by session status (comma-separated for multiple)

Default""
order_by?string

Field to order results by

Default"created_at"

Value in

  • "created_at"
  • "updated_at"
order?string

Order direction ("asc" or "desc")

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/shipos/v1/picking-sessions"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "status": "UNASSIGNED",      "completion_outcome": "FULLY_PICKED",      "max_units_per_order": 0,      "bins": 0.1,      "warehouse_id": "string",      "merchant_team_id": [        "string"      ],      "started_at": "2019-08-24T14:15:22Z",      "closed_at": "2019-08-24T14:15:22Z",      "id": "string",      "min_units_per_order": 0,      "team_id": "string",      "type": "SINGLE_ITEM_BATCH",      "creation_mode": "DIRECT",      "picked_by_user_id": "string",      "picked_by_user_name": "string",      "session_number": "string",      "total_units_count": 0.1,      "unique_items_count": 0.1,      "remaining_units_to_pick": 0.1,      "picking_session_fulfillment_orders_count": 0.1    }  ],  "meta": {    "page": 0.1,    "page_size": 0.1,    "has_next_page": true,    "has_previous_page": true,    "start_index": 0.1,    "end_index": 0.1  }}