Generate Label Url

This endpoint allows you to retrieve the label URL for a specific shipment identified by the orderId.

Method: GET

Endpoint: {{base_url}}/v1/external/shipments/{orderId}/label-url

orderId (path parameter): The unique identifier for the order whose shipment label URL you wish to retrieve.

On a successful request, the server responds with a 200 OK status and a JSON object containing the following fields:

waybill: Currently returns null. This field may be used in future implementations to provide the waybill number associated with the shipment.

format: Currently returns null. This field may indicate the format of the label, which is not defined at this time.

message: Currently returns null. This field may be used for any messages related to the request or label generation.

label_url: A string containing the URL to access the shipment label. This will be an empty string if the label is not available.

Ensure that the orderId provided in the request is valid and corresponds to an existing shipment.

The response fields may be updated in future versions of the API, so check the documentation regularly for any changes.

Request