page.face

Name : page

Type : Map

Name : menu

Type : Map

blog-list.face

Name : page

Type : Map

Name : menu

Type : Map

Name : blog_posts

Type : List

Name : blog_categories

Type : List

Name : blog_tags

Type : List

Name : blog_authors

Type : List

blog-post.face

Name : page

Type : Map

Name : menu

Type : map

Name : blog_post

Type : Map

Name : blog_category

Type : Map

Name : blog_tags

Type : List

Name : blog_authors

Type : List

store-cart.face

Name : page

Type : Map

Name : cart

Type : Map

Name : currency

Type : Map

store-category.face

Name : category

Type : Map

Name : page

Type : Map

Name : menu

Type : Map

Name : currency

Type : Map

Name : pagination

Type : Map

store-checkout.face

Name : page

Type : Map

Name : checkout

Type : Map

Name : menu

Type : Map

Name : currency

Type : Map

store-collection.face

Name : page

Type : Map

Name : no_products_message

Type : String

Name : collection

Type : Map

Name : currency

Type : Map

store-payment-status.face

Name : page

Type : Map

Name : payment_status

Type : Map

Name : page

Type : Map

store-product-list.face

Name : product

Type : Map

Name : currency

Type : Map

store-product-quick-view.face

Name : product

Type : Map

Name : currency

Type : Map

Name : page

Type : Map

store-product.face

Name : product

Type : Map

Name : page

Type : Map

Name : menu

Type : Map

Name : currency

Type : Map

store-currency-list.face

Name : currencies

Type : List

store-product-search.face

Name : search

Type : Map

Name : currency

Type : Map

Name : no_products_message

Type : String

Name : page

Type : Map

Name : pagination

Type : Map

store-recommended-product.face

Name : recommended_products

Type : Map

Name : currency

Type : Map

Name : no_products_message

Type : String

Name : page

Type : Map

store-collection-widget.face

Name : collection

Type : Map

Name : currency

Type : Map

Name : no_products_message

Type : String

Name : page

Type : Map

Name : pagination

Type : Map

store-product-list-view.face

Name : product

Type : Map

Name : currency

Type : Map

Name : page

Type : Map

page

Type : Map

page.site_id

Type :

page.is_store_enabled

Type : boolean

Returns a true/false value which indicates if the store is enabled.

page.site_id

Type : long

Returns the unique ID of the site.

page.primary_domain

Type : String

Returns the primary domain of the site, if primary domain exists.

page.id

Type : long

Returns the unique ID of the page.

page.type

Type : int

Returns the type of the page.

page.url

Type : String

Returns the URL of the page.

page.title

Type : String

Returns the title of the page.

page.site_title

Type : String

Returns the title of the site.

page.site_caption

Type : String

Returns the caption of the site.

page.meta_tags

Type : String

Returns a String which contains the meta tag for the site.

page.is_title_enabled

Type : boolean

Returns a true/false value indicating if the title is enabled for the site.

page.is_caption_enabled

Type : boolean

Returns a true/false value indicating if caption is enabled for the site.

page.is_logo_enabled

Type : boolean

Returns a true/false value indicating if logo is enabled for the site.

page.is_sidebar_enabled

Type : boolean

Returns a true/false value indicating if sidebar is enabled for the site.

page.is_banner_enabled

Type : boolean

Returns a true/false value indicating if banner is enabled for the site.

page.is_custom_banner_enabled

Type : boolean

Returns a true/false value indicating if custom banner is enabled for the site.

page.is_search_enabled

Type : boolean

Returns a true/false value indicating if search is enabled for the site.

page.search_url

Type : String

Returns the search URL for the site.

Type : String

Returns the primary search.

page.is_social_icon_enabled

Type : boolean

Returns a true/false value indicating if social icons are enabled.

page.is_contact_information_enabled

Type : boolean

Returns a true/false value indicating if contact information is enabled.

page.is_breadcrumb_enabled

Type : boolean

Returns a true/false value indicating if breadcrumb is enabled.

page.is_menu_enabled

Type : boolean

Returns a true/false value if menu is enabled.

Type : boolean

Returns a true/false value if footer is enabled.

page.email_id

Type : String

Returns a String containing the email ID, if it is specified in your site settings.

page.phone_number

Type : String

Returns a String containing the phone number, if is specified in your site settings.

page.social_icons_order

Type : List of Strings

Returns a list of Strings which contain the order of social icons for the site.

page.social_icons_list

Type : Map of data

Returns a Map of social icons and their respective URLs.

page.header_code

Type : String

Returns the header code for the site.

Type : String

Returns the footer code for the site.

page.custom_css

Type : String

Returns custom CSS for the site, if there is any.

page.stylesheets

Type : String

Returns the tag containing the style sheets for the site.

page.scripts

Type : String

Returns the scripts used in the site.

page.template_assets

Type : String

Returns the template assets used in the site.

Type : Map of logo

Returns the logo details of the site.

page.banner

Type : String

Returns the banner content of the site.

page.sidebar_content

Type : String

Returns the sidebar content of the site.

Type : String

Returns the footer content of the site.

page.is_portal_enabled

Type : boolean

Returns a true/false value indicating if the member portal is enabled for the site.

page.content

Type : String

Returns the content of the site.

Type : List of breadcrumb

Returns the breadcrumb details of the site.

page.form_code

Type : String

Returns the URL for authenticating the i-frame.

page.is_portal_signup_enabled

Type : boolean

Returns a true/false value indicating if site sign up is enabled.

page.stock_images

Type : String

Returns stock image URLs for the site.

page.signup_settings

Type : Map of signup_settings

Returns the fields enabled for sign up settings in a Map.

page.blog_page_no

Type : int

Returns the page number for the current blog.

page.blog_posts_per_page

Type : int

Returns the number of blog posts per page.

page.blog_summary_view

Type : boolean

Returns a true/false value indicating if blog summary is enabled.

page.blog_next_page

Type : int

Returns the page number of the next blog.

page.blog_prev_page

Type : int

Returns the page number of the previous blog.

page.blog_next_page_url

Type : String

Returns the URL of the next blog page.

page.blog_prev_page_url

Type : String

Returns the URL of the previous blog page.

page.blog_post_count

Type : int

Returns the number of blog posts.

page.blog_page_count

Type : int

Returns the number of blog pages.

page.blog_view_type

Type : String

Returns the type of blog view, the values being- 'page_view','category_view','tag_view','author_view', and 'post_view'

page.blog_view_entity_url

Type : String

Returns the URL for the blog view.

page.blog_pagination_url

Type : String

Returns the pagination URL of the blog.

page.blog_feed_url

Type : String

Returns the feed URL of the blog.

page.template_vars

Type : Map of template_vars

Returns the default variables of the template on a Map.

page.is_portal_user_allowed

Type : boolean

Returns a true/false value indicating if a portal user is allowed.

page.show_cart_icon

Type : boolean

Returns a true/false value indicating if the cart icon should be shown.

page.top_band_content

Type : String

--.

page.portal_signup_uri

Type : String

--.

page.is_multi_currency_enabled

Type : boolean

--.

page.is_sorting_enabled

Type : boolean

--.

page.is_specification_enabled

Type : boolean

--.

blog_post

Type : Map

blog_post.post_id

Type : long

Returns the unique post ID of the blog post.

blog_post.post_title

Type : String

Returns the blog post title.

blog_post.post_url

Type : String

Returns the blog post URL.

blog_post.description

Type : String

Returns the description of the blog post.

blog_post.post_image

Type : String

Returns the image URL of the blog post.

blog_post.post_author

Type : long

Returns the post author's ID.

blog_post.post_published_time

Type : String

Returns the time when the post was published.

blog_post.post_scheduled_time

Type : String

Returns the time when the blog post is scheduled to be posted.

blog_post.rss_published_time

Type : String

Returns the published time of the RSS feed.

blog_post.post_published_time_gmt

Type : String

Returns the time in which the post was published in GMT.

blog_post.publish_status

Type : int

Returns the published status of the post, the values being 0-POST_DRAFT, 1-POST_PUBLISHED, 2-POST_SCHEDULED, 3-POST_REVISED

blog_post.publish_type

Type : String

Returns the publish type for the post, values being 'draft', 'publish' and 'future'.

blog_post.summary

Type : String

Returns the summary of the blog post.

blog_post.summary_image

Type : String

Returns the summary image URL of the blog post.

blog_post.content

Type : String

Returns the content of the blog post.

blog_post.category

Type : Map of category

Returns the category of the blog post in a Map.

blog_post.tags

Type : List of blog_post_tag

Returns the tags of the blog post in a List.

blog_post.author

Type : Map of author

Returns the author details of the blog post.

blog_post.is_social_share_enabled

Type : boolean

Returns a true/false value indicating if social share is enabled.

blog_post.social_share_options

Type : Map of social_share_options

Returns the social share options in a Map.

social_share_options

Type : Map

social_share_options.align

Type : String

Returns the alignment.

social_share_options.style

Type : String

Returns the style.

social_share_options.show_count

Type : String

Returns the count of posts to show.

blog_categories

Type : List of blog_category

blog_category

Type : Map

blog_category.resource_id

Type : long

Returns the unique resource ID of the blog category.

blog_category.category_name

Type : String

Returns the name of the category.

blog_category.category_url

Type : String

Returns the URL of the category.

blog_category.seo

Type : Map of

--.

blog_category.published_post_count

Type : String

--.

blog_tags

Type : List of blog_tag

blog_tags.seo

Type : Map of

--.

blog_tag

Type : Map

blog_tag.resource_id

Type : long

Returns the unique resource ID.

blog_tag.tag_name

Type : String

Returns the name of the tag.

blog_tag.tag_url

Type : String

Returns the URL of the tag.

blog_tag.published_post_count

Type : String

Returns the publish post count.

blog_authors

Type : List of blog_author

blog_author

Type : Map

blog_author.resource_id

Type : long

Returns the unique resource ID.

blog_author.published_post_count

Type : String

Returns the published post count.

blog_author.mapping_author_id

Type : long

Returns the Mapping author ID.

blog_author.mapping_resource_id

Type : long

Returns the Mapping resource ID.

blog_author.author_id

Type : long

Returns the unique ID of the author.

blog_author.author_name

Type : String

Returns the name of the author.

blog_author.author_url

Type : String

Returns the URL of the author.

author

Type : Map

author.author_id

Type : long

Returns the unique ID of the author.

author.author_name

Type : String

Returns the name of the author.

author.author_url

Type : String

Returns the URL of the author.

category

Type : Map

category.resource_id

Type : long

Returns the unique resource ID of the category.

category.category_name

Type : String

Returns the name of the category.

category.category_url

Type : String

Returns the URL of the category.

category.sort_by_options

Type : List of SortByOptionsView

Returns the URL of the category.

blog_post_tag

Type : Map

blog_post_tag.post_id

Type : long

Returns the unique post ID.

blog_post_tag.tag_id

Type : long

Returns the unique tag ID.

blog_post_tag.tag_name

Type : String

Returns the name of the tag.

blog_post_tag.tag_url

Type : String

Returns the URL of the tag.

cart

Type : Map

cart.cart_id

Type : String

Returns the unique cart ID.

cart.items

Type : List of cart_item

Returns the list of items in the cart.

cart.count

Type : int

Returns the number of items in the cart.

cart.total_price

Type : double

Returns the total price of the items in the cart.

cart.checkout_url

Type : String

Returns the checkout URL of the cart.

cart_item

Type : Map

cart_item.name

Type : String

Returns the name of the item.

cart_item.description

Type : String

Returns the description of the item.

cart_item.handle

Type : String

Returns the handle of the item.

cart_item.url

Type : String

Returns the URL of the item.

cart_item.quantity

Type : int

Returns the quantity of the item.

cart_item.total_price

Type : double

Returns the total price of the item.

currency

Type : Map

currency.symbol

Type : String

Returns the currency symbol.

currency.symbol_formatted

Type : String

Returns the currency symbol format.

currency.format

Type : String

Returns the currency format.

currency.symbol_on_left

Type : boolean

Returns a true/false value indicating if the symbol should be on the left.

currency.code_on_left

Type : boolean

Returns a true/false value indicating if the code should be on the left.

currency.code

Type : String

--.

category

Type : Map

category.category_id

Type : long

Returns the unique category ID.

category.name

Type : String

Returns the name of the category.

category.description

Type : String

Returns the description of the category.

category.handle

Type : String

Returns the category handle.

category.url

Type : String

Returns the URL of the category.

category.number_columns

Type : int

Returns the number of columns in the category.

category.order

Type : int

Returns the order of the category.

category.parent_category_id

Type : long

Returns the parent category ID.

category.products

Type : List of product

Returns the products of a category in a List.

category.seo

Type : Map of

Returns SEO details.

category.sub_categories

Type : List of sub_category

Returns sub-categories in a List.

category.visibility

Type : boolean

Returns a true/false value indicating the visibility.

category.specifications

Type : List of category_specification

Returns the specifications in a List.

category.images

Type : List of image

Returns the list of images for the category.

category.bread_crumbs

Type : List of bread_crumb

Returns the breadcrumb list for the category.

category_specification

Type : Map

category_specification.sets

Type : List of category_specification_set

Returns the list of category specification sets.

category_specification_set

Type : Map

category_specification_set.name

Type : String

Returns the name of category specifications.

category_specification_set.attributes

Type : List of attribute

Returns the list of attributes in the specification set.

attribute

Type : Map

attribute.id

Type : long

Returns the unique ID of the attribute.

attribute.name

Type : String

Returns the name of the attribute.

attribute.type

Type : String

Returns the type of attribute.

attribute.options

Type : List of attribute_option

Returns the various options for the attribute.

attribute_option

Type : Map

attribute_option.id

Type : long

Returns the ID of the attribute.

attribute_option.name

Type : String

Returns the name of the attribute.

attribute_option.value

Type : String

Returns the value of the attribute.

attribute_option.color_code

Type : String

Returns the color code of the attribute.

product

Type : Map

product.product_id

Type : String

Returns the ID of the product.

product.name

Type : String

Returns the name of the product.

product.type

Type : int

Returns the type of product.

product.handle

Type : String

Returns the handle of the product.

product.url

Type : String

Returns the URL of the product.

product.quick_look_url

Type : String

Returns the quick look URL of the product.

product.category_id

Type : long

Returns the category ID of the product.

product.status

Type : boolean

Returns a true/false value indicating the status of the product.

product.description

Type : String

Returns a description of the product.

product.short_description

Type : String

Returns a short description of the product.

product.has_variant_price

Type : boolean

Returns a true/false value indicating if the product has a variant price.

product.has_variants

Type : boolean

Returns a true/false value indicating if the product has variants.

product.is_out_of_stock

Type : boolean

Returns a true/false value indicating if the product is out of stock.

product.label_price

Type : double

Returns the label price of the product.

product.selling_price

Type : double

Returns the selling price of the product.

product.starts_with

Type : double

Returns the starting price of the product.

product.ends_with

Type : double

Returns the ending price of the product.

product.on_sale

Type : boolean

Returns a true/false value indicating if the product is on sale.

product.is_returnable

Type : boolean

Returns a true/false value indicating if the product is returnable.

product.is_stock_managed

Type : boolean

Returns a true/false value indicating if stock is managed.

product.documents

Type : List of document

Returns the list of documents regarding the product.

product.images

Type : List of image

Returns the list of images regarding the product.

product.attributes

Type : List of attribute

Returns the list of attributes of the product.

product.seo

Type : Map of seo

Returns the SEO details of the product.

product.variants

Type : List of variant

Returns the list of product variants.

product.tags

Type : List of product_tag

Returns the list of product tags.

product.bread_crumbs

Type : List of bread_crumb

Returns the list of breadcrumbs for the product.

product.review_id

Type : long

Returns the review ID of the product.

product.category_name

Type : String

--.

product.brand

Type : String

--.

product.specification_group

Type : List of ProductSpecificationGroup

--.

product.is_social_share_enabled

Type : boolean

--.

product.social_share_options

Type : --.

--.

product.is_product_custom_fields_enabled

Type : boolean

--.

product.is_product_review_enabled

Type : boolean

--.

product_tag

Type : Map

product_tag.id

Type : long

Returns the unique ID of the product tag.

product_tag.name

Type : String

Returns the name of the product tag.

product_tag.handle

Type : String

Returns the handle of the product tag.

product_tag.url

Type : String

Returns the URL of the product tag.

variant

Type : Map

variant.variant_id

Type : long

Returns the ID of the variant.

variant.options

Type : List of attribute_option

Returns the list of variant options.

variant.stock_available

Type : int

Returns the number of stock available for the variant.

variant.is_out_of_stock

Type : boolean

Returns a true/false value indicating if the variant is out of stock.

variant.is_returnable

Type : boolean

Returns a true/false value indicating if the variant is returnable.

variant.selling_price

Type : double

Returns the selling price of the product.

variant.label_price

Type : double

Returns the label price of the product.

variant.sku

Type : String

Returns the SKU of the product.

variant.documents

Type : List of document

Returns the list of documents regarding the variant.

variant.images

Type : List of image

Returns the list of images in the variant.

variant.isbn

Type : String

--.

variant.mpn

Type : String

--.

variant.upc

Type : String

--.

variant.ean

Type : String

--.

variant.custom_fields

Type : List of CustomField

--.

specification

Type : Map

specification.sets

Type : List of product_specification_set

Returns the list of product specification sets.

product_specification_set

Type : Map

product_specification_set.name

Type : String

returns the name of the product specification set

product_specification_set.attributes

Type : List of attribute_option

Returns the attributes of the product specification set.

document

Type : Map

document.document_id

Type : long

Returns the unique document ID.

document.name

Type : String

Returns the name of the document.

Type : boolean

Returns a true/false value indicating if the document is featured.

document.attachment_order

Type : int

Returns the attachment order of the document.

document.alter_text

Type : String

--.

sub_category

Type : Map

sub_category.category_id

Type : long

Returns the unique category ID.

sub_category.name

Type : String

Returns the name of the sub category.

sub_category.description

Type : String

Returns the description of the sub category.

sub_category.handle

Type : String

Returns the handle of the sub category.

sub_category.url

Type : String

Returns the URL of the sub category.

sub_category.parent_category_id

Type : long

Returns the parent category ID of the sub category.

sub_category.visibility

Type : boolean

Returns a true/false value indicating if the sub category is visible.

sub_category.images

Type : List of image

Returns the list of images of the sub category.

sub_category.sibling_order

Type : int

--.

seo

Type : Map

seo.description

Type : String

Returns the SEO description.

seo.keyword

Type : String

Returns the SEO keywords.

seo.title

Type : String

Returns the SEO title.

image

Type : Map

image.id

Type : long

Returns the unique ID of the image.

image.url

Type : String

Returns the URL of the image.

image.alternate_text

Type : String

Returns the alternate text for the image.

image.order

Type : int

Returns the order of the image.

Type : boolean

Returns a true/false value indicating if the image is featured.

image.is_placeholder_image

Type : boolean

Returns a true/false value indicating if the image is a placeholder image.

image.title

Type : String

--.

checkout

Type : Map

checkout.form

Type : String

Returns the checkout form.

collection

Type : Map

collection.id

Type : long

Returns the ID of the collection.

collection.name

Type : String

Returns the name of the collection.

collection.handle

Type : String

Returns the handle of the collection.

collection.url

Type : String

Returns the URL of the collection.

collection.description

Type : String

Returns the description of the collection.

collection.products

Type : List of product

Returns the list of products in the collection.sort_by_options

collection.sort_by_options

Type : List of sort_by_option

--.

payment_status

Type : Map

payment_status.salesorder_number

Type : String

--.

payment_status.currency_code

Type : String

--.

payment_status.order_placed

Type : boolean

--.

payment_status.transaction_status

Type : String

--.

payment_status.error

Type : Map of

--.

payment_status.payment_mode

Type : String

--.

payment_status.amount

Type : String

--.

payment_status.payments

Type : List of PaymentInfoView

--.

currencies

Type : Map

currencies.currency_code

Type : String

--.

currencies.exchange_rate

Type : String

--.

currencies.currency_symbol

Type : String

--.

currencies.currency_format

Type : String

--.

currencies.price_precision

Type : int

--.

currencies.is_base_currency

Type : boolean

--.

currencies.currency_flag

Type : String

--.

sort_by_options

Type : Map

sort_by_options.name

Type : String

--.

sort_by_options.value

Type : String

--.

sort_by_options.is_selected

Type : boolean

--.

specification_group

Type : Map

specification_group.name

Type : String

--.

specification_group.attributes

Type : List of attribute_option

--.

payment

Type : Map

payment.payment_mode

Type : String

--.

payment.amount

Type : String

--.

custom_fields

Type : Map

custom_fields.customfield_id

Type : long

--.

custom_fields.field_type

Type : String

--.

custom_fields.label

Type : String

--.

custom_fields.value

Type : String

--.

custom_fields.values

Type : List of value

--.

custom_fields.display_value

Type : String

--.

custom_fields.options

Type : List of string

--.

custom_fields.edit_on_store

Type : boolean

--.

custom_fields.index

Type : int

--.

custom_fields.is_mandatory

Type : boolean

--.

custom_fields.is_enabled

Type : boolean

--.

custom_fields.show_in_storefront

Type : boolean

--.

custom_fields.pii_type

Type : String

--.

custom_fields.show_in_pdf

Type : boolean

--.