Documentation
Feedback
Guides

Regionalization setup (Beta)

This feature is in closed beta, which means that only specific customers can access it now. If you want to implement it in the future, please contact our Support.

Regionalization is a feature of VTEX Intelligent Search that allows store administrators to optimize search results according to the availability of sellers in a customer's region. For information on installing and configuring VTEX Intelligent Search in your store, refer to the Search app article.

Regionalization leverages a native functionality from the VTEX Intelligent Search known as Availability. This feature searches for products currently in stock within a specified region. In addition, it checks the inventories of registered sellers in the store, ensuring a comprehensive assessment of available stock within the designated area.

Stores that have more than one registered white label seller usually have specific inventories for each region. This is the case for supermarkets, for example. With the Regionalization feature enabled, if a customer enters their ZIP code while browsing the store (before checkout), the search results will only display the products available in the corresponding region.

{"base64":"  ","img":{"width":590,"height":384,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":1168388,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/regionalization-beta-0.gif"}}

Before you begin

Make sure you have finished these actions before setting up the Regionalization feature in your store:

  • Install and configure VTEX Intelligent Search in your store, according to instructions in the Search developer guide and information available in the VTEX Intelligent Search track.
  • Follow the steps described in Regionalization (Beta), including seller configuration and a request to our support to activate the Regionalization feature.

Configuration

In the following sections, learn how to set up Regionalization in your store.

Setting up the search-result app

To use the Regionalization feature, you must have the Search Result app installed. After this configuration, you must set the simulationBehavior prop as default on the search.jsonc file to the correct use of the Regionalization, as shown below.


_11
{
_11
"store.search": {
_11
"blocks": ["search-result-layout"],
_11
"props": {
_11
"context": {
_11
"skusFilter": "FIRST_AVAILABLE",
_11
"simulationBehavior": "default"
_11
}
_11
}
_11
}
_11
}

Showing out-of-stock products on the search results page

You can show customers out-of-stock products from your sellers using the Regionalization feature.

The products shown will depend on the Availability context.

For this, you must make the following configurations on your store's Catalog and on VTEX IO.

Catalog

To display products, even when they are out of stock, the Show out of stock option must be enabled. Take the following steps:

  1. On VTEX Admin, click on the Catalog module.
  2. Click on Products and SKUs.
  3. Click on the Add Product button for a new product, or on the Update button for a product update.
  4. Check the box of the Show out of stock option from the product.
  5. Click on Save.

You can also set the ShowWithoutStock attribute in the Create Product endpoint or in the Update Product endpoint.

VTEX IO

Set the hideUnavailableItems prop to true on the autocomplete-result-list.v2 block. Check our Search documentation.


_10
{
_10
"search-bar": {
_10
"blocks": ["autocomplete-result-list.v2"],
_10
"props": {
_10
"hideUnavailableItems": true
_10
}
_10
}
_10
}

Indexing

After finishing the configuration, stores using VTEX Intelligent Search for the first time need to initiate the indexing of the store's Catalog with the Intelligent Search. If applicable, follow the steps below:

  1. On VTEX Admin, go to Store Settings > Intelligent Search > Integrations.
  2. Click Start.

Stores that have already set up this integration do not need to redo this action. For more information about this page, check the Integration Settings guide.

Contributors
1
Photo of the contributor
+ 1 contributors
Was this helpful?
Yes
No
Suggest edits (Github)
Contributors
1
Photo of the contributor
+ 1 contributors
On this page