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.

Busca de exemplo de planilha para marca

Descrição

Endpoint responsável por retornar um exemplo de planilha de marcas para uso em importação 📄.

O arquivo disponibilizado contém o cabeçalho com todos os campos permitidos, incluindo campos obrigatórios e opcionais, servindo como referência oficial para o preenchimento correto.

Esse modelo pode ser utilizado como base para estruturar e validar os dados antes do envio, garantindo maior conformidade com as regras da importação ✅.

Ao utilizar essa planilha como padrão, você reduz erros de formatação e evita inconsistências no processamento.

Parâmetros

Headers Obrigatórios

Exemplo de Requisição

1curl --request GET \
2  --url {{MAIN_URL}}/products/brands/import/example \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \

✅ Resposta de Sucesso

HTTP Status: 200 OK

Content-Type: application/octet-stream

Content-Disposition: attachment; filename="brand-example.csv"

O arquivo retornado contém o seguinte cabeçalho:

1Name,Code,Logo,Active,Uri,Short description,Video url,Search description,Seo title,Seo keywords,Seo canonical,Seo social title,Seo twitter image url,Seo graph image url,Seo google category id,Seo index on google,Seo google condition,Seo google age group,Seo google gender

Descrição das Colunas

⚠️ Possíveis erros:

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

Importação de marcas por planilha

Descrição

Endpoint responsável por permitir que o lojista importe marcas para sua loja por meio de planilhas 📄.

O lojista pode consultar previamente os campos válidos no contexto V3, garantindo que a estrutura esteja adequada ao novo padrão de importação.

Com base nisso, é possível adaptar e organizar a planilha corretamente, evitando inconsistências no processamento.

Para realizar a importação, basta informar a planilha, a política comercial e o parâmetro replaceData, que definirá o comportamento da atualização das marcas no sistema ⚙️.

Parâmetros

Headers Obrigatórios

Parâmetros do Corpo (multipart/form-data)

Estrutura do Arquivo CSV

O arquivo CSV deve conter as seguintes colunas:

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/products/brands/import \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --header 'Content-Type: multipart/form-data' \
5  --form 'file=@brands.csv' \
6  --form 'tradePolicyId=1' \
7  --form 'replaceData=false'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "maps": [
3    1,
4    2,
5    3
6  ],
7  "entities": [
8    {
9      "id": 1,
10      "externalId": "654321",
11      "error": null,
12      "name":"Zike",
13      "active": true
14    },
15    {
16      "id": 2,
17      "externalId": "654322",
18      "error": null,
19      "name":"Adibas",
20      "active": true
21    },
22    {
23      "id": 3,
24      "externalId": "654323",
25      "error": null,
26      "name":"Pumao",
27      "active": true
28    }
29  ]
30}

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