Download labels in bulk

Download shipping labels for multiple shipments at once. Returns a merged PDF or a ZIP archive depending on label formats.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
shipments
array of numbers or strings
required

List of shipment IDs to download labels for. These are the numeric shipment IDs, not tracking numbers

shipments*
boolean
Defaults to false

If true, includes additional shipment files (customs documents, carrier documents, etc.)

additional_includes
array of numbers or strings
Defaults to

Filter additional files by document_type_id. Only used when additional_files is true. If empty, returns all available documents. Include 10 to also retrieve the Bill of Lading (file_bol).

Available document_type_id values:

IDDescription
1Shipment manifest
6Proof of Delivery
7Letter of Responsibility
8Insurance Certificate
9Return Receipt
10Commercial Invoice
11FTL Instructions Letter
12FTL Additional Files
13FTL Rate Confirmation
14LTL Commercial Invoice
15LTL Additional Files
16Additional Files (tickets)
17Certificate of Origin
18USMCA / FTA Certificate
19Export Declaration (EEI/SED)
20Safety Data Sheet (MSDS)
21Import Permit
22Customs Power of Attorney
23Tax ID / VAT Identification Form
24Proforma Invoice
25Packing List
26Weight/sorter image from carrier (dispute resolution)
27Auxiliary Electronic Content Declaration
additional_includes
boolean
Defaults to false

If true, includes a report of processed labels (successes and errors)

boolean
Defaults to false

If true, generates and includes packing slips for each package in the associated order

boolean
Defaults to false

If true, appends the store's return policy page after each packing slip

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/pdf
application/zip
application/json