List orders
/ordersCosts 1 rate-limit point · Rate limits
The Shopify orders of the store as the Orders page lists them, newest first, each with the Invoice Falcon invoice that exists for it (number, when it was sent, printed or downloaded, e-invoice state) or invoice: null when none was made yet. Filters match the page: payment status, fulfillment status, a created date range and a free-text search. Pages by Shopify cursor: pass page.end_cursor as after for the next page. Read-only; it never creates invoices.
financial_status values: paid (Paid), pending (Pending), refunded (Refunded), partially_paid (Partially paid), partially_refunded (Partially refunded), authorized (Authorized), voided (Voided), expired (Expired).
fulfillment_status values: fulfilled (Fulfilled), unfulfilled (Unfulfilled), partially_fulfilled (Partially fulfilled), in_progress (In progress), on_hold (On hold), pending_fulfillment (Pending), scheduled (Scheduled), restocked (Restocked).
invoice.type values: invoice (Invoice), quote (Quote), pro_forma (Pro forma invoice), credit_note (Credit note), custom (Custom document).
invoice.e_invoice.status values: generated (E-invoice embedded), fallback (Standard PDF), requested (Requested).
Also searched aslist ordersshow my ordersrecent ordersorders without an invoiceunpaid ordersorders from last weekfind orderwhich orders were invoiced
Query parameters
per_pageintegerRows per page, 1-100 (default 25).
afterstringCursor of the last row of the previous page (page.end_cursor), to go forward.
beforestringCursor of the first row of the next page (page.start_cursor), to go back.
qstringFree text, in Shopify order search syntax: an order number ("#1001"), a customer name or email, or a field filter ("tag:wholesale", "sku:ABC").
created_at_minstringOnly orders created on or after this date (YYYY-MM-DD, shop time zone).
created_at_maxstringOnly orders created on or before this date (YYYY-MM-DD, shop time zone).
financial_statusstringPayment status filter: paid, pending, refunded, partially_paid, authorized, voided. One of:
paid(Paid),pending(Pending),refunded(Refunded),partially_paid(Partially paid),partially_refunded(Partially refunded),authorized(Authorized),voided(Voided),expired(Expired).One ofpaidpendingrefundedpartially_paidpartially_refundedauthorizedvoidedexpiredfulfillment_statusstringFulfillment filter: shipped, unshipped, partial, in_progress, on_hold (shipped = fulfilled, unshipped = unfulfilled). One of:
fulfilled(Fulfilled),unfulfilled(Unfulfilled),partially_fulfilled(Partially fulfilled),in_progress(In progress),on_hold(On hold),pending_fulfillment(Pending),scheduled(Scheduled),restocked(Restocked).One offulfilledunfulfilledpartially_fulfilledin_progresson_holdpending_fulfillmentscheduledrestocked
Returns
itemsarray of objectsShow 12 child attributesHide child attributes
shopify_order_idstringExample:gid://shopify/Order/5551001kindstringExample:orderorder_numberstringExample:#1001created_atstringExample:2026-03-01T10:00:00Zprocessed_atstringExample:2026-03-01T10:00:00Zfinancial_statusstringExample:paidfulfillment_statusstringExample:fulfilledcurrencystringExample:EURtotalstringExample:120.50customerobjectShow 2 child attributesHide child attributes
namestringExample:Ann LeeemailstringExample:ann@example.com
invoiceobjectShow 9 child attributesHide child attributes
idintegerExample:980191045typestringExample:invoicenumberstringExample:INV-77created_atstringExample:2026-11-10T09:24:21Zsent_atstringExample:2026-03-02T10:00:00Zprinted_atstringExample:2026-03-03T10:00:00Zdownloaded_atstring, nullablereminder_sent_atstring, nullablee_invoiceobjectShow 3 child attributesHide child attributes
statusobject, nullableerrorstring, nullablerequestedbooleanExample:false
cursorstringExample:cur5551001
pageobjectCursor paging of a Shopify-backed list: pass
end_cursorasafterfor the next page.Show 6 child attributesHide child attributes
sizeintegerExample:25has_next_pagebooleanExample:truehas_previous_pagebooleanExample:falsestart_cursorstring, nullableExample:aend_cursorstring, nullableExample:ztotalinteger, nullableExample:2
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.
Shopify did not answer or returned an error (shopify_error). Retry later.
Every error has the same shape: see Errors.
curl "https://app.invoicefalcon.com/api/v3/external/orders" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/orders", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/orders",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/orders")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)curl "https://app.invoicefalcon.com/api/v3/external/orders?financial_status=paid&fulfillment_status=fulfilled" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/orders?financial_status=paid&fulfillment_status=fulfilled", {
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.invoicefalcon.com/api/v3/external/orders?financial_status=paid&fulfillment_status=fulfilled",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/orders?financial_status=paid&fulfillment_status=fulfilled")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"items": [
{
"shopify_order_id": "gid://shopify/Order/5551001",
"kind": "order",
"order_number": "#1001",
"created_at": "2026-03-01T10:00:00Z",
"processed_at": "2026-03-01T10:00:00Z",
"financial_status": "paid",
"fulfillment_status": "fulfilled",
"currency": "EUR",
"total": "120.50",
"customer": {
"name": "Ann Lee",
"email": "ann@example.com"
},
"invoice": {
"id": 980191045,
"type": "invoice",
"number": "INV-77",
"created_at": "2026-11-10T09:24:21Z",
"sent_at": "2026-03-02T10:00:00Z",
"printed_at": "2026-03-03T10:00:00Z",
"downloaded_at": null,
"reminder_sent_at": null,
"e_invoice": {
"status": null,
"error": null,
"requested": false
}
},
"cursor": "cur5551001"
},
{
"shopify_order_id": "gid://shopify/Order/5551002",
"kind": "order",
"order_number": "#1002",
"created_at": "2026-03-01T10:00:00Z",
"processed_at": "2026-03-01T10:00:00Z",
"financial_status": "paid",
"fulfillment_status": "fulfilled",
"currency": "EUR",
"total": "120.50",
"customer": {
"name": "Ann Lee",
"email": "ann@example.com"
},
"invoice": null,
"cursor": "cur5551002"
}
],
"page": {
"size": 25,
"has_next_page": true,
"has_previous_page": false,
"start_cursor": "a",
"end_cursor": "z",
"total": 2
}
}{
"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"
}{
"errors": [
"Shopify did not return the orders: no response"
],
"code": "shopify_error"
}