Templates da Loja

Visão Geral

Os templates são responsáveis por definir a estrutura, layout e comportamento visual da loja 🧩

Eles controlam desde elementos básicos da página (como idioma e meta-tags) até integrações externas, SEO e renderização.

Dentro da plataforma, os templates podem ser configurados, personalizados e atualizados por meio de endpoints administrativos, permitindo que o lojista adapte a loja conforme sua necessidade.

Além disso, é possível trabalhar tanto com:

• Configurações padrão do template
• Configurações customizadas (mais avançadas)

Entidades Envolvidas

Template Representa a estrutura principal da loja, incluindo layout e regras de exibição.

Configurações de Template Conjunto de parâmetros que controlam o comportamento do template, como SEO, integrações, renderização e identidade visual ⚙️

Configurações Customizadas Permitem maior flexibilidade, possibilitando a inserção de HTML, scripts e alterações específicas, como headers e footers.

Integrações Externas Configurações relacionadas a serviços como Google, Meta e autenticação social.

Notas e Considerações

Os templates podem ser gerenciados por meio dos seguintes tipos de operações:

• Listagem de templates → Permite visualizar todos os templates disponíveis da loja
• Detalhamento de template → Retorna informações completas de um template específico
• Listagem de configurações → Exibe todas as configurações disponíveis e aplicadas
• Atualização de configurações → Permite alterar múltiplas configurações padrão
• Configuração customizada → Permite personalizações avançadas com HTML e scripts

Importante: Alterações em templates podem impactar diretamente a experiência do usuário, SEO e integrações da loja, portanto devem ser realizadas com cautela 🚨

Listagem de Templates

Descrição

Endpoint responsável por retornar uma lista de templates disponíveis da loja 🧩.

Atua em contexto administrativo, permitindo que o lojista visualize os templates utilizados para configurações e personalizações da loja.

Por meio desse endpoint, é possível consultar quais templates estão ativos ou disponíveis, facilitando o entendimento da estrutura visual e funcional aplicada.

O que são templates? Templates são estruturas pré-definidas que determinam o layout e a organização dos elementos de uma página, como cores, posicionamento, componentes e estilos 🎨

Essa funcionalidade é útil para:

• Mapear os templates em uso
• Auxiliar na personalização da loja
• Garantir consistência visual entre páginas

Dessa forma, o lojista consegue gerenciar melhor a estrutura de templates, tendo mais controle sobre customizações e ajustes na experiência da loja ⚙️.

Headers Obrigatórios

Campos Disponíveis (fields)

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/template \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2  "registers": [
3    {
4      "id": 1,
5      "group": "tema-base",
6      "code": "area-restrita",
7      "branch": "main",
8      "name": "Area Restrita",
9      "uri": "/restrict-area",
10      "customSetting": [],
11      "createdAt": "2025-06-01 19:00:31",
12      "updatedAt": "2025-07-25 14:30:20",
13      "lastDeployStatus": "finished",
14      "lastDeployDate": "2025-08-28 17:53:04",
15      "salesChannelCount": 1
16    }
17  ],
18  "pagination": {
19    "limit": 10,
20    "offset": 0,
21    "pages": 1,
22    "registers": 10
23  }
24}

Listagem de Configurações de templates

Descrição

Endpoint responsável por retornar uma lista de configurações de templates da loja. Possibilita ao lojista identificar quais as configurações atuais dos templates e quais configs pode adicionar

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Campos de Condição Disponíveis

Campos de Ordenação Disponíveis

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/template/{templateId}/setting \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2  "registers": [
3    {
4      "templateId": 1,
5      "salesChannelId": 1,
6      "code": "seo-title",
7      "type": "string",
8      "value": "My cool store",
9      "createdAt": "2025-07-25 14:55:43",
10      "updatedAt": "2025-09-18 13:23:01"
11    },
12  ],
13  "pagination": {
14    "limit": 10,
15    "offset": 0,
16    "pages": 1,
17    "registers": 10
18  }
19}

Busca detalhes de um template

Descrição

Endpoint responsável por retornar os detalhes completos de um template da loja 🧩.

Atua em contexto administrativo, permitindo que o lojista visualize o estado atual de um template e tenha acesso às suas configurações.

Por meio desse endpoint, é possível consultar informações detalhadas do template, facilitando sua configuração e personalização conforme a necessidade.

Essa funcionalidade é útil para:

• Verificar o estado do template
• Ajustar configurações específicas
• Realizar personalizações com mais controle

Dessa forma, o lojista consegue gerenciar e customizar templates de forma mais precisa, garantindo maior consistência e flexibilidade na loja ⚙️.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/template/{templateId} \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

1{
2  "id": 1,
3  "group": "tema-base",
4  "code": "retrict-area",
5  "branch": "main",
6  "name": "Area Restrita",
7  "uri": "/restrict-area",
8  "customSetting": {
9    "Config1": "<p>Config1</p>",
10    "Config2": "<p>Config2</p>"
11  },
12  "createdAt": "2026-03-12 14:06:47",
13  "updatedAt": "2026-03-12 14:07:39",
14  "lastDeployStatus": null,
15  "lastDeployDate": null,
16  "salesChannelCount": 1
17}

⚠️ Possíveis erros:

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_RENDER_TEMPLATE_NOT_FOUND",
6    "message": "The requested template was not found."
7  }
8}

Atualização de configurações de template

Descrição

Endpoint responsável por atualizar um conjunto de configurações de template da loja 🧩.

Atua em contexto administrativo, permitindo que o lojista configure diversos aspectos essenciais do template de forma centralizada.

Por meio desse endpoint, é possível alterar múltiplas configurações de uma só vez, abrangendo desde estrutura da página até integrações externas e SEO.

Essa funcionalidade permite configurar:

• Estrutura da página HTML (idioma, charset, viewport)
• Modo de manutenção da loja
• Configurações completas de SEO
• Renderização e pré-renderização
• Integrações com Google, Meta e outros serviços
• Meta-tags e rastreamento
• Ícones e identidade visual (favicons)
• Recaptcha e autenticação social
• Regras e funcionalidades adicionais da loja

Dessa forma, o lojista consegue gerenciar configurações críticas do template com mais eficiência, garantindo melhor desempenho, segurança e visibilidade da loja ⚙️.

---

Tabela de configurações disponíveis

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/template/{templateId}/setting/sales-channel/{salesChannelId} \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "settings":[
6      {
7        "code":"in-maintenance",
8        "value": false
9      }
10    ]
11  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1[
2  {
3    "error": null,
4    "code": "in-maintenance",
5    "value": false
6  }
7]

⚠️ 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.

Atualização de configuração customizada de template

Descrição

Endpoint responsável por atualizar uma configuração customizada de template da loja 🧩.

Atua em contexto administrativo, permitindo que o lojista personalize o template com maior flexibilidade, indo além das configurações padrão.

Por meio desse endpoint, é possível inserir e atualizar configurações específicas, incluindo conteúdos e estruturas customizadas no template.

Essa funcionalidade permite:

• Adicionar ou editar tags HTML
• Customizar elementos visuais do template
• Atualizar conteúdos como header e footer
• Adaptar o layout conforme necessidades específicas

Dessa forma, o lojista consegue realizar customizações mais avançadas no template, garantindo uma experiência mais alinhada com a identidade e objetivos da loja ⚙️.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/template/{templateId}/setup \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "salesChannelId": 1,
6    "customSetting":{
7      "desktopHeader":"<header>...</header>",
8      "desktopFooter": "<footer>...</footer>",
9      "mobileFooter": "<footer>...</footer>"
10    }
11  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1[
2  {
3		"storeId": 1,
4		"salesChannelId": 1,
5		"templateId": 1,
6		"testAbKey": "",
7		"customSetting": {
8      "desktopHeader": "<header>...</header>",
9      "desktopFooter": "<footer>...</footer>",
10      "mobileFooter": "<footer>...</footer>"
11		}
12	}
13]

⚠️ 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.