API v3 overview
What API v3 covers, who can use it, and a first request in under a minute.
Last updated
API v3 is the current Invoice Falcon API. It covers what the app’s dashboard does: invoices, quotes, credit notes and packing slips for Shopify orders, the orders themselves, templates and their version history, customers, and the store’s settings. It is the same set of actions that Quinn, Shopify Sidekick and the MCP server use, so anything those can do, your code can do.
- Base URL:
https://app.invoicefalcon.com/api/v3/external - Format: JSON in, JSON out.
- Reference: every endpoint, one page each, in the API v3 reference.
- Machine-readable spec:
/api/v3/openapi.json(OpenAPI 3.1, no key needed).
Who can use it
Section titled “Who can use it”A store can call API v3 when both are true:
| Requirement | If it’s missing |
|---|---|
| The store uses the current Invoice Falcon dashboard | 403 with code: "v3_required". Use API v1 until the store moves. |
| The store is on a paid plan (Pro or Partner, or a store that installed before 8 July 2026) | 403 with code: "paid_plan_required" |
Quickstart
Section titled “Quickstart”1. Get the API key
Section titled “1. Get the API key”In the Invoice Falcon app, open Settings, then the Integrations tab. In the API access section, click Generate API key and copy it. The same key works for API v1 and API v3. See Authentication.
export INVOICE_FALCON_API_KEY="if_api_key_..."2. Check the plan and what’s left this month
Section titled “2. Check the plan and what’s left this month”curl -s https://app.invoicefalcon.com/api/v3/external/account/plan \ -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"3. List the latest invoices
Section titled “3. List the latest invoices”curl -s "https://app.invoicefalcon.com/api/v3/external/documents/invoices?per_page=5" \ -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"{ "items": [ { "id": 48213, "document_type": "invoice", "invoice_number": "INV-1042", "order": { "shopify_order_id": "gid://shopify/Order/5550001234", "name": "#1042", "number": 1042 }, "customer": { "id": 911, "name": "Ana Ruiz", "email": "ana@example.com" }, "financial_status": "paid", "currency": "EUR", "total": "129.00", "sent_at": "2026-11-02T14:05:11Z", "paid": true, "trashed": false } ], "page": { "number": 1, "size": 5, "total": 318, "total_pages": 64 }}4. Invoice an order and email it
Section titled “4. Invoice an order and email it”curl -s -X POST https://app.invoicefalcon.com/api/v3/external/documents/invoices \ -H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \ -H "Content-Type: application/json" \ -d '{"order_id": "#1042", "send_email": true}'If the order already has an invoice (most are created automatically when the order comes in), you get that invoice back with 200 and "already_existed": true instead of a duplicate.
How the API is organised
Section titled “How the API is organised”| Area | Paths | What it holds |
|---|---|---|
| Documents | /documents/invoices, /documents/quotes, /documents/credit_notes, /documents/packing_slips, /documents/bulk |
Create, read, edit, send, mark paid, trash and restore documents; PDFs; bulk print and send jobs |
| Orders | /orders, /orders/drafts, /orders/:id/troubleshoot |
Shopify orders and draft orders with their Invoice Falcon document, and a one-call diagnosis of why an invoice wasn’t sent |
| Templates | /templates, /templates/:id/versions, /templates/designs |
Create, edit, duplicate, set default, delete; version history and restore |
| Customers | /customers |
Customers as Invoice Falcon stores them |
| Account | /account/... |
Plan and usage, document settings, emails, sending, automation, e-invoicing, integrations, setup progress |
Next steps
Section titled “Next steps”- Authentication
- Requests and responses: pagination, ids, partial updates and confirmations.
- Common tasks: worked examples for the jobs integrations do most.
- Errors and rate limits.
- MCP server, to connect Claude, ChatGPT or your own agent.
Thanks for letting us know.
Still stuck? Ask Quinn or chat with support