Skip to content

Print invoices in bulk

POST/documents/bulk/print

Costs 2 rate-limit points · Rate limits

Starts a bulk PDF job for many invoices, as the Invoices page bulk print / download does: pick invoices by id or by the list filters, get one merged PDF (bundle) or a zip of single PDFs (separate). Returns 202 with a job id; poll GET /documents/bulk/:job_id for progress and the download link.

Asynchronous: only one bulk job may run per shop at a time (429 bulk_action_in_progress). Limited to 5,000 invoices. Free text search (q) is not supported here; use ids or date / status filters.

Also searched asbulk print invoicesdownload many invoicesexport invoices as pdfprint all invoiceszip of invoicesprint invoices for a date rangedownload last month invoices

Request body

  • idsarray of integers

    Invoice ids to include. Without ids the list filters below select the invoices.

  • document_typestring

    Which documents when filtering: 'invoice' (default), 'quote', 'credit_note' or 'pro_forma'.

    One of invoicequotecredit_notepro_forma
  • linkstring

    'linked' (created from a Shopify order), 'not_linked' (standalone) or 'trashed'.

    One of linkednot_linkedtrashed
  • processing_typestring

    'bundle' (one merged PDF, default) or 'separate' (zip of single PDFs).

    One of bundleseparate
  • delivery_methodstring

    'download' (default) or 'print', as the dashboard distinguishes them.

    One of printdownload
  • statusstring

    Shopify financial status of the order, one or many ('paid', 'pending').

  • fromstring

    Created on or after this date (ISO 8601).

  • tostring

    Created on or before this date (ISO 8601).

  • template_namestring

    Template to render with (default 'default').

Returns

  • job_idinteger
    Example: 12
  • statusstring
    Example: pending
  • countinteger
    Example: 0
  • kindstring
    Example: print

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

422

The request failed validation. Nothing was saved.

429

Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.

Every error has the same shape: see Errors.

POST/documents/bulk/print
curl -X POST "https://app.invoicefalcon.com/api/v3/external/documents/bulk/print" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "ids": [
      48213,
      48190,
      48177
    ]
  }'
Response
{
  "job_id": 12,
  "status": "pending",
  "count": 0,
  "kind": "print"
}