Using redirects

Create a redirect

To create a redirect, follow these steps:

1. From the Studio home page or from the left navigation menu, go to Redirects.

2. Click Add redirect: the Create new redirect dialog opens.

   

3. In the Redirect from field, enter the URL of the page or the path of the page folder to redirect from.

   The path of the page folder must start with / (for example, /sale-2021).
   Enter the path of a deleted page folder. Do not use the path of an existing page folder.

4. If necessary, in the Source query field, enter query parameters for the source path you entered in the Redirect from field. Enter the parameters with the query=foo&otherQuery=bar pattern.
   For example, if you enter category=women&brand=thebrand as query parameters and the source path is /sale-2021, the redirect will be set for /sale-2021?category=women&brand=thebrand.

5. From the Status code drop-down, select the HTTP status code for the redirect.

6. From the Type drop-down, select the type of redirect. Depending on the type of redirect, the next field changes.

7. Do one of the following:

   • In the Link field, enter the internal link to the dynamic page or the URL of the external page to redirect to.

     The internal link must start with / (for example, /sales).
     The URL must start with the protocol (for example, https://example.com/page/to-redirect-to).

   • From the Target page folder drop-down, select the page folder in the Site builder to redirect to.

8. Click Save: the redirect is displayed in the redirect list.

Edit a redirect

To edit the settings of a redirect, follow these steps:

1. In the Redirects area, search for the redirect in the list.

2. Hold the pointer over the redirect and click the Edit icon.

   

3. Apply the changes, then click Save. In the redirect list, the redirect is saved with Reason set to Edited.

Delete a redirect

To delete a redirect, follow these steps:

1. In the Redirects area, search for the redirect in the list.

2. Do one of the following:

   • Hold the pointer over the redirect and click the Delete icon.
   • Select the redirect's checkbox, then click Delete. To delete more than one redirect, you can select multiple checkboxes at a time.

3. In the Delete redirect? dialog, click Delete.

Search redirects

To search a redirect, use the search box in the Redirects area. In the search box, enter your search text starting with a /. For example, /sale-2021.

Add bulk redirects

When moving to commercetools Frontend from other tools, it is possible to add bulk redirects to your project by uploading a CSV file.

To upload the CSV file, follow these steps:

1. From the Studio home page or from the left navigation menu, go to Redirects.

2. Click Bulk upload: the Bulk upload redirects dialog opens.

3. Click Add .CSV file and select the file to upload.

4. Click Validate and upload redirects. If the file meets the CSV file requirements, the redirects will be added to your commercetools Frontend project with the type Migration.
   Otherwise, an error message will appear prompting you to fix the problem encountered.

CSV file requirements

The CSV file must include the source path and the target path in the following format:

/page/to/redirect-from;https://example.com/page/to/redirect-to

For example, /perfume?brand=perfume%20brand;https://yourwebsite.com/perfume/perfume-brand.

The CSV file must meet the following requirements:

• The file must contain up to 500 lines.
• The file must contain only redirects. For example, do not include a row header.
• The file must use UTF-8 encoding.
• Paths must start with /.
• The delimiter character must be ;.
• If needed, the enclosure character must be " and the escape character must be \.