Skip to content

Retrieve order

GET/orders/{id}

Costs 1 rate-limit point · Rate limits

One Shopify order as the order page shows it: customer, addresses, line items, totals and tax lines from Shopify, plus every Invoice Falcon document that exists for it (invoice, credit notes) with their numbers and send/print/download times. Accepts a gid, a bare Shopify id or the order number ("#1001" or "1001"). Read-only.

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).

documents.type values: invoice (Invoice), quote (Quote), pro_forma (Pro forma invoice), credit_note (Credit note), custom (Custom document).

documents.e_invoice.status values: generated (E-invoice embedded), fallback (Standard PDF), requested (Requested).

Also searched asshow orderorder detailswhat did we send for orderis order 1001 invoicedopen orderorder line itemsdocuments for an order

Path parameters

  • idstringRequired

    A Shopify id (gid://shopify/Order/123 or 123) or the order number as the store shows it ("#1001" or "1001").

Returns

The order object.

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

404

The resource does not exist for this shop, or no action is registered at this path.

422

The request failed validation. Nothing was saved.

429

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.

GET/orders/{id}
curl "https://app.invoicefalcon.com/api/v3/external/orders/{id}" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "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": {
    "shopify_customer_id": "gid://shopify/Customer/42",
    "name": "Ann Lee",
    "email": "ann@example.com",
    "phone": null,
    "note": null,
    "default_address": null
  },
  "invoice": {
    "id": 980191041,
    "type": "invoice",
    "number": "INV-77",
    "created_at": "2026-11-10T09:24:20Z",
    "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
    }
  },
  "email": "ann@example.com",
  "phone": null,
  "note": "Gift",
  "cancelled_at": null,
  "totals": {
    "subtotal": "100.00",
    "shipping": "10.00",
    "tax": "10.50",
    "discounts": "0.00",
    "total": "120.50"
  },
  "shipping_method": "Standard",
  "billing_address": {
    "name": "Ann Lee",
    "first_name": "Ann",
    "last_name": "Lee",
    "address1": "1 Main St",
    "address2": null,
    "city": "Berlin",
    "province": null,
    "province_code": null,
    "country": "Germany",
    "country_code": "DE",
    "zip": "10115",
    "phone": null
  },
  "shipping_address": null,
  "line_items": [
    {
      "id": "gid://shopify/LineItem/9",
      "title": "Hat",
      "variant_title": "Red",
      "sku": "HAT-R",
      "barcode": null,
      "quantity": 2,
      "unit_price": "50.00",
      "total": "100.00",
      "image_url": null,
      "selling_plan": null,
      "product_id": "gid://shopify/Product/88",
      "variant_id": "gid://shopify/ProductVariant/77"
    }
  ],
  "tax_lines": [
    {
      "title": "VAT",
      "rate": 0.19,
      "amount": "10.50"
    }
  ],
  "documents": [
    {
      "id": 980191041,
      "type": "invoice",
      "number": "INV-77",
      "created_at": "2026-11-10T09:24:20Z",
      "sent_at": "2026-03-02T10:00:00Z",
      "printed_at": "2026-03-03T10:00:00Z",
      "downloaded_at": null,
      "reminder_sent_at": null,
      "paid_at": null,
      "pdf_ready": false,
      "e_invoice": {
        "status": null,
        "error": null,
        "requested": false
      }
    }
  ]
}