VTEX Developer Portal

Development

I don't see my changes

️ Once you link your app, you should see all your changes live at https://{workspace}-{account}.myvtex.com. If your theme changes are not reflecting on your store workspace, check the following workarounds to fix your scenario.

My workspace does not reflect changes in Typescript types

The vtex link command does not listen to changes in Typescript types. To solve this issue, run vtex unlink to stop the link. Then, link the app again after the new changes.

My endpoint is returning old values

Set the no-cache option on your endpoint's response, as in the following example:

ctx.set('Cache-Control', 'no-cache')

Notice that, for providing a fast response, caching is enabled by default. However, we understand that a real-time response might be necessary when testing an app during development.

️ We strongly recommend that you do not disable cache for stores in production.

My theme changes are not reflecting on my store
  1. Log in to your store's VTEX account.
  2. Run vtex ls to list the apps installed on your account.
  3. Check if the major of the store theme app installed is different from the one you are developing.

️ To see your changes in action, the version of the theme project you're working must be in the same major as the one from the store theme app installed on your account.

  1. Check if there is another store theme app installed on your VTEX account. If positive, uninstall it.

I can't install an app

I can't install an app with a major other than 0.x

majormajor

Run vtex ls to check which apps are included on the Edition App installed on your account. If you see the app you're trying to install with another major, you might have an issue with the Edition App installed on your account.

In this case, consider opening a support ticket to change the Edition App installed on an account. First, go to the Edition App doc to learn more about the available Edition Apps.

I can't create a new workspace

Render fail when sender is vtex.menu, Request failed with status code 400

Checking if the Search Integration process started

  1. Open your account admin and go to Store Setup > Search > Integration Settings.
  2. Check if the search has been activated in the store.
  3. Press the Start integration button to start integration.

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

️ The Integration settings is responsible for the Catalog's initial indexing with VTEX Intelligent Search. After installing the application, this will be the first step to integrating it with the Catalog.

start-integrationstart-integration

️ Still having trouble? Contact our support team!

Updated 6 months ago


Development


Suggested Edits are limited on API Reference Pages

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