Retrieve draft
/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
idstringRequiredA Shopify id (gid://shopify/Order/123 or 123) or the order number as the store shows it ("#1001" or "1001").
Returns
shopify_draft_order_idstringExample:gid://shopify/DraftOrder/700kindstringExample:draft_orderorder_numberstringExample:#1001created_atstringExample:2026-03-01T10:00:00Zprocessed_atstringExample:2026-03-01T10:00:00Zfinancial_statusstringExample:paidstatusstringExample:opencurrencystringExample:EURtotalstringExample:120.50customerobjectShow 6 child attributesHide child attributes
shopify_customer_idstringExample:gid://shopify/Customer/42namestringExample:Ann LeeemailstringExample:ann@example.comphonestring, nullablenotestring, nullabledefault_addressobject, nullable
invoiceobject, nullableemailstringExample:ann@example.comphonestring, nullablenotestringExample:Giftcancelled_atstring, nullabletotalsobjectShow 5 child attributesHide child attributes
subtotalstringExample:100.00shippingstringExample:10.00taxstringExample:10.50discountsstringExample:0.00totalstringExample:120.50
shipping_methodstringExample:Standardbilling_addressobjectShow 12 child attributesHide child attributes
namestringExample:Ann Leefirst_namestringExample:Annlast_namestringExample:Leeaddress1stringExample:1 Main Staddress2string, nullablecitystringExample:Berlinprovincestring, nullableprovince_codestring, nullablecountrystringExample:Germanycountry_codestringExample:DEzipstringExample:10115phonestring, nullable
shipping_addressobject, nullableline_itemsarray of objectsShow 12 child attributesHide child attributes
idstringExample:gid://shopify/LineItem/9titlestringExample:Hatvariant_titlestringExample:RedskustringExample:HAT-Rbarcodestring, nullablequantityintegerExample:2unit_pricestringExample:50.00totalstringExample:100.00image_urlstring, nullableselling_plannullproduct_idstringExample:gid://shopify/Product/88variant_idstringExample:gid://shopify/ProductVariant/77
tax_linesarray of objectsShow 3 child attributesHide child attributes
titlestringExample:VATratenumberExample:0.19amountstringExample:10.50
documentsarray of anys
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 resource does not exist for this shop, or no action is registered at this path.
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.
Every error has the same shape: see Errors.
curl "https://app.invoicefalcon.com/api/v3/external/orders/drafts/{id}" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/orders/drafts/{id}", {
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/drafts/{id}",
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/drafts/{id}")
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){
"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": []
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"Resource not found"
],
"code": "not_found"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}