Import a Manifest

Import a JSON representation of a manifest of inbound stock.

Direction WMS → WCS

HTTP Method POST

Path /api/goodsIn/import

Request Body

{
  "manifestNumber": "5c105a0e-04fa-4728-9193-f67022832eed",
  "scanCode": "SCAN12345",
  "refill": false,
  "lines": [
    {
      "externalReference": "c4a62c29-a7b8-4cfd-8fb7-436534358853",
      "productId": "PROD12345",
      "batchId": "BATCH12345",
      "expiry": "2027-01-01",
      "stockOwner": "OWNER12345",
      "quantity": 10.0,
      "unitIdentifiers": ["UNIT-0001", "UNIT-0002"]
    },
    {
      "externalReference": "616A54F3-1EF3-4AE0-9E01-EAA34E26B3D5",
      "productId": "PROD54321",
      "batchId": "BATCH54321",
      "expiry": "2027-01-02",
      "stockOwner": "OWNER12345",
      "quantity": 15.0
    }
  ]
}

Field notes:

• lines[].unitIdentifiers (array of strings, optional): Serial numbers for unitary (individually tracked) products. Not validated as required, so the key can be left out of the request entirely; sending null or an empty array is equivalent and is the expected form for non-unitary stock.

Responses

202: Manifest import passed validation

{
  "message": "Accepted"
}

400: Manifest import failed validation

{
  "message": "Bad Request",
  "errors": [
    {
      "message": "Manifest field ManifestNumber must not be null and contain at least 1 non-whitespace character",
      "path": "manifestNumber"
    },
    {
      "message": "Manifest field ScanCode must not be null and contain at least 1 non-whitespace character",
      "path": "scanCode"
    },
    {
      "message": "Manifest field Lines must not be empty",
      "path": "lines"
    },
    {
      "message": "Line field ProductId must not be null and contain at least 1 non-whitespace character",
      "path": "lines[0].productId"
    },
    {
      "message": "Line field Quantity must not be null",
      "path": "lines[0].quantity"
    },
    {
      "message": "Line field Quantity must be a positive number",
      "path": "lines[0].quantity"
    }
  ]
}

401: Access denied, Invalid Authentication

{
  "message": "Unauthorized"
}