Sign in

v1

latestOpenAPI 3.0.12026-07-242073551.1 MB
Shipments

Print My Label QR Code

Enhance the shipping and delivery process by generating an easy-to-scan QR code for the associated label specified in the PrintLabel API endpoint. <br /> <br />For example, you can take the QR code to your nearest post office and scan it to generate the label image instead of the label itself without the need for having a printer. <br /> <br />Note: This endpoint can only be used for Royal Mail Tracked Return services.

get/v4/shipments/printMyLabelQRCode/rm/{shipmentId}

Path parameters

shipmentIdstring required

A unique identifier (shipmentId) or tracking number returned in the Create shipment response. This ID is used to reference and track a specific shipment for which the QR is being generated.

Response

Returns the printed QR Code as a Base 64 encoded PNG.

ShipmentIdstring uuid required

A unique identifier assigned to the shipment by the carrier for which the QR code was requested in the path paramater. This reaffirms the specific shipment being referenced.

QRCodestring required

The actual QR image in the PNG format. This image can be decoded and rendered as an image. Scanning this QR code provides instant access to information about the shipment.

Example response

{
  "ShipmentId": "c4e60776-288f-464e-b35b-ff0f3252c0f0",
  "QRCode": "iVBORw0KGgoAAAANSUhEUgAA ... A4QAAAXcCAYAAAB6Q0CbAAAAAXNSR0IArs4"
}