---
title: "Print Label"
method: GET
path: "/v4/shipments/printLabel/dxf/{shipmentId}"
tags: ["Shipments"]
---

# Print Label

`GET /v4/shipments/printLabel/dxf/{shipmentId}`

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

- `shipmentId` string, required

## Query parameters

- `labelFormat` 'PDF' — Specifies the format of the shipping label that will be returned in the **createShipment** response. The current accepted format is PDF, which will return a Base 64-encoded PDF of the shipping label. <br /> <br />***Note:** By default, this field is set to PDF.*

## Response `200`

Returns the printed label in the format specified.

- DXFreightLabelFormatResponsePrintLabelResponse — Print Label Response
  - `ShipmentId` string, 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.
  - `TrackingNumber` string, 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.
  - `CarrierTrackingUrl` string, 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.
  - `Label` string, 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', required — Specifies the format in which the generated shipping label was requested, for example, PDF.

## Other responses

- `400` — Invalid request response.
- `401` — Unauthorized
- `403` — Forbidden
- `404` — The shipment was not found.
- `500` — Internal Server Error

---

[API](https://skmtc.dev/intersoftsapient/apis/sapient-core-api.md) · [All operations](https://skmtc.dev/intersoftsapient/apis/sapient-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/intersoftsapient/sapient-core-api/revisions/3315ad0b5875/schema)
