Skip to content

List drafts

GET/orders/drafts

Costs 1 rate-limit point · Rate limits

The Shopify draft orders as the Draft orders tab lists them, newest first, each with the quote Invoice Falcon made for it (number, when it was sent, printed or downloaded) or invoice: null. Filters: draft status (open, invoice_sent, completed), a created date range and a free-text search. Pages by Shopify cursor. Read-only.

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

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

Also searched aslist draft ordersshow draftsopen quotesdraft orders without a quoterecent draftswhich drafts got a quote

Query parameters

  • per_pageinteger

    Rows per page, 1-100 (default 25).

  • afterstring

    Cursor of the last row of the previous page (page.end_cursor), to go forward.

  • beforestring

    Cursor of the first row of the next page (page.start_cursor), to go back.

  • qstring

    Free 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_minstring

    Only orders created on or after this date (YYYY-MM-DD, shop time zone).

  • created_at_maxstring

    Only orders created on or before this date (YYYY-MM-DD, shop time zone).

  • statusstring

    Draft status filter: open, invoice_sent, completed. One of: open (Open), invoice_sent (Invoice sent), completed (Completed).

    One of openinvoice_sentcompleted

Returns

  • itemsarray of objects
    Show 12 child attributesHide child attributes
    • shopify_draft_order_idstring
      Example: gid://shopify/DraftOrder/700
    • kindstring
      Example: draft_order
    • order_numberstring
      Example: #D1
    • 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 2 child attributesHide child attributes
      • namestring
        Example: Ann Lee
      • emailstring
        Example: ann@example.com
    • invoiceobject
      Show 8 child attributesHide child attributes
      • idinteger
        Example: 980191038
      • typestring
        Example: quote
      • numberstring
        Example: Q-1
      • created_atstring
        Example: 2026-11-10T09:24:20Z
      • sent_atstring, nullable
      • printed_atstring, nullable
      • downloaded_atstring, nullable
      • reminder_sent_atstring, nullable
    • cursorstring
      Example: cur700
  • pageobject

    Cursor paging of a Shopify-backed list: pass end_cursor as after for the next page.

    Show 6 child attributesHide child attributes
    • sizeinteger
      Example: 25
    • has_next_pageboolean
      Example: false
    • has_previous_pageboolean
      Example: false
    • start_cursorstring, nullable
    • end_cursorstring, nullable
    • totalinteger, nullable
      Example: 1

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.

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.

502

Shopify did not answer or returned an error (shopify_error). Retry later.

Every error has the same shape: see Errors.

GET/orders/drafts
curl "https://app.invoicefalcon.com/api/v3/external/orders/drafts" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "items": [
    {
      "shopify_draft_order_id": "gid://shopify/DraftOrder/700",
      "kind": "draft_order",
      "order_number": "#D1",
      "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": {
        "name": "Ann Lee",
        "email": "ann@example.com"
      },
      "invoice": {
        "id": 980191038,
        "type": "quote",
        "number": "Q-1",
        "created_at": "2026-11-10T09:24:20Z",
        "sent_at": null,
        "printed_at": null,
        "downloaded_at": null,
        "reminder_sent_at": null
      },
      "cursor": "cur700"
    }
  ],
  "page": {
    "size": 25,
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": null,
    "end_cursor": null,
    "total": 1
  }
}