Download labels in bulk

post

https://queries.test.envia.com/shipments/labels-bulk

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

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*

additional_files

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:

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

additional_includes

with_report

boolean

Defaults to false

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

with_packing

boolean

Defaults to false

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

with_return_policy

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

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/pdf

application/zip

application/json

200File download — returns a PDF or ZIP depending on label formats

400Bad request