GET pickwaves/{pickwaveId}
Returns a Pickwave record for a given Pickwave Id
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
pickwaveId | integer | Required |
Body Parameters
None.
Response Information
Resource Description
Returns a Pickwave record for a given Pickwave Id
PickwaveModelName | Description | Type | Additional information |
---|---|---|---|
PickwaveID | The StoreFeeder ID for the pickwave. | integer | None. |
AssignedOnUTC | The date/time that the pickwave was assigned on. This is returned in UTC. | date | None. |
AssignedUserID | The StoreFeeder user ID assigned to the pickwave. | integer | None. |
DespatchedOrderCount | The total number of despatched orders in the pickwave. | integer | None. |
PickedOnUTC | The date/time that the pickwave picking was completed on. This is returned in UTC. | date | None. |
PickerID | The StoreFeeder picker ID picking the order in the warehouse. | integer | None. |
StartedOnUTC | The date/time that the pickwave picking was started on. This is returned in UTC. | date | None. |
Status | The current pickwave status (Open / Completed). | string | None. |
Tag | THe tag assigned to the pickwave. | string | None. |
TotalOrderCount | The total number of orders in the pickwave. | integer | None. |
WarehouseID | The StoreFeeder warehouse ID where the products in the pickwave are stored. | integer | None. |
Response Formats
application/json, text/json
Sample:
{ "PickwaveID": 1, "AssignedOnUTC": "2024-12-11T06:00:52.2911096Z", "AssignedUserID": 3, "DespatchedOrderCount": 1, "PickedOnUTC": "2024-12-11T06:00:52.2911096Z", "PickerID": 4, "StartedOnUTC": "2024-12-11T06:00:52.2911096Z", "Status": "Open", "Tag": "Example Tag", "TotalOrderCount": 5, "WarehouseID": 2 }
application/xml, text/xml
Sample:
<PickwaveModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <PickwaveId>1</PickwaveId> <AssignedOnUtc>2024-12-11T06:00:52.2911096Z</AssignedOnUtc> <AssignedUserId>3</AssignedUserId> <DespatchedOrderCount>1</DespatchedOrderCount> <PickedOnUtc>2024-12-11T06:00:52.2911096Z</PickedOnUtc> <PickerId>4</PickerId> <StartedOnUtc>2024-12-11T06:00:52.2911096Z</StartedOnUtc> <Status>Open</Status> <Tag>Example Tag</Tag> <TotalOrderCount>5</TotalOrderCount> <WarehouseId>2</WarehouseId> </PickwaveModel>