related_items
This component fetches related items of a specific source item, such as a Product that has had Related Products assign to it.
{% component type: "related_items", source: "Products", itemId: "<Item ID>" %}
Parameters and Options
Parameter
Values
Required
Description
type
related_itemsThis 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
<Item ID>The module item ID (specific Product) the data is to be sourced from
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).
sortBy
id
parentid
name
weighting
url
urlslug
releasedate
expirydate
LastUpdatedDate
Author
ItemCategories
ItemTags
<CustomPropertyName>
...and any other top level properties available for the module
The name of the property to sort by. If empty or not present, alpha/numeric sorting will be used.
Remove spaces from custom property names here.
sortOrder
ASC (default)
DESCASC sorts the items in ascending order while DESC sorts in descending order (based on alpha/numeric or date sorting).If empty or not present, alpha/numeric sorting will be used.
limit
10 (default)
<integer>The maximum number of items returned. If displayPagination is enabled this determines the maximum number of items per page.
object
item
collection (default)Determines the method for Liquid rendering.
item returns each item iteratively, one after another, for output (generally, output to a container element with no need for looping through the data).collection returns all items as one collection for output (your container element and looping logic would be handled in the Components Layout).collectionVariable
<yourLiquidVariableName>Assigns the data to a Liquid collection enabling further access to the data on the Page or Template using Liquid.
Your collectionVariable value must only contain English letters, numbers or underscores. Spaces or special characters are not supported.
Liquid Output
The below example has 2 related items and is the default structure you will get from this Component.
{
"Params": {
"type": "related_items",
"source": "Products",
"itemid": "2535",
"layout": "",
"collectionvariable": "relatedCollection"
},
"Pagination": {
"CurrentPage": 1,
"ItemsPerPage": 10,
"NumberOfPages": 1,
"TotalItemsCount": 2
},
"Parent": {
"Id": 2554,
"Name": "related_items",
"Url": "/component-types/related_items",
"Url_List": [
"/component-types/related_items"
],
"UrlSlug": "related_items",
"ParentId": 2127,
"ParentId_List": [
2127
],
"ParentName": "Liquid Components",
"ParentUrl": "/component-types",
"TemplateName": "Docs Template",
"Module_Alias": "DocumentationPost",
"Module_ID": 1870,
"Enabled": true,
"ReleaseDate": "2018-09-20T00:00:00",
"ExpiryDate": "2099-12-10T00:00:00",
"SiteSearchKeywords": [],
"Description": "\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n{% component type: \"snippet\", alias: \"section_parameters\" %}\n\n{% component type: \"json\", source_type:\"string\", source:\"{{tabularData}}\", layout:\"/snippets/tabularJSON.layout\" %}\n</section>\n\n{% component type: \"snippet\", alias: \"section_output\" %}\n\n{% component type: \"related_items\", source: \"Products\", itemId: \"2535\", layout: "", collectionVariable: \"relatedCollection\" %}\n\n<p>The below example has 2 related <code>items</code> and is the default structure you will get from this Component.</p>\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{relatedCollection}}\", lang: \"json\" %}\n</section>\n\n{% component type: \"snippet\", alias: \"section_virtual_layout\" %}\n<p>Based on the above example, if not using any custom layout or collection, the default virtual layout will output as a list of related items:</p>\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"html\" %}\n<p>Rendering the list:</p>\n{% component type:\"related_items\", source: \"Products\", itemId: \"2535\" %}\n</section>\n\n{% component type: \"snippet\", alias: \"section_accessing_data\" %}\n<p>This data is also accessible directly on the Page or Template via a Liquid Collection by adding <code>collectionVariable</code> to the Component.</p>\n\n<p>An example using <code>collectionVariable</code> with value \"relatedCollection\":</p>\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n\n<p><em>Accessing a specific item within the collection. In this case the first item (zero based index), which in our example would render the value <code>DEMO product 2</code></em></p>\n\n{% component type: \"snippet\", alias: \"code_block_processor\", data: \"{{data}}\", lang: \"liquid\" %}\n</section>",
"Weighting": 810,
"DisableForSiteSearch": false,
"CreatedByMemberId": "0",
"ItemCategories": [],
"ItemCategoryIdList": [],
"ItemTags": [
"Ecommerce"
],
"Author": 0,
"Author_Name": "",
"Author_Url": "",
"Item_Rating": 0,
"Active": true,
"IgnoreUpdates": true,
"UpdatesLog": "<ul><li>All new article</li></ul>",
"ExternalResources": "",
"AdditionalRelatedArticle": 0,
"AdditionalRelatedArticle2": 0,
"Authors": "2418",
"ShowPageForSearchEngine": true,
"MetaTitle": "",
"SEOTitle": "",
"MetaDescription": "This component fetches related items of a specific source item, such as a Product that has had Related Products assign to it.",
"CanonicalLink": "",
"SocialMetaTags": "",
"SeoPriority": 0.8,
"EnableAMP": false,
"AMPContent": "",
"OpenGraphProperties": {
"title": "",
"type": "",
"url": "",
"locale": "",
"image": ""
},
"ExternalId": 0,
"Params": {
"type": "snippet",
"alias": "section_output",
"data": "\n{% component type: \"related_items\", source: \"Products\", itemId: \"<Item ID>\" %}\n",
"lang": "liquid",
"name": "SECTION Output",
"content": "<section id=\"secOutput\">\n <h2>Liquid Output</h2>",
"enabled": true,
"required": "true",
"values": "item,collection <em>(default)</em>",
"altname": "itemId",
"description": "The module item ID (specific Product) the data is to be sourced from"
}
},
"Items": [
{
"Id": 2536,
"Name": "DEMO product 2",
"Url": "/catalogs/demo-product-2",
"Url_List": [
"/catalogs/demo-product-2"
],
"UrlSlug": "demo-product-2",
"ParentId": 2485,
"ParentId_List": [
-1
],
"ParentName": "",
"ParentUrl": "",
"TemplateName": "",
"Module_Alias": "Product",
"Module_ID": 2485,
"Enabled": true,
"ReleaseDate": "2020-05-05T23:00:00",
"ExpiryDate": "2099-12-11T13:00:00",
"SiteSearchKeywords": [],
"Description": "<p>Sample product for the ecommerce store.</p>",
"Weighting": 0,
"DisableForSiteSearch": false,
"SKUCode": "DEMO2",
"SmallImage": "/images/template-detail-crafter-mobile@2x.png",
"LargeImage": "/images/template-detail-crafter-desktop@2x.jpg",
"OnSale": false,
"IsGiftVoucher": false,
"ProductWeight": 0.0000,
"ProductWidth": 0.0000,
"ProductHeight": 0.0000,
"ProductDepth": 0.0000,
"EnableDropShipping": false,
"UnitType": "",
"MinimumUnits": 0,
"MaximumUnits": 0,
"RecurringType": "None",
"IsShippable": true,
"IsDownloadable": false,
"NumberOfPossibleDownloads": 0,
"Supplier": 0,
"Price": 0.0,
"PriceHtml": "<span data-cms_product_data_price=\"2536\">0.00</span>",
"priceWithTax": 0.0,
"priceWithTaxHtml": "<span data-cms_product_data_price_with_tax=\"2536\">0.00</span>",
"RecommendedPriceWithTax": 0.0,
"RecommendedPriceWithTaxHtml": "<span data-cms_product_data_recommended_price_with_tax=\"2536\">0.00</span>",
"RecommendedPrice": 0.0,
"RecommendedPriceHtml": "<span data-cms_product_data_recommended_price=\"2536\">0.00</span>",
"EnableInventoryControl": false,
"HasGeneratedInventoryProducts": false,
"InStockHtml": "<span data-cms_product_data_in_stock=\"2536\"></span>",
"IsHide": false,
"InStock": 0,
"IsDisable": false,
"taxRate": 0.0,
"IsGroupedProduct": true,
"decimalsQuantity": 0,
"VolumeDiscount": [
{
"Price": 0.0,
"Quantity": 0
}
],
"ProductDataJSON": {
"itemId": 2536,
"maximumUnits": 0,
"minimumUnits": 0,
"recommendedPrice": 0.0,
"QuantityThreshold": [
{
"Price": 0.0,
"Quantity": 0
}
],
"inStockTotal": null,
"prices": {
"0": 0.0
},
"enablePreOrder": false,
"variations": null,
"attributes": {},
"options": {},
"taxRate": 0.0,
"taxInPercent": 0.0
},
"ProductDataJsonHTML": "<script>initEcommerceProductPriceVariations(2536,{\"itemId\":2536,\"maximumUnits\":0,\"minimumUnits\":0,\"recommendedPrice\":0.0,\"QuantityThreshold\":[{\"Price\":0.0,\"Quantity\":0}],\"inStockTotal\":null,\"prices\":{\"0\":0.0},\"enablePreOrder\":false,\"variations\":null,\"attributes\":{},\"options\":{},\"taxRate\":0.0,\"taxInPercent\":0.0});</script>",
"CreatedByMemberId": "0",
"ItemCategories": [],
"ItemCategoryIdList": [],
"ItemTags": [],
"Author": 0,
"Author_Name": "",
"Author_Url": "",
"Item_Rating": 0,
"MyCustomProperty": null,
"ShowPageForSearchEngine": false,
"MetaTitle": "",
"SEOTitle": "",
"MetaDescription": "",
"CanonicalLink": "",
"SocialMetaTags": "",
"SeoPriority": 0.5,
"EnableAMP": false,
"AMPContent": "",
"OpenGraphProperties": {
"title": null,
"type": null,
"url": null,
"locale": null,
"image": null
},
"ExternalId": 0,
"Params": {}
},
{
"Id": 2563,
"Name": "DEMO Product 3",
"Url": "/catalogs/demo-product-3",
"Url_List": [
"/catalogs/demo-product-3"
],
"UrlSlug": "demo-product-3",
"ParentId": 2485,
"ParentId_List": [
-1
],
"ParentName": "",
"ParentUrl": "",
"TemplateName": "",
"Module_Alias": "Product",
"Module_ID": 2485,
"Enabled": true,
"ReleaseDate": "2020-05-19T23:00:00",
"ExpiryDate": "2099-12-11T13:00:00",
"SiteSearchKeywords": [],
"Description": "",
"Weighting": 0,
"DisableForSiteSearch": false,
"SKUCode": "7067ce22-6b5d-4bdb-80e6-b878ca0b31f2",
"SmallImage": "",
"LargeImage": "",
"OnSale": false,
"IsGiftVoucher": false,
"ProductWeight": 0.0000,
"ProductWidth": 0.0000,
"ProductHeight": 0.0000,
"ProductDepth": 0.0000,
"EnableDropShipping": false,
"UnitType": "",
"MinimumUnits": 0,
"MaximumUnits": 0,
"RecurringType": "None",
"IsShippable": true,
"IsDownloadable": false,
"NumberOfPossibleDownloads": 0,
"Supplier": 0,
"Price": 0.0,
"PriceHtml": "<span data-cms_product_data_price=\"2563\">0.00</span>",
"priceWithTax": 0.0,
"priceWithTaxHtml": "<span data-cms_product_data_price_with_tax=\"2563\">0.00</span>",
"RecommendedPriceWithTax": 0.0,
"RecommendedPriceWithTaxHtml": "<span data-cms_product_data_recommended_price_with_tax=\"2563\">0.00</span>",
"RecommendedPrice": 0.0,
"RecommendedPriceHtml": "<span data-cms_product_data_recommended_price=\"2563\">0.00</span>",
"EnableInventoryControl": false,
"HasGeneratedInventoryProducts": false,
"InStockHtml": "<span data-cms_product_data_in_stock=\"2563\"></span>",
"IsHide": false,
"InStock": 0,
"IsDisable": false,
"taxRate": 0.0,
"IsGroupedProduct": true,
"decimalsQuantity": 0,
"VolumeDiscount": [
{
"Price": 0.0,
"Quantity": 0
}
],
"ProductDataJSON": {
"itemId": 2563,
"maximumUnits": 0,
"minimumUnits": 0,
"recommendedPrice": 0.0,
"QuantityThreshold": [
{
"Price": 0.0,
"Quantity": 0
}
],
"inStockTotal": null,
"prices": {
"0": 0.0
},
"enablePreOrder": false,
"variations": null,
"attributes": {},
"options": {},
"taxRate": 0.0,
"taxInPercent": 0.0
},
"ProductDataJsonHTML": "<script>initEcommerceProductPriceVariations(2563,{\"itemId\":2563,\"maximumUnits\":0,\"minimumUnits\":0,\"recommendedPrice\":0.0,\"QuantityThreshold\":[{\"Price\":0.0,\"Quantity\":0}],\"inStockTotal\":null,\"prices\":{\"0\":0.0},\"enablePreOrder\":false,\"variations\":null,\"attributes\":{},\"options\":{},\"taxRate\":0.0,\"taxInPercent\":0.0});</script>",
"CreatedByMemberId": "0",
"ItemCategories": [],
"ItemCategoryIdList": [],
"ItemTags": [],
"Author": 0,
"Author_Name": "",
"Author_Url": "",
"Item_Rating": 0,
"MyCustomProperty": null,
"ShowPageForSearchEngine": false,
"MetaTitle": "",
"SEOTitle": "",
"MetaDescription": "",
"CanonicalLink": "",
"SocialMetaTags": "",
"SeoPriority": 0.5,
"EnableAMP": false,
"AMPContent": "",
"OpenGraphProperties": {
"title": null,
"type": null,
"url": null,
"locale": null,
"image": null
},
"ExternalId": 0,
"Params": {}
}
]
}Virtual Layout
Based on the above example, if not using any custom layout or collection, the default virtual layout will output as a list of related items:
<ul>
{% for item in this.items %}
<li>
<a href="{{item.url}}" title="{{item.name}}">{{item.name}}</a>
</li>
{% endfor %}
</ul>
Rendering the list:
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 this approach, see Part 2 of the free ‘Learning Liquid Course’.
Rendering Property Values
This data is also accessible directly on the Page or Template via a Liquid Collection by adding collectionVariable to the Component.
An example using collectionVariable with value "relatedCollection":
{% component type:"related_items", source: "Products", itemId: "2535", collectionVariable: "relatedCollection" %}
Accessing a specific item within the collection. In this case the first item (zero based index), which in our example would render the value DEMO product 2
{{relatedCollection.items[0]['Name']}}
Related Articles
- Site Settings & Management
Domains
The WebinOne 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. - Site Settings & Management
Payment Settings
Integrate various payment gateways, for multiple countries and currencies, into WebinOne for form payments, subscriptions and eCommerce workflows. - CRM
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. - CRM
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. - OpenAPI (Admin)
CRM Orders API
Retrieve and Update Order Items via the public API endpoint using "where" filtering. - OpenAPI (Admin)
CRM Order Lines API
Create, Retrieve, Update and Delete CRM Order Lines within an Order via the public API endpoint. - Liquid Objects & Usage
{{ order }} object
This liquid object will output the order details of a submitted payment. ... - OpenAPI (Admin)
CRM Order Assets API
Create CRM Order Assets, such as Discount Codes, Gift Vouchers, Shipping Options and Tax Codes via the public API endpoint. - OpenAPI (Admin)
CRM Order Payments API
Create, Retrieve, Update and Delete CRM Order Payments within an Order via the public API endpoint using "where" filtering. - OpenAPI (Admin)
CRM Order Statuses API
Retrieve CRM Order Statuses via the public API endpoint using "where" filtering. - OpenAPI (Admin)
Print API
Retrieve the print version of an Order asset via the public API endpoint by type. - Liquid Components
module (Catalogs)
This module component fetches data relating to eCommerce Catalogs and can be used to render Catalog structures and Products within them. - Liquid Components
module (Products)
This module component fetches data relating to eCommerce Products and can be used to render Product information. - Liquid Components
ecommerce_add_to_cart
This component renders an anchor element allowing the javascript function to add the item to the shopping cart. - Liquid Components
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. - Liquid Components
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. - Liquid Components
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. - Liquid Components
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. - Liquid Components
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. - OpenAPI (Admin)
Ecommerce Discount Codes API
Create, Retrieve, Update and Delete Ecommerce Discount Codes via the public API endpoint using "where" filtering. - OpenAPI (Admin)
Ecommerce Gift Vouchers API
Create, Retrieve, Update and Delete Ecommerce Gift Vouchers via the public API endpoint using "where" filtering. - Liquid Components
shopping_cart
This component fetches data relating to the shopping cart, such as any products added, order totals, tax, shipping, etc. - OpenAPI (Admin)
Ecommerce Shipping Options API
Create, Retrieve, Update and Delete Ecommerce Shipping Options via the public API endpoint as well as return external shipping providers and settings. - Liquid Components
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. - Liquid Components
shippingProviderFields
This component provides a placeholder for populating additional Shipping Provider options to the user. - OpenAPI (Admin)
Ecommerce Taxes API
Create, Retrieve, Update and Delete Ecommerce Taxes via the public API endpoint using "where" filtering. - Liquid Components
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. - Liquid Components
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. - Liquid Components
orders
This component fetches Orders from the CRM, either owned by the logged-in user or for all customer Orders. - eCommerce
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. - eCommerce
Products
Products are one of the most powerful and flexible modules in WebinOne. Create customised product schemas with multiple price points, catalogs, inventory tracked attributes/variables, SEO optimisation and more. - eCommerce
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. - eCommerce
Discount codes
Provide discount code functionality for your WebinOne shopping cart. Ideal for promotions, customer loyalty and conversions or to help move more stock. - eCommerce
Gift vouchers
Gift vouchers can be issued to your customers or purchased by them online via the shopping cart. - eCommerce
Taxes
Create any number of required tax codes specific to the shipping country selected in your WebinOne shopping cart. - Liquid Components
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. - Liquid Components
domain_settings
This module component retrieves settings associated with the current domain, or optionally from another specified domain configured in the site instance. - eCommerce
Shipping Options
WebinOne 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
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. - eCommerce
eCommerce Javascript
This is the provided javascript options for further controlling/customising the ecommerce javascript provided by the CMS. - Extensions
Abandoned Cart Recovery
With Abandoned Cart Recovery functionality, you can automatically send email reminders to customers who add products to their cart (while logged in) and leave without completing the order. - Extras
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@webinone.com and we will consult you as soon as possible.