|
Http Verb |
GET |
|---|---|
|
Url |
/inventory/warehouses/r1/central-warehouses/{centralWarehouseId}/pickup-users |
|
Permissions required |
|
|
Personally Identifiable Information (PII) |
No |
|
Sensitive Information |
No |
|
Last Modified Version |
r1 |
|
Released since |
2026 W2 (FSM 23.0) |
|
Deprecated since |
|
|
Removed since |
|
|
Tech Tags |
PAGINATION ORDERING-SERVER-SIDE |
Business Logic
Retrieves a paginated list of warehouse pickup users based on filtering criteria.
Path Parameters
|
Field |
Note |
|---|---|
|
centralWarehouseId |
The identifier of the central warehouse. |
Query String Parameters
Filter
|
Field |
Validations |
Note |
|---|---|---|
|
id |
Collection<Long> |
Filter by specific pickup user IDs. |
|
user |
Collection<Long> |
Filter by specific user IDs. |
|
isSchedulingResource |
Boolean |
Filter by scheduling resource flag. |
Order
Default.
Page
Default.
Fields
Default.
Language
Default.
Header Parameters
Default.
Response documentation
Response payload fields
|
Field |
Type |
Description |
|---|---|---|
|
id |
Long |
Unique identifier of the warehouse pickup user. |
|
warehouse |
Long |
Reference identifier to the central warehouse. |
|
user |
Long |
Reference identifier to the user. |
|
isSchedulingResource |
Boolean |
Flag indicating if the user is a scheduling resource. |
|
identityDocumentType |
Long |
Reference identifier to the identity document type. |
|
identityDocumentNumber |
String |
The identity document number. |
|
isPreferred |
Boolean |
Flag indicating if this is the preferred pickup user. |
Response error codes