Outbound | POST | {Client’s URL}

Summary

This API will call the channel for handover notifications.

Description

This API will call the client system for handover notifications.The API is expected to return success in case of repeated calls.

Request

{
  "locationCode": "wd02",
  "handoverItems": [
    {
      "orderCode": "order123",
      "shipmentCode": "ship123",
      "gatePassCode": "gate124H23",
      "packBoxDetailsList": [
        {
          "boxId": 1,
          "awbNumber": "AWB001"
        },
        {
          "boxId": 2,
          "awbNumber": "AWB002"
        }
      ]
    },
    {
      "orderCode": "order124",
      "shipmentCode": "ship124",
      "gatePassCode": "gate124H24",
      "packBoxDetailsList": [
        {
          "boxId": 3,
          "awbNumber": "AWB0011"
        },
        {
          "boxId": 4,
          "awbNumber": "AWB0022"
        }
      ]
    }
  ]
}
Parameter Name Data Type Description Mandatory
locationCode String Location code of the warehouse from where the order will be shipped yes
handoverItems Object[] List of handover items yes
handoverItems.orderCode String Unique code used by the channel to identify order yes
handoverItems.shipmenCode String Unique code used by the channel to identify shipment yes
handoverItems.gatePassCode String gatePassCode used while creating the gatePass for this shipment no
handoverItems.packBoxDetailsList Object[] Box level details no
packBoxDetailsList.boxId Long Unique id to identify a particular shipment no
packBoxDetailsList.awbNumber String AWB number of a particular box no

Response

{
    "hasError": false,
    "errorMessage":"message"
}

HttpStatus : 200