Product profile page objects
Product profile pages, which users access when they click a product from a home, listing, comparison, or browsing page, contain detailed product information. Product profile pages are found at http://mytheme/apps/productId.
Product profile pages provide access to the following information, accessible through tabs (sub-pages) in the base theme:
- Overview
- Features
- Reviews
- Questions
- Resources
- Support
- Editions
Product sub-pages provide access to the same information as profile pages, so theme developers can design a single page for product profiles if desired, with two exceptions: due to technical limitations, the Reviews and Questions sub-pages contain extra information specific to reviews and questions respectively.
The application object on the profile page contains the following
information.
| Property | Definition |
|---|---|
config | Contains the following product configuration properties: • id: Product ID, the same number that appears in the page URL• uuid: Product unique identifier• type: Product type, for example WEB_APP |
summary | Contains summary information that appears in the product title bar in the base theme: • title: Product name• details: Short product summary• logoSrc: URL to logo image• productRibbon: Text and text properties of the label that appears on the logo, for example CORE APP• merchandisingBadges: Array of small merchandising images |
categories | List of associated categories and category URLs |
startingPrice | Contains the following product price information: • currency: Three-letter currency ISO currency code, for example USD• symbol: Currency symbol, for example $• frequency:• 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 |
domains | Contains data related to the domain product available on |
editions | Contains all relevant edition information required to build a list of editions: • bullets: List of features common to all editions• items: List of editions that contains details about each. There are many edition properties. The following data is relevant for theme designers: • List of costs per unit, for example $5.00 per month per user • Unit limit, for example 1 per user • Discount, either fixed price or percentage • Contract duration, for example 12 months • Target audience, for example small business or retail chains • List of edition-specific features • Action, such as a buy button or Contact Us button • footnotes: Fine-print pricing information |
addonProducts | Information about add-on products (see Manage add-on products). This object contains the same type of information as the editions object. |
addons | Information about add-on offerings (see Legacy features). This object contains the same type of information as the editions object. |
resources | List of supplementary resources such as videos or PDF documents, with links |
screenshots | List of product screenshots, with links |
support | List of support resources including links, telephone number, and email address |
features | List of product features, which appear by default on the Features sub-page at http://mytheme/apps/productId/productName/features |
buyButton | Label, styling, and action of the buy button, for example Buy Now |
leads | All data required to create a lead form (when the action is "Contact Us" instead of a direct purchase) • collectLeads: Indicates whether leads are enabled for the product• button: Lead button text, for example Contact Us• form: All form fields required to collect a lead, and the endpoint URL to which to post the form |
customAttributes | List of custom attributes added by the |
navigation | List of all sections or sub-pages available for the current product |
recommendations | Lists industry recommendations |
relatedContent | A subset of product data, including pricing and product rating, used to build the panel on the right of the profile page |
| h | reviews |
overview | Contains the following product overview information |
questions | List of user questions. This data is only available on the questions sub-page at http://mytheme/apps/productId/productName/questions • title: Question title• comment: Full question text• author: Author name and picture• answerCount: Number of answers• byDate: Question creation date• isCurrentUserQuestion: Indicates whether the current user asked the question• answers: List of answers• actionEndpoint: Product question API endpoint, for retrieving, updating, or deleting questions. For more information, see the Product Questions API documentation. |
Was this page helpful?
Tell us more…
Help us improve our content. Responses are anonymous.
Thanks
We appreciate your feedback!