Skip to content

Pick Container Complete

Notify WMS when a pick container has been completed in the WCS.

Direction WCS → WMS

HTTP Method POST

Path /pickTaskGroup/pickTaskGroupContainerComplete

Field notes:

Field NameData TypeDescriptionNotes
externalReferenceStringThe unique identifier that was passed on the pick list import’s task group that this pick belonged toSource: externalReference from Pick Task Group Import
externalCustomerOrderIdStringThe customer order identifier that was passed on the pick list importSource: externalCustomerOrderId from Pick Task Group Import
externalCustomerBatchIdStringThe customer batch identifier that was passed on the pick list importSource: externalCustomerBatchId from Pick Task Group Import
portStringThe identifier of the port that the stock was picked atPort numbers are numeric, so “1”, “2”, “3” etc
operatorStringThe username of the operative that completed the pick
tsuIdStringThe ID of the container that the stock was picked into
shipmentTypeStringAn identifier for which type of flow the pick list stemmed fromValues: Batch-Pick, Pick-Pack
containerDestinationString
itemsObject Array
items.skuString
items.quantityDouble
items.batchNumberString
items.expiryString
items.stockOwnerString
items.pickTaskExternalReferencesString ArrayThe list of task identifier that was passed on the pick list importSource: task.externalReferenceId from Pick Task Import
taskMetadatasObject ArrayMetadata for each pick task associated with the container
taskMetadatas.taskIdLongThe WCS internal task identifier
taskMetadatas.externalReferenceObjectThe external reference object that was passed on the pick task importSource: externalReference from Pick Task Import
taskMetadatas.externalReferenceIdStringThe external reference identifier that was passed on the pick task importSource: externalReferenceId from Pick Task Import
taskMetadatas.externalCustomerOrderIdStringThe customer order identifier associated with the taskMay be null
taskMetadatas.externalCustomerBatchIdStringThe customer batch identifier associated with the taskMay be null
taskMetadatas.metadataObjectAdditional 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"
}
}
]
}

200: Pick container complete accepted

{
"message": "Success"
}

400: Pick container complete rejected

{
"message": "Bad Request"
}

401: Authentication failed

{
"message": "Unauthorized"
}