Skip to content

Resource

Orders

The order object

Attributes

  • shopify_order_idstring
    Example: gid://shopify/Order/5551001
  • kindstring
    Example: order
  • order_numberstring
    Example: #1001
  • created_atstring
    Example: 2026-03-01T10:00:00Z
  • processed_atstring
    Example: 2026-03-01T10:00:00Z
  • financial_statusstring
    Example: paid
  • fulfillment_statusstring
    Example: fulfilled
  • currencystring
    Example: EUR
  • totalstring
    Example: 120.50
  • customerobject
    Show 6 child attributesHide child attributes
    • shopify_customer_idstring
      Example: gid://shopify/Customer/42
    • namestring
      Example: Ann Lee
    • emailstring
      Example: ann@example.com
    • phonestring, nullable
    • notestring, nullable
    • default_addressobject, nullable
  • invoiceobject
    Show 9 child attributesHide child attributes
    • idinteger
      Example: 980191041
    • typestring
      Example: invoice
    • numberstring
      Example: INV-77
    • created_atstring
      Example: 2026-11-10T09:24:20Z
    • sent_atstring
      Example: 2026-03-02T10:00:00Z
    • printed_atstring
      Example: 2026-03-03T10:00:00Z
    • downloaded_atstring, nullable
    • reminder_sent_atstring, nullable
    • e_invoiceobject
      Show 3 child attributesHide child attributes
      • statusobject, nullable
      • errorstring, nullable
      • requestedboolean
        Example: false
  • emailstring
    Example: ann@example.com
  • phonestring, nullable
  • notestring
    Example: Gift
  • cancelled_atstring, nullable
  • totalsobject
    Show 5 child attributesHide child attributes
    • subtotalstring
      Example: 100.00
    • shippingstring
      Example: 10.00
    • taxstring
      Example: 10.50
    • discountsstring
      Example: 0.00
    • totalstring
      Example: 120.50
  • shipping_methodstring
    Example: Standard
  • billing_addressobject
    Show 12 child attributesHide child attributes
    • namestring
      Example: Ann Lee
    • first_namestring
      Example: Ann
    • last_namestring
      Example: Lee
    • address1string
      Example: 1 Main St
    • address2string, nullable
    • citystring
      Example: Berlin
    • provincestring, nullable
    • province_codestring, nullable
    • countrystring
      Example: Germany
    • country_codestring
      Example: DE
    • zipstring
      Example: 10115
    • phonestring, nullable
  • shipping_addressobject, nullable
  • line_itemsarray of objects
    Show 12 child attributesHide child attributes
    • idstring
      Example: gid://shopify/LineItem/9
    • titlestring
      Example: Hat
    • variant_titlestring
      Example: Red
    • skustring
      Example: HAT-R
    • barcodestring, nullable
    • quantityinteger
      Example: 2
    • unit_pricestring
      Example: 50.00
    • totalstring
      Example: 100.00
    • image_urlstring, nullable
    • selling_plannull
    • product_idstring
      Example: gid://shopify/Product/88
    • variant_idstring
      Example: gid://shopify/ProductVariant/77
  • tax_linesarray of objects
    Show 3 child attributesHide child attributes
    • titlestring
      Example: VAT
    • ratenumber
      Example: 0.19
    • amountstring
      Example: 10.50
  • documentsarray of objects
    Show 11 child attributesHide child attributes
    • idinteger
      Example: 980191041
    • typestring
      Example: invoice
    • numberstring
      Example: INV-77
    • created_atstring
      Example: 2026-11-10T09:24:20Z
    • sent_atstring
      Example: 2026-03-02T10:00:00Z
    • printed_atstring
      Example: 2026-03-03T10:00:00Z
    • downloaded_atstring, nullable
    • reminder_sent_atstring, nullable
    • paid_atstring, nullable
    • pdf_readyboolean
      Example: false
    • e_invoiceobject
      Show 3 child attributesHide child attributes
      • statusobject, nullable
      • errorstring, nullable
      • requestedboolean
        Example: false
The order object
{
  "shopify_order_id": "gid://shopify/Order/5551001",
  "kind": "order",
  "order_number": "#1001",
  "created_at": "2026-03-01T10:00:00Z",
  "processed_at": "2026-03-01T10:00:00Z",
  "financial_status": "paid",
  "fulfillment_status": "fulfilled",
  "currency": "EUR",
  "total": "120.50",
  "customer": {
    "shopify_customer_id": "gid://shopify/Customer/42",
    "name": "Ann Lee",
    "email": "ann@example.com",
    "phone": null,
    "note": null,
    "default_address": null
  },
  "invoice": {
    "id": 980191041,
    "type": "invoice",
    "number": "INV-77",
    "created_at": "2026-11-10T09:24:20Z",
    "sent_at": "2026-03-02T10:00:00Z",
    "printed_at": "2026-03-03T10:00:00Z",
    "downloaded_at": null,
    "reminder_sent_at": null,
    "e_invoice": {
      "status": null,
      "error": null,
      "requested": false
    }
  },
  "email": "ann@example.com",
  "phone": null,
  "note": "Gift",
  "cancelled_at": null,
  "totals": {
    "subtotal": "100.00",
    "shipping": "10.00",
    "tax": "10.50",
    "discounts": "0.00",
    "total": "120.50"
  },
  "shipping_method": "Standard",
  "billing_address": {
    "name": "Ann Lee",
    "first_name": "Ann",
    "last_name": "Lee",
    "address1": "1 Main St",
    "address2": null,
    "city": "Berlin",
    "province": null,
    "province_code": null,
    "country": "Germany",
    "country_code": "DE",
    "zip": "10115",
    "phone": null
  },
  "shipping_address": null,
  "line_items": [
    {
      "id": "gid://shopify/LineItem/9",
      "title": "Hat",
      "variant_title": "Red",
      "sku": "HAT-R",
      "barcode": null,
      "quantity": 2,
      "unit_price": "50.00",
      "total": "100.00",
      "image_url": null,
      "selling_plan": null,
      "product_id": "gid://shopify/Product/88",
      "variant_id": "gid://shopify/ProductVariant/77"
    }
  ],
  "tax_lines": [
    {
      "title": "VAT",
      "rate": 0.19,
      "amount": "10.50"
    }
  ],
  "documents": [
    {
      "id": 980191041,
      "type": "invoice",
      "number": "INV-77",
      "created_at": "2026-11-10T09:24:20Z",
      "sent_at": "2026-03-02T10:00:00Z",
      "printed_at": "2026-03-03T10:00:00Z",
      "downloaded_at": null,
      "reminder_sent_at": null,
      "paid_at": null,
      "pdf_ready": false,
      "e_invoice": {
        "status": null,
        "error": null,
        "requested": false
      }
    }
  ]
}