Documentation
Feedback
Guides
App Development

App Development
Troubleshooting

Troubleshoot common issues in development and production environments with this guide.

Development

I don't see my changes

Once you link your app, you should see all your changes live at https://{workspace}--{accountName}.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 automatically detect changes in Typescript types. To address this issue, follow these steps:

  1. Stop the link process with vtex unlink.
  2. Update the Typescript types.
  3. Run vtex link to link the app again.
My endpoint is returning outdated values

If your endpoint is returning outdated values, consider disabling caching temporarily by setting the no-cache option on your endpoint's response, as in the following example:


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

Please note that caching is enabled by default to enhance performance. Only use this option during development if a real-time response is necessary. Ensure not to disable caching for production stores.

My theme changes are not reflecting on my store

To see your changes in action, the version of the Store Theme you are working must be in the same major as the one from the Store Theme app installed on your account.

  1. Log in to your VTEX account.
  2. List the apps installed on your account by running vtex ls.
  3. Check if the major of the Store Theme app installed is different from the one you are developing.
  4. 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

{"base64":"  ","img":{"width":713,"height":135,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":33250,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/development-0.png"}}

Run vtex ls to check which apps are included on the Edition App installed on your account. If you see the app you are 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 request a change to the Edition App installed on your account. First, go to the Edition App article 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. Access the Admin and go to Store Settings > Intelligent Search > Integrations.
  2. Check if the search has been activated in the store.
  3. Click 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.

{"base64":"  ","img":{"width":2096,"height":986,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":102637,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/development-1.png"}}

Production

My store translation is not behaving as expected

My store is being translated when it shouldn't
  • Checking the default locale

Access the API http://portal.vtexcommercestable.com.br/api/tenant/tenants?q={accountName} and check the defaultLocale file.

Replace the {accountName} with your VTEX account name.

If the defaultLocale value doesn't match your store locale, open a support ticket to report the issue.

My routes are not behaving as expected

My redirect path doesn't work
  • Checking if the redirect is saved in the Rewriter

    1. Install the GraphiQL IDE in your account by running vtex install vtex.admin-graphql-ide@3.x.
    2. Access the Admin and go to Store Settings > Storefront > GraphiQL IDE.
    3. Select the vtex.rewriter@1.x app from the dropdown list.
    4. Run the following query, replacing {URL} with the from path you are having trouble with:

    _10
    {
    _10
    redirect {
    _10
    get(path: "/{URL}") {
    _10
    from
    _10
    to
    _10
    }
    _10
    }
    _10
    }

    The expected answer is a JSON object containing all the redirects related to that path. Take the following example:


    _10
    {
    _10
    "data": {
    _10
    "redirect": {
    _10
    "get": {
    _10
    "from": "/about-us",
    _10
    "to": "/my-store"
    _10
    }
    _10
    }
    _10
    }
    _10
    }

  • If the query doesn't return the redirect path

    Access the Admin, go to Storefront > Pages > Redirects, and save the desired URL redirects. For more information, refer to the Managing URL redirects guide.

  • If the query returns the redirect path

    Check if your Store Theme or another app has defined a route with the same path you are attempting to save as a redirect. If the route already exists, the redirect will be ignored.

My store is presenting inconsistencies

Product price is different on Search Results and Product Detail pages

The Search Results and Product Details pages have different indexing processes. This can lead to differences in the price.

  1. Reindex the products presenting inconsistencies.
  2. Check the value set for the Search Result app's simulationBehavior prop. If set to skip, change it to default.

When the simulationBehavior is set to skip, the Search Results page displays the cold price based on the user cache. In order to fetch and display the latest price registered in the catalog, change it to default.

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