Skip to content

Create quote

POST/documents/quotes

Costs 2 rate-limit points · Rate limits

Creates the quote for a Shopify draft order the way the Quotes page does: reads the draft order from Shopify, builds the quote with its line items and addresses (and the payment link when the draft has an invoice URL), renders the PDF and returns the full quote. If the shop already has a quote for that draft order it is returned with already_existed: true.

Renders a PDF, which counts against a free plan invoice limit. With send_email: true it also emails the quote to the customer immediately.

Also searched ascreate quotequote this draft ordergenerate quotemake a quotenew quotequote for draft ordersend quote for draft

Request body

  • draft_order_idstringRequired

    The Shopify draft order: a gid (gid://shopify/DraftOrder/123), a bare id, or its name ('#D1').

  • send_emailboolean

    true emails the quote to the draft order customer right after creating it (default false).

  • generate_pdfboolean

    false skips rendering the PDF (default true).

  • template_idinteger

    Template to render with. Default: the shop default quote template.

Returns

  • idinteger
    Example: 980191017
  • document_typestring
    Example: quote
  • invoice_numberstring
    Example: Q-1001
  • titlestring
    Example: Quote
  • orderobject
    Show 3 child attributesHide child attributes
    • shopify_order_idstring
      Example: gid://shopify/DraftOrder/555
    • namestring
      Example: #D1001
    • numberinteger, nullable
  • customerobject
    Show 8 child attributesHide child attributes
    • idinteger, nullable
    • namestring, nullable
    • emailstring
      Example: quote@example.com
    • shopify_customer_idstring, nullable
    • phonestring, nullable
    • tax_numberstring, nullable
    • eori_numberstring, nullable
    • tagsarray of anys
  • financial_statusstring, nullable
  • currencystring
    Example: EUR
  • totalstring
    Example: 50.00
  • issued_onstring
    Example: 2026-11-10
  • due_onstring, nullable
  • sent_atstring, nullable
  • printed_atstring, nullable
  • reminder_sent_atstring, nullable
  • paidboolean
    Example: false
  • editedboolean
    Example: true
  • trashedboolean
    Example: false
  • e_invoice_statusstring, nullable
  • created_atstring
    Example: 2026-11-10T08:35:25Z
  • shopify_draft_order_idstring
    Example: gid://shopify/DraftOrder/555
  • fulfillment_statusstring, nullable
  • datesobject
    Show 5 child attributesHide child attributes
    • order_placed_atstring, nullable
    • issued_onstring
      Example: 2026-11-10
    • due_onstring, nullable
    • tax_datestring, nullable
    • fulfilled_onstring, nullable
  • po_numberstring, nullable
  • payment_termsstring, nullable
  • payment_gatewaystring, nullable
  • localestring, nullable
  • totalsobject
    Show 11 child attributesHide child attributes
    • currencystring
      Example: EUR
    • taxes_includedboolean, nullable
    • subtotalstring
      Example: 0.00
    • discountsstring
      Example: 0.00
    • shippingstring
      Example: 0.00
    • taxstring
      Example: 0.00
    • dutiesstring
      Example: 0.00
    • totalstring
      Example: 0.00
    • total_paidstring
      Example: 0.00
    • total_refundedstring
      Example: 0.00
    • total_duestring
      Example: 0.00
  • billing_addressobject, nullable
  • shipping_addressobject, nullable
  • line_itemsarray of anys
  • shipping_linesarray of anys
  • tax_linesarray of anys
  • discount_codesarray of anys
  • notesobject
    Show 3 child attributesHide child attributes
    • notestring, nullable
    • custom_notestring, nullable
    • note_attributesarray of anys
  • custom_fieldsarray of anys
  • tagsarray of anys
  • trackingobject
    Show 2 child attributesHide child attributes
    • companiesarray of anys, nullable
    • numbersarray of anys, nullable
  • pdfobject
    Show 4 child attributesHide child attributes
    • availableboolean
      Example: false
    • filenamestring, nullable
    • urlstring, nullable
    • generated_atstring, nullable
  • e_invoiceobject
    Show 3 child attributesHide child attributes
    • statusobject, nullable
    • requestedboolean
      Example: false
    • errorstring, nullable
  • updated_atstring
    Example: 2026-11-10T08:35:25Z
  • payment_urlstring
    Example: https://shop.example/pay/abc
  • already_existedboolean
    Example: true

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.

409

The request conflicts with the current state (an issued invoice is locked, the next invoice number moved, a template is still in use, a job already finished). Nothing was changed.

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.

POST/documents/quotes
curl -X POST "https://app.invoicefalcon.com/api/v3/external/documents/quotes" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "draft_order_id": "#D12"
  }'
Response
{
  "id": 980191017,
  "document_type": "quote",
  "invoice_number": "Q-1001",
  "title": "Quote",
  "order": {
    "shopify_order_id": "gid://shopify/DraftOrder/555",
    "name": "#D1001",
    "number": null
  },
  "customer": {
    "id": null,
    "name": null,
    "email": "quote@example.com",
    "shopify_customer_id": null,
    "phone": null,
    "tax_number": null,
    "eori_number": null,
    "tags": []
  },
  "financial_status": null,
  "currency": "EUR",
  "total": "50.00",
  "issued_on": "2026-11-10",
  "due_on": null,
  "sent_at": null,
  "printed_at": null,
  "reminder_sent_at": null,
  "paid": false,
  "edited": true,
  "trashed": false,
  "e_invoice_status": null,
  "created_at": "2026-11-10T08:35:25Z",
  "shopify_draft_order_id": "gid://shopify/DraftOrder/555",
  "fulfillment_status": null,
  "dates": {
    "order_placed_at": null,
    "issued_on": "2026-11-10",
    "due_on": null,
    "tax_date": null,
    "fulfilled_on": null
  },
  "po_number": null,
  "payment_terms": null,
  "payment_gateway": null,
  "locale": null,
  "totals": {
    "currency": "EUR",
    "taxes_included": null,
    "subtotal": "0.00",
    "discounts": "0.00",
    "shipping": "0.00",
    "tax": "0.00",
    "duties": "0.00",
    "total": "0.00",
    "total_paid": "0.00",
    "total_refunded": "0.00",
    "total_due": "0.00"
  },
  "billing_address": null,
  "shipping_address": null,
  "line_items": [],
  "shipping_lines": [],
  "tax_lines": [],
  "discount_codes": [],
  "notes": {
    "note": null,
    "custom_note": null,
    "note_attributes": []
  },
  "custom_fields": [],
  "tags": [],
  "tracking": {
    "companies": null,
    "numbers": null
  },
  "pdf": {
    "available": false,
    "filename": null,
    "url": null,
    "generated_at": null
  },
  "e_invoice": {
    "status": null,
    "requested": false,
    "error": null
  },
  "updated_at": "2026-11-10T08:35:25Z",
  "payment_url": "https://shop.example/pay/abc",
  "already_existed": true
}