Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
ProductSummaryList
vtex.product-summary
Version: 2.52.3
Latest version: 2.90.0

This page is about version 2.52.3 of the app, which is not the most recent version. The latest stable version is 2.90.0.

The list-context.product-list interface is a instance of the list-context interfaces, which means its part of a set of special interfaces that enables you to create lists of content that can be edited via Site Editor.

In order to create a list of products, you need to use the list-context.product-list block and a product-summary.shelf.

product-list-block

This block is used to specify what variation of product-summary to be used to create the list of products, and the list-context.product-list you want as follows:


_14
"product-summary.shelf#demo1": {
_14
"children": [
_14
"stack-layout#prodsum",
_14
"product-summary-name",
_14
"product-rating-inline",
_14
"product-summary-space",
_14
"product-summary-price",
_14
"product-summary-buy-button"
_14
]
_14
},
_14
"list-context.product-list#demo1": {
_14
"blocks": ["product-summary.shelf#demo1"],
_14
"children": ["slider-layout#demo-products"]
_14
},

list-context.product-list is also responsible for performing the GraphQL query that fetches the list of products, so it can receive the following props:

Prop nameTypeDescriptionDefault value
categoryStringCategory ID of the listed items. For sub-categories, use "/" (e.g. "1/2/3")-
specificationFiltersArray({ id: String, value: String })Specification Filters of the listed items.[]
collectionStringFilter by collection.-
orderByEnumOrdination type of the items. Possible values: OrderByTopSaleDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, OrderByNameDESCOrderByTopSaleDESC
hideUnavailableItemsBooleanHides items that are unavailable.false
maxItemsNumberMaximum items to be fetched.10
skusFilterSkusFilterEnumControl SKUs returned for each product in the query. The less SKUs needed to be returned, the more performant your shelf query will be."ALL_AVAILABLE"
installmentCriteriaInstallmentCriteriaEnumControlControl what price to be shown when price has different installments options."MAX_WITHOUT_INTEREST"

For SkusFilterEnum:

NameValueDescription
First AvailableFIRST_AVAILABLEMost performant, ideal if you do not have a SKU selector in your shelf. Will return only the first available SKU for that product in your shelf query.
All AvailableALL_AVAILABLEA bit better performace, will only return SKUs that are available, ideal if you have a SKU selector but still want a better performance.
AllALLReturns all SKUs related to that product, least performant option.

For InstallmentCriteriaEnum:

NameValueDescription
Maximum without interestMAX_WITHOUT_INTERESTWill display the maximum installment option with no interest.
MaximumMAX_WITH_INTERESTWill display the maximum installment option having interest or not.
See also
Vtex.product Summary
VTEX IO Apps
VTEX App Store
VTEX IO Apps