order object
A completed order. Available in the thankyou and upsell templates.
Properties
| Name | Type | Description |
|---|---|---|
id | string | Order identifier |
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 |
bundles | array | Bundles included in the order |
metafields | array | Order metafields |