Resource
Documents
The document object
Attributes
idintegerExample:980191059document_typestringExample:quoteinvoice_numberstringExample:Q-1001titlestringExample:QuoteorderobjectShow 3 child attributesHide child attributes
shopify_order_idstringExample:gid://shopify/DraftOrder/990777namestringExample:#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-10T09:24:24Zshopify_draft_order_idstringExample:gid://shopify/DraftOrder/990777fulfillment_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-10T09:24:24Zpayment_urlstringExample:https://shop.example/pay/abc
Endpoints
- GET
/documents/bulk - GET
/documents/bulk/{job_id} - POST
/documents/bulk/{job_id}/cancel - POST
/documents/bulk/print - POST
/documents/bulk/send - GET
/documents/credit_notes - POST
/documents/credit_notes - GET
/documents/credit_notes/{id} - DEL
/documents/credit_notes/{id} - POST
/documents/credit_notes/{id}/pdf - POST
/documents/credit_notes/{id}/send - GET
/documents/invoices - POST
/documents/invoices - GET
/documents/invoices/{id} - PATCH
/documents/invoices/{id} - DEL
/documents/invoices/{id} - GET
/documents/invoices/{id}/history - POST
/documents/invoices/{id}/mark_paid - POST
/documents/invoices/{id}/mark_unpaid - POST
/documents/invoices/{id}/pdf - DEL
/documents/invoices/{id}/permanent - POST
/documents/invoices/{id}/restore - POST
/documents/invoices/{id}/send - GET
/documents/packing_slips/{invoice_id} - GET
/documents/quotes - POST
/documents/quotes - GET
/documents/quotes/{id} - POST
/documents/quotes/{id}/pdf - POST
/documents/quotes/{id}/send
The document object
{
"id": 980191059,
"document_type": "quote",
"invoice_number": "Q-1001",
"title": "Quote",
"order": {
"shopify_order_id": "gid://shopify/DraftOrder/990777",
"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-10T09:24:24Z",
"shopify_draft_order_id": "gid://shopify/DraftOrder/990777",
"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-10T09:24:24Z",
"payment_url": "https://shop.example/pay/abc"
}