Generates labels for an order.
The body of the call to the Labeler API uses a structured JSON format with mandatory and optional fields. The JSON must be properly structured to be accepted and mandatory fields must be populated. Each property in the request has a specific data type for the value; all values must conform to the required data type.
The number of generated PDF labels depends on the number of objects in the parcels array. barcode identifies a label and is the only required field within the object.
Base URL
Toggle the Base URL to call either staging or production based on the environment that you are working with:
Production:
https://api.paack.io/v3/labels
Staging:
https://api.staging.paack.io/v3/labels
HEADER
Pass your access_token as a Bearer token in the Authorization header. The value of the header should look like this:
Bearer {{access_token}}
Parameter Constraints
You can click in the input box of each parameter to see all the constraints related to a field.
Encoding
Characters allowed as string values:
!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~...''""--¡¢£¤¥¦§¨©ª«¬®¯°±²³´µ¶·¸¹º»¼½¾¿ÀÁÂÃÄÅÆÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖ×ØÙÚÛÜÝÞßàáâãäåæçèéêëìíîïðñòóôõö÷øùúûüýþÿThe Labeler API accepts the ASCII printable characters and extended ASCII printable characters except the following:
†€‚Ÿžœ›š™˜—•ŽŒ‹Š‰ˆ‡ƒAll supported characters are described here.
The Labeler API matches the definition of the order management service. The list below includes only required and printable fields but you can extend your request with any field from the order creation API.