[ { "Id": "2146", "URL": "/component-types/module-banner-group", "Name": "module (Banner Group)", "Description": "This module component fetches data relating to Banner Groups. {% component type: "module", source: "Banner Group", layout: "List" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source Banner Group (default) The module’s entity/alias name or ID that the data is to be sourced from. layout " },{ "Id": "2284", "URL": "/liquid/workflow-object", "Name": "{{ workflow }} object", "Description": "This liquid object will output the Workflow details of a submitted Form. You can use this on the default form submission page (/_form-submission-results/) or any custom redirect page you have setup for the confirmation page of your form. The output can also be used within the forms auto-response email Body, From Name, and Subject fields, as well as the Workflow Notification email Body and Email Templates. {{ this.workflow }} Liquid OutputAn example of the data structure for a successfully submitted form is below. { "id": 2, "name": "Inquiry Workflow", "recipients": [ "sales@example.com" ] } var obj = { "id": 2, "name": "Inquiry Workflow", "recipients": [ "sales@example.com" ] } ; var code = $('#code9 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); 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..." },{ "Id": "2153", "URL": "/about-treepl-cms/support", "Name": "Support", "Description": " Treepl Support Support Tickets Support Ticketing is fully integrated with your Treepl Portal and is your primary point of contact for the Treepl CMS team. If you have any issues, need development services, or have general questions, you can contact the friendly and responsive team straight from your Portal. Support Tickets will be listed here and show their current status and full chat history. You can reply directly through the Portal interface or simply reply to the support ticket email to add to the chat history. Live Chat Live Chat is also available throughout our support hours and can be accessed via any page of the Treepl website (lower right hand corner). Live Chat is best suited for general questions, sales enquiries. Many technical questions can also be answered, although if issues may need further investigation or developer assistance, consider submitting a support ticket so your question/s can be directed accordingly. Support Hours Our support hours cover 20hrs a day, 5 days a week. As a general guide, below is the approximate coverage per key timezones around the world. London / Copenhagen: 10pm - 5pm San..." },{ "Id": "2147", "URL": "/component-types/module-banner", "Name": "module (Banner)", "Description": "This module component fetches data relating to Banner items. {% component type: "module", source: "Banner", layout: "List" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source Banner (default) The module’s entity/alias name or ID that the data is to be sourced from. layout List (default)<Your..." },{ "Id": "3266", "URL": "/open-api-admin/crm-order-lines-api", "Name": "CRM Order Lines API", "Description": " POST CRM Order Line Create Creates a new Order Line item based on the provided data. /api/v2/admin/orders/{id}/order-lines Data / Response: { "ProductId": 0, "ProductName": "string", "Quantity": 0, "UnitPrice": 0, "Attributes": [ { "AttributeId": 0, "OptionsIds": [ "string" ] } ] } var obj = { "ProductId": 0, "ProductName": "string", "Quantity": 0, "UnitPrice": 0, "Attributes": [ { "AttributeId": 0, "OptionsIds": [ "string" ] } ] } ; var code = $('#code25 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Id": 0, "AWBNumber": "string", "CurrencyCountry": "string", "Currency": "string", "Country": "string", "InvoiceDate": "2024-05-17T18:47:19.762Z", "InvoiceNumber": 0, "IsDeleted": true, "IsRecurring": true, "MainOrderId": 0, "MemberId": 0, "OrderName": "string", "PaymentState": "None", "StatusId": 0, "TotalCost": 0, "CreatedDateTime": "2024-05-17T18:47:19.762Z", "HasSubscriptions": true, "HasPaidSubscription": true, "TrackingURL": "string", "TransactionId": "string", "AmountPaid": 0, "AmountPending": 0, "OrderCaseType": "FormCase", "StatusShort": { "Id": 0, "Name": "string" }, "Discount": { "Code": "string", "Cost": 0 }, "GiftVoucher": { "Name": "string", "Cost": 0 }, "Tax": { "Code": "string", "Rate": 0 }, "ShippingInfo": { "Name": "string", "Cost": 0, "Address": "string", "City": "string", "State": "string", "Zipcode": "string", "Country": "string" }, "Member": { "Id": 0, "Email": "string", "FirstName": "string", "LastName": "string" }, "OrderLines": [ { "Id": 0, "EntityType": "Form", "ProductId":..." },{ "Id": "2041", "URL": "/content-modules/forms", "Name": "Forms", "Description": "0 Quick Start Creating a Form Found under 'Content' > 'Forms' in the admin, you can create as many forms as needed, add system and custom fields, edit the forms HTML layout and configure advanced settings such as notifications and Form behaviour. To create a new form click the blue 'ADD NEW FORM' button at the top of the page, or to edit an existing form click on the form name or the associated pencil icon () on the far right. 1Form Builder When creating or editing a form you'll be able to set the name, alias and type of the form and build out the desired fields using the form builder. Name Description Name Descriptive name for the form. Form Alias System reference for the form. Changing the..." },{ "Id": "2140", "URL": "/component-types/module-gallery-slider", "Name": "module (Gallery/Slider)", "Description": "This module component fetches data relating to Gallery/Sliders. {% component type: "module", source: "Gallery/Slider", layout: "List" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source Gallery/Slider (default) The module’s entity/alias name or ID that the data is to be sourced from. layout List (default)<Your Layout..." },{ "Id": "2372", "URL": "/liquid/order-object", "Name": "{{ order }} object", "Description": "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..." },{ "Id": "2462", "URL": "/about-treepl-cms/trial-sites-vs-live-sites", "Name": "Trial Sites vs Live Sites", "Description": " Site Performance & Resources Currently, there are no differences in performance or resources limits between Trial Sites and Live Sites, apart from Trial Sites being idled after 60 minutes of inactivity. This is done to conserve server resources for inactive Trial Sites. However, Trial Sites will be automatically reactivated upon a new request/visits to the admin or front-end of the site. (reactivation may take 30-40 seconds before the site loads upon the first visit) Search Engine Indexing Trial Sites will automatically enforce disabling from Search Engines by adding no-index meta tags to all pages - irrespective of the 'Show this page for search engines' settings. This is done to prevent pages being index by search engines while in development. Once the Trial Site is activated to a Live Site, the 'Show this page for search engines' settings will be honoured and the automatic no-index meta tag insertion removed. Domain Names Trial Sites cannot have domain names assigned to them. This is achieved during the activation process (changing a Trial Site to a Live Site). " },{ "Id": "2143", "URL": "/component-types/module-slide", "Name": "module (Slide)", "Description": "This module component fetches data relating to Slide items. {% component type: "module", source: "Slide", layout: "List" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source Slide (default) The module’s entity/alias name or ID that the data is to be sourced from. layout List (default)<Your..." },{ "Id": "2135", "URL": "/content-modules/blogs", "Name": "Blogs", "Description": " Whether you need a simple list of news items to a full-featured blogging site, the Treepl CMS Blog module can be configured for your requirements, including tags, categories, authors, search, dynamic content and more. The module and its settings can be found under the 'Content' item in the left hand admin menu, then choose "". Quick Start 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..." },{ "Id": "3263", "URL": "/open-api-admin/crm-order-assets-api", "Name": "CRM Order Assets API", "Description": " PUT CRM Order Assets Discount Code Update Sets a single Discount Code to an Order based on the data provided. /api/v2/admin/orders/{id}/discount-code Data / Response: { "DiscountId": "string" } var obj = { "DiscountId": "string" } ; var code = $('#code88 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Id": 0, "AWBNumber": "string", "CurrencyCountry": "string", "Currency": "string", "Country": "string", "InvoiceDate": "2024-05-17T18:47:19.762Z", "InvoiceNumber": 0, "IsDeleted": true, "IsRecurring": true, "MainOrderId": 0, "MemberId": 0, "OrderName": "string", "PaymentState": "None", "StatusId": 0, "TotalCost": 0, "CreatedDateTime": "2024-05-17T18:47:19.762Z", "HasSubscriptions": true, "HasPaidSubscription": true, "TrackingURL": "string", "TransactionId": "string", "AmountPaid": 0, "AmountPending": 0, "OrderCaseType": "FormCase", "StatusShort": { "Id": 0, "Name": "string" }, "Discount": { "Code": "string", "Cost": 0 }, "GiftVoucher": { "Name": "string", "Cost": 0 }, "Tax": { "Code": "string", "Rate": 0 }, "ShippingInfo": { "Name": "string", "Cost": 0, "Address": "string", "City": "string", "State": "string", "Zipcode": "string", "Country": "string" }, "Member": { "Id": 0, "Email": "string", "FirstName": "string", "LastName": "string" }, "OrderLines": [ { "Id": 0, "EntityType": "Form", "ProductId": 0, "ModuleId": 0, "ProductName": "string", "Quantity": 0, "TaxRate": 0, "UnitPrice": 0, "TotalPrice": 0, "FileName": "string", "IsDownload": true, "Attributes": [ { "AttributeId": 0, "OptionsIds": [ "string" ] } ] } ],..." },{ "Id": "2144", "URL": "/component-types/module-faq-group", "Name": "module (FAQ Group)", "Description": "This module component fetches data relating to FAQ Groups. {% component type: "module", source: "FAQ Group", layout: "List" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source FAQ Group (default) The module’s entity/alias name or ID that the data is to be sourced from. layout " },{ "Id": "2145", "URL": "/component-types/module-faq-question", "Name": "module (FAQ Question)", "Description": "This module component fetches data relating to FAQ Questions. {% component type: "module", source: "FAQ Question", layout: "List" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source FAQ Question (default) The module’s entity/alias name or ID that the data is to be sourced from. layout " },{ "Id": "2349", "URL": "/content-modules/events", "Name": "Events", "Description": " From a simple list of upcoming meetings, a calendar view of important dates, to limited seat paid events spanning a few hours or multiple days, the Event module can be tailored for a variety of event types and use-cases and provides administrators with ease of management and access to subscribers and booking information. The module and its settings can be found under the 'Content' item in the left hand admin menu, then choose "". 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,..." },{ "Id": "2136", "URL": "/content-modules/banners", "Name": "Banners", "Description": " Quick Start 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 Description Module Name..." },{ "Id": "3270", "URL": "/open-api-admin/crm-order-payments-api", "Name": "CRM Order Payments API", "Description": " GET CRM Order Payments List Retrieves a list of Order Payments as a JSON response based on your provided query parameters. /api/v2/admin/orders/{id}/payments Data / Response: { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } var obj = { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } ; var code = $('#code146 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Items": [ { "Id": 0, "Amount": 0, "AmountCaptured": 0, "GatewayReason": "string", "TransactionId": "string", "Status": "string", "PaymentType": "CreditCard", "PaymentGatewayType": "stripe", "Notes": "string", "CreatedDateTime": "2024-05-17T18:40:25.699Z" } ], "TotalItemsCount": 0 } var obj = { "Items": [ { "Id": 0, "Amount": 0, "AmountCaptured": 0, "GatewayReason": "string", "TransactionId": "string", "Status": "string", "PaymentType": "CreditCard", "PaymentGatewayType": "stripe", "Notes": "string", "CreatedDateTime": "2024-05-17T18:40:25.699Z" } ], "TotalItemsCount": 0 } ; var code = $('#code147 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); POST CRM Order Payment Create Creates a new Order Payment based on the provided data. /api/v2/admin/orders/{id}/payments Data / Response: { "OrderId": "string", "Notes": "string", "PaymentType": "CreditCard", "Amount": 0, "CreatedDateTime": "2024-05-17T18:40:14.180Z" } var obj = { "OrderId": "string", "Notes":..." },{ "Id": "2137", "URL": "/content-modules/galleries-sliders", "Name": "Galleries/Sliders", "Description": " You can set up any number of Galleries with unlimited image items (Slides) as well as customise each of their layouts for your own design and functionality. Quick Start 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": "1960", "URL": "/component-types/module-custom-modules", "Name": "module (Custom Modules)", "Description": "{% component type: "module", source: "<Custom Module name/ID>", layout: "List 1" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source <Module name/ID> The module’s entity/alias name or ID that the data is to be sourced from. layout <Your Layout name> " },{ "Id": "2185", "URL": "/treepl-portal/treepl-cms-hosted-email", "Name": "Treepl CMS Hosted Email", "Description": " Managing Hosted Email Accounts with Treepl CMS Hosted email accounts can be managed via your Treepl Portal. After clicking the edit/pencil () icon against the desired site in your ‘Live Sites’ list, you’ll see the ‘Email Accounts’ tab. Here you’ll find controls to manage existing email accounts, create new accounts or set up new email hosting altogether. Starting New Hosted Email Service To start a new hosted email service (when none is currently set up), click the “Get Started” button to begin the process. Select the primary domain you’ll be using for email from the dropdown list available (you’ll be able to add domain aliases later). Clicking “Save” will provision the email service for that domain. Email Domain Alias Clicking the “+ Add domain alias” link under the primary domain listed for hosted email, you’re able to add additional domains that will be used as email domain aliases. That is, other domains that will also be mapped to ALL other email address you create here. Once added, you’ll need to ensure MX and SPF records are in place as per this article. Domain aliases create additional email addresses for ALL email..." },{ "Id": "3273", "URL": "/open-api-admin/crm-order-statuses-api", "Name": "CRM Order Statuses API", "Description": " GET CRM Order Statuses List Retrieves a list of Order Statuses as a JSON response based on your provided query parameters. /api/v2/admin/order/order-statuses Data / Response: { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } var obj = { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } ; var code = $('#code183 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Items": [ { "Id": 0, "EmailId": 0, "NotifyCustomer": true, "IsSystem": true, "Name": "string", "Type": "New", "TypeDisplayName": "string", "Workflows": [ 0 ] } ], "TotalItemsCount": 0 } var obj = { "Items": [ { "Id": 0, "EmailId": 0, "NotifyCustomer": true, "IsSystem": true, "Name": "string", "Type": "New", "TypeDisplayName": "string", "Workflows": [ 0 ] } ], "TotalItemsCount": 0 } ; var code = $('#code184 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); ..." },{ "Id": "2138", "URL": "/content-modules/faqs", "Name": "FAQs", "Description": " You can customise the Layouts of FAQ’s with your own HTML in any way you like, such as creating an interactive accordion, sections with headings, answers that pop-up in a modal or click through to their own detail page. 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": "2148", "URL": "/component-types/module-author", "Name": "module (Author)", "Description": "This module component fetches data relating to Author items. {% component type: "module", source: "Author", layout: "List" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source Author (default) The module’s entity/alias name or ID that the data is to be sourced from. layout List (default)<Your..." },{ "Id": "2328", "URL": "/component-types/module-page-folder", "Name": "module (Page Folder)", "Description": "This module component fetches data relating to Page Folders. Possible use cases for this are displaying the folder/directory name and description (if one is set) for the currently viewed page. Page Folders are based on the same structure as many other modules in Treepl CMS (Page Folders and Pages are nested modules). So you can retrieve, list, sort and filter your site page folders just like you might Blogs or Custom Modules. {% component type: "module", source: "1516", layout: "Folder Detail" %} Parameters and Options Parameter Values Required Description type module (default) This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules..." },{ "Id": "3330", "URL": "/open-api-admin/print-api", "Name": "Print API", "Description": " GET Print Item Retrieves a Print version (HTML) of the Order Asset by type provided in the URL endpoint. /api/v2/admin/print/{orderId}/{type} Data / Response: N/A var obj = N/A ; var code = $('#code220 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); HTML content for the print version var obj = HTML content for the print version ; var code = $('#code221 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); " },{ "Id": "2311", "URL": "/email-marketing/api-provider", "Name": "API Provider", "Description": "Found under ‘Email Marketing’ ‘API Provider’, select the service provider from the dropdown list and then enter your API key provided by your email marketing provider. Mailchimp API Key To generate your Mailchimp API key, log into your Mailchimp account and click on your profile name in the top right of the screen. Select ‘Account’ from the dropdown. Then click on the ‘Extras’ tab and select ‘API keys’. Under the “Your API keys” heading, click the “Create API Key” button and your key will be generated. Copy the key value and add it to the Treepl ‘API Provider’ section and save the settings. Your Mailchimp integration is now complete and you can start managing Mailing List and Subscribers directly from within Treepl CMS. " },{ "Id": "2160", "URL": "/component-types/module-page", "Name": "module (Page)", "Description": "This module component fetches data relating to Pages. Possible use cases for this are creating dynamic menus or automatic on-page sitemaps. Specifically, creating a dynamic on-page sub-menu (of all the pages within the current folder/directory). Pages are based on the same structure as many other modules in Treepl CMS. So you can retrieve, list, sort and filter your site pages just like you might Blog Posts or Custom Modules. {% component type: "module", source: "Page", layout: "Page Detail" %} Parameters and Options Parameter Values Required Description type module (default) This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow..." },{ "Id": "3329", "URL": "/open-api-admin/modules-api", "Name": "Modules API", "Description": " GET Modules List Retrieves a list of Modules as a JSON response based on your provided query parameters. /api/v2/admin/modules Data / Response: { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } var obj = { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } ; var code = $('#code233 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Items": [ { "Id": 0, "Name": "string", "Alias": "string", "Title": "string", "Notes": "string", "MediaFolder": "string", "NewItemButtonValue": "string", "UrlSlug": "string", "Icon": "string", "LastUpdatedDate": "2024-05-22T16:57:15.059Z", "IsDefault": true, "SecureZones": [ 0 ], "ExtraSettings": { "EnableRollback": true }, "SiteUserPermissions": { "SpecifyExpiryDate": true, "RequiresApproval": true, "FrontendApiRestrictionSettings": [ { "NotificationSettings": { "CustomWorkflowIds": [ 0 ], "EmailNotification": { "EmailContent": "string", "EmailFromAddress": "string", "EmailSubject": "string", "FromName": "string", "TemplateId": 0 } }, "Id": 0, "Enable": true, "FrontendApiRestrictionType": "AddItems", "HasOwnership": true, "OwnershipRestriction": "OnlyOwnerAllowed", "UserTypeApiRestriction": "LoggedInUser", "SecureZones": [ 0 ], "Title": "string" } ] }, "AdvancedOptions": { "ChildModuleId": 0, "AllowItemsTreeView": true, "AllowItemsSimplifiedTreeView": true, "AllowItemsListView": true, "AllowMultipleParentItems": true, "EnableSubscription": true, "EnableRelatedModuleItems": true, "DefaultItemsView": "string", "RootTreeLevelViewAllowAddItemsOfParentType": true, "RootTreeLevelViewAllowAddItemsOfChildType": true, "InnerTreeLevelViewAllowAddItemsOfParentType": true, "InnerTreeLevelViewAllowAddItemsOfChildType": true, "AllowCreatingForeignItems": true } } ], "TotalItemsCount": 0 } var obj = {..." },{ "Id": "2513", "URL": "/learning-liquid-free-online-course/introduction-to-liquid", "Name": "Part 1: Introduction to Liquid", "Description": "Time for completion: 5 mins Prerequisites Just a very basic understand of HTML. This course will start at the very beginning and build on concepts as we go along. Although, if you’d like to play along we recommend having access to a Treepl CMS site instance, which you can do so for free here if not already signed up. A thirst for knowledge (get it?) What is Liquid Firstly, Liquid was designed to be easy to use and understand, while providing great power and flexibility. The perfect coding language for designers and front-end devs… which is why we use it in Treepl CMS. Liquid is defined as a templating language, meaning it uses templated snippets of code, or layouts, to be later populated with your sites data/content. On top of this it provides methods for retrieving your sites data and to manipulate that data, hence controlling the final output based on a variety of conditions. In a nutshell; it allows you to retrieve site data, adjust it for your needs, and render it in the browser based on your required layout. In a..." },{ "Id": "2125", "URL": "/treepl-portal/trial-site-activation-going-live", "Name": "Trial Site Activation (Going Live)", "Description": "This process requires both actions in Treepl Portal and in your DNS (Domain Name System) provider’s console. So you'll need to have access to the DNS during this process, or be in contact with someone who has it. Typically, your DNS will be managed in one of two places: Your domain registrar’s console (using their DNS/Zone management tools) A third-party DNS service (such as Cloudflare) Walk-through: Trial Site Activation and DNS Settings In this video, we’ll walk through all the DNS changes required for sending your Treepl CMS website live; plus other optional DNS records you may wish to add. We’ll also look at finding who your domain registrar is and where your DNS is hosted. To set up your Treepl account visit: https://treepl.co/reseller-program Overview of Steps & Timeframes Steps Timeframe Moving DNS / Changing Name Servers (only if moving DNS) (~24-48hrs) Checking your Trial Site " },{ "Id": "2545", "URL": "/component-types/module-catalogs", "Name": "module (Catalogs)", "Description": "{% component type: "module", source: "Catalogs", layout: "List" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source Catalogs (default) The module’s entity/alias name or ID that the data is to be sourced from. layout List (default)<Your Layout name> " },{ "Id": "2549", "URL": "/component-types/module-products", "Name": "module (Products)", "Description": "{% component type: "module", source: "Products", layout: "List" %} Parameters and Options Parameter Values Required Description type module (default)module_of_member This is the name of the entity that needs to be used for the component retrieving function.module is the standard retrieving function to retrieve all items.module_of_member retrieves only those items 'Added by' the currently logged in user (identified by the CreatedByMemberId property in the module items Liquid data).The 'Added by' System Property will only be available where the modules settings have 'Allow Add New Items' turned on under the 'Site User Permissions'. source Products (default) The module’s entity/alias name or ID that the data is to be sourced from. layout List (default)<Your Layout name> " },{ "Id": "2156", "URL": "/content-modules/authors", "Name": "Authors", "Description": " An author’s name, photo, bio and other information can be stored against their listing and then assigned to most other CMS items to be displayed on the website or used for filtering. For example, Blog Posts can be assigned an Author via the CMS with that author then being displayed on the website front-end as the creator of the post. The author can have their own detail page for viewing additional information and even listing other content they are responsible for. The Blog (and other modules) can also be sorted and filtered by Author to list those items related to that person. 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..." },{ "Id": "3328", "URL": "/open-api-admin/module-properties-api", "Name": "Module Properties API", "Description": " GET Module Properties List Retrieves a list of Module Properties as a JSON response based on your provided query parameters. /api/v2/admin/modules/{id}/properties Data / Response: N/A var obj = N/A ; var code = $('#code285 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); [ { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "string", "Alias": "string", "Mandatory": true, "SortOrder": 0, "IsMultiple": true, "DisplayValue": "string", "Notes": "string", "DisplayNotesInline": true, "DisplayDownloadableCheckbox": true, "EnableWysiwyg": true, "EnableCodeEditor": true, "PreValues": [ "string" ], "EditorAlias": "string", "Value": "string", "Indexer": "string", "Unique": true } ] var obj = [ { "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "Name": "string", "Alias": "string", "Mandatory": true, "SortOrder": 0, "IsMultiple": true, "DisplayValue": "string", "Notes": "string", "DisplayNotesInline": true, "DisplayDownloadableCheckbox": true, "EnableWysiwyg": true, "EnableCodeEditor": true, "PreValues": [ "string" ], "EditorAlias": "string", "Value": "string", "Indexer": "string", "Unique": true } ] ; var code = $('#code286 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); POST Module Property Create Creates a new Module Property based on the provided data. /api/v2/admin/modules/{id}/properties Data / Response: { "Name": "string", "Alias": "string", "Mandatory": true, "IsMultiple": true, "DisplayNotesInline": true, "DisplayDownloadableCheckbox": true, "EnableWysiwyg": true, "EnableCodeEditor": true, "Notes": "string", "EditorAlias": "string", "PreValues": [ "string" ]..." },{ "Id": "3327", "URL": "/open-api-admin/module-items-api", "Name": "Module Items API", "Description": " GET Module Items List Retrieves a list of Module Items as a JSON response based on your provided query parameters. /api/v2/admin/module-items/{moduleId}/list Data / Response: { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } var obj = { "Where" : {}, "Order_By" : "Id", "Offset" : 0, "Limit" : 100, } ; var code = $('#code306 code'); code.text((JSON.stringify(obj, null, 4))); code.html((code.html()).replace(/\[\[/g, '')); { "Items": [ { "Id": 0, "Url": "string", "ItemRating": 0, "UrlList": [ "string" ], "LastUpdatedDate": "2024-05-22T16:11:07.052Z", "ItemCategoriesIdList": [ 0 ], "SiteSearchKeywordsString": "string", "IsActiveDraft": true, "EventProperties": { "HideWhenFull": true, "AllowMultipleSubscriptionPerEmail": true, "Capacity": 0, "Allocation": 0, "EventDateStart": "2024-05-22T16:11:07.052Z", "EventDateEnd": "2024-05-22T16:11:07.052Z" }, "ProductProperties": { "SmallImage": "string", "LargeImage": "string", "OnSale": true, "IsGiftVoucher": true, "ProductWeight": 0, "ProductWidth": 0, "ProductHeight": 0, "ProductDepth": 0, "EnableDropShipping": true, "UnitType": "string", "MinimumUnits": 0, "MaximumUnits": 0, "RecurringType": "None", "IsShippable": true, "IsDownloadable": true, "NumberOfPossibleDownloads": 0, "Supplier": 0, "IsHide": true, "InStock": 0, "IsDisable": true, "IsGroupedProduct": true, "DownloadableFileLink": "string" }, "Name": "string", "UrlSlug": "string", "ParentId": 0, "Enabled": true, "ReleaseDate": "2024-05-22T16:11:07.052Z", "ExpiryDate": "2024-05-22T16:11:07.052Z", "Description": "string", "Weighting": 0, "DisableForSiteSearch": true, "SKUCode": "string", "CreatedByMemberId": 0, "Author": 0, "ModuleId": 0, "TemplateId": 0, "LayoutId": 0, "Parents": [ 0 ], "ItemCategories":..." }, ]