Change log

eCommerce 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.

Access CMS controls for things like Shopping Cart lifetime, size/weight units, order statuses, and tax and shipping options.

Settings

Shop Settings

Option
Description
Shopping Cart Lift Time in Hours
The number of hours a user’s shopping cart will remain active and accessible.

Measuerment Settings

Option
Description
Dimension Units
The unit of measurement used for products width, height and depth dimensions for use in shipping calculations.
Available units are:
Centimeters (cm)
Inches (in)
Millimeters (mm)
Metres (m)
Feet (ft).
Weight Units
The unit of measurement used for products weight for use in shipping calculations.
Available units are:
Kilograms (kg)
Pounds (lb)
Ounces (oz)
Grams (g).

Manage Status

Statuses here relate to the state of an eCommerce order and are either set manually by the admin user or controlled automatically during the order processing stages (dependant on payment type used).

Order statuses can be applied purely as a label in the admin or they can be used to trigger status email notifications to admin users and/or the customer directly.

Statuses can be reordered here, via drag-and-drop, which will correspond with the order listed in the status field against CRM orders. This helps when order processes are executed in a specific order which can be shown as such in the status dropdown.

Add/Edit Order Statuses

To create a new Status, click the ‘ADD NEW STATUS’ button at the top of the page, or to edit an existing Status, click on the associated pencil icon () on the far right.

Any number of custom statuses can also be added to suit your order process.

Below are the available options when configuring an order status:

Option
Description
Status Name
Provide a descriptive name for the status. The status name is displayed in the admin when managing Orders and can also be used in status emails to the customer and in workflow notifications.
Type
The status type is for descriptive purposes only and cannot be changed. Any new statuses will have a type of ‘Custom’.
Workflow
Select any Workflow/s that are to be triggered when this status is applied.
Notify Customer?
Check this option if the customer who placed the order is to be notified when this status is applied to the order (using the ‘Order Status Changed’ system email layout).

Status Types

There are 6 system order statuses set up by default, which can not be deleted. These system statuses can also be used manually by the admin user when managing an order.
Any added status is created with a type of 'Custom'.

Option
Description
New
Status set when order is newly created.
Awaiting Payment
Status set when order is created via the checkout form.
Pending Charge
Status set when Two Step Card Payment successfully places funds for the order on hold.
Payment Canceled
Status set when an admin user canceled a pending charge payment or, a pending charge payment expires, and as a result, is canceled.
Payment Failed
Status set when a message from payment provider is recieved by the CMS that the payment has failed.
Paid
Status set when a message from payment provider is recieved by the CMS that the payment has succeeded.
Custom
Status set when an admin user manually adjusts the order as such.

Order Status Change System Email

When a status is configured to notify the customer, the ‘Order Status Changed’ system email will be used for the sent message.

Clicking the envelope icon () to the right of the associated status will link through to the appropriate system email settings for that status.
Each status will have its own email message and configuration.

In the Liquid scope of this system email (and the Workflow Notification email) the {{this}} object will also contain data associated with the status change, including the site URL, the old status and the new status, for example:

{
	"Order": {...same as the order object...},
	"Customer": {...same as the currentmember object...},
	"SiteUrl": "https://www.yourdomain.com",
	"OldOrderStatus": {
		"Name": "Awaiting Payment",
		"OrderStatus": "AwaitingPayment",
		"Id": "14246795687818690566",
		"IsSystem": true
	},
	"NewOrderStatus": {
		"Name": "Paid",
		"OrderStatus": "Paid",
		"Id": "14246795687818690567",
		"IsSystem": true
	}
}

Tax and Shipping

Configure tax and shipping options for each domain/country you have in place for your site (under ‘Settings’ > ‘Domains’).

Use the “Currency/Country” dropdown to display and edit the relevant country settings.

Tax Settings

Option
Description
Tax applies to
Determines if tax calculations should include the items selected in this option (Shipping Options, Gift Vouchers) during Shopping Cart and Checkout processes.
For example; if your shipping provider already includes tax in their calculations, or tax is not required for shipping charges, you can deselect ‘Shipping Options’. Or if you wish to sell Gift Vouchers excluding tax, since the tax will be charged on the items when redeeming the voucher, you can deselect ‘Gift Vouchers’.
Enable tax dropdown
Determines if the {% component type: 'tax_codes' %} component renders the tax dropdown in the shopping cart or not (and disables server-side validation if not).
Auto-select tax if only one available
If the tax dropdown in the shopping cart has only one option available, checking this setting will allow the eCommerce javascript to automatically select and apply that option when the shopping cart page loads so the user does not have to.
Hide tax selector if only one available
If the tax dropdown in the shopping cart has only one option available, checking this setting will allow the eCommerce javascript to hide the dropdown from view (this setting should be used in conjunction with the above auto-select tax option to avoid validation issues if the tax option is not automatically selected).

Shipping Countries

Option
Description
Shipping countries
Determines which countries will be shown in the country dropdown (when rendering the component {% component type: 'countries' %}).
If no countries are selected here, then all countries will display by default.
If the countries component has the allowedCountries parameter added (eg: {% component type: 'countries', allowedCountries:'US,AU' %}) then the parameter’s settings will override these shop settings.
Select all shipping countries
Provides the ability to select all of the above shipping countries in the dropdown (for easily selecting all countries and then, optionally, deselecting the few not needed).
Choose default country
Based on the selected shipping countries from the above settings, this determines which country should be selected by default in the dropdown rendered by the countries component tag.
Make shipping country required
Determines if the shipping country dropdown will be required (eg: if it can be left unselected or removed/hidden during the eCommerce process).
Shipping option order price limitations applied to
When shipping options are configured with ‘Total order price limitations’, this setting determines if those price limitations should apply before or after tax is applied. For example; if you have a ‘Free Shipping’ option that is only applied if the order total is over $100, you can configure this setting to calculate that condition based on an order total before or after tax, depending on your needs.


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.
  • {{ order }} object
    This liquid object will output the order details of a submitted payment. ...
  • 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.
  • 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.