Documentação de Redirect

Visão Geral

O redirect (redirecionamento) é responsável por encaminhar automaticamente uma URL para outro destino dentro ou fora da loja 🔀.

Ele é utilizado principalmente para manter a consistência de acesso, mesmo quando uma URL é alterada, removida ou reorganizada, evitando erros como páginas não encontradas (404).

Os redirects também desempenham um papel importante em SEO, garantindo que a relevância e indexação de páginas antigas sejam preservadas ao direcionar corretamente para novos endereços.

O sistema suporta dois tipos de redirecionamento:

• 301 (Moved Permanently) — redirecionamento permanente 📌
• 302 (Found / Temporary) — redirecionamento temporário ⏳

Entidades Envolvidas

• Redirect (Redirect)
Define a relação entre uma URL de origem e uma URL de destino.
• URL de Origem (Source URL)
Endereço que será acessado inicialmente e redirecionado.
• URL de Destino (Target URL)
Endereço final para onde o usuário será direcionado.
• Política Comercial (Trade Policy)
Define o contexto em que o redirect será aplicado.

Notas e Considerações

• Apenas os códigos 301 e 302 são suportados.
• Redirects são essenciais para evitar erros de navegação e perda de tráfego.
• Devem ser utilizados com cuidado para não gerar loops ou conflitos de redirecionamento ⚠️.
• Alterações impactam diretamente na indexação e SEO da loja ⚙️.

Listagem de redirect de urls existentes

Descrição

Este endpoint é responsável por listar os redirects cadastrados na loja.

A resposta retorna a relação de URLs de origem e seus respectivos destinos, permitindo visualizar quais páginas estão sendo redirecionadas e para onde.

Esse endpoint é utilizado para:

• consultar redirects ativos;
• validar configurações após alterações de URL;
• apoiar auditorias de SEO;
• identificar possíveis conflitos ou redirecionamentos incorretos.

Parâmetros

Headers Obrigatórios

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/products/urls/redirects \
3  --header "Authorization: Bearer userToken" \

✅ Resposta de Sucesso

1{
2  "registers": [
3    {
4      "tradePolicyId": 1,
5      "url": "/produto-maneiro.html",
6      "redirect": true,
7      "redirectCode": 301,
8      "target": "https://suaLoja.com.br/produtoManeiro.html",
9      "createdAt": "2024-07-25 18:15:14",
10      "updatedAt": "2025-09-24 13:57:11"
11    },
12    {
13      "tradePolicyId": 1,
14      "url": "/produto.html",
15      "redirect": true,
16      "redirectCode": 301,
17      "target": "https://suaLoja.com.br/produto-maneiro.html",
18      "createdAt": "2024-08-08 17:50:35",
19      "updatedAt": "2025-09-24 13:57:11"
20    }
21  ],
22  "pagination": {
23    "limit": 10,
24    "offset": 0,
25    "pages": 1,
26    "registers": 2
27  }
28}

Criação de redirect de url

Descrição

Endpoint responsável por criar um redirecionamento para uma URL 🔀.

Atua em contexto administrativo, permitindo que o lojista direcione acessos de uma URL para outra.

Por meio desse endpoint, é possível configurar redirects, garantindo que ao acessar um endereço antigo ou inválido, o usuário seja automaticamente encaminhado para a URL correta.

Essa funcionalidade é essencial para:

• Evitar links quebrados
• Manter a consistência da navegação
• Preservar o SEO da loja

Tipos de redirecionamento suportados: o endpoint aceita apenas os códigos HTTP:

• 301 (Moved Permanently): indica que a URL foi movida de forma permanente 📌
• 302 (Found / Temporary): indica que o redirecionamento é temporário ⏳

A escolha do código impacta diretamente o comportamento de navegadores e buscadores, especialmente em relação a cache e indexação.

Dessa forma, o lojista consegue gerenciar mudanças de URLs de forma segura e estratégica, garantindo uma boa experiência para o usuário e para os mecanismos de busca ⚙️.

Parâmetros

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/products/urls/redirects \
3  --header "Authorization: Bearer userToken" \
4  --data '{
5    "origin": "/tech-brand-smart-phone",
6    "target": "/tech-brand-smartphone",
7    "code": "301",
8    "tradePolicyId":1
9  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "tradePolicyId": 1,
3  "url": "/tech-brand-smart-phone",
4  "redirect": true,
5  "redirectCode": 301,
6  "target": "tech-brand-smartphone",
7  "createdAt": "",
8  "updatedAt": ""
9}

⚠️ Possíveis erros:

1{
2  "status": false,
3  "data": {
4    "code": 400,
5    "errorCode": "UAPPI_STORE_DUPLICATED_URL",
6    "message": "The requested URL was already been used."
7  }
8}

Atualização de urls

Descrição

Este endpoint é responsável por atualizar um redirect existente na loja.

A atualização consiste em configurar um redirect, redirecionando a URL atual para outro endereço.

Essa funcionalidade é utilizada para manter a organização da estrutura de páginas, corrigir endereços ou ajustar redirecionamentos sem a necessidade de excluir e recriar registros.

Parâmetros

Headers Obrigatórios

Parâmetros do Corpo

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/products/urls/redirects \
3  --header "Authorization: Bearer userToken" \
4  --data '{
5    "redirect": true,
6    "url":"tech-brand-product",
7    "code": "302",
8    "target": "tech-brand-smartphone",
9    "active":true,
10    "tradePolicyId":1
11  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "tradePolicyId": 1,
3  "url": "tech-brand-product",
4  "redirect": true,
5  "redirectCode": 302,
6  "target": "tech-brand-smartphone",
7  "createdAt": "2026-03-17 19:34:46",
8  "updatedAt": "2026-03-17 19:37:02"
9}

⚠️ Possíveis erros:

Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.

Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.