External Fulfillment Shipping v2024-09-11
generateShipLabels
Generate and retrieve all shipping labels for one or more packages in the shipment you specify.
put/externalFulfillment/2024-09-11/shipments/{shipmentId}/shipLabels
Path parameters
shipmentIdstring required
The ID of the shipment whose shipping labels you want to generate and retrieve.
Query parameters
shippingOptionIdstring
The ID of the shipping option whose shipping labels you want.
operation'GENERATE' | 'REGENERATE' required
Specify whether you want to generate or regenerate a label.
Request body
Example request
{
"packageIds": [
"TEST_CASE_200_PACKAGE_ID"
],
"courierSupportedAttributes": {
"carrierName": "ATS",
"trackingId": "151958276037"
}
}Response
Success.
Example response
{
"packageShipLabelList": [
{
"packageId": "TEST_CASE_200_PACKAGE_ID",
"shipLabelMetadata": {
"carrierName": "ATSPL",
"trackingId": "343284200328",
"pickupWindow": {
"startTime": 163132120,
"endTime": 162132660
},
"timeSlot": {
"startTime": 1612933142,
"endTime": 1612494142,
"handoverMethod": "PICKUP"
}
},
"fileData": {
"url": "string"
},
"status": "FAILURE",
"errorDetails": {
"code": "00001",
"message": "A temporary failure occurred in the SmartConnect product."
}
}
]
}