Custom page objects

Your theme can include custom data tags to retrieve data that is not available by default. For more information, see Customized data. You can use the following custom data in your theme:

Application

Applications that custom data return have the same objects as product profiles. See Product profile page objects.

FAQ

FAQ information provided through custom data. The same information is available on the help page. See Help page objects.

Navigator

Navigator information provided through custom data. The same information is available on the browsing page. See Product browsing page objects.

External data

External data does not have a defined structure because it depends on the data that comes from the external APIs that the theme developer uses.

List

The list object returns an array of products including various product properties. Lists return fewer properties than product profile pages.

Products appear in the items array that is included in the list object. The following table lists the product properties.

Property	Definition
id	Product ID
iconUrl	Product icon image URL
profileLogoUrl	Product profile logo URL
overviewImageUrl	Product overview image URL
productRibbon	Properties that define the label that is usually applied to the product icon in sliders: text: Ribbon text textColor: RGB value for ribbon text color ribbonColor: RGB value for ribbon color
merchandisingBadges	Array of small merchandising images that are usually used in the slider: name: Badge name uuid: Badge unique identifier image: Badge image URL
uuid	Product unique identifier
description	Product description text
overview	Product overview text
showRating	Indicates whether product ratings are displayed
hidePricings	Indicates whether product pricing is hidden
free	Indicates whether product is free
referable	Indicates whether referral users can use the product to generate leads
buyable	Indicates whether the product can be purchased directly. If false, the buy button is not available.
freeTrialOrEditionPresent	Indicates whether the product has a free trial or free edition
discounted	Indicates whether the product includes a discount
name	Product name
blurb	Short product description
url	Product profile page URL
startingPrice	Contains the following product price information: currency: Three-letter currency ISO currency code, for example USD symbol: Currency symbol, for example $ frequency: Payment frequency details label: Payment frequency label text, for example Month shortLabel: Abbreviated label, for example Mo id: Frequency ID, for example ONE_TIME, MONTHLY, YEARLY, and so on price: Product price without currency symbol, for example 15.99 priceCaption: Text that accompanies the price, for example Starting at formattedPrice: Product price with currency symbol, for example $15.99 formattedFullPrice: Product price with currency symbol and payment frequency, for example $15.99/Mo
tags	Array of tags such as attributes, categories, or customer tags type: Tag type, for example CATEGORY id: Tag ID number name: Tag name badge: Text label for the tag showBadge: Indicates whether to show the badge showOnNavigation: Indicates whether to show the badge in the navigation (to filter results) children: Lists any child tags, for example subcategories description: Tag description
rating	Product rating out of five stars
badges	Array of promotional text badges id: Badge ID, for example FREE_TRIAL label: Badge label text, for example Free Trial