Documentação de Marcas

Visão Geral

Uma marca é, essencialmente, uma empresa que se apresenta ao mercado por meio de sua identidade, cultura e posicionamento 🏷️.

Ela é construída a partir de elementos como imagem, comunicação, proposta de valor e características percebidas nos seus produtos.

No contexto de e-commerce, a marca vai muito além de apenas indicar quem é o fabricante.

Ela atua como elemento estratégico de organização, segmentação e fortalecimento comercial dentro da loja.

As marcas podem possuir páginas próprias, descrições institucionais, identidade visual personalizada e até comportamentos distintos conforme a política comercial aplicada.

Além disso, exercem papel importante em filtros de navegação, estratégias de SEO, campanhas promocionais e ações de merchandising, contribuindo diretamente para a experiência do usuário e para o desempenho comercial 🚀.

Entidades Envolvidas

A principal entidade relacionada a uma marca são os produtos, pois são eles que materializam sua proposta de valor.

Uma marca pode estar vinculada a diversos produtos, permitindo agrupamento estratégico, organização do catálogo e fortalecimento da identidade comercial dentro da plataforma.

A marca também pode se relacionar com políticas comerciais, regras de exibição e configurações específicas, influenciando diretamente como seus produtos são apresentados ao consumidor.

Atualização de imagem da marca

Descrição

Endpoint responsável por cadastrar a imagem vinculada a uma marca da loja 🖼️.

Permite que o lojista adicione uma imagem à marca cadastrada, mantendo as informações visuais sempre atualizadas.

Dessa forma, a gestão das marcas permanece organizada e alinhada à estratégia da loja.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/products/brands/{brandId}/image \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --form 'image=@brand.jpg'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "logo": "/upload/stores/brand/987654321987654321987654321.webp",
3  "originalLogo": "/upload/stores/brand/987654321987654321987654321.png"
4}

⚠️ Erro retornado:

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_STORE_BRAND_NOT_FOUND",
6    "message": "The requested brand was no found"
7  }
8}

Exclusão de imagem da marca

Descrição

Endpoint responsável por remover a imagem vinculada a uma marca da loja 🖼️.

Permite que o lojista realize a exclusão da imagem cadastrada, mantendo as informações visuais sempre atualizadas.

Esse recurso é útil quando há necessidade de corrigir, substituir ou padronizar a identidade visual da marca.

Dessa forma, a gestão das marcas permanece organizada e alinhada à estratégia da loja.

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/products/brands/{brandId}/image \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

HTTP Status: 200 OK

1true

⚠️ Erro retornado:

1{
2  "status": false,
3  "data": {
4    "code": 404,
5    "errorCode": "UAPPI_STORE_BRAND_NOT_FOUND",
6    "message": "The requested brand was no found"
7  }
8}