Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Summary

This API will call the channel 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.

Info

Shopfront platforms can choose to opt out using this API if they donot support the Manifest status/workflow

Request

Code Block
languagejson
{
  "transporter": "WERTYU",
  "locationCode": "wd02",
  "manifestId": 87456,
  "manifestItems": [
    {
      "orderCode": "H19304030001",
      "shipmentCode": "eid123",
      "awbNumber": "awb123"
    }
  ]
}

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

Response

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

...