Versions Compared

Old Version 4

changes.mady.by.user Raghav Mehta

Saved on

compared with

New Version Current

changes.mady.by.user Raghav Mehta

Saved on

Key

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

Outbound | GET  | {Client’s URL}

Summary

This API will be used to fetch shipping label information .from Shopfront platform

Description

This API will fetch the shipping label along with all the shipping details from the Shopfront platform for the customer orders which are being processed in warehouse/store.

Request Params

  • shipmentCode

  • orderCode

Parameter Name

Data Type

Description

Mandatory

shipmentCode

String

Unique code used by the channel to identify the shipment

Yes

orderCode

String

Unique code used by the channel to identify the order

Yes

Response

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

...

Note: Any one of shippingLabelUrl and shippingLabel should be present

Parameter Name

Data Type

Description

Mandatory

shippingLabelUrl

String

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

No

awbNumber

String

Tracking number provided by the courier partner

Yes

shippingLabel

String

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

No

transporter

String

Courier partner name

Yes

HttpStatus : 200