...
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
...
| Code Block | ||
|---|---|---|
| ||
{
"orderCode": "ORD123456",
"shipmentId": 987654321,
"shipmentCode": "SHIP123456",
"locationCode": "LOC987654",
"arePackBoxLabelsRequired": true
} |
Parameter Name | Data Type | Description | Mandatory |
| String | Unique code used by the channel to identify the order | Yes |
| String | Unique code used by the channel to identify the shipment | Yes |
| StringInteger | Unique code used by the channel Increff system to identify the ordershipment | Yes |
| Boolean | For B2B Orders, if this flag is true means WMS system expects box labels | No |
Response
| Code Block | ||
|---|---|---|
| ||
{
"shippingLabelUrl": "https://mybrandexample.com/transporter/labels/shipping-label-12345.pdf",
"awbNumber": "AWB123456789",
"awb456fd5435"transporter": "FedEx",
"shippingLabel": "Base64EncodedLabelString",
"boxLabelDetails": [
{
"boxId": "BOX001",
"boxLabelUrl": "https://example.com/labels/box-label-001.pdf",
"boxAwb": "AWB123001"
},
{
"base64shippinglabelstring",
"transporter "boxId": "BOX002",
"boxLabelUrl": "https://example.com/labels/box-label-002.pdf",
"boxAwb": "transporterAWB123002"
}
]
} |
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 |
boxLabelDetails | List | List of box label details for individual shipment boxes. | No |
boxId | String | Unique identifier for the box. | Yes (if boxLabelDetails is present) |
boxLabelUrl | String | Downloadable URL for the box label. | Yes (if boxLabelDetails is present) |
boxAwb | String | AWB bill numbers for the box. | Yes (if boxLabelDetails is present) |
HttpStatus : 200