Import a Task Group

Import a JSON representation of a task group.

Direction WMS → WCS

HTTP Method POST

Path /api/task/pick/import

Request Body

{
  "externalReference": "4c859d80-5828-4bf4-b33a-2c6cccd0cfc4",
  "taskCategory": "100",
  "expectedCompletionTime": "2026-01-31 14:30",
  "timeZone": "Europe/London",
  "externalCustomerOrderId": "CUSTOMER12345",
  "externalCustomerBatchId": "CUSTOMERBATCH12345",
  "shippingBarcode": "SHIP123456789",
  "shipmentType": "Pick-Pack",
  "containerRegex": "^CONTAINER\\d{10}$",
  "packagingSuggestion": "Medium Box",
  "courier": "Speedy Parcels",
  "shippingLabelUrl": "https://example.com/labels/shipping-label.pdf",
  "prePackMessages": [
    "Fragile items, handle with care",
    "Hazardous items, handle with care"
  ],
  "postPackMessages": [
    "Ensure promotional leaflets are packed",
    "Ensure Hazmat label is applied"
  ],
  "tasks": [
    {
      "externalReference": "a7dd81eb-64b7-42d3-a5cd-09509f0d1c9a",
      "metadata": {"ALLOCATION_REFERENCE": "REF12345", "SKU": "SKU12345"},
      "productId": "PROD12345",
      "batchId": "BATCH12345",
      "expiry": "2027-01-01",
      "stockOwner": "OWNER12345",
      "requestedQuantity": 5.0
    },
    {
      "externalReference": "6d9021f3-5793-4531-95f6-f3db4c8bafb5",
      "metadata": {"ALLOCATION_REFERENCE": "REF54321", "SKU": "SKU54321"},
      "productId": "PROD54321",
      "stockOwner": "OWNER12345",
      "requestedQuantity": 10.0
    },
    {
      "externalReference": "484D65C8-1965-4326-8057-5FBE5BC427E1",
      "productId": "PROD1111",
      "stockOwner": "OWNER12345",
      "requestedQuantity": 15.0
    }
  ],
  "allowShortAllocation": false
}

Field notes:

• tasks[].metadata (object, optional): Key-value map of supplementary task data. Not validated as required, so the key can be left out of the request entirely; sending null or an empty object is equivalent.

Responses

202: TaskGroup passed validation

{
  "message": "Accepted"
}

400: TaskGroup failed validation

{
  "message": "Bad Request",
  "errors": [
    {
      "message": "Task field externalReference must not be null and contain at least 1 non-whitespace character",
      "path": "externalReference"
    },
    {
      "message": "must match \"\\b\\d{3}\\b\"",
      "path": "taskCategory"
    },
    {
      "message": "Shipment Type field must not be null and contain at least 1 non-whitespace character",
      "path": "shipmentType"
    },
    {
      "message": "Task field tasks must not be empty",
      "path": "tasks"
    },
    {
      "message": "must not be blank",
      "path": "tasks[0].taskId"
    }
  ]
}

401: Access denied, Invalid Authentication

{
  "message": "Unauthorized"
}