Order - Liquid Object Reference - 0.11.3
Object Name | Order |
Version | 0.11.3 |
Description
The Order object represents an order the customer has placed.
Attributes
Attribute | Type | Description |
---|---|---|
additional_payment_path | String | Returns a path that can be used to make an additional payment for this Order |
adjustment_items | List[OrderItem] | Returns a list of adjustment OrderItems in this Order |
collection_point | CollectionPoint | Returns the CollectionPoint for this Order |
collection_time | Timestamp | Returns the collection time for this Order |
contact | Contact | Returns the Contact for this Order |
currency_code | String | Returns currency used for this Order |
customer_notes | String | Returns any notes left by the Customer at the checkout |
id | String | Returns the unique id for this Order |
item_count | Number | Returns the total number of items in this Order |
items | List[OrderItem] | Returns a list of OrderItems in this Order |
ordered_at | Timestamp | Returns the timestamp for when this Order was placed |
path | String | Returns the url path for this Order |
payment_surcharge_values | List[Surcharge] | Returns a list of Surcharges that might be applied to this Order |
payments | List[Payment] | Returns a list of Payments made for this Order |
quotable? | Boolean | Returns true if the Order contains any LineItems that allow quotes |
reference | String | Returns the unique reference number for this Order |
reorder_path | String | Returns the link path to start the Reorder process |
ship_to_contact | Contact | Returns the Contact this Order will be shipped to |
shipping_notes | String | Returns any shipping notes left by the Customer at the checkout |
status | String | Returns the status of this Order |
store | Store | Returns the Store that this Order belongs to |
sub_total | Number | Returns the sub total price for all LineItems, excluding any taxes where tax is exclusive |
surcharge_items | List[OrderItem] | Returns a list of surcharge LineItems in this Order |
taxes | List[Tax] | Returns a list of LineItems in this Order |
test_order? | Boolean | Returns true if the Order represents a test order |
total | Number | Returns the total price including tax for this Order |
total_deposit | Number | Returns the total deposit amount for all LineItems |
total_deposit_points | Number | Returns the total deposit points amount for all LineItems in this Order |
total_earn_points_amount | Number | Returns the total earn points amount for all LineItems in this Order |
total_fixed_term_subscriptions | Number | Returns the total price for fixed term subscription in this Order |
total_fixed_term_subscriptions_points | Number | Returns the total points price for fixed term subscriptions in this Order |
total_non_subscriptions | Number | Returns the total price for non-subscription items in this Order |
total_non_subscriptions_points | Number | Returns the total points price for non-subscription items in this Order |
total_paid | Number | Returns the total amount already paid for this Order |
total_paid_points | Number | Returns the total points amount already paid for this Order |
total_payable | Number | Returns the total amount to be paid for this Order |
total_payable_points | Number | Returns the total points amount to be paid for this Order |
total_points | Number | Returns the total points price for this Order |
total_remaining_subscriptions | Number | Returns the total amount to be paid for subscription items in this Order |
total_remaining_subscriptions_points | Number | Returns the total points amount to be paid for subscription items in this Order |
total_shipping | Number | Returns the total price for Shipping for this Order |
total_subscriptions | Number | Returns the total price for subscription items in this Order |
total_subscriptions_points | Number | Returns the total points price for subscription items in this Order |
total_tax | Number | Returns the total tax for this Order |
url | String | Returns the complete url for this Order |
Addresses
Shipping and Billing addresses
Attribute | Type | Description |
---|---|---|
billing_address_lines | List[String] | Returns a list of all the address lines in the Billing Street for this Order |
billing_city | String | Returns the Billing Country for this Order |
billing_country | String | Returns the Billing City for this Order |
billing_postal_code | String | Returns the Billing Postal Code for this Order |
billing_state | String | Returns the Billing State for this Order |
billing_street | String | Returns the Billing Street for this Order |
shipping_address_lines | List[String] | Returns a list of all the address lines in the Billing Street for this Order |
shipping_city | String | Returns the Shipping Country for this Order |
shipping_country | String | Returns the Shipping City for this Order |
shipping_postal_code | String | Returns the Shipping Postal Code for this Order |
shipping_state | String | Returns the Shipping State for this Order |
shipping_street | String | Returns the Shipping Street for this Order |
Bookings
Various attributes related to the Bookable Products
Attribute | Type | Description |
---|---|---|
bookable? | Boolean | Returns true if the Order contains any Bookable products |
bookable_items | List[OrderItem] | Returns a list of OrderItems in this Order which are for Bookable products |
bookings | List[Booking] | Returns a list of Bookings associated with this Order |
collect_booking_attendees? | Boolean | Returns true if the customer needs to enter the contact details for BookingAttendees |
Checkout
Various attributes related to the checkout
Attribute | Type | Description |
---|---|---|
checkout_email | String | Returns the email used during checkout |
checkout_phone | String | Returns the phone number used during checkout |
Objects that return Orders
Back to Liquid Reference for 0.11.3
Back to Documentation