[ { "Id": "2544", "URL": "/component-types/orders", "Name": "orders", "Description": "{% component type: "orders" %} Parameters and Options Parameter Values Required Description type orders This is the name of the entity that needs to be used for the component retrieving function. viewType list (default)detail Outputs a subset of data when viewType is `list` and more data related to the item when set to `detail`. This is to help with performance when listing many items and where not all data is required for output. layout <path/to/layout> Path to file that will contain the Liquid layout content to be parsed. If an empty string, nothing will be rendered.If paramater is not included, the default virtual layout will be rendered (see below). " },{ "Id": "2582", "URL": "/component-types/crm_contacts", "Name": "CRMContacts", "Description": "{% component type: "CRMContacts" %} Due to GDPR and privacy regulations CRM contact records will only be output by this component if the "Allow listing my contact data in the CMS" option has been enabled in the users CRM record. This option can only be checked by the user during the submission of the "Update Account Form" or a web Form with the "Allow listing my contact data in the CMS" field added to it. Parameters and Options Parameter Values Required Description type CRMContacts This is the name of the entity that needs to be used for the component retrieving function. layout <path/to/layout> Path to file that will contain the Liquid layout content to be parsed. If an empty string, nothing will be rendered.If paramater is not included, the default virtual..." },{ "Id": "2581", "URL": "/component-types/crm_custom_group", "Name": "CRMCustomGroup", "Description": "{% component type: "CRMCustomGroup", groupAlias: "<YOUR CUSTOM GROUP ALIAS>" %} Due to GDPR and privacy regulation CRM contact records will only be output by this component if the "Allow listing my contact data in the CMS" option has been enabled. This option can only be checked by the user during the submission of the "Update Account Form" or a web Form with the "Allow listing my contact data in the CMS" field added to it. Parameters and Options Parameter Values Required Description type CRMCustomGroup This is the name of the entity that needs to be used for the component retrieving function. groupAlias <YourGroupAlias> The Custom Group alias name that the data is to be sourced from. fieldAlias <YourFieldAlias> " },{ "Id": "3046", "URL": "/component-types/member_update_form", "Name": "member_update_form", "Description": "This is useful when creating front-end functionality intended for website administrator use when editing CRM contact information is required. {% component type: "member_update_form" %} This component is only used for logged in members with the CRM Admin User Role assigned. Due to GDPR and privacy regulations CRM contact records will only be output by this component if the "Allow listing my contact data in the CMS" option has been enabled in the users CRM record. This option can only be checked by the user during the submission of the "Update Account Form" or a web Form with the "Allow listing my contact data in the CMS" field added to it. Parameters and Options Parameter Values Required Description type member_update_form This is the name of the entity that needs to be used for the component retrieving function. layout <path/to/layout> " },{ "Id": "2541", "URL": "/component-types/cases", "Name": "cases", "Description": "{% component type: "cases" %} Parameters and Options Parameter Values Required Description type cases This is the name of the entity that needs to be used for the component retrieving function. viewType list (default)detail Outputs a subset of data when viewType is `list` and more data related to the item when set to `detail`. This is to help with performance when listing many items and where not all data is required for output. layout <path/to/layout> Path to file that will contain the Liquid layout content to be parsed. If an empty string, nothing will be rendered.If paramater is not included, the default virtual layout will be rendered (see below). " },{ "Id": "3332", "URL": "/open-api-admin/workflows-api", "Name": "Workflows API", "Description": " GET Workflows List Retrieves a list of Workflows as a JSON response based on your provided query parameters. /api/v2/admin/workflows Data / Response: { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } var obj = { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } ; var code = $('#code39 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Items": [ { "Id": 0, "Name": "string", "IsDefault": true } ], "TotalItemsCount": 0 } var obj = { "Items": [ { "Id": 0, "Name": "string", "IsDefault": true } ], "TotalItemsCount": 0 } ; var code = $('#code40 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); " },{ "Id": "3292", "URL": "/open-api-admin/email-notification-sender-api", "Name": "Email Notification Sender API", "Description": " POST Email Sender Case Triggers the sending of the Case Email Notification based on the data provided. /api/v2/admin/email-notification-sender/case Data / Response: { "CaseId": 0 } var obj = { "CaseId": 0 } ; var code = $('#code42 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); Status 204 var obj = Status 204 ; var code = $('#code43 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); POST Email Sender Confirm Email Triggers the sending of the Confirm Email Email Notification based on the data provided. /api/v2/admin/email-notification-sender/confirm-email Data / Response: { "Email": "string" } var obj = { "Email": "string" } ; var code = $('#code45 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); Status 204 var obj = Status 204 ; var code = $('#code46 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); POST Email Sender Deferred Order Payment Triggers the sending of the Deferred Order Payment Email Notification based on the data provided. /api/v2/admin/email-notification-sender/deferred-order-payment Data / Response: { "OrderId": 0 } var obj = { "OrderId": 0 } ; var code..." },{ "Id": "3253", "URL": "/open-api-admin/content-templates-api", "Name": "Content Templates API", "Description": " GET Content Templates List Retrieves a list of Content Templates as a JSON response based on your provided query parameters. /api/v2/admin/content-templates Data / Response: { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } var obj = { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } ; var code = $('#code81 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Items": [ { "Id": 0, "Content": "string", "FtpPath": "string", "IsSystem": true, "IsDefault": true, "AmpContent": "string", "Name": "string", "Settings": { "MainCSS": "UseGlobal", "RecaptchaJS": "UseGlobal", "EcommerceJS": "UseGlobal", "PaymentJS": "UseGlobal" } } ], "TotalItemsCount": 0 } var obj = { "Items": [ { "Id": 0, "Content": "string", "FtpPath": "string", "IsSystem": true, "IsDefault": true, "AmpContent": "string", "Name": "string", "Settings": { "MainCSS": "UseGlobal", "RecaptchaJS": "UseGlobal", "EcommerceJS": "UseGlobal", "PaymentJS": "UseGlobal" } } ], "TotalItemsCount": 0 } ; var code = $('#code82 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); POST Content Template Create Creates a new Content Template based on the provided data. /api/v2/admin/content-templates Data / Response: { "Content": "string", "IsDefault": true, "Name": "string", "AmpContent": "string", "Settings": {..." },{ "Id": "3245", "URL": "/open-api-admin/categories-api", "Name": "Categories API", "Description": " GET Categories List Retrieves a list of Categories as a JSON response based on your provided query parameters. /api/v2/admin/categories Data / Response: { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } var obj = { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } ; var code = $('#code96 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Items": [ { "Id": "string", "Name": "string", "FullName": "string", "NestingLevel": 0, "Weight": 0, "Children": [ "string" ] } ], "TotalItemsCount": 0 } var obj = { "Items": [ { "Id": "string", "Name": "string", "FullName": "string", "NestingLevel": 0, "Weight": 0, "Children": [ "string" ] } ], "TotalItemsCount": 0 } ; var code = $('#code97 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); POST Category Create Creates a new Category based on the provided data. /api/v2/admin/categories Data / Response: { "Name": "string", "ParentId": "string" } var obj = { "Name": "string", "ParentId": "string" } ; var code = $('#code99 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Id": "string", "Name": "string", "FullName": "string",..." },{ "Id": "3293", "URL": "/open-api-admin/file-system-api", "Name": "File System API", "Description": " GET File System Single Folder Item Retrieves a list of Files from a single Folder as a JSON response based on your provided folder URL. /api/v2/admin/file-system Data / Response: { "Url": "/" } var obj = { "Url": "/" } ; var code = $('#code111 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); [ { "Path": "string", "Name": "string", "SizeBytes": 0, "Content": "string", "Extension": "string", "IsEmpty": true, "Url": "string", "DateUpdated": "2024-05-22T15:22:59.910Z", "IsFolder": true, "SecureZoneIds": [ "string" ] } ] var obj = [ { "Path": "string", "Name": "string", "SizeBytes": 0, "Content": "string", "Extension": "string", "IsEmpty": true, "Url": "string", "DateUpdated": "2024-05-22T15:22:59.910Z", "IsFolder": true, "SecureZoneIds": [ "string" ] } ] ; var code = $('#code112 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); GET File System Single File Item Retrieves a single File as a JSON response based on your provided file URL. /api/v2/admin/file-system Data / Response: { "Url": "/" } var obj = { "Url": "/" } ; var code = $('#code114 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Path": "string", "Name": "string", "SizeBytes": 0, "Content": "string", "Extension":..." },{ "Id": "2522", "URL": "/ecommerce/getting-started-with-ecommerce", "Name": "Getting Started", "Description": " Step 1: Domain Currency and Format So that you can configure your eCommerce items completely you’ll want to ensure your domain/s are assigned to the appropriate country/cultural settings. Going to ‘Settings’ ‘Domains’ and under the first tab “Site Domains”, ensure the correct country is assigned (listed in the ‘Country’ column) to each domain added. If not, simply click on the current country name (which should be a blue link) to select another country and then click “Save”. You’ll also want to assign some cultural and currency related settings for each domain (set under the ‘Currency and Format’ column). This is set to ‘Default’ to start with which cannot be changed directly. You’ll need to create additional Currency and Format options to assign here. To do this, click on the ‘Currency and Format’ tab on the current Domains page and click the ‘Add New Format Setting’ button. Complete the fields as needed and save your new option. Now heading back to the ‘Site Domains’ tab you’ll be able to assign the new option to the appropriate domain name/s. Step 2: Taxes You’ll likely need to assign tax rules to various eCommerce related items (Product pricing,..." },{ "Id": "2443", "URL": "/ecommerce/products", "Name": "Products", "Description": " Well defined Products can make or break your online store and this module allows you a great deal of flexibility when creating a wide range of product types, from physical goods, digital downloads, recurring services, and gift vouchers. Settings From the item list view, click the " EDIT SETTINGS" button to display a menu for further options, as detailed below. Settings These settings relate to the overall options and functionality and how content might be managed by site administrators. For nested modules, such as Blogs, Events, Banners, Galleries, FAQs, and any nested Custom Modules, you may wish to edit the settings for each of the 2 nested modules. You can easily switch between the 2 module's settings using the switcher at the top of page (under the modules name). The disabled, greyed out item, indicates the currently active module - while the highlighted linked item, provides a link to the connected module. Settings " },{ "Id": "2442", "URL": "/ecommerce/catalogs", "Name": "Catalogs", "Description": " Catalogs can be nested to any level, extended with custom fields for more complex implementations, listed and filtered in a variety of ways and given multiple layouts for different situations. Settings From the item list view, click the " EDIT SETTINGS" button to display a menu for further options, as detailed below. Settings These settings relate to the overall options and functionality and how content might be managed by site administrators. For nested modules, such as Blogs, Events, Banners, Galleries, FAQs, and any nested Custom Modules, you may wish to edit the settings for each of the 2 nested modules. You can easily switch between the 2 module's settings using the switcher at the top of page (under the modules name). The disabled, greyed out item, indicates the currently active module - while the highlighted linked item, provides a link to the connected module. Settings Option..." },{ "Id": "2433", "URL": "/component-types/module_tag_list", "Name": "module_tag_list", "Description": "This module component fetches data relating to Tags allocated to a specific module. {% component type: "module_tag_list", module: "<Module name/ID>" %} Only Tags that are assigned to items within the specified module are returned. In other words, Tags with an item count of 0 won't be returned. Parameters and Options Parameter Values Required Description type module_tag_list This is the name of the entity that needs to be used for the component retrieving function. module <Module name/ID> The module’s entity/alias name or ID that the data is to be sourced from. parentItemId <Parent ID> The module group ID the data is to be sourced from. layout..." },{ "Id": "2441", "URL": "/ecommerce/discount-codes", "Name": "Discount codes", "Description": " Discount codes are a powerful sales tool when used wisely and Treepl CMS can help you control how you utilise these. Control release and expiry date of codes, the type of discount (fixed price, percentage, free shipping...) and even how many times a code can be used. Managing Discount Codes Found under ‘eCommerce’ ‘Discount codes’, here you’ll find a list of all discount codes created for use in your shopping cart. Clicking the pencil icon () to the right of each item will allow editing of that discount code Clicking the trash can icon () will delete the discount code. To manually create a new discount code, click the “ADD NEW CODE” button above the item list. Adding / Editing Here you’ll be able to configure the details of your discount code and enable it for use within your shopping cart. Below are further details for the fields available. Option Description Code The actual code your customers need to enter in order to redeem this voucher. This..." },{ "Id": "2434", "URL": "/component-types/module_category_list", "Name": "module_category_list", "Description": "This module component fetches data relating to Categories allocated to a specific module. {% component type: "module_category_list", module: "<Module name/ID>" %} Only Categories that are assigned to items within the specified module are returned. In other words, Categories with an item count of 0 won't be returned. Parameters and Options Parameter Values Required Description type module_category_list This is the name of the entity that needs to be used for the component retrieving function. module <Module name/ID> The module’s entity/alias name or ID that the data is to be sourced from. parentItemId <Parent ID> The module group ID the data is to be sourced from. layout..." },{ "Id": "2440", "URL": "/ecommerce/gift-vouchers", "Name": "Gift vouchers", "Description": "Treepl CMS gives you control to manually create or override gift vouchers as needed and send out via email to any recipient, along with a customised message. Managing Gift Vouchers Found under ‘eCommerce’ ‘Gift vouchers’, here you’ll find a list of all gift vouchers either manually created (via the admin) or purchased via your shopping cart. Clicking the pencil icon () to the right of each item will allow editing of that gift voucher. Clicking the trash can icon () will delete the gift voucher. To manually create a new gift voucher, click the “ADD NEW VOUCHER” button above the item list. Adding / Editing When setting up a new gift voucher you’ll be able to configure the details, and after saving, set the recipient information and send out the voucher. Below are further details for the fields available. Details Option Description Currency The currency in which you want the gift voucher created in. Name " },{ "Id": "2435", "URL": "/component-types/module_archive", "Name": "module_archive", "Description": "This module component fetches data according to a yearly and monthly archiving of items from a specific module (based on item Release Dates). {% component type: "module_archive", module: "<Module name/ID>" %} Only archive dates that match items within the specified module are returned. In other words, archive dates with an item count of 0 won't be returned. Parameters and Options Parameter Values Required Description type module_archive This is the name of the entity that needs to be used for the component retrieving function. module <Module name/ID> The module’s entity/alias name or ID that the data is to be sourced from. parentItemId <Parent ID> The module group ID the data is to be..." },{ "Id": "2481", "URL": "/component-types/categories", "Name": "categories", "Description": " {% component type: "categories" %} Parameters and Options Parameter Values Required Description type categories This is the name of the entity that needs to be used for the component retrieving function. parentCategory -1 (default)<ID> The ID of the parent category to start retrieving subcategories from.Leaving out this parameter, or setting the value to -1, will result in the default of all categories being retrieved. levelsDeep -1 (default)<number> The number of levels down the category hierachy to be retrieved, starting from parentCategory.Leaving out this parameter, or setting the value to -1, will result in the default of all levels being retrieved. collectionVariable " },{ "Id": "3167", "URL": "/component-types/commentthreads", "Name": "commentThreads", "Description": "{% component type: "commentThreads", moduleItemId:"1234" %} Parameters and Options Parameter Values Required Description type commentThreads This is the name of the entity that needs to be used for the component retrieving function. moduleItemId <ItemID> The module item's ID, used to render the comments, and post comments, against the given item. layout <path/to/layout> Path to file that will contain the Liquid layout content to be parsed (for the overall Comment container and form). If an empty string, nothing will be rendered.If paramater is not included, the default virtual layout will be rendered (see below). If using your own custom layout here you must also specify a custom layout for the..." },{ "Id": "3168", "URL": "/component-types/comments", "Name": "comments", "Description": "{% component type: "comments", moduleItemId:"1234" %} Parameters and Options Parameter Values Required Description type comments This is the name of the entity that needs to be used for the component retrieving function. moduleItemId <ItemID> The module item's ID, used to render the comments, and post comments, against the given item. layout <path/to/layout> Path to file that will contain the Liquid layout content to be parsed (for the overall Comment container and form). If an empty string, nothing will be rendered.If paramater is not included, the default virtual layout will be rendered (see below). If using your own custom layout here you must also specify a custom layout for the..." },{ "Id": "2439", "URL": "/ecommerce/taxes", "Name": "Taxes", "Description": " Managing Taxes Found under ‘eCommerce’ ‘Taxes’, here you’ll find a list of all tax rates configured for use on your website, including the country they relate to. Clicking the pencil icon () to the right of each item will allow editing of that tax rate. Clicking the trash can icon () will delete the tax rate. To create a new tax rate, click the “ADD NEW TAX” button above the item list. Adding / Editing Here you’ll be able to configure the details of your tax rate and enable it for use within your shopping cart. Below are further details for the fields available. Option Description Country The shipping country this tax rate will display for when selected from the shopping cart stage. Tax Code A descriptive display name for the tax rate (ie: GST, VAT, OH State Tax, etc.). Tax Rate A percentage value..." },{ "Id": "3169", "URL": "/component-types/favorites", "Name": "favorites", "Description": "You can use Favorites on any built-in system module (such as Blogs, Authors, Events, etc.), Custom Modules and eCommerce Catalogs/Products. By default, the component renders an icon (a heart by default) forming the interface button for users to add (or remove) an item in their Favorites inventory. Additionally, the component can output all the items data for listing the member's favorite items, via Liquid, with your own custom layouts. {% component type: "favorites", source: "<Module name/ID>" %} Parameters and Options Parameter Values Required Description type favorites This is the name of the entity that needs to be used for the component retrieving function. source <Module name/ID> The module’s entity/alias name or ID that the data is to be sourced from. itemId " },{ "Id": "2531", "URL": "/component-types/countries", "Name": "countries", "Description": "{% component type: "countries" %} Parameters and Options Parameter Values Required Description type countries This is the name of the entity that needs to be used for the component retrieving function. layout <path/to/layout> Path to file that will contain the Liquid layout content to be parsed. If an empty string, nothing will be rendered.If paramater is not included, the default virtual layout will be rendered (see below). allowedCountries <LIST OF COUNTRY CODES> Restricts the output to only those countries indicated by a comma separated list of country codes (eg: US,AU) If an empty string, or if paramater is not included, all countries will be listed by default. ..." },{ "Id": "2521", "URL": "/component-types/domain_settings", "Name": "domain_settings", "Description": "This component can be output throughout all site content areas and emails with the retrieved settings including things like the domain's default landing page, country, culture and currency attributes. {% component type: "domain_settings" %} Parameters and Options Parameter Values Required Description type domain_settings This is the name of the entity that needs to be used for the component retrieving function. domain <YOURDOMAIN.COM> Specify any additional saved domain for the site to access its domain settings. Leaving out this parameter, or leaving the value empty, will result in the current domain used as default. collectionVariable <yourLiquidVariableName> Assigns the data to a Liquid collection enabling further access to the data on the Page or..." },{ "Id": "2438", "URL": "/ecommerce/shipping-options", "Name": "Shipping Options", "Description": " 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. " },{ "Id": "2591", "URL": "/ecommerce/settings", "Name": "Settings", "Description": "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.The minimum value allowed in this setting is 1 hour and the maximum is 876000 hours. Abandoned Cart Time in Hours The number of hours until a user’s shopping cart session is recorded as abandoned (after inactivity).The minimum value allowed in this setting is 1 hour and the maximum is 876000 hours.This setting is only available when using the Aboandoned Cart Recovery extension. 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..." },{ "Id": "2611", "URL": "/ecommerce/shopping-cart-javascript", "Name": "eCommerce Javascript", "Description": "Below describes the various javascript options, such as overriding alert pop-ups, before and after JS events and triggers. Override Alerts Such customisation may be used in order to customise all ecommerce alerts (instead of overwriting window.alert function that may be used elsewhere throughout the site) The below script can be added to your existing JS file (or within a <script> element on your site template) <script> window.EcommerceMessages = { "AddedToCart" : "The item has been added to the shopping cart.", "RequiredAttributesNotSelectedError" : "Please choose relevant options before adding to cart", "NotEnoughInStockError" : "In stock is less then item quantity entered", "ProductAttributeVariationIsDisabledError" : "This variation of the product is disabled.", "InventoryProductNotFoundError" : "Product with this attribute is not in stock", "InvalidMinimumUnitsError" : "Quantity entered is too small, please enter a larger quantity.", "InvalidMaximumUnitsError" : "Quantity entered is too large, please enter a smaller quantity.", "DestinationCountryMandatoryError" : "Please select a destination country", "DiscountNotFoundError" : "Discount not found", "DiscountMinOrderCostLimitationError" : "Shopping cart total cost is less than discount minimum order cost limit", "DiscountInActiveError" : "Discount code is currently disabled", "DiscountReleaseDateTimeError" : "Discount is not yet available", "DiscountExpirationDateTimeError" : "Discount has expired", "DiscountDifferentCurrencyError" : "Discount currency is different from domain..." },{ "Id": "2613", "URL": "/ecommerce/payment-form-javascript", "Name": "Payment Form Javascript", "Description": " Payment Form Events Payment form events can be intercepted for implementing your own customisations around form validations and submissions. Ensure you have the most up-to-date reCaptcha v3 script inserted in your form code layout in order to utilise the below event function. Either by restoring your form layout to default or by selecting the reCaptcha v3 code from the “Form Fields” manager above the form layout window. CMS_CustomSubmit This event will be triggered after a reCaptcha v3 validation (instead of the regular `submit` event), allowing you to add any additional validation actions (or other custom functions) and stop the regular form submit via event.preventDefault(). This is helpful for performing an AJAX submission of the form (along with already validated reCaptcha token and payment data). Returned data: Example from a Stripe transaction. { "form": [form Object], "paymentMethod": { "id": "pm_1Il7u9433Ww5sV49gBZgIjEO", "object": "payment_method", "billing_details": { "address": { "city": null, "country": null, "line1": null, "line2": null, "postal_code": null, "state": null }, "email": "test@testing.com", "name": null, "phone": null }, "card": { "brand": "visa", "checks": { "address_line1_check": null, "address_postal_code_check": null, "cvc_check": null }, "country": "US", "exp_month": 4, "exp_year": 2024, "funding": "credit", "generated_from": null, "last4": "4242", "networks": { "available":..." },{ "Id": "2583", "URL": "/component-types/json", "Name": "json", "Description": "{% component type: "json", source_type: "<your-json-source-type>", source: "<your-json-source>" %} Parameters and Options Parameter Values Required Description type json This system parameter identifies the type of component for processing the data. source_type pathurlstring Defines the type of JSON source you will be working with.path The JSON file will be found at a local, relative file path, eg: '/some/path/filename.json'url The JSON data will be found at an external (or local) location via an absolute URL, eg: 'https://some.domain/some_api'string The JSON data will be provided directly to the component source parameter as a string, eg: '{"some":"value"}' source <YOUR JSON FILE PATH OR STRING> The local file path, data URL, or JSON string to parse (corresponding..." },{ "Id": "2432", "URL": "/component-types/api-file-system", "Name": "api (File System)", "Description": "{% component type: "api", resource: "File System", folder: "/", collectionVariable: "yourLiquidVariableName" %} Parameters and Options Parameter Values Required Description type api This system parameter identifies the type of component for retrieving data from the CMS resource File System The system resource used for the data collection. folder / default<Your Folder Path> The folder URL to retrieve files from (default value is '/' for root directory).A custom folder path might look like this: /images/gallery01/Only files directly within the specified path will be retrieved. Sub folders and their child files are not returned in the collection. collectionVariable <yourLiquidVariableName> " },{ "Id": "3216", "URL": "/component-types/frontend_api", "Name": "frontend_API ", "Description": "{% component type: "api", resource: "File System", folder: "/", collectionVariable: "yourLiquidVariableName" %} Parameters and Options Parameter Values Required Description type api This system parameter identifies the type of component for retrieving data from the CMS resource File System The system resource used for the data collection. folder / default<Your Folder Path> The folder URL to retrieve files from (default value is '/' for root directory).A custom folder path might look like this: /images/gallery01/Only files directly within the specified path will be retrieved. Sub folders and their child files are not returned in the collection. collectionVariable <yourLiquidVariableName> " },{ "Id": "2361", "URL": "/liquid/bc-liquid-comparisons", "Name": "BC Liquid Comparisons", "Description": "Below are some typical Business Catalyst (BC) legacy Liquid and tags and their closest Treepl CMS comparisons that you may have found left over in old code. Item Data BC: Page Name{module_pagename}eg: "About" Treepl CMS:{{this.name}}Name of current item (within the context/scope of the template/layout where it is placed) BC: Page Title{module_pagetitle}eg: "About ABC Company" Treepl CMS:{{this.seotitle}}Meta title of current item (within the context/scope of the template/layout where it is placed) BC: Page ID{module_oid}eg: "12345" Treepl CMS:{{this.id}}ID of current item (within the context/scope of the template/layout where it is placed) "this" Documentation View full article This Liquid object is globally accessible in every liquid template or layout and outputs specific data relating to the item being render. {{ this }}For example, if {{this}} is placed in a Page content area it will render the liquid data of that page. Likewise if placed in a Module content field, it will..." },{ "Id": "2356", "URL": "/content-modules/site-search", "Name": "Site Search", "Description": "Results from multiple modules (ie: Pages, Products, Blog Posts...) will all be included in the one output/collection and displayed using the one specified list layout. Search queries are currently made against all of the following modules: Pages Blogs (Blogs and Posts) Events (Groups and Items) Banners (Groups and Items) Galleries/Sliders (Groups and Items) FAQs (Groups and Items) Custom Modules Authors Products/Catalogs The fields that can be search upon include: Name SKU Code Site Search Keywords Description Search List Layout The site search list layout, by default, is found under ‘Pages’ ‘Edit Settings’ ‘Layouts’ and you can create additional list layouts in the Page settings for this purpose. You can also change the source of the layout used with the source parameter on the ‘site_search’ component tag. For example, you could change the source form “Page” to “Blog Post” and create your list layout within the Blog Post layout interface. Regardless of where the list layout is sourced from, only data output in the resulting items can be rendered to the list. For example, the name and description are common fields across all module types and so you can safely use {{this['name']}}..." },{ "Id": "2369", "URL": "/site-settings-and-management/alpha-beta-features", "Name": "Alpha & Beta Features", "Description": " Beta Features The Beta Features section, found under the gear icon in the top right of the admin, provides the ability to enable/disable current beta features before they are implemented into the platform. Beta Features may break current functionality, cause loss of data, or change how they function at any time. These are not stable features and are not advised to be use in production. Current Beta features include: There are no current beta features. Alpha Features Features in Alpha are under internal flags but can be enable upon request for any of your trial sites if you wish to explore and test the features. There are no current alpha features. Release Flow Alpha and Beta Features will typically move through a 2-3 stage release cycle. Meaning, if a beta feature is released in a Backlog Release (eg: version 5.4.0) it will be available in the admin to enable/disable by the site admin user and/or reseller. Then, in the next Backlog Release (eg: version 5.4.1) the beta feature will move to an alpha state - enabled by default in the CMS backend and adjustable only via support ticket request. Finally, in..." }, ]