Menu
Feedback
Start here
Tutorials


Tutorials
Explore in-depth tutorials for operating your VTEX store.
Tutorials
Storefront
Layout
URL Mapping (301 Redirect)

This tutorial is for stores using Legacy CMS Portal. For other stores, the configuration is made in Pages. Please refer to Managing URL redirects for more information.

URL mapping is used to redirect specific URLs to other URLs. This feature is useful when a store already has URLs indexed in search engines and wants to redirect them to more attractive ones without changing the SEO and avoiding indexing errors.

All mapping activities recorded will be executed according to 301 redirects. The 301 redirect, also known as “permanent redirect,” transfers all key data from the original URL (Page Rank, Link Popularity, etc.) to the new URL.

There are two ways to add and change URL mapping:

Manually

  1. In the VTEX Admin, access Storefront > Layout

  2. Click on the CMS folder to open the directory.

  3. Click on the URL Builder folder.

  4. Click on the Add button to add a new mapping or the Update button to edit an existing one.

  5. Fill in the URL Builder fields.

  6. Save by clicking on Save URL.

URL Builder fields

  • Url from: URL that will be redirected. This URL must not contain the domain. Required field.
  • Url to: URL to which the navigation will be redirected. This URL must not contain the domain. Required field.
  • Start date: date and time when the mapping will start to be considered. Required field.
  • Start date: date and time when the mapping will no longer be considered.
  • Active: indicates if the mapping option is active or inactive.

To map a URL to home (root directory), fill in the Url to field with a slash /.

Via spreadsheet

  1. In the VTEX Admin, access Storefront > Layout
  2. Click on the CMS folder to open the directory.
  3. Click on the URL Builder folder.
  4. Click on Import to import the spreadsheet.
  5. Download the spreadsheet template illustrated below by clicking on Export.
    {"base64":"  ","img":{"width":921,"height":254,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":16474,"url":"https://raw.githubusercontent.com/vtexdocs/help-center-content/refs/heads/main/docs/en/tutorials/Storefront/Layout/url-mapping-301-redirect_1.png"}}
  6. Fill in the spreadsheet fields.
  7. After populating the spreadsheet template, click on the Localize button on the import page to upload the template.
  8. Select the file you want to upload. The filename extension must be .xls in the format Excel 97-2003 Workbook.
  9. Click on the Save file button to finish. A message will be displayed informing the number of URLs added.

Spreadsheet fields

  • Url from: URL that will be redirected. This URL must not contain the store’s domain. Example: /path_on_my_old_website.html.
  • Url to: URL to which the navigation will be redirected. This URL must not contain the store’s domain. Example: /path_on_my_old_website.html.
  • Active: indicates if the mapping option is active or inactive. Set 1 to enable and 0 to disable.
  • Start date: date when the mapping will start to be considered. The date format must be dd/mm/yyyy.
  • End date: date when the mapping will no longer be considered. The date format must be dd/mm/yyyy.
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
Was this helpful?
Yes
No
Suggest Edits (GitHub)
What are shelves?
« Previous
Creating and editing a page template
Next »
Contributors
2
Photo of the contributor
Photo of the contributor
+ 2 contributors
On this page
Still got questions?
Ask the community
Find solutions and share ideas in the VTEX community.
Join our community
Request support from VTEX
For personalized assistance, contact our experts.
Open a support ticket
GithubDeveloper portalCommunityFeedback