Change log

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.

Managing Shipping Options

Found under ‘eCommerce’ > ‘Shipping Options’, here you’ll find a list of all shipping options configured for use on your website, including their base price and which currency/country they relate to.

Clicking the pencil icon () to the right of each item will allow editing of that shipping option. Clicking the trash can icon () will delete the shipping option.

To create a new shipping option, click the “ADD NEW SHIPPING OPTION” button above the item list.

Adding / Editing

When setting up a new shipping option you’ll be able to configure the details, and after saving, configure the rules around how/when this option is applicable to the user’s shopping cart.

Below are further details for the fields available.

Be sure to enable shipping for each product (on each product's settings page) where shipping is applicable.

DETAILS

Option
Description
Name
The descriptive name of the shipping option that will be displayed in the shopping cart shipping dropdown.
Currency/Country
The currency/country setting in which the shipping option is to be used.
Type

UserDefined
Allows for custom settings to be applied to control how/when this shipping option is applied.

Australia Post
Integrated shipping provider. See below for more details.

FedEx
Integrated shipping provider. See below for more details.

UPS
Integrated shipping provider. See below for more details.

USPS
Integrated shipping provider. See below for more details.

Canada Post
Integrated shipping provider. See below for more details.

New Zealand Post
Integrated shipping provider. See below for more details.

Tax Never Applies
When checked, tax calculations will not be applied to this Shipping Option within the eCommerce system.
Tax Code

Not Applicable
Setting the shipping tax to ‘Not Applicable’ instructs Treepl CMS to use no tax rates from the CMS in the calculation of shipping prices when ‘User Defined’ shipping options are applied.
When integrated shipping providers are used, the tax rate provided by the shipping integration provider, if available/applicable, will be used instead.

<YOUR TAX CODE/S>
The tax rate applicable for this shipping option (from your available Taxes currently configured for your site instance).

Price

A per order value representing the starting/base price of the shipping option (further values as per below 'Settings' may be calculated along with this price).

When the Shipping Option ‘Type’ is set to any integrated shipping provider, this ‘Price’ field will be removed and the following fields will become available relating to the shipping provider services and credentials required.

Shipping Provider Services
Available service offerings from the Shipping Provider (eg: Express, Domestic, International, etc...).
API Keys, Account ID's, etc.
Additional fields here will depend on the Shipping Provider selected and will typically include API credentials and account authorisation details.
See Shipping Integrations below for further details.
Postal Code
The zip/postal code that shipping will originate from (typically where the business owner will send the packages from).

SETTINGS

Option
Description
Handling Charge
An additional,per order value representing a part of the shipping costs(eg:a handling fee).
Additional Per Item Handling Charge
An additional,per item quantity value representing a part of the shipping costs(eg:a handling fee based on the number of items purchased).
Weight Limitations
These fields represent a minimum and maximum weight range,respectively. Therefore,this shipping option will only be available for selection in the shopping cart if the total weight of all applicable products is greater than the minimum or less than the maximum values set here.

Your products must have weight information configured for this limitation to be effective.

Width Limitations
These fields represent a minimum and maximum width range,respectively. Therefore,this shipping option will only be available for selection in the shopping cart if the total width of all applicable products is greater than the minimum or less than the maximum values set here.

Your products must have width information configured for this limitation to be effective.

Height Limitations
These fields represent a minimum and maximum height range,respectively. Therefore,this shipping option will only be available for selection in the shopping cart if the total height of all applicable products is greater than the minimum or less than the maximum values set here.

Your products must have height information configured for this limitation to be effective.

Depth Limitations
These fields represent a minimum and maximum depth range,respectively. Therefore,this shipping option will only be available for selection in the shopping cart if the total depth of all applicable products is greater than the minimum or less than the maximum values set here.

Your products must have depth information configured for this limitation to be effective.

Order Price Limitations
These fields represent a minimum and maximum price range,respectively. Therefore,this shipping option will only be available for selection in the shopping cart if the total order price of all applicable products is greater than the minimum or less than the maximum values set here.
Show Shipping option to
A multi-select option allowing this shipping option to be displayed only for the chosen member type/s(Consumer and Wholesaler).

This setting relates to logged in users only and will not affect users not logged in.

Limit Delivery to Following Countries
A multi-select option allowing this shipping option to be displayed only for the chosen countries.

This setting works off the current domain country settings to determine the purchasing country.

Exclude Shipping if Purchasing from these Catalogs
A multi-select option excluding this shipping option from displaying if any products in the shopping cart were added from the selected catalog/s.

Displaying Shipping Options

To display shipping options in your shopping cart, and to further display integrated shipping provider options (if in use), you will need to include a shipping form with some or all of the following components on your shopping cart system page (found under ‘Settings’ > ‘System Pages’ > ‘shopping_cart’):

  • A Country selector.
  • A Shipping Option selector (listing the shipping options you’ve created).
  • A Taxes selector.
  • The Shipping Provider Fields component (to show additional shipping options from the provider).

The default layout for this is as follows.

<form action="#" class="system_form">
    {% assign destinationCountryCode = shoppingCartData.destinationCountry.code %}
    {% if  shoppingCartData.destinationCountry.code == "" or shoppingCartData.destinationCountry.code == null%}
    {% assign destinationCountryCode = shoppingCartData.domainCountry.code %}
    {% endif %}
    {% component type:"countries", collectionVariable:"" %}
    {% component type:"shipping_options", collectionVariable:"", filteredCountry:"{{destinationCountryCode}}" %}
    {% component type:"tax_codes", collectionVariable:"", filteredCountry:"{{destinationCountryCode}}" %}
    {% component type: "shippingProviderFields" %}
</form>

See the related articles below for further information about each component type.

Shipping Integrations

Australian Post

https://auspost.com.au/

Details to come...

FedEx

https://www.fedex.com/

Details to come...

UPS

https://www.ups.com/

Details to come...

USPS

https://www.usps.com/

Details to come...

Canada Post

https://www.canadapost.ca/

Go to https://www.canadapost.ca/cpotools/apps/drc/home (make sure you have a validated Canada Post Account).

Once signed in, it should automatically list your Development and Production API keys. If you need to regenerate keys you can do it here too. If no API keys exist, you can create new ones.

  1. Copy your Customer # (located in the Company tab)
  2. Copy your API Username & API Password (depending on your website progress – development for Beta, and production for the final site). Username/Password are on the same line, so it goes username : password

'API Username' and 'API Password' fields should be filled not by the Canada Post account username and password but by API username and password that can be retrieved as described above. Further details can also be found in this Canada Post documentation: https://www.canadapost.ca/cpo/mc/business/productsservices/developers/services/gettingstarted.jsf?LOCALE=en

Canada Post API

In the Treepl CMS setup, the 'Postal Code' option should match the postal code in your Canada Post Set Up. (Canada Post requires your postal code to have no space in it and all upper case. Eg: V3H2Y1)

New Zealand Post

https://www.nzpost.co.nz/

Details to come...



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
  • Advanced CRM Groups
  • {{ order }} object
    This liquid object will output the order details of a submitted payment. {% capture data...
  • 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.
  • shippingProvidesFields
    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
    With the recent release of eCommerce features there are some advanced system components that are...
  • 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.
  • Settings
  • 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.