Outbound | POST | {Client’s URL}

Summary

This API will call the Shopfront platform to create a manifest at their end.

Description

This API will call the Shopfront channel platform to create a manifest for a group of shipments which are being sent in the API request body.

<aside> ℹ️ Shopfront platforms can choose to opt out using this API if they donot support the Manifest status/workflow

</aside>

Request

{
  "transporter": "WERTYU",
  "locationCode": "wd02",
  "manifestId": 87456,
  "manifestItems": [
    {
      "orderCode": "H19304030001",
      "shipmentCode": "eid123",
      "awbNumber": "awb123",
      "packboxDetailsList": [
        {
          "boxId": 1322674400,
          "awbNumber": "ATY0078"
        }
      ]
    }
  ]
}
Parameter Name Data Type Description Mandatory
transporter String Courier partner name yes
locationCode String Location code of the warehouse from where the order will be shipped yes
manifestId Long Increff manifest id no
manifestItems Object[] List of shipments to be added to the manifest yes
manifestItems.orderCode String Unique code used by the channel to identify the order yes
manifestItems.shipmentCode String Unique code used by the channel to identify the shipment yes
manifestItems.awbNumber String Tracking number for this shipment provided by courier partner yes
manifestItems.packBoxDetailsList Object[] Details of pack boxes no
packBoxDetailsList.boxId Long Id to uniquely identify a box in a manifest no
packBoxDetailsList.awbNumber String AWB number of a particular box in a manifest no

Response

{
  "manifestCode": "72653",
  "manifestItems": [
    {
      "orderCode": "515",
      "shipmentCode": "95848"
    }
  ]
}

HttpStatus : 200