Invoice Falcon API - Invoice Falcon Docs

Welcome to the Invoice Falcon API documentation. Use the API to programmatically manage invoices, templates, customers, and settings for your Shopify store.

Quick start

1. Get your API key

Open the Invoice Falcon app in your Shopify admin, navigate to Settings > Integrations, and generate your API key.

2. List your invoices

curl -s \
  -H "X-Auth-Token: YOUR_API_KEY" \
  https://app.invoicefalcon.com/api/v1/external/invoices | jq

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 | jq

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 | jq

Available endpoints

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

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

Endpoint	Description
`GET /customers`	List customers 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

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.