Documentation
Feedback
Guides
VTEX IO Apps

VTEX IO Apps
Product Summary List
vtex.product-summary
Version: 2.90.4
Latest version: 2.90.4

The specified version of the app (2.x.0) does not exist. This page is about the latest stable version, which is 2.90.4.

The Product Summary List app (list-context.product-list) is an instance of the list-context interface, which provides predefined interfaces used to create content lists, such as a product list.

{"base64":"  ","img":{"width":1919,"height":951,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":437866,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-product-summary-productsummarylist-0.png"}}

To create a product list, you must use the list-context.product-list and product-summary.shelf blocks.

product-list-block

This block is used to specify the variation of product-summary that should be used to create the product list 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 also runs the GraphQL query that fetches the product list, allowing it to receive the following props:

Prop nameTypeDescriptionDefault value
categorystringCategory ID of the listed items. For subcategories, use "/" (example: "1/2/3").-
specificationFiltersArray({ id: String, value: String })Specification filters of the listed items.[]
collectionstringFilter by collection.-
orderByenumSort type of the items. Possible values are: '', OrderByTopSaleDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, OrderByNameDESC.OrderByTopSaleDESC
hideUnavailableItemsbooleanHides unavailable items.false
maxItemsnumberMaximum items to be fetched.10
skusFilterSkusFilterEnumControl SKUs returned for each product in the query. The fewer SKUs that need to be returned, the more efficient your shelf query will be. Possible values are: FIRST_AVAILABLE, ALL_AVAILABLE, ALL."ALL_AVAILABLE"
installmentCriteriaInstallmentCriteriaEnumControls the price that will be displayed when the price has different installment options. Possible values are: MAX_WITHOUT_INTEREST, MAX_WITH_INTEREST."MAX_WITHOUT_INTEREST"
listNamestringName of the list property in Google Analytics events.-
preferredSKUPreferredSKUEnumControls the SKU that will be selected in the summary. Possible values are: FIRST_AVAILABLE, LAST_AVAILABLE, PRICE_ASC, PRICE_DESC."FIRST_AVAILABLE"

SkusFilterEnum:

NameValueDescription
First AvailableFIRST_AVAILABLEBest performance, ideal if you don't have a SKU selector on your shelf. It returns only the first available SKU for that product in your shelf query.
All AvailableALL_AVAILABLESomewhat better performance. It only returns available SKUs, which is ideal if you have a SKU selector but still want better performance.
AllALLReturns all SKUs related to the product. This is the least efficient option.

InstallmentCriteriaEnum:

NameValueDescription
Maximum without interestMAX_WITHOUT_INTERESTDisplays the maximum installment option with no interest.
MaximumMAX_WITH_INTERESTDisplays the maximum installment option with or without interest.

PreferredSKUEnum:

NameValueDescription
First AvailableFIRST_AVAILABLESelects the first available SKU it finds.
Last AvailableLAST_AVAILABLESelects the last available SKU it finds.
CheapestPRICE_ASCSelects the cheapest SKU in stock it finds.
Most ExpensivePRICE_DESCSelects the most expensive available SKU it finds.

To select the SKU that will take precedence over this prop, create a Product (field) specification and assign the value of the desired SKU to be initially set for each product. If the specification doesn't exist or the value is empty, the preferredSKU prop will be used as a fallback. For more information, see Configuring custom images for the SKU Selector.

See also
Vtex.product Summary
VTEX IO Apps
VTEX App Store
VTEX IO Apps