Sign in

v1

latestOpenAPI 3.0.02026-07-1397337495.2 KB
labels

Created Combined Label Document

Download a combined label file

post/v1/documents/combined_labels

Request body

label_idsSeId[]

The list of up to 30 label ids to include in the combined label document. Note that to avoid response size limits, you should only expect to be able to combine 30 single page labels similar in size to that of USPS labels.

label_format'pdf'

The file format for the combined label document; note that currently only "pdf" is supported.

label_download_type'url' | 'inline'

There are two different ways to download a label:

Label Download TypeDescription
urlYou will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days.
inlineYou will receive the Base64-encoded label as part of the response. No need for a second request to download the label.

Example request

{
  "label_ids": [
    "se-28529731"
  ]
}

Response

The requested object creation was a success.

Example response

{
  "label_download": {
    "href": "http://api.shipengine.com/v1/labels/se-28529731",
    "pdf": "http://api.shipengine.com/v1/labels/se-28529731",
    "png": "http://api.shipengine.com/v1/labels/se-28529731",
    "zpl": "http://api.shipengine.com/v1/labels/se-28529731"
  }
}