Invoice Falcon API
Use the Invoice Falcon API to work with a Shopify store's invoices, quotes, credit notes, packing slips, templates, customers and settings from your own code.
Last updated
Get started
Terminal window
Terminal window
Terminal window
invoicefalcon.comContactTermsinvoicefalcon.com
Use the Invoice Falcon API to work with a Shopify store’s invoices, quotes, credit notes, packing slips, templates, customers and settings from your own code.
Choose an API version
Section titled “Choose an API version”| Version | Use it when | Start here |
|---|---|---|
| API v3 (current) | The store uses the current Invoice Falcon dashboard. Covers everything the dashboard does, and includes an MCP server for AI agents. | API v3 overview |
| API v1 | The store still uses the previous dashboard, or you maintain an existing v1 integration. v1 gets no new endpoints. | The quick start below |
Both versions use the same API key and the same rate limit, and both need a paid plan.
API v1 quick start
Section titled “API v1 quick start”1. Get your API key
Section titled “1. Get your API key”Open the Invoice Falcon app in your Shopify admin, go to Settings > Integrations > API access, and click Generate API key.
2. List your invoices
Section titled “2. List your invoices”curl -s \ -H "X-Auth-Token: YOUR_API_KEY" \ https://app.invoicefalcon.com/api/v1/external/invoices | jq3. Create an invoice from a Shopify order
Section titled “3. Create an invoice from a Shopify order”curl -s -X POST \ -H "X-Auth-Token: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"order_id": 123456789}' \ https://app.invoicefalcon.com/api/v1/external/invoices | jq4. Get a PDF download link
Section titled “4. Get a PDF download link”curl -s \ -H "X-Auth-Token: YOUR_API_KEY" \ https://app.invoicefalcon.com/api/v1/external/invoices/INVOICE_SLUG/pdf | jqAPI v1 endpoints
Section titled “API v1 endpoints”Invoices
Section titled “Invoices”| Endpoint | Description |
|---|---|
GET /invoices |
List invoices with filtering and pagination |
POST /invoices |
Create an invoice from a Shopify order ID |
GET /invoices/:slug |
Get full invoice details |
GET /invoices/search?q= |
Search by name, email, number, or country |
GET /invoices/:slug/pdf |
Get a signed PDF download URL |
POST /invoices/:slug/send_email |
Send the invoice email to the customer |
POST /invoices/:slug/regenerate |
Re-sync from Shopify and regenerate PDF |
POST /invoices/bulk_pdf |
Queue bulk PDF generation for multiple invoices |
Templates
Section titled “Templates”| Endpoint | Description |
|---|---|
GET /templates |
List all templates |
GET /templates/:id |
Get template details |
POST /templates |
Create a new template |
PATCH /templates/:id |
Update a template |
DELETE /templates/:id |
Delete a template |
Customers
Section titled “Customers”| Endpoint | Description |
|---|---|
GET /customers |
List the customers Invoice Falcon stores (on an invoice, edited or added in the app), with search |
GET /customers/:id |
Get customer details with addresses |
POST /customers |
Create a customer |
PATCH /customers/:id |
Update a customer |
DELETE /customers/:id |
Delete a customer |
Settings
Section titled “Settings”| Endpoint | Description |
|---|---|
GET /settings |
Get store invoicing configuration |
PATCH /settings |
Update store settings |
Head to the API Reference tab for full endpoint details, or continue to Authentication and Rate Limiting to learn the basics.
Was this page helpful?
Thanks for letting us know.
Still stuck? Ask Quinn or chat with support