Create quote
/documents/quotesCosts 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_idstringRequiredThe Shopify draft order: a gid (gid://shopify/DraftOrder/123), a bare id, or its name ('#D1').
send_emailbooleantrue emails the quote to the draft order customer right after creating it (default false).
generate_pdfbooleanfalse skips rendering the PDF (default true).
template_idintegerTemplate to render with. Default: the shop default quote template.
Returns
idintegerExample:980191017document_typestringExample:quoteinvoice_numberstringExample:Q-1001titlestringExample:QuoteorderobjectShow 3 child attributesHide child attributes
shopify_order_idstringExample:gid://shopify/DraftOrder/555namestringExample:#D1001numberinteger, nullable
customerobjectShow 8 child attributesHide child attributes
idinteger, nullablenamestring, nullableemailstringExample:quote@example.comshopify_customer_idstring, nullablephonestring, nullabletax_numberstring, nullableeori_numberstring, nullabletagsarray of anys
financial_statusstring, nullablecurrencystringExample:EURtotalstringExample:50.00issued_onstringExample:2026-11-10due_onstring, nullablesent_atstring, nullableprinted_atstring, nullablereminder_sent_atstring, nullablepaidbooleanExample:falseeditedbooleanExample:truetrashedbooleanExample:falsee_invoice_statusstring, nullablecreated_atstringExample:2026-11-10T08:35:25Zshopify_draft_order_idstringExample:gid://shopify/DraftOrder/555fulfillment_statusstring, nullabledatesobjectShow 5 child attributesHide child attributes
order_placed_atstring, nullableissued_onstringExample:2026-11-10due_onstring, nullabletax_datestring, nullablefulfilled_onstring, nullable
po_numberstring, nullablepayment_termsstring, nullablepayment_gatewaystring, nullablelocalestring, nullabletotalsobjectShow 11 child attributesHide child attributes
currencystringExample:EURtaxes_includedboolean, nullablesubtotalstringExample:0.00discountsstringExample:0.00shippingstringExample:0.00taxstringExample:0.00dutiesstringExample:0.00totalstringExample:0.00total_paidstringExample:0.00total_refundedstringExample:0.00total_duestringExample:0.00
billing_addressobject, nullableshipping_addressobject, nullableline_itemsarray of anysshipping_linesarray of anystax_linesarray of anysdiscount_codesarray of anysnotesobjectShow 3 child attributesHide child attributes
notestring, nullablecustom_notestring, nullablenote_attributesarray of anys
custom_fieldsarray of anystagsarray of anystrackingobjectShow 2 child attributesHide child attributes
companiesarray of anys, nullablenumbersarray of anys, nullable
pdfobjectShow 4 child attributesHide child attributes
availablebooleanExample:falsefilenamestring, nullableurlstring, nullablegenerated_atstring, nullable
e_invoiceobjectShow 3 child attributesHide child attributes
statusobject, nullablerequestedbooleanExample:falseerrorstring, nullable
updated_atstringExample:2026-11-10T08:35:25Zpayment_urlstringExample:https://shop.example/pay/abcalready_existedbooleanExample:true
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 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.
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 -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"
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/quotes", {
method: "POST",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"draft_order_id": "#D12"
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.invoicefalcon.com/api/v3/external/documents/quotes",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"draft_order_id": "#D12"
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/quotes")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
draft_order_id: "#D12"
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)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": "gid://shopify/DraftOrder/1146789216411",
"send_email": true
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/quotes", {
method: "POST",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"draft_order_id": "gid://shopify/DraftOrder/1146789216411",
"send_email": true
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.invoicefalcon.com/api/v3/external/documents/quotes",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"draft_order_id": "gid://shopify/DraftOrder/1146789216411",
"send_email": True
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/quotes")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
draft_order_id: "gid://shopify/DraftOrder/1146789216411",
send_email: true
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)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",
"template_id": 312,
"generate_pdf": true
}'const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/quotes", {
method: "POST",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({
"draft_order_id": "#D12",
"template_id": 312,
"generate_pdf": true
}),
});
const data = await res.json();import os
import requests
res = requests.post(
"https://app.invoicefalcon.com/api/v3/external/documents/quotes",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
json={
"draft_order_id": "#D12",
"template_id": 312,
"generate_pdf": True
},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/quotes")
req = Net::HTTP::Post.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"], "Content-Type" => "application/json")
req.body = {
draft_order_id: "#D12",
template_id: 312,
generate_pdf: true
}.to_json
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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
}{
"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": false
}{
"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": [
"This shop keeps issued invoices unchanged, so this invoice cannot be edited."
],
"code": "invoice_locked"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}