Resource
Orders
The order object
Attributes
shopify_order_idstringExample:gid://shopify/Order/5551001kindstringExample:orderorder_numberstringExample:#1001created_atstringExample:2026-03-01T10:00:00Zprocessed_atstringExample:2026-03-01T10:00:00Zfinancial_statusstringExample:paidfulfillment_statusstringExample:fulfilledcurrencystringExample:EURtotalstringExample:120.50customerobjectShow 6 child attributesHide child attributes
shopify_customer_idstringExample:gid://shopify/Customer/42namestringExample:Ann LeeemailstringExample:ann@example.comphonestring, nullablenotestring, nullabledefault_addressobject, nullable
invoiceobjectShow 9 child attributesHide child attributes
idintegerExample:980191041typestringExample:invoicenumberstringExample:INV-77created_atstringExample:2026-11-10T09:24:20Zsent_atstringExample:2026-03-02T10:00:00Zprinted_atstringExample:2026-03-03T10:00:00Zdownloaded_atstring, nullablereminder_sent_atstring, nullablee_invoiceobjectShow 3 child attributesHide child attributes
statusobject, nullableerrorstring, nullablerequestedbooleanExample:false
emailstringExample:ann@example.comphonestring, nullablenotestringExample:Giftcancelled_atstring, nullabletotalsobjectShow 5 child attributesHide child attributes
subtotalstringExample:100.00shippingstringExample:10.00taxstringExample:10.50discountsstringExample:0.00totalstringExample:120.50
shipping_methodstringExample:Standardbilling_addressobjectShow 12 child attributesHide child attributes
namestringExample:Ann Leefirst_namestringExample:Annlast_namestringExample:Leeaddress1stringExample:1 Main Staddress2string, nullablecitystringExample:Berlinprovincestring, nullableprovince_codestring, nullablecountrystringExample:Germanycountry_codestringExample:DEzipstringExample:10115phonestring, nullable
shipping_addressobject, nullableline_itemsarray of objectsShow 12 child attributesHide child attributes
idstringExample:gid://shopify/LineItem/9titlestringExample:Hatvariant_titlestringExample:RedskustringExample:HAT-Rbarcodestring, nullablequantityintegerExample:2unit_pricestringExample:50.00totalstringExample:100.00image_urlstring, nullableselling_plannullproduct_idstringExample:gid://shopify/Product/88variant_idstringExample:gid://shopify/ProductVariant/77
tax_linesarray of objectsShow 3 child attributesHide child attributes
titlestringExample:VATratenumberExample:0.19amountstringExample:10.50
documentsarray of objectsShow 11 child attributesHide child attributes
idintegerExample:980191041typestringExample:invoicenumberstringExample:INV-77created_atstringExample:2026-11-10T09:24:20Zsent_atstringExample:2026-03-02T10:00:00Zprinted_atstringExample:2026-03-03T10:00:00Zdownloaded_atstring, nullablereminder_sent_atstring, nullablepaid_atstring, nullablepdf_readybooleanExample:falsee_invoiceobjectShow 3 child attributesHide child attributes
statusobject, nullableerrorstring, nullablerequestedbooleanExample:false
Endpoints
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
}
}
]
}