Print Label

get

https://api.intersoftsapient.net/v4/shipments/printLabel/rm/{shipmentId}

Generate and return the label for the Royal Mail shipment. This endpoint is utilised after a Royal Mail shipment has been created and is meant to facilitate the printing of the label required for that shipment.

Note: This endpoint changes the status of the shipment 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.

Path Params

shipmentId

string

required

length between 0 and 36

A unique identifier (shipmentId) or tracking number returned in the Create shipment response. This ID is used to reference and track specific shipments within the system.

Query Params

labelFormat

string

enum

Specifies the format of the shipping label that will be returned in the createShipment response.

The following are the accepted values:

• PDF - returns a Base64-encoded PDF
• PNG - returns a Base64-enconded PNG
• ZPL203DPI - returns Base 64 encoded text for Zebra printer at 203 DPI
• ZPL300DPI - returns Base 64 encoded text for Zebra printer at 300 DPI
• DATASTREAM - returns essential label elements in a structured format, including the tracking URL, barcode number, and 2D barcode image. Instead of providing a pre-printed label image This format allows you to create and customise shipment labels within your own systems.
• PDF4X3 - returns a Base64-encoded 4x3 format PDF
• PNG4X3 - returns a Base64-enconded 4x3 format PNG

Note: By default, this field is set to PDF.

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

The shipment was not found.

500

Internal Server Error

200Returns the printed label in the format specified.

400Invalid request response.