Send invoices in bulk
/documents/bulk/sendCosts 2 rate-limit points · Rate limits
Emails many invoices to their customers in one job, as the Invoices page bulk send does: pick invoices by id, or by a created date range with optional status / link / document type. Returns 202 with a job id; GET /documents/bulk/:job_id reports which were sent.
Sends emails to customers as soon as the job runs; there is no confirmation step. Refused when the shop cannot send email (email_sending_disabled). Only one bulk job may run per shop at a time (429 bulk_action_in_progress). Filtering needs both from and to.
Also searched asbulk send invoicesemail all unpaid invoicessend invoices for a date rangesend many invoicesemail these invoicesmass send invoices
Request body
idsarray of integersInvoice ids to include. Without ids the list filters below select the invoices.
document_typestringWhich documents when filtering: 'invoice' (default), 'quote', 'credit_note' or 'pro_forma'.
One ofinvoicequotecredit_notepro_formalinkstring'linked' (created from a Shopify order), 'not_linked' (standalone) or 'trashed'.
One oflinkednot_linkedtrashedstatusstringShopify financial status of the order, one or many ('paid', 'pending').
fromstringCreated on or after this date (ISO 8601).
tostringCreated on or before this date (ISO 8601).
Returns
job_idintegerExample:10statusstringExample:pendingcountintegerExample:0kindstringExample:send
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The request failed validation. Nothing was saved.
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.
curl -X POST "https://app.invoicefalcon.com/api/v3/external/documents/bulk/send" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"ids": [
48213,
48190
]
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/bulk/send", {
method: "POST",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"ids": [
48213,
48190
]
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.invoicefalcon.com/api/v3/external/documents/bulk/send",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"ids": [
48213,
48190
]
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/bulk/send")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
ids: [
48213,
48190
]
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)curl -X POST "https://app.invoicefalcon.com/api/v3/external/documents/bulk/send" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": [
"pending",
"partially_paid"
],
"from": "2026-03-01",
"to": "2026-03-31"
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/bulk/send", {
method: "POST",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"status": [
"pending",
"partially_paid"
],
"from": "2026-03-01",
"to": "2026-03-31"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.invoicefalcon.com/api/v3/external/documents/bulk/send",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"status": [
"pending",
"partially_paid"
],
"from": "2026-03-01",
"to": "2026-03-31"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/bulk/send")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
status: [
"pending",
"partially_paid"
],
from: "2026-03-01",
to: "2026-03-31"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"job_id": 10,
"status": "pending",
"count": 0,
"kind": "send"
}{
"job_id": 10,
"status": "pending",
"count": 0,
"kind": "send"
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}