Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

edit OrderByScoreDESC description #652

Merged
merged 3 commits into from
Dec 19, 2023
Merged

edit OrderByScoreDESC description #652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
29edb57
replace relevance doc url
julia-rabello Dec 18, 2023
e0b180f
edit OrderByScoreDESC
julia-rabello Dec 18, 2023
8b3dac0
Update CHANGELOG.md
julia-rabello Dec 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

## [Unreleased]

### Fixed

- OrderByScoreDESC description on `README.md`

## [3.129.1] - 2023-12-08

### Changed
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Check all props to configure your search data in the table below:
| `queryField` | `string` | ![https://img.shields.io/badge/-Mandatory-red](https://img.shields.io/badge/-Mandatory-red) Query string of the search URL that defines the results that should be fetched in the custom query. For example: `Blue`. This prop only works if the `mapField` prop is declared as well. | `undefined`. |
| `mapField` | `string` | ![https://img.shields.io/badge/-Mandatory-red](https://img.shields.io/badge/-Mandatory-red) Search URL's `map` parameter to define which results should be fetched in the custom query, for example `specificationFilter_100`. This prop only works if the `queryField` prop is declared as well. | `undefined` |
| `maxItemsPerPage` | `number` | Maximum number of items per search page. The maximum value of this prop is `50`. If a higher number is added, the query will fail. | `10`|
| `orderByField` | `enum` | Determines which order products must follow when displayed. The possible values are named after the sorting type: `OrderByReleaseDateDESC`, `OrderByBestDiscountDESC`, `OrderByPriceDESC`, `OrderByPriceASC`, `OrderByNameASC`, `OrderByNameDESC`, `OrderByScoreDESC` ([relevance Score](https://help.vtex.com/en/tutorial/how-does-the-score-field-work--1BUZC0mBYEEIUgeQYAKcae)), or `OrderByTopSaleDESC`. `ASC` and `DESC` stand for ascending order and descending order, respectively. The last option (`OrderByTopSaleDESC`) considers the number of sold units of the product in the past 90 days, taking into account only ecommerce orders (no physical stores orders) from `order-placed` events (e.g. without checking if the payment was approved). If the store has an app, it is possible to consider the events from the app as long as they are implemented on the store's side, they aren't implemented by default. In case the shopper has an ad-blocking extension or a browser restriction that disables sending events, their navigation will not be counted. | `OrderByScoreDESC` |
| `orderByField` | `enum` | Determines which order products must follow when displayed. The possible values are named after the sorting type: `OrderByReleaseDateDESC`, `OrderByBestDiscountDESC`, `OrderByPriceDESC`, `OrderByPriceASC`, `OrderByNameASC`, `OrderByNameDESC`, `OrderByScoreDESC`, or `OrderByTopSaleDESC`. `ASC` and `DESC` stand for ascending order and descending order, respectively. `OrderByScoreDESC` considers only [relevance settings](https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/1qlObWIib6KqgrfX1FCOXS) and is not related to the [Score](https://help.vtex.com/en/tutorial/how-does-the-score-field-work--1BUZC0mBYEEIUgeQYAKcae) Catalog field, incompatible with VTEX Intelligent Search. The last option (`OrderByTopSaleDESC`) considers the number of sold units of the product in the past 90 days, taking into account only ecommerce orders (no physical stores orders) from `order-placed` events (e.g. without checking if the payment was approved). If the store has an app, it is possible to consider the events from the app as long as they are implemented on the store's side, they aren't implemented by default. In case the shopper has an ad-blocking extension or a browser restriction that disables sending events, their navigation will not be counted. | `OrderByScoreDESC` |
| `hideUnavailableItems` | `boolean` | Determines whether the search result should hide unavailable items (`true`) or not (`false`). | `false` |
| `facetsBehavior` | `string` | Defines the filters' behavior. When set to `Dynamic`, it restricts the results according to the filters that the user has already selected. If set to `Static`, all filters will continue to be displayed to the user, even if there are no results.| `Static` |
| `skusFilter` | `enum` | Refines the SKUs returned for each product in the query. The fewer returned SKUs, the more performant your shelf query will be. Available value options: `FIRST_AVAILABLE` (returns only the first available SKU), `ALL_AVAILABLE` (returns all available SKUs), and `ALL` (returns all product's SKUs). | `ALL_AVAILABLE` |
Expand Down
Loading