Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Labels

Retrieve labels of a shipment

Returns labels for a specific shipment. Labels are delivered as Base64-encoded data.

For PNG format, each label has its own object. For all others, the labels are collected in one object.

Note: Use the scaling feature at your own risk. Shipmondo can’t guarantee the scaled labels are usable. Always get the label approved by the carrier before using this feature in production.

get/shipments/{id}/labels

Path parameters

idinteger required

ID for the shipment to be included in the filter

Query parameters

label_format'a4_pdf' | '10x19_pdf' | '10x19_png' | '10x19_zpl' | 'compact_png' | 'compact_pdf' | 'compact_zpl'

Which format the labels should be.

10x19 is 10 cm x 19 cm

compact format returns the smallest label possible.

scale_by'height' | 'width'

Scale down the labels by either width or height. Only applicable when label_format: a4_pdf, 10x19_pdf, 10x19_zpl, compact_pdf, compact_zpl

scale_sizenumber
Example:15.6

Desired scaled length in cm of dimension in "scale_by".If the length is higher or wider than the original labels, the labels will not be scaled.

Only applicable when label_format: a4_pdf, 10x19_pdf, 10x19_zpl, compact_pdf, compact_zpl.

Response

Successful.

base64string

Data encoded in Base64 format

file_format'pdf' | 'png' | 'zpl'

File format for the returned data

Example response

[
  {
    "base64": "JVBERi0xLjMKJf//////AAAAAA...",
    "file_format": "pdf"
  }
]