Change log

{{ order }} object

This liquid object will output the order details of a submitted payment.

{{ this.order }}

Order Object Availability

Currently, this object’s structure, and where it can be accessed, varies depending on the type of payment being made. The following table indicates the locations that currently support the order Object Liquid and further below describes the order Object output for the supported locations, based on the various payment scenarios.

Location/ Description
Order Object Availability
(by Payment Type)
Generic
(General)
Generic
(SecureZone)
SingleItem
(Event)
CheckOut
(Shop)
Manual
(Admin)
Confirmation/ Redirect PageThe confirmation page after the payment form submission (either system default or custom redirect page).
n/a
Workflow EmailThe Workflow Notification email/s sent to the site admin/s after payment form submission.
n/a
Workflow Email FieldsThe 'From' and 'Subject' fields for the Workflow Notification email/s.
n/a
Auto-response EmailThe Auto-response email sent to the user after payment form submission.
n/a
Auto-response Email FieldsThe 'From' and 'Subject' fields for the Auto-response email.
n/a
Invoice EmailThe Invoice system email sent to the user after payment form submission.
Invoice Email FieldsThe 'From' and 'Subject' fields for the Invoice email.
Supplier EmailThe Supplier Notification system email sent to the assigned supplier after payment form submission.
n/a
n/a
n/a
n/a
Supplier Email FieldsThe 'From' and 'Subject' fields for the Supplier Notification email.
n/a
n/a
n/a
n/a
Low Stock EmailThe Low Stock Notification system email sent to the site admin/s after payment form submission.
n/a
n/a
n/a
n/a
Low Stock Email FieldsThe 'From' and 'Subject' fields for the Low Stock Notification email.
n/a
n/a
n/a
n/a
Gift Voucher EmailThe Gift Voucher system email sent to the site admin/s after payment form submission.
n/a
n/a
n/a
Gift Voucher Email FieldsThe 'From' and 'Subject' fields for the Gift Voucher email.
n/a
n/a
n/a
Secure Zone Details EmailThe Secure Zone Login Details system email sent to the user after payment form submission.
n/a
n/a
n/a
n/a
Secure Zone Details Email FieldsThe 'From' and 'Subject' fields for the Secure Zone Details email.
n/a
n/a
n/a
n/a

Checkout (form type: checkout)

Receipt page and Emails

The order object output, after a checkout submission, in the ‘order-receipt’ system page and the checkout form’s Workflow Notification, Invoice, Autoresponder, and Supplier email/s (email template and email body).

{
	"customerEmail": "joetest@test.com",
	"paymentType": "CreditCard",
	"state": "Paid",
	"formId": 13,
	"memberId": 47,
	"caseId": 89,
	"name": "Checkout 07 Feb 2021 07:55 AM",
	"invoiceNumber": 29,
	"invoiceCode": "",
	"invoiceDate": "2/7/2021 7:55:55 AM",
	"shippingAddress": {
		"addressLine": "1 Street",
		"city": "Streetville",
		"state": "NSW",
		"zipCode": "2000",
		"country": "AUSTRALIA"
	},
	"amountPending": "0.0000",
	"amountPaid": "10.0500",
	"amountPaidHtml": "<span data-cms_cart_total=\"123\">$10.05</span>",
	"amountPendingHtml": "<span data-cms_cart_total=\"123\">$0.00</span>",
	"awbNumber": "",
	"trackingUrl": "",
	"id": "123",
	"paymentIntentId": "XXXXXXXXXXXXXX",
	"paymentIntentClientSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
	"formatSetting": {
		"name": "AU",
		"culture": "en-AU",
		"decimalsQuantity": 2,
		"currency": {
			"code": "AUD",
			"symbol": "$",
			"digitalCode": "36",
			"name": "Australian Dollar"
		}
	},
	"domainCountry": {
		"name": "AUSTRALIA",
		"code": "AU"
	},
	"destinationCountry": {
		"name": "AUSTRALIA",
		"code": "AU"
	},
	"shippingOption": {
		"id": "12252410371037462605",
		"shippingOptionId": "7361027874612052004",
		"name": "AustraliaPost - Parcel Post",
		"price": 8.1364,
		"taxPercent": 10.0000,
		"taxRate": 0.1000,
		"taxPrice": 0.81,
		"totalPrice": 8.95,
		"subTotalPrice": 8.14
	},
	"discount": {
		"id": null,
		"code": null,
		"type": null,
		"amount": 0.0
	},
	"giftVoucher": {
		"id": null,
		"code": null,
		"amount": 0.0,
		"balance": 0.0
	},
	"subTotalPrice": "1.0000",
	"taxPercent": "10.0000",
	"taxRate": "0.1000",
	"taxPrice": "0.9100",
	"discountPrice": "0",
	"totalPrice": "10.0500",
	"shippingPrice": "8.1364",
	"shippingTaxRate": "0.1000",
	"shippingTaxPrice": "0.81",
	"shippingSubTotalPrice": "8.14",
	"shippingTotalPrice": "8.95",
	"giftVoucherPrice": "0",
	"subTotalTaxPrice": "0.1000",
	"discountedSubTotalTaxPrice": "0.1000",
	"grandTotalPrice": "1.1000",
	"totalPriceExcludingTax": "9.1400",
	"totalPriceExcludingTaxAndGiftVoucherAmount": "9.1364",
	"taxCode": "GST",
	"totalPriceExcludingTaxHtml": "<span data-cms_cart_total_price_excluding_tax=\"123\">$9.14</span>",
	"totalPriceExcludingTaxAndGiftVoucherAmountHtml": "<span data-cms_cart_total_price_excluding_tax_and_gift_voucher_amount=\"123\">$9.14</span>",
	"grandTotalPriceHtml": "<span data-cms_cart_grand_total_price=\"123\">$1.10</span>",
	"discountPriceHtml": "<span data-cms_cart_discount_price=\"123\">$0.00</span>",
	"discountedSubTotalTaxPriceHtml": "<span data-cms_cart_discounted_sub_total_tax_price=\"123\">$0.10</span>",
	"subTotalTaxPriceHtml": "<span data-cms_cart_subtotal_tax_price=\"123\">$0.10</span>",
	"taxPriceHtml": "<span data-cms_cart_tax_price=\"123\">$0.91</span>",
	"shippingTotalPriceHtml": "<span data-cms_cart_shipping_total_price=\"123\">$8.95</span>",
	"shippingPriceHtml": "<span data-cms_cart_shipping_price=\"123\">$8.14</span>",
	"shippingTaxPriceHtml": "<span data-cms_cart_shipping_tax_price=\"123\">$0.81</span>",
	"shippingTaxPercentHtml": "<span data-cms_cart_shipping_tax_percent=\"123\">10.0000%</span>",
	"taxPercentHtml": "<span data-cms_cart_tax_percent=\"123\">10.0000%</span>",
	"giftVoucherPriceHtml": "<span data-cms_cart_gift_voucher_price=\"123\">$0.00</span>",
	"totalPriceHtml": "<span data-cms_cart_total=\"123\">$10.05</span>",
	"items": [{
		"id": "15049017874163171386",
		"ecommerceItemId": 2139,
		"smallImage": null,
		"name": "product1",
		"type": "ModuleItem",
		"moduleId": 0,
		"SKUCode": "39207d4d-c9c0-4a9d-a435-f2c8f8778e68/Size/Large",
		"quantity": 1,
		"productFileLink": null,
		"Url": "/shop/product1",
		"taxCode": "GST",
		"onSalse": false,
		"price": 0.0000,
		"taxPercent": 10.0000,
		"unitPrice": 1.0000,
		"taxPrice": 0.1000,
		"unitTotalPrice": 1.10,
		"totalPrice": 1.10,
		"unitTaxPrice": 0.10000000,
		"taxRate": 0.1000,
		"totalPriceExcludingTax": 1.0000,
		"unitRecommendedPrice": 0.0000,
		"unitRecommendedTaxPrice": 0.0,
		"unitRecommendedTotalPrice": 0.0,
		"taxPercentHtml": "<span data-cms_cart_item_tax_percent=\"15049017874163171386\">10.0000%</span>",
		"totalPriceExcludingTaxHtml": "<span data-cms_cart_item_total_without_tax=\"15049017874163171386\">$1.00</span>",
		"unitTaxPriceHtml": "<span data-cms_cart_item_unit_tax=\"15049017874163171386\">$0.10</span>",
		"unitTotalPriceHtml": "<span data-cms_cart_item_total_unit_price=\"15049017874163171386\">$1.10</span>",
		"unitPriceHtmlTotal": "<span data-cms_cart_item_total_unit_price=\"15049017874163171386\">$1.10</span>",
		"priceHtml": "<span data-cms_cart_item_price=\"15049017874163171386\">$0.00</span>",
		"unitPriceHtml": "<span data-cms_cart_item_subtotal_price=\"15049017874163171386\">$1.00</span>",
		"taxPriceHtml": "<span data-cms_cart_item_tax=\"15049017874163171386\">$0.10</span>",
		"totalPriceHtml": "<span data-cms_cart_item_total_price=\"15049017874163171386\">$1.10</span>",
		"quantityHtml": "<input type=\"number\" value=\"1\" data-cms_cart_item_quantity=\"15049017874163171386\">",
		"removeHtml": "<a href=\"javascript:\" data-cms_cart_remove_order_line=\"15049017874163171386\"><svg xmlns=\"http://www.w3.org/2000/svg\" width=\"24\" height=\"24\" viewBox=\"0 0 24 24\"><path d=\"M19 6.41l17.59 5 12 10.59 6.41 17.59 19 13.41 12z\"></path><path d=\"M0 0h24v24h0z\" fill=\"none\"></path></svg></a>",
		"taxCodeHtml": "<span data-cms_cart_tax_code_html=\"15049017874163171386\">GST</span>",
		"unitRecommendedPriceHtml": "<span data-cms_cart_unit_recommended_price_html=\"15049017874163171386\">$0.00</span>",
		"unitRecommendedTaxPriceHtml": "<span data-cms_cart_unit_recommended_tax_price_html=\"15049017874163171386\">$0.00</span>",
		"unitRecommendedTotalPriceHtml": "<span data-cms_cart_unit_recommended_total_price_html=\"15049017874163171386\">$0.00</span>",
		"attributes": [{
				"id": "12550665647534637091",
				"name": "Size",
				"attributeType": "0",
				"valueType": "FixedPrice",
				"options": [{
					"id": "749807479205920820",
					"name": "Large",
					"price": 1.0000,
					"taxPercent": 10.0000,
					"taxPrice": 10.00000000,
					"image": "",
					"totalPrice": 11.00000000
				}],
				"subTotalPrice": 1.0000,
				"taxPercent": 10.0000,
				"taxPrice": 10.00000000,
				"price": 1.0000,
				"totalPrice": 11.00000000
			}
		]
	}],
	"subTotalPriceHtml": "<span data-cms_cart_subtotal=\"123\">$1.00</span>",
	"taxCodeHtml": "<span data-cms_cart_tax_code_html=\"123\">GST</span>"
}

Low Stock Email

The order object, after a checkout submission, in the ‘Low Stock Notification’ system email (if any ordered products trigger the low stock threshold) (email template and email body).

{
  "domain": "https://YOUR-DOMAIN.com/",
  "products": [
    {
      "orderLineId": "15049017874163171333",
      "quantity": 1,
      "unitPrice": 10.0000,
      "taxRate": 0.1000,
      "taxPrice": 1.00000000,
      "totalPrice": 11.00000000,
      "price": 10.0000,
      "type": 0,
      "moduleId": 1859,
      "sKUCode": "11223344",
      "name": "T-Shirt",
      "smallImage": null,
      "instock": 3,
      "attributes": [
        {
          "name": "Colour",
          "options": [
            {
              "name": "Green"
            }
          ]
        }
      ]
    }
  ],
  "totalCount": 1
}

Form Payment (form type: generic)

Confirmation page and Emails

The order object, after a generic payment collection form submission, in the Confirmation page and the forms Workflow Notification, Autoresponder, and Invoice email (email template and email body).

{
	"customerEmail": "joetest@test.com",
	"paymentType": "CreditCard",
	"state": "Paid",
	"formId": 22,
	"memberId": 47,
	"caseId": 102,
	"name": "General Payment 08 Feb 2021 12:44 PM",
	"invoiceNumber": 42,
	"invoiceCode": "",
	"invoiceDate": "2/8/2021 12:44:59 PM",
	"shippingAddress": {
		"addressLine": null,
		"city": null,
		"state": null,
		"zipCode": null,
		"country": null
	},
	"amountPending": "0.0",
	"amountPaid": "5.5",
	"amountPaidHtml": "$5.50",
	"amountPendingHtml": "$0.00",
	"awbNumber": "",
	"trackingUrl": "",
	"id": "159",
	"paymentIntentId": "XXXXXXXXXXXXXXXXX",
	"paymentIntentClientSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
	"formatSetting": {
		"name": "AU",
		"culture": "en-AU",
		"decimalsQuantity": 2,
		"currency": {
			"code": "AUD",
			"symbol": "$",
			"digitalCode": "36",
			"name": "Australian Dollar"
		}
	},
	"domainCountry": {
		"name": "AUSTRALIA",
		"code": "AU"
	},
	"destinationCountry": {
		"name": null,
		"code": null
	},
	"shippingOption": {
		"id": "12252410371037462628",
		"shippingOptionId": null,
		"name": null,
		"price": 0.0,
		"taxPercent": 0.0,
		"taxRate": 0.0,
		"taxPrice": 0.0,
		"totalPrice": 0.0,
		"subTotalPrice": 0.0
	},
	"discount": {
		"id": null,
		"code": null,
		"type": null,
		"amount": 0.0
	},
	"giftVoucher": {
		"id": null,
		"code": null,
		"amount": 0.0,
		"balance": 0.0
	},
	"subTotalPrice": "5.5",
	"taxPercent": "0",
	"taxRate": "0",
	"taxPrice": "0",
	"discountPrice": "0",
	"totalPrice": "5.5",
	"shippingPrice": "0",
	"shippingTaxRate": "0",
	"shippingTaxPrice": "0",
	"shippingSubTotalPrice": "0",
	"shippingTotalPrice": "0",
	"giftVoucherPrice": "0",
	"subTotalTaxPrice": "0.0",
	"discountedSubTotalTaxPrice": "0.0",
	"grandTotalPrice": "5.5",
	"totalPriceExcludingTax": "5.5",
	"totalPriceExcludingTaxAndGiftVoucherAmount": "5.5",
	"taxCode": "",
	"totalPriceExcludingTaxHtml": "$5.50",
	"totalPriceExcludingTaxAndGiftVoucherAmountHtml": "$5.50",
	"grandTotalPriceHtml": "$5.50",
	"discountPriceHtml": "$0.00",
	"discountedSubTotalTaxPriceHtml": "$0.00",
	"subTotalTaxPriceHtml": "$0.00",
	"taxPriceHtml": "$0.00",
	"shippingTotalPriceHtml": "$0.00",
	"shippingPriceHtml": "$0.00",
	"shippingTaxPriceHtml": "$0.00",
	"shippingTaxPercentHtml": "0%",
	"taxPercentHtml": "0%",
	"giftVoucherPriceHtml": "$0.00",
	"totalPriceHtml": "$5.50",
	"items": [{
		"id": "15049017874163171404",
		"ecommerceItemId": 0,
		"smallImage": null,
		"name": "General Payment",
		"type": null,
		"moduleId": 0,
		"SKUCode": "General Payment",
		"quantity": 1,
		"productFileLink": null,
		"Url": null,
		"taxCode": null,
		"onSalse": false,
		"price": 5.5,
		"taxPercent": 0.0,
		"unitPrice": 5.5,
		"taxPrice": 0.0,
		"unitTotalPrice": 5.5,
		"totalPrice": 5.5,
		"unitTaxPrice": 0.0,
		"taxRate": 0.0,
		"totalPriceExcludingTax": 5.5,
		"unitRecommendedPrice": 0.0,
		"unitRecommendedTaxPrice": 0.0,
		"unitRecommendedTotalPrice": 0.0,
		"taxPercentHtml": "0%",
		"totalPriceExcludingTaxHtml": "$5.50",
		"unitTaxPriceHtml": "$0.00",
		"unitTotalPriceHtml": "$5.50",
		"unitPriceHtmlTotal": "$5.50",
		"priceHtml": "$5.50",
		"unitPriceHtml": "$5.50",
		"taxPriceHtml": "$0.00",
		"totalPriceHtml": "$5.50",
		"quantityHtml": "<input type=\"number\" value=\"1\">",
		"removeHtml": "",
		"taxCodeHtml": "",
		"unitRecommendedPriceHtml": "$0.00",
		"unitRecommendedTaxPriceHtml": "$0.00",
		"unitRecommendedTotalPriceHtml": "$0.00",
		"attributes": []
	}],
	"subTotalPriceHtml": "$5.50",
	"taxCodeHtml": ""
}

Secure Zone/Membership Payment (form type: generic)

Invoice Email

The order object, after a paid Secure Zone payment form submission, in the ‘Invoice’ system email (email template and email body).

{
	"customerEmail": "joetest@test.com",
	"paymentType": "CreditCard",
	"state": "Paid",
	"formId": 19,
	"memberId": 45,
	"caseId": 98,
	"name": "Secure Zone paid (subscription)",
	"invoiceNumber": 38,
	"invoiceCode": "",
	"invoiceDate": "2/7/2021 7:12:27 PM",
	"shippingAddress": {
		"addressLine": null,
		"city": null,
		"state": null,
		"zipCode": null,
		"country": null
	},
	"amountPending": "0.0000",
	"amountPaid": "12.0000",
	"amountPaidHtml": "$12.00",
	"amountPendingHtml": "$0.00",
	"awbNumber": "",
	"trackingUrl": "",
	"id": "12877807959236673687",
	"paymentIntentId": "XXXXXXXXXXXXXXXXX",
	"paymentIntentClientSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
	"formatSetting": {
		"name": "AU",
		"culture": "en-AU",
		"decimalsQuantity": 2,
		"currency": {
			"code": "AUD",
			"symbol": "$",
			"digitalCode": "36",
			"name": "Australian Dollar"
		}
	},
	"domainCountry": {
		"name": "AUSTRALIA",
		"code": "AU"
	},
	"destinationCountry": {
		"name": null,
		"code": null
	},
	"shippingOption": {
		"id": "12252410371037462624",
		"shippingOptionId": null,
		"name": null,
		"price": 0.0,
		"taxPercent": 0.0,
		"taxRate": 0.0,
		"taxPrice": 0.0,
		"totalPrice": 0.0,
		"subTotalPrice": 0.0
	},
	"discount": {
		"id": null,
		"code": null,
		"type": null,
		"amount": 0.0
	},
	"giftVoucher": {
		"id": null,
		"code": null,
		"amount": 0.0,
		"balance": 0.0
	},
	"subTotalPrice": "12.0000",
	"taxPercent": "0",
	"taxRate": "0",
	"taxPrice": "0",
	"discountPrice": "0",
	"totalPrice": "12.0000",
	"shippingPrice": "0",
	"shippingTaxRate": "0",
	"shippingTaxPrice": "0",
	"shippingSubTotalPrice": "0",
	"shippingTotalPrice": "0",
	"giftVoucherPrice": "0",
	"subTotalTaxPrice": "0.0000",
	"discountedSubTotalTaxPrice": "0.0000",
	"grandTotalPrice": "12.0000",
	"totalPriceExcludingTax": "12.0000",
	"totalPriceExcludingTaxAndGiftVoucherAmount": "12.0000",
	"taxCode": "",
	"totalPriceExcludingTaxHtml": "$12.00",
	"totalPriceExcludingTaxAndGiftVoucherAmountHtml": "$12.00",
	"grandTotalPriceHtml": "$12.00",
	"discountPriceHtml": "$0.00",
	"discountedSubTotalTaxPriceHtml": "$0.00",
	"subTotalTaxPriceHtml": "$0.00",
	"taxPriceHtml": "$0.00",
	"shippingTotalPriceHtml": "$0.00",
	"shippingPriceHtml": "$0.00",
	"shippingTaxPriceHtml": "$0.00",
	"shippingTaxPercentHtml": "0%",
	"taxPercentHtml": "0%",
	"giftVoucherPriceHtml": "$0.00",
	"totalPriceHtml": "$12.00",
	"items": [{
		"id": "15049017874163171396",
		"ecommerceItemId": 2,
		"smallImage": null,
		"name": "Paid Zone",
		"type": "SecureZoneSubscription",
		"moduleId": 0,
		"SKUCode": "Paid Zone",
		"quantity": 1,
		"productFileLink": null,
		"Url": null,
		"taxCode": null,
		"onSalse": false,
		"price": 12.0000,
		"taxPercent": 0.0000,
		"unitPrice": 12.0000,
		"taxPrice": 0.0000,
		"unitTotalPrice": 12.00,
		"totalPrice": 12.00,
		"unitTaxPrice": 0.00000000,
		"taxRate": 0.0000,
		"totalPriceExcludingTax": 12.0000,
		"unitRecommendedPrice": 0.0000,
		"unitRecommendedTaxPrice": 0.0,
		"unitRecommendedTotalPrice": 0.0,
		"taxPercentHtml": "0.0000%",
		"totalPriceExcludingTaxHtml": "$12.00",
		"unitTaxPriceHtml": "$0.00",
		"unitTotalPriceHtml": "$12.00",
		"unitPriceHtmlTotal": "$12.00",
		"priceHtml": "$12.00",
		"unitPriceHtml": "$12.00",
		"taxPriceHtml": "$0.00",
		"totalPriceHtml": "$12.00",
		"quantityHtml": "<input type=\"number\" value=\"1\">",
		"removeHtml": "",
		"taxCodeHtml": "",
		"unitRecommendedPriceHtml": "$0.00",
		"unitRecommendedTaxPriceHtml": "$0.00",
		"unitRecommendedTotalPriceHtml": "$0.00",
		"attributes": []
	}],
	"subTotalPriceHtml": "$12.00",
	"taxCodeHtml": ""
}

Event Payment (form type: singleItem)

Confirmation page and Emails

The order object, after a Event payment collection form submission, in the Confirmation page and the forms Workflow Notification, Autoresponder, and Invoice email (email template and email body).

{
	"customerEmail": "joetest@test.com",
	"paymentType": "CreditCard",
	"state": "Paid",
	"formId": 15,
	"memberId": 47,
	"caseId": 25,
	"name": "Event Registration 08 Feb 2021 01:40 PM",
	"invoiceNumber": 43,
	"invoiceCode": "",
	"invoiceDate": "2/8/2021 1:40:40 PM",
	"shippingAddress": {
		"addressLine": null,
		"city": null,
		"state": null,
		"zipCode": null,
		"country": null
	},
	"amountPending": "0.00",
	"amountPaid": "2.00",
	"amountPaidHtml": "$2.00",
	"amountPendingHtml": "$0.00",
	"awbNumber": "",
	"trackingUrl": "",
	"id": "164",
	"paymentIntentId": "XXXXXXXXXXXXXX",
	"paymentIntentClientSecret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
	"formatSetting": {
		"name": "AU",
		"culture": "en-AU",
		"decimalsQuantity": 2,
		"currency": {
			"code": "AUD",
			"symbol": "$",
			"digitalCode": "36",
			"name": "Australian Dollar"
		}
	},
	"domainCountry": {
		"name": "AUSTRALIA",
		"code": "AU"
	},
	"destinationCountry": {
		"name": null,
		"code": null
	},
	"shippingOption": {
		"id": "12252410371037462629",
		"shippingOptionId": null,
		"name": null,
		"price": 0.0,
		"taxPercent": 0.0,
		"taxRate": 0.0,
		"taxPrice": 0.0,
		"totalPrice": 0.0,
		"subTotalPrice": 0.0
	},
	"discount": {
		"id": null,
		"code": null,
		"type": null,
		"amount": 0.0
	},
	"giftVoucher": {
		"id": null,
		"code": null,
		"amount": 0.0,
		"balance": 0.0
	},
	"subTotalPrice": "2.0000",
	"taxPercent": "0",
	"taxRate": "0",
	"taxPrice": "0",
	"discountPrice": "0",
	"totalPrice": "2.00",
	"shippingPrice": "0",
	"shippingTaxRate": "0",
	"shippingTaxPrice": "0",
	"shippingSubTotalPrice": "0",
	"shippingTotalPrice": "0",
	"giftVoucherPrice": "0",
	"subTotalTaxPrice": "0.0000",
	"discountedSubTotalTaxPrice": "0.0000",
	"grandTotalPrice": "2.0000",
	"totalPriceExcludingTax": "2.00",
	"totalPriceExcludingTaxAndGiftVoucherAmount": "2.0000",
	"taxCode": "",
	"totalPriceExcludingTaxHtml": "$2.00",
	"totalPriceExcludingTaxAndGiftVoucherAmountHtml": "$2.00",
	"grandTotalPriceHtml": "$2.00",
	"discountPriceHtml": "$0.00",
	"discountedSubTotalTaxPriceHtml": "$0.00",
	"subTotalTaxPriceHtml": "$0.00",
	"taxPriceHtml": "$0.00",
	"shippingTotalPriceHtml": "$0.00",
	"shippingPriceHtml": "$0.00",
	"shippingTaxPriceHtml": "$0.00",
	"shippingTaxPercentHtml": "0%",
	"taxPercentHtml": "0%",
	"giftVoucherPriceHtml": "$0.00",
	"totalPriceHtml": "$2.00",
	"items": [{
		"id": "15049017874163171408",
		"ecommerceItemId": 2133,
		"smallImage": null,
		"name": "Seat Test",
		"type": "ModuleItem",
		"moduleId": 0,
		"SKUCode": "bfcc9976-4500-4bc5-9384-9ba76e8e6e33",
		"quantity": 1,
		"productFileLink": null,
		"Url": "/_event-group/seat-test",
		"taxCode": null,
		"onSalse": false,
		"price": 2.0000,
		"taxPercent": 0.0,
		"unitPrice": 2.0000,
		"taxPrice": 0.0000,
		"unitTotalPrice": 2.00,
		"totalPrice": 2.00,
		"unitTaxPrice": 0.0000,
		"taxRate": 0.0,
		"totalPriceExcludingTax": 2.0000,
		"unitRecommendedPrice": 0.0,
		"unitRecommendedTaxPrice": 0.0,
		"unitRecommendedTotalPrice": 0.0,
		"taxPercentHtml": "0%",
		"totalPriceExcludingTaxHtml": "$2.00",
		"unitTaxPriceHtml": "$0.00",
		"unitTotalPriceHtml": "$2.00",
		"unitPriceHtmlTotal": "$2.00",
		"priceHtml": "$2.00",
		"unitPriceHtml": "$2.00",
		"taxPriceHtml": "$0.00",
		"totalPriceHtml": "$2.00",
		"quantityHtml": "<input type=\"number\" value=\"1\">",
		"removeHtml": "",
		"taxCodeHtml": "",
		"unitRecommendedPriceHtml": "$0.00",
		"unitRecommendedTaxPriceHtml": "$0.00",
		"unitRecommendedTotalPriceHtml": "$0.00",
		"attributes": []
	}],
	"subTotalPriceHtml": "$2.00",
	"taxCodeHtml": ""
}

Accessing the Data

JSON Output

You can output the full JSON for your component data by referencing the root Liquid object {{this}} in your module’s layouts, or directly on your page, if using the collectionVariable parameter in your component tag.

For example:

{% component type: ... collectionVariable: "myData" %}

You can then render the JSON like so:

{{myData}}

For more details on using this approach, see Part 2 of the free ‘Learning Liquid Course’.

Rendering Property Values

As an example of rendering a piece of this data onto your Invoice email layout you could use the following Liquid:

{{ this.order.totalPriceHtml }}{{ this.order.formatSetting.currency.code }}

This would output the value $11.00AUD to the layout based on the above example data.

Extending on this example, we can use this data in a conditional Liquid statement to display custom information to the customer:

{% if this.order.totalPrice > 100 %} <!-- Order over $100 -->
    <h2>Congratulations!</h2>
    <p>Your order qualifies for a complimentary $10 Gift Card which we'll send out with your purchase.</p>
{% else %} <!-- if the order is $100 or less -->
    <h2>Thank you!</h2>
    <p>We hope you like your new purchase.<br>
    Remember, if you spend over $100 you'll receive a bonus $10 Gift Card!</p>
{% endif %}


Related Articles

  • Domains
    The Treepl CMS Domain settings allow you to control default domain, landing pages, domain authentication for system emails along with country and cultural settings like number and currency formatting.
  • Payment Settings
    Integrate various payment gateways, for multiple countries and currencies, into Treepl CMS for form payments, subscriptions and eCommerce workflows.
  • Orders
    Orders store accounts of any payments made via the website and provide management for additional payments, invoices, order statuses, tracking info, the products purchased within the order and the details of the form submission used to take the order.
  • Advanced CRM Groups
    Advanced CRM Groups allow you to extend the data fields within multiple areas of the CRM, either globally or on a per-record basis.
  • module (Catalogs)
    This module component fetches data relating to eCommerce Catalogs and can be used to render Catalog structures and Products within them.
  • module (Products)
    This module component fetches data relating to eCommerce Products and can be used to render Product information.
  • ecommerce_add_to_cart
    This component renders an anchor element allowing the javascript function to add the item to the shopping cart.
  • ecommerce_buy_now
    This component renders an anchor element allowing the javascript function to add the item to the shopping cart and then proceeding directly to the shopping cart page.
  • ecommerce_item_quantity
    This component renders a form input element allowing a quantity to be set for when the source item is added to the shopping cart.
  • item_attributes
    This component fetches all attributes/options for a specified product. By default, each attribute group is rendered, with its options and any prices, according to their specified form inputs.
  • related_items
    This component fetches related items of a specific source item, such as a Product that has had Related Products assign to it.
  • grouped_items
    This component fetches grouped items of a specific source item, such as a Product that has been Grouped with other Products and allows the ability to navigate between grouped items.
  • currencies
    This component renders a form select element of all currency names, codes and symbols by default, and can also be used to output currency data to a Liquid collection.
  • shopping_cart
    This component fetches data relating to the shopping cart, such as any products added, order totals, tax, shipping, etc.
  • shipping_options
    This component renders a form select element of all shipping options configured on the site, and can also be used to output shipping option data to a Liquid collection.
  • shippingProviderFields
    This component provides a placeholder for populating additional Shipping Provider options to the user.
  • tax_codes
    This component renders a form select element of all tax codes configured on the site, and can also be used to output tax code data to a Liquid collection.
  • payment_form_fields
    This component is used to render payment fields, and payment related validation errors, within a form using the capabilities provided by your configured payment gateway.
  • orders
    This component fetches Orders from the CRM, either owned by the logged-in user or for all customer Orders.
  • Getting Started
    To get started with the eCommerce module there are some overall settings to configure that provide eCommerce with further context in order to function appropriately for your situation.
  • Products
    Products are one of the most powerful and flexible modules in Treepl CMS. Create customised product schemas with multiple price points, catalogs, inventory tracked attributes/variables, SEO optimisation and more.
  • Catalogs
    When organising any eCommerce store, Catalogs are crucial to your Products structure and browserbility. Easily create and customise unlimited product catalogs for your online store.
  • Discount codes
    Provide discount code functionality for your Treepl CMS shopping cart. Ideal for promotions, customer loyalty and conversions or to help move more stock.
  • Gift vouchers
    Gift vouchers can be issued to your customers or purchased by them online via the shopping cart.
  • Taxes
    Create any number of required tax codes specific to the shipping country selected in your Treepl CMS shopping cart.
  • countries
    This component renders a form select element of all country names and country codes by default, and can also be used to output country codes/names to a Liquid collection.
  • domain_settings
    This module component retrieves settings associated with the current domain, or optionally from another specified domain configured in the site instance.
  • Shipping Options
    Treepl CMS provides the ability to configure both custom shipping options and integrated shipping providers based on a variety of conditions during the shopping cart stage.
  • Settings
    These various eCommerce settings allow you to further control and customise the way your website functions, both in the admin and on the front-end, in terms of eCommerce functionality.
  • eCommerce Javascript
    This is the provided javascript options for further controlling/customising the ecommerce javascript provided by the CMS.
  • CRM Orders
  • Migrating to Advanced Payment Flow
    This article describes differences and possible required actions for migrating to the Advanced Payment Gateway flow.

External Resources

There are currently no external resources available.

Please let us know if you have any other contributions or know of any helpful resources you'd like to see added here.


Questions?

We are always happy to help with any questions you may have.
Visit the Treepl Forum for community support and to search previously asked questions or send us a message at support@treepl.co and we will consult you as soon as possible.