order object
A completed order. Available in the thankyou, upsell and customer-order templates, and from customer.orders and customer.last_order.
Properties
| Name | Type | Description |
|---|---|---|
id | string | Order identifier |
ref | string | Order reference, for example 1042 |
name | string | Order reference with a #, for example #1042 |
created_at | string | The date of the order, in ISO 8601 |
financial_status | string | Payment status slug, for example paid or pending |
fulfillment_status | string | Shipping status slug, for example fulfilled or unfulfilled, or nil |
customer_url | string | The URL of the order page in the customer account |
shipping_address | address object or null | The shipping address |
paymentStatus | string | Human-readable payment status |
paymentStatusSlug | string | Machine-readable payment status slug |
gatewayType | string | Payment gateway used |
shippingCost | string | Shipping cost. 0 or null means free shipping |
sub_total | number | Order items subtotal |
total | number | Order total, including VAT, shipping, and any coupon discount |
total_tax_amount | number | Total tax amount |
vat | number | VAT rate as a fraction (for example, 0.2 for 20%) |
order_variants | array of order_variant object | The purchased product variants |
coupon | coupon object or null | The coupon applied to the order, if any |
metafields | array | Order metafields |