Sign in

v1

latestOpenAPI 3.0.12026-08-0688138402.2 KB
Labels

Retrieve labels for multiple shipments

Returns labels for multiple shipments.

For PNG format each label has its own object in the labels array. For all other, the labels is 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/labels

Query parameters

idsstring[] required

Comma-separated list of shipment IDs which labels should be retrieved for. Limited to 25 shipment IDs per request.

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.

idinteger

Shipment ID

Example response

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