CreatePickwaveRequest
Parameters for creating one or more pickwaves from a set of orders.
| Name | Description | Type | Additional information |
|---|
| OrderKeys |
The order numbers or order GUIDs to include in the pickwave(s). At least one is required. Orders are split across multiple pickwaves based on MaxPickwaveSize (default 1,000 per pickwave).
|
Collection of string
|
None.
|
| PickerUserId |
Optional. The StoreFeeder user ID to assign as the picker. The user must have the picker role.
|
integer
|
None.
|
| PickerUserGuid |
Optional. The GUID of the user to assign as the picker. The user must have the picker role.
|
globally unique identifier
|
None.
|
| BarcodeValidationType |
The barcode scanning validation mode for the pickwave. Defaults to None (0).
|
BarcodeValidationTypes
|
None.
|
| WarehouseId |
The warehouse ID to pick from. Orders not in this warehouse will be excluded with a warning.
|
integer
|
None.
|
| RestrictByWarehouseZone |
If true, only orders with products in the specified WarehouseZoneIds will be included.
|
boolean
|
None.
|
| WarehouseZoneIds |
The warehouse zone IDs to restrict picking to. Required if RestrictByWarehouseZone is true.
|
Collection of integer
|
None.
|
| Levels |
Warehouse level configuration with priority ordering for multi-level warehouses.
|
Collection of CreatePickwaveWarehouseLevel
|
None.
|
| UseConsolidatedPicking |
If true, enables consolidated picking mode where orders are grouped into totes.
|
boolean
|
None.
|
| Tag |
Optional descriptive label for the pickwave batch (max 50 characters). Auto-numbered when multiple pickwaves are created (e.g. "Morning Batch 1/3").
|
string
|
None.
|
| MaxPickwaveSize |
Optional. Maximum number of orders per pickwave (max 1000). Orders exceeding this are split into additional pickwaves.
|
integer
|
None.
|
| MaxToteSize |
Optional. Maximum number of items per tote when using consolidated picking. Must be 0 or greater.
|
integer
|
None.
|
| SplitByCourier |
If true, orders are grouped by courier channel so each pickwave contains orders for the same courier. Orders without a courier are excluded with a warning.
|
boolean
|
None.
|
| MaxPickwaveWeightKg |
Optional. Maximum total weight in kilograms per pickwave. Orders exceeding this individually are excluded with a warning.
|
decimal number
|
None.
|
