Used to modify the output format of the label.

Meaning and Usage

With this method, you can change the label format by providing modified labelSettings object from the POST shipment/batch method.

Optimization of Label Retrieval

Processing a large number of labels (e.g., printing in A4 format) is computationally intensive. Therefore, a cache mechanism is implemented for label printing.

For A4 format: 5 minutes

For simple labels: 60 seconds

If you want to significantly speed up label processing after calling the PUT method, we recommend using the data method instead of repeatedly calling GET shipment/batch/{batchId}/label.
The data method returns labels for individual shipments with a cache set to 1 second.

Advantages of the `data` Method

The method is available in the response body of GET shipment/batch/{batchId} as the value of the labelUrl key.

When converting to ZPL format, the response already contains ZPL, so you don’t need to convert Base64 → ZPL as with the label method.

Disadvantages of the `data` Method

Returns only an individual label. If GET/shipment/batch/{batchId} contains multiple shipments, you will need to call the method for each shipment separately.

Returns the label only in the default format. That means if you are using PUT to change only the label position (e.g., from default to A4), do not use this method.

Recommended Procedure

Call the PUT method to create or update a batch.

Call GET shipment/batch/{batchId}.

The response contains a new dataGUID in the data method (see image).

This identifier changes with each call to the PUT method.

You can either:

Compare the new GUID with the previous one (if you store it), or

Set a minimum delay between the PUT and GET methods.

Call the data method with the new GUID to retrieve the label with the updated format.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Path Params

Header Params

Body Params application/json

Example

{
    "labelSettings": {
        "format": "Pdf",
        "completeLabelSettings": {
            "isCompleteLabelRequested": true,
            "pageSize": "A4"
        }
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Used to modify the output format of the label.

Meaning and Usage#

Optimization of Label Retrieval#

Advantages of the data Method#

Disadvantages of the data Method#

Recommended Procedure#