Receive Shipment

Process and synchronize received shipments into the warehouse management system.

Direction External System → WMS

HTTP Method POST

Path /inbound/sync/receiveShipment

Request Body

{
  "shipmentNumber": "SHP-2024-001234",
  "supplierReference": "SUP-REF-5678",
  "expectedDeliveryDate": "2024-01-20T09:00:00Z",
  "actualDeliveryDate": "2024-01-20T10:15:00Z",
  "carrier": "DHL",
  "trackingNumber": "1234567890",
  "status": "RECEIVED",
  "shipmentLines": [
    {
      "lineNumber": 1,
      "productId": "PROD-ABC123",
      "sku": "COFFEE-BEANS-1KG",
      "expectedQuantity": 100,
      "receivedQuantity": 98,
      "unitOfMeasure": "EACH",
      "lotNumber": "LOT-2024-001",
      "expiryDate": "2025-01-20T00:00:00Z"
    }
  ],
  "deliveryLocation": {
    "warehouseId": "WH-001",
    "dockNumber": "DOCK-A1"
  },
  "receivedBy": "OPERATOR-001",
  "notes": "2 units damaged during transport"
}

Response Codes

200: Shipment successfully processed

400: Invalid shipment data

401: Authentication required

409: Shipment already exists

422: Validation failed

Success Response (200)

{
  "success": true,
  "message": "Shipment successfully received and processed",
  "shipmentId": "12345",
  "shipmentNumber": "SHP-2024-001234",
  "processedAt": "2024-01-20T10:30:00Z",
  "processedLines": 1,
  "totalReceivedQuantity": 98
}

Error Response (400)

{
  "success": false,
  "error": "INVALID_SHIPMENT_DATA",
  "message": "Shipment data validation failed",
  "details": [
    {
      "field": "shipmentNumber",
      "message": "Shipment number is required"
    },
    {
      "field": "shipmentLines",
      "message": "At least one shipment line is required"
    }
  ]
}

Error Response (409)

{
  "success": false,
  "error": "SHIPMENT_EXISTS",
  "message": "Shipment with this number already exists",
  "existingShipment": {
    "shipmentId": "12345",
    "shipmentNumber": "SHP-2024-001234",
    "status": "RECEIVED"
  }
}