Return Receipt Notification

When returned goods are received and processed in the warehouse, the WMS sends a receipt notification to the host returns management system.

Direction WMS → Host

HTTP Method POST

Path {host-url}/process-returns

Request Body

{
  "createdTimestamp": 1706176200000,
  "createdDate": "2024-01-25T10:30:00.000Z",
  "returnReceipts": [
    {
      "returnShipmentNumber": "2024-001234",
      "shipmentNumber": "SHP-2024-005678",
      "orderNumber": "ORD-98765",
      "returnWarehouseName": "WAREHOUSE_01",
      "returnSenderType": "CUSTOMER",
      "returnReceiptLines": [
        {
          "productId": "PROD-ABC123",
          "quantity": 1,
          "processedState": "PRISTINE",
          "identified": true,
          "notes": null,
          "stockOwner": "OWNER_A",
          "batchInformation": [
            {
              "batchId": "BATCH-001",
              "expiryDate": "2025-06-30",
              "quantity": 1,
              "units": [
                {
                  "identifiers": [
                    {
                      "type": "SERIAL_NUMBER",
                      "value": "SN-00001"
                    }
                  ]
                }
              ]
            }
          ]
        },
        {
          "productId": "PROD-DEF456",
          "quantity": 1,
          "processedState": "DAMAGED",
          "identified": true,
          "notes": "DU1",
          "stockOwner": "OWNER_A",
          "batchInformation": []
        }
      ]
    }
  ]
}

Responses

200: Return receipt accepted by host