Versions Compared

Key

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

...

Parameter Name

Data Type

Description

Mandatory

shipmentCode

String

Unique code used by the channel to identify the shipment

yesYes

orderCode

String

Unique code used by the channel to identify the order

yesYes

Response

Code Block
languagejson
{
  "shippingLabelUrl": "https://mybrand.com/transporter.pdf",
  "awbNumber": "awb456fd5435",
  "shippingLabel": "base64shippinglabelstring",
  "transporter": "transporter"
}

...

Parameter Name

Data Type

Description

Mandatory

shippingLabelUrl

String

Downloadable pdf url of the shipping label document(either of shippingLabel and shippingLabelUrl is mandatory)

noNo

awbNumber

String

Tracking number provided by the courier partner

yesYes

shippingLabel

String

Base64 encoded string of the shipping label(either of shippingLabel and shippingLabelUrl is mandatory)

noNo

transporter

String

Courier partner name

yesYes

HttpStatus : 200