> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# pickSessions
> List pick sessions, newest first. Filter by status to find open work, by location for one warehouse, and by creation time for a day's sessions.
**Required scopes:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
## Arguments
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
DateTime}>
Only include sessions created before this ISO-8601 instant.
DateTime}>
Only include sessions created at or after this ISO-8601 instant.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
Only include sessions picking from this location.
PickSessionSortKey}>
Which key to sort by. Sessions sort by creation time, newest first; pass `reverse` for oldest first.
Reverses the sort direction selected by `orderBy` (or its default).
[PickSessionStatus!]}>
Only include sessions with one of these statuses, e.g. \[CREATING, ACTIVE] for work in progress.
## Returns
PickSessionConnection!} required>
A paginated list of PickSession items.
[PickSessionEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
Opaque cursor for this item; pass to `after`/`before` to page from here.
PickSession!} required>
The item at this edge.
WarehouseTeamMember}>
The team member who queued the session for its picker. Null when the picker created it themselves.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
DateTime}>
When the session was completed.
PickSession}>
Zone picking: the session this one's items were moved into, when its status is CONSOLIDATED.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
PickSession}>
Zone picking: the upstream session whose leftover items started this one.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
DateTime!} required>
When the session was created.
The name of the saved pick filter the session was built from, if any.
The id of this pick session.
PickSessionInventorySource!} required>
Which stock the session draws from.
PickSessionItemConnection!} required>
The session's active lines in pick order. Archived lines after a split are omitted; session totals still include them.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
The pick session's legacy Mongo ObjectId (24-char hex), as shown in the Redo app's URLs.
Location}>
The warehouse the session picks from. Null if unset or no longer readable.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
How many orders the session holds, including orders on archived lines.
DateTime}>
When picking finished.
WarehouseTeamMember}>
The team member picking the session. Null before someone claims it or when the user no longer exists.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
DateTime}>
When labels for the session's orders were printed.
Units marked out of stock across every line, including archived lines.
Units picked so far across every line, including archived lines.
PickSessionScanType!} required>
Where picked items are scanned and sorted into orders.
PickSessionStatus!} required>
Where the session is in its lifecycle.
PickSessionStrategy!} required>
How orders were grouped into the session.
Units to pick across every line, including archived lines.
DateTime!} required>
When the session last changed.
[PickSession!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
WarehouseTeamMember}>
The team member who queued the session for its picker. Null when the picker created it themselves.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
Email address of the team member.
Display name of the team member. Null when the user has no name set.
DateTime}>
When the session was completed.
PickSession}>
Zone picking: the session this one's items were moved into, when its status is CONSOLIDATED.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
PickSession}>
Zone picking: the upstream session whose leftover items started this one.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
DateTime!} required>
When the session was created.
The name of the saved pick filter the session was built from, if any.
The id of this pick session.
PickSessionInventorySource!} required>
Which stock the session draws from.
PickSessionItemConnection!} required>
The session's active lines in pick order. Archived lines after a split are omitted; session totals still include them.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
**Fields**
[PickSessionItemEdge!]!} required>
The list of edges (each a node plus its pagination `cursor`).
[PickSessionItem!]!} required>
The nodes in this page, without the edge/cursor wrapper — a convenience over `edges`.
PageInfo!} required>
Pagination metadata for the current page.
The pick session's legacy Mongo ObjectId (24-char hex), as shown in the Redo app's URLs.
Location}>
The warehouse the session picks from. Null if unset or no longer readable.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
The city of the location's address.
The company name associated with the location.
The country code, e.g. "US".
DateTime!} required>
When the record was created.
The id of this location.
InventoryItemConnection!} required>
Traceable inventory units at this warehouse.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
LocationInventoryLevelConnection!} required>
Per-product inventory levels held at this location.
**Requires:** [`inventory_read`](/docs/api-reference/v3/reference/scopes#scope-inventory_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
The location's display name.
The contact phone number for the location.
The postal or ZIP code, e.g. "84101".
The state or province code, e.g. "UT".
StorageLocationConnection!} required>
Bins and other storage locations within this warehouse.
**Requires:** [`locations_read`](/docs/api-reference/v3/reference/scopes#scope-locations_read)
**Arguments**
Forward pagination cursor — returns items after it. Pass an `edges[].cursor` or `pageInfo.endCursor` from a previous page.
Backward pagination cursor — returns items before it. Pass an `edges[].cursor` or `pageInfo.startCursor` from a previous page.
Forward pagination: returns the first N items (max 100, default 25). Use with `after`; mutually exclusive with `last`/`before`.
Backward pagination: returns the last N items (max 100, default 25). Use with `before`; mutually exclusive with `first`/`after`.
The first line of the street address.
The second line of the street address.
DateTime!} required>
When the record was last updated.
How many orders the session holds, including orders on archived lines.
DateTime}>
When picking finished.
WarehouseTeamMember}>
The team member picking the session. Null before someone claims it or when the user no longer exists.
**Requires:** [`pick_sessions_read`](/docs/api-reference/v3/reference/scopes#scope-pick_sessions_read)
Email address of the team member.
Display name of the team member. Null when the user has no name set.
DateTime}>
When labels for the session's orders were printed.
Units marked out of stock across every line, including archived lines.
Units picked so far across every line, including archived lines.
PickSessionScanType!} required>
Where picked items are scanned and sorted into orders.
PickSessionStatus!} required>
Where the session is in its lifecycle.
PickSessionStrategy!} required>
How orders were grouped into the session.
Units to pick across every line, including archived lines.
DateTime!} required>
When the session last changed.
PageInfo!} required>
Pagination metadata for the current page.
Cursor of the last edge in this page; pass to `after` to page forward.
Whether more items exist after this page (drives forward pagination with `first`/`after`).
Whether more items exist before this page (drives backward pagination with `last`/`before`).
Cursor of the first edge in this page; pass to `before` to page backward.
## Example
```graphql theme={null}
query {
pickSessions(after: "...", before: "...", createdAtMax: "...", createdAtMin: "...", first: 10, last: 10, locationId: "...", orderBy: CREATED_AT, reverse: true, status: ACTIVE) {
nodes {
completedAt
createdAt
filterName
id
inventorySource
legacyId
orderCount
pickedAt
# ...
}
pageInfo { hasNextPage endCursor }
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.