Pick Container Complete
Notify WMS when a pick container has been completed in the WCS.
Direction WCS → WMS
HTTP Method POST
Path /pickTaskGroup/pickTaskGroupContainerComplete
Request Body
Section titled “Request Body”Field notes:
| Field Name | Data Type | Description | Notes |
|---|---|---|---|
| externalReference | String | The unique identifier that was passed on the pick list import’s task group that this pick belonged to | Source: externalReference from Pick Task Group Import |
| externalCustomerOrderId | String | The customer order identifier that was passed on the pick list import | Source: externalCustomerOrderId from Pick Task Group Import |
| externalCustomerBatchId | String | The customer batch identifier that was passed on the pick list import | Source: externalCustomerBatchId from Pick Task Group Import |
| port | String | The identifier of the port that the stock was picked at | Port numbers are numeric, so “1”, “2”, “3” etc |
| operator | String | The username of the operative that completed the pick | |
| tsuId | String | The ID of the container that the stock was picked into | |
| shipmentType | String | An identifier for which type of flow the pick list stemmed from | Values: Batch-Pick, Pick-Pack |
| containerDestination | String | ||
| items | Object Array | ||
| items.sku | String | ||
| items.quantity | Double | ||
| items.batchNumber | String | ||
| items.expiry | String | ||
| items.stockOwner | String | ||
| items.pickTaskExternalReferences | String Array | The list of task identifier that was passed on the pick list import | Source: task.externalReferenceId from Pick Task Import |
| taskMetadatas | Object Array | Metadata for each pick task associated with the container | |
| taskMetadatas.taskId | Long | The WCS internal task identifier | |
| taskMetadatas.externalReference | Object | The external reference object that was passed on the pick task import | Source: externalReference from Pick Task Import |
| taskMetadatas.externalReferenceId | String | The external reference identifier that was passed on the pick task import | Source: externalReferenceId from Pick Task Import |
| taskMetadatas.externalCustomerOrderId | String | The customer order identifier associated with the task | May be null |
| taskMetadatas.externalCustomerBatchId | String | The customer batch identifier associated with the task | May be null |
| taskMetadatas.metadata | Object | Additional metadata associated with the task |
Example Request Body
{ "externalReference": "21338450-abb0-46cc-abaa-606a439d98d3", "externalCustomerOrderId": "CUSTOMER12345", "externalCustomerBatchId": "CUSTOMERBATCH12345", "tsuId": "TSU12345", "containerDestination": "DESTINATION12345", "shipmentType": "Pick-Pack", "operator": "User1", "port": "1", "items": [ { "sku": "SKU12345", "quantity": 2.0, "batchId": "BATCH-2024-11", "expiry": "2025-06-01", "stockOwner": "OWNER12345", "pickTaskExternalReferences": [ "aa818292-5611-485b-ba16-15360f1d5893", "5e01ee2e-5541-48e1-9005-91d82b27fdf3" ] } ], "taskMetadatas": [ { "taskId": 1493513553, "externalReference": { "LineNo": "60000", "PickNo": "PI1401615" }, "externalReferenceId": "PI1401615-60000", "externalCustomerOrderId": null, "externalCustomerBatchId": null, "metadata": { "Fascia": "FA", "taskCategoryCode": "100" } } ]}Expected Responses
Section titled “Expected Responses”200: Pick container complete accepted
{ "message": "Success"}400: Pick container complete rejected
{ "message": "Bad Request"}401: Authentication failed
{ "message": "Unauthorized"}