Skip to content

Resource

Documents

The document object

Attributes

  • idinteger
    Example: 980191059
  • 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/990777
    • 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-10T09:24:24Z
  • shopify_draft_order_idstring
    Example: gid://shopify/DraftOrder/990777
  • 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-10T09:24:24Z
  • payment_urlstring
    Example: https://shop.example/pay/abc
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"
}