Receive Shipment

Process and synchronize a received shipment into the warehouse management system. The shipment is validated, persisted, and published as an event. Duplicate shipments are accepted and return a success response.

Direction Host → WMS

HTTP Method POST

Path /inbound/sync/receiveShipment

Request Body

A Shipment object. The shipmentNumber is the unique identifier. shipmentType can be CUSTOMER, B_2_B, INTER_WAREHOUSE, etc. fulfilmentType defaults to AON and dispatchTsuType defaults to PACKAGE if not specified. b2bOrderDetail is required for B_2_B and INTER_WAREHOUSE shipment types.

{
  "voyagerRequest": {
    "warehouseName": "WAREHOUSE_01",
    "requestedBy": "UPSTREAM_SYSTEM"
  },
  "shipmentNumber": "SHP-2024-001234",
  "shipmentType": "B_2_B",
  "stockStatus": "AVAILABLE",
  "fulfilmentType": "AON",
  "customerName": "Jane Smith",
  "organizationName": "Acme Corp",
  "dispatchTsuType": "PACKAGE",
  "customerOrderNumber": "ORD-98765",
  "shippingLabelRef": "LBL-001",
  "shippingLabelBarcode": "9876543210",
  "expectedDispatchDate": "2024-01-25T09:00:00",
  "paperworkLanguage": "en",
  "packagingGroup": "STANDARD",
  "products": [
    {
      "product": "PROD-ABC123",
      "externalProductReference": "EXT-REF-001",
      "quantity": 2,
      "uom": "EACH",
      "packMessages": [
        {
          "type": "PRE_PACK",
          "text": "Handle with care"
        }
      ],
      "personalisedReference": null,
      "metaData": {},
      "stockOwner": "OWNER_A",
      "serialNumberRequired": false
    },
    {
      "product": "PROD-DEF456",
      "externalProductReference": "EXT-REF-002",
      "quantity": 1,
      "uom": "EACH",
      "packMessages": [],
      "personalisedReference": null,
      "metaData": {},
      "stockOwner": "OWNER_A",
      "serialNumberRequired": false
    }
  ],
  "valueAddCode": ["GIFT_WRAP"],
  "dispatchCountry": "GB",
  "dispatchPostcode": "M1 1AA",
  "carrierService": "NEXT_DAY",
  "premiumShipment": false,
  "sortCode": "SC-01",
  "subSortCode": "SSC-01",
  "holdShipment": false,
  "processAfterDate": "2024-01-24T08:00:00",
  "processBeforeDate": "2024-01-26T18:00:00",
  "prePackMessages": [],
  "postPackMessages": [],
  "packingSuggestion": "BOX_A",
  "site": "SITE_01",
  "b2bOrderDetail": {
    "purchaseOrderNumber": "PO-2024-001234",
    "deliveryAddress": {
      "addressLine1": "Unit 5, Industrial Estate",
      "addressLine2": "Riverside Way",
      "addressLine3": null,
      "city": "Manchester",
      "county": "Greater Manchester",
      "postcode": "M1 2AB",
      "country": "GB",
      "gln": "5012345000015"
    },
    "senderAddress": {
      "addressLine1": "Warehouse 01",
      "addressLine2": "Distribution Park",
      "addressLine3": null,
      "city": "Warrington",
      "county": "Cheshire",
      "postcode": "WA1 1AA",
      "country": "GB",
      "gln": "5012345000022"
    },
    "productIdToCustomerProductId": {
      "PROD-ABC123": "CUST-SKU-001",
      "PROD-DEF456": "CUST-SKU-002"
    },
    "packMessages": {},
    "postMessages": {},
    "boxLabelProperties": {},
    "palletManifestProperties": {},
    "deliveryNoteProperties": {},
    "allocationInstructions": {},
    "additionalOrderDetails": {},
    "storeNumber": "STORE-042",
    "supplierCode": "SUP-001",
    "bookingReference": "BK-2024-001234",
    "billOfLading": null,
    "departmentIdentifier": "DEPT-01",
    "supplierName": "Acme Corp",
    "divisionName": "Consumer Electronics"
  },
  "destinationCountry": "GB",
  "destination": "LONDON_HUB",
  "hazardMaterialAirRoute": false,
  "fillOrKill": false,
  "fragile": false,
  "highValueFragile": false,
  "metaData": {}
}

Responses

200: Shipment successfully processed (including duplicates)

{
  "identifier": "SHP-2024-001234",
  "warehouseName": "WAREHOUSE_01",
  "success": true,
  "error": null
}

400: Validation failed

{
  "identifier": "SHP-2024-001234",
  "warehouseName": "WAREHOUSE_01",
  "success": false,
  "error": {
    "errorCode": "400",
    "errorMessage": "VALIDATION_FAILURE_REASON"
  }
}