{{ order }} object

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

Currently, this object is only available on the Invoice system email layout (Body, From Name, and Subject fields), found under 'Email Notification' > 'System Emails' > 'Invoice'.

{{ this.order }}

An example of the data structure for a successfully submitted order form is below.

{
  "id": 2, <!-- CMS Order ID -->
  "memberemail": "asmith@example.com",
  "memberid": 1, <!-- CRM Contacts ID -->
  "memberlink": "https://WWW.YOURDOMAIN.COM/admin/contacts/1/info",
  "link": "https://WWW.YOURDOMAIN.COM/admin/orders/2",
  "items": [
    {
      "entityid": 8, <!-- CMS Form ID -->
      "entitytype": "Form",
      "name": "My Order Form", <!-- CMS Form Name -->
      "price": 1.50,
      "quantity": 1,
      "totalcost": 1.50,
      "currency": {
        "code": "AUD",
        "symbol": "$",
        "digitalcode": "36",
        "name": "Australian Dollar"
      }
    }
  ],
  "status": "success",
  "paymenttype": "stripe",
  "totalcost": 1.50,
  "transactionid": "ch_XXXXXXXXXXXXXXXX",
  "createddatetime": "2019-05-14T03:12:50.54",
  "updateddatetime": "2019-05-14T03:12:53.133",
  "currency": {
    "code": "AUD",
    "symbol": "$",
    "digitalcode": "36",
    "name": "Australian Dollar"
  }
}

Accessing the Data

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

{{ this.order.symbol }}{{ this.order.totalcost }}

This would output the value $1.50 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.totalcost > 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

  • System Pages
    System Pages, under 'Settings', is where you’ll find all those pages required by certain system...
  • form
    This component outputs data relating to a specific Form. {% component type: "form", alias: "<form_alias>"...
  • Form Submissions
  • System Emails
    System emails are emails that are sent when a particular action is carried out on...
  • {{ formSubmissionData }} object
    This liquid object will output the submission details of a Form. You can use this...
  • {{ workflow }} object
    This liquid object will output the Workflow details of a submitted Form. You can use...
  • Forms
    Forms are an essential part of collecting user information on your website.Treepl CMS makes managing...
  • Secure Zones
    Secure Zones provide a way of creating restricted content on your website that only registered...
  • ReCaptcha Styling
    Treepl CMS supports Google reCAPTCHA v2 and v3 implementations. Below are some additional options you...

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.
Send us a message at support@treepl.co and we will consult you as soon as possible.