Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipments

Print Label

Generate and return the label for the Amazon shipment. This endpoint is utilised after an Amazon shipment has been created and is meant to facilitate the printing of the label required for that shipment. <br /> <br />Note: This endpoint changes the shipment status to "label printed"​. This endpoint should be called at the time of actual printing or label creation, depending on how your business operates. Shipments must be updated to label printed status prior to manifesting.

get/v4/shipments/printLabel/amazon/{shipmentId}

Path parameters

shipmentIdstring required

Shipment ID <br />The Shipment ID may be an id or a tracking/barcode number.

Query parameters

labelFormat'PDF' | 'PNG'

Sets the label format that will be returned in the createShipment Response. <br />Valid values are: <br />PDF - returns a Base64-encoded PDF <br />PNG - returns a Base64-encoded PNG <br />Defaults to PDF if not populated.

Label Format <br />
<br />PDF Base 64 encoded PDF <br />PNG Base 64 encoded PNG <br />
<br />Defaults To PDF

Response

Returns the printed label in the format specified.

ShipmentIdstring uuid required

A unique identifier assigned to the shipment by the carrier for which the label is requested. This reaffirms the specific shipment being referenced.

TrackingNumberstring nullable

A unique number assigned to the shipment that allows both the sender and the receiver to track the shipment's status and location throughout its transit. This number is essential for monitoring the delivery progress.

CarrierTrackingUrlstring uri nullable

A URL link provided by the carrier that directs users to a webpage where they can track the shipment in real-time. This link provides detailed status updates and visibility into the shipment's journey.

Labelstring nullable

The generated base64-encoded string of the shipping label in the format requested in the LabelFormat field. This label includes essential shipping information, barcodes, and addresses, necessary for the proper handling and delivery of the shipment.

LabelFormat'PDF' | 'PNG' required

Sets the label format that will be returned in the createShipment Response. <br />Valid values are: <br />PDF - returns a Base64-encoded PDF <br />PNG - returns a Base64-encoded PNG <br />Defaults to PDF if not populated.

Example response

{
  "ShipmentId": "c4e60776-288f-464e-b35b-ff0f3252c0f0",
  "TrackingNumber": "TT12384739GB",
  "CarrierTrackingUrl": "http://shipmentcarrier.com/tracking/DF12384739GB",
  "Label": "iVBORw0KGgoAAAANSUhEUgAA ... A4QAAAXcCAYAAAB6Q0CbAAAAAXNSR0IArs4"
}