Skip to main content

Get Label

Retrieves the label for the specified shipment.

Please make sure tracking number is got before making this call, or you will get HTTP 404.

Endpoint: GET /api/shipments/{id}/label

Required Scope: shipments:read

Path Parameter​

ParameterTypeRequiredDescription
idstringYesThe ID of the shipment to refund.

Response Specification​

Returns a Shipment Label object wrapped in Result.

Sample JSON​

{
  "Data": {
    "Link": "https://...",
    "Base64": null,
    "ContentType": "application/pdf"
  },
  "Succeeded": true,
  "Error": null,
  "CapturedValues": {}
}
{
  "Succeeded": false,
  "Error": {
    "Code": "HttpError404",
    "Message": "shipment label xxxx not found, please ensure tracking number is got before printing label"
  },
  "CapturedValues": {}
}