Skip to main content

Listing page objects

The listing page, found at http://mytheme/listing, is the place where customers can search for and filter products. It contains two unique objects: a list of products (all products by default), and a list of filters that customers can select to refine the product list. The filters are based on product properties such as categories, attributes, platforms, and so on.

Listing page product properties

The listingProducts object contains a list of products, as well as any selected filters, sorting, and pagination criteria.

PropertyDefinition
itemsProduct details. See the List section in Custom page objects.
queryThe current search query and/or selected filters
paginationCurrent page of search results, total number of pages, and page list (previous, selected, next)
compareSee Product comparison page objects
sortingLists the possible page sorting options (relevance, popularity, newest first, alphabetical, and rating) and the selected option

Listing page filter properties

Filters are product categories, subcategories, and attributes that users can select to refine the product list. For more information on categories and attributes, see Groups.

All filter items (categories, subcategories, and attributes) are included in the listingProperties object and have the same properties.

PropertyDefinition
queryKeyTerm used to build query URL, for example cat (category), scat (subcategory), or attr (attribute)
idCategory ID label (for attributes) or number (for categories)
textFilter label as it appears in the user interface, for example Featured Apps
selectedIndicates whether the filter is selected
urlFull query URL that includes all selected filters

Was this page helpful?