Skip to content

Retrieve draft

GET/orders/drafts/{id}

Costs 1 rate-limit point · Rate limits

One Shopify draft order as its page shows it: customer, addresses, line items and totals from Shopify, plus the quote Invoice Falcon made for it, if any. Accepts a gid (gid://shopify/DraftOrder/123), a bare id or the draft name ("#D12"). Read-only.

status values: open (Open), invoice_sent (Invoice sent), completed (Completed).

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

Also searched asshow draft orderdraft order detailsopen quoteis the draft quoteddraft line items

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

  • shopify_draft_order_idstring
    Example: gid://shopify/DraftOrder/700
  • kindstring
    Example: draft_order
  • order_numberstring
    Example: #1001
  • created_atstring
    Example: 2026-03-01T10:00:00Z
  • processed_atstring
    Example: 2026-03-01T10:00:00Z
  • financial_statusstring
    Example: paid
  • statusstring
    Example: open
  • currencystring
    Example: EUR
  • totalstring
    Example: 120.50
  • customerobject
    Show 6 child attributesHide child attributes
    • shopify_customer_idstring
      Example: gid://shopify/Customer/42
    • namestring
      Example: Ann Lee
    • emailstring
      Example: ann@example.com
    • phonestring, nullable
    • notestring, nullable
    • default_addressobject, nullable
  • invoiceobject, nullable
  • emailstring
    Example: ann@example.com
  • phonestring, nullable
  • notestring
    Example: Gift
  • cancelled_atstring, nullable
  • totalsobject
    Show 5 child attributesHide child attributes
    • subtotalstring
      Example: 100.00
    • shippingstring
      Example: 10.00
    • taxstring
      Example: 10.50
    • discountsstring
      Example: 0.00
    • totalstring
      Example: 120.50
  • shipping_methodstring
    Example: Standard
  • billing_addressobject
    Show 12 child attributesHide child attributes
    • namestring
      Example: Ann Lee
    • first_namestring
      Example: Ann
    • last_namestring
      Example: Lee
    • address1string
      Example: 1 Main St
    • address2string, nullable
    • citystring
      Example: Berlin
    • provincestring, nullable
    • province_codestring, nullable
    • countrystring
      Example: Germany
    • country_codestring
      Example: DE
    • zipstring
      Example: 10115
    • phonestring, nullable
  • shipping_addressobject, nullable
  • line_itemsarray of objects
    Show 12 child attributesHide child attributes
    • idstring
      Example: gid://shopify/LineItem/9
    • titlestring
      Example: Hat
    • variant_titlestring
      Example: Red
    • skustring
      Example: HAT-R
    • barcodestring, nullable
    • quantityinteger
      Example: 2
    • unit_pricestring
      Example: 50.00
    • totalstring
      Example: 100.00
    • image_urlstring, nullable
    • selling_plannull
    • product_idstring
      Example: gid://shopify/Product/88
    • variant_idstring
      Example: gid://shopify/ProductVariant/77
  • tax_linesarray of objects
    Show 3 child attributesHide child attributes
    • titlestring
      Example: VAT
    • ratenumber
      Example: 0.19
    • amountstring
      Example: 10.50
  • documentsarray of anys

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/drafts/{id}
curl "https://app.invoicefalcon.com/api/v3/external/orders/drafts/{id}" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "shopify_draft_order_id": "gid://shopify/DraftOrder/700",
  "kind": "draft_order",
  "order_number": "#1001",
  "created_at": "2026-03-01T10:00:00Z",
  "processed_at": "2026-03-01T10:00:00Z",
  "financial_status": "paid",
  "status": "open",
  "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": null,
  "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": []
}