Print Label

Generate and return the label for the DX shipment. This endpoint is utilised after a DX 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
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
string
enum

The desired format for the shipping label that is to be generated and retrieved by the createShipment API response, such as PDF that returns a Base64-encoded PDF label.

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

Language
Credentials
OAuth2
Response
Choose an example:
application/json