VTEX Developer Portal

2. Configuring your account

Now that you have completed the VTEX IO basic setup, it is time to:

By meeting these two prerequisites, your store is apt to use the VTEX Store Framework, free from any technical issues that could emerge due to flaws during the implementation steps.

Step 1 - Setting your account's Edition app

An Edition app is a mandatory app that exports a bundle of settings and basic configurations to the VTEX account in which it is installed.

By default, every VTEX store comes with the Edition app for building storefronts with VTEX Legacy CMS installed. To use the VTEX Store Framework instead, get in touch with our Customer Care team and request the installation of the [email protected] app in your VTEX account.

️ Whether you are a new VTEX account or a former account using VTEX Legacy CMS, installing the [email protected] Edition app is necessary to implement the Store Framework solution successfully.

Step 2 - Implementing the VTEX Intelligent Search

So you can start customizing your storefront with VTEX Store Framework, you first need to configure the VTEX Intelligent Search.

VTEX Intelligent Search is an intelligent search engine for e-commerce that aims to assist customers throughout their entire purchasing journey.

The solution is an alternative to the platform's old native search engine and requires the installation of the following two apps on your VTEX account:

  • admin-search - Allows stores to configure every functionality made available by the search solution, including first-time catalog indexing.
  • search-resolver - Solves all search queries, being the main back-end app from the Intelligent Search.

Installing the Search apps

  1. Log in to your VTEX account using your terminal:
vtex login {account}

️ Replace the value between curly braces according to your scenario.

  1. Once logged in, run the following command to list the apps already installed on your account:
vtex list
  1. If any of the two apps is missing from the list, install them using the VTEX IO CLI at the master workspace as in the following:
vtex install vtex.admin-search [email protected]

Starting the Search Integration process

After installing the Search apps, you will need to start indexing and integrate VTEX Intelligent Search with your store's Catalog.

  1. Go to your VTEX store's admin.
  2. In the side menu, go to Store Setup > Search > Integration settings.
  3. Press the Start integration button to start integration.

start-integrationstart-integration

The indexing process will start, and you will then see a link to the Indexing Status screen.

Once the indexing is finished, you'll be ready to start using VTEX Store Framework successfully. Time to get busy! Let's go?

Updated about 19 hours ago



2. Configuring your account


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.