Pick Task Group Complete

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

Direction WCS → WMS

HTTP Method POST

Path /pickTaskGroup/pickTaskGroupComplete

Request Body

Field notes:

Field Name	Data Type	Description	Notes
taskGroupId	String	The Autostore Task Group ID that this pick belonged to
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
type	String	An identifier for which type of flow the pick list stemmed from	Values: Batch-Pick, Pick-Pack
status	String	An identifier for the completion state of the pick list	Values: SUCCESS, ABANDONED
externalCustomerOrderId	String	The external customer order ID for the pick list that was completed
tasksCompleted	Object Array	A list of all tasks that were completed for this pick task group
tasksCompleted.externalReference	String	The identifier that was passed on the pick list import’s task that this pick belonged to	Source: task.externalReferenceId from Pick Task Import
tasksCompleted.status	String	Indicates the final completion status of an individual task within the task group.	Values: IMPORTED (task group was ABANDONED), COMPLETED (task completed successfully), CANCELLED (WMS cancellation request completed successfully; the task group status may remain SUCCESS while the individual task status is CANCELLED).
tasksCompleted.productId	String	The product ID for the task that was completed
tasksCompleted.batchId	String	The batch code for the product that was picked for this task if it had one	May be null
tasksCompleted.expiry	String	The expiration for the product that was picked for this task if it had one	May be null
tasksCompleted.stockOwner	String	The stock owner for the product that was picked for this task
tasksCompleted.requestedQuantity	Double	The original requested quantity for this product
tasksCompleted.allocatedQuantity	Double	The total amount of stock that was reserved for this product for this task
tasksCompleted.pickedQuantity	Double	The total amount of stock that was picked for this product for this task
tasksCompleted.shortQuantity	Double	The total amount of stock that could not be picked for this product for this task

Example Request Body

{
  "externalReference": "b59f0c10-cfdb-45d2-a29a-544c9660c42d",
  "taskGroupId": "TASKGROUP12345",
  "externalCustomerOrderId": "CUSTOMER12345",
  "externalCustomerBatchId": "BATCH12345",
  "status": "SUCCESS",
  "shipmentType": "Pick-Pack",
  "operator": "User1",
  "port": "1",
  "tasksCompleted": [
    {
      "externalReference": "44b96bdc-5912-4c79-85a1-4ce6f22684af",
      "externalCustomerOrderId": "CUSTOMER12345",
      "externalCustomerBatchId": "BATCH12345",
      "metadata": {"ALLOCATION_REFERENCE": "REF12345", "SKU": "SKU12345"},
      "status": "SUCCESS",
      "productId": "PROD12345",
      "batchId": "BATCH-2024-11",
      "expiry": "2025-06-01",
      "stockOwner": "OWNER12345",
      "requestedQuantity": 2.0,
      "allocatedQuantity": 2.0,
      "pickedQuantity": 2.0,
      "shortQuantity": 2.0
    }
  ]
}

Field notes:

• tasksCompleted[].metadata (object, optional): Key-value map of supplementary task data. Not validated as required; WMS should expect it to be null or empty when nothing is set.

Expected Responses

200: Pick task group completed accepted

{
  "message": "Success"
}

400: Pick task group complete rejected

{
  "message": "Bad Request"
}

401: Authentication failed

{
  "message": "Unauthorized"
}