Sign in

v1

latestOpenAPI 3.1.0Proprietary2026-07-24710198.3 KB
Shipments

Download labels in bulk

Download shipping labels (and optional additional files) in bulk for a list of shipments. Returns a single PDF file if all labels are PDF, or a ZIP archive if there is a mix of formats (PDF, ZPL, PNG, etc.).

When to use: Call this endpoint when you need to download labels for multiple shipments at once — for example, for batch printing in a warehouse or fulfillment center.

Prerequisites:

  • Valid JWT authentication token (Bearer)
  • One or more shipment IDs from previously generated labels

Key behaviors:

  • Single shipment without additional files: returns the file directly with its original extension
  • Multiple shipments, all PDF: merges into a single PDF ordered by the shipments array
  • Mixed formats (PDF + ZPL/PNG): returns a ZIP file organized by extension folders
  • Packing slip layout is controlled by the company's e-commerce config (packing_print.option): after_label places slips as separate pages after the label; unify combines the slip on the same page as the label (PDF only)

Response headers:

  • Content-Type: application/pdf or application/zip
  • Content-Disposition: suggested filename for download
  • x-file-extension: .pdf or .zip
  • x-filename: filename of the returned file
post/shipments/labels-bulk

Request body

additional_filesboolean

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

with_reportboolean

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

with_packingboolean

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

with_return_policyboolean

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

Example request

{
  "shipments": [
    12345,
    12346,
    12347
  ]
}

Response

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