Product list
The product list object represents a product list content area on the site.
List of available attributes
- any_product_on_sale?
- columns
- content_settings
- design_settings
- id
- item_height
- item_width
- layout_type
- mask_content_overflow?
- mobile_columns
- products
- product_count
- show_cart_button?
- show_discount_label?
- show_discount_percentage?
- show_navigation_buttons?
- show_price?
- show_product_filters?
- sort_order
any_product_on_sale?
A boolean indicating whether any product displayed in the product list has sale price applied.
columns
The number of columns the list items are divided into in desktop view.
content_settings
A JSON object of product list's content settings.
design_settings
A JSON object of product list's design settings.
id
Product list's unique ID.
item_height
Height of the list item when using the catalogue layout.
item_width
Width of the list item when using the catalogue layout.
layout_type
Layout style selected for the product list.
mask_content_overflow?
A boolean indicating whether items overflowing the product list's container are masked or not.
mobile_columns
The number of columns the list items are divided into in mobile view.
products
Returns an array of products displayed in the product list. Each item is a Product.
product_count
The maximum number of products displayed in the product list.
show_cart_button?
A boolean indicating whether the Add to cart button is displayed for list items.
show_discount_label?
A boolean indicating whether discount labels are shown for items with sale prices.
show_discount_percentage?
A boolean indicating whether discount percentage is shown on discount label if possible.
show_navigation_buttons?
A boolean indicating whether navigation buttons are visible when using the catalogue layout.
show_price?
A boolean indicating whether the price is displayed for list items.
show_product_filters?
A boolean indicating whether filters are displayed above the product list.
sort_order
The default sorting order of list items.