Documentação de Valores de Atributos

Visão Geral

Os valores de atributos representam as opções disponíveis dentro de um atributo de produto 🧩.

Enquanto o atributo define a característica (ex.: Cor, Tamanho), os valores definem quais variações podem ser escolhidas (ex.: Preto, Branco, Azul).

Esses valores são fundamentais para a criação de variações de produtos, permitindo que o cliente selecione diferentes combinações antes de realizar a compra.

No contexto administrativo, os valores são cadastrados e organizados pelo lojista, podendo também receber imagens associadas, especialmente em casos onde a representação visual é importante (como cores ou texturas).

Além disso, os valores podem ser ordenados manualmente, influenciando diretamente na forma como são exibidos na loja.

Entidades Envolvidas

Valor do Atributo (Attribute Value)

Atributo (Attribute)

Produto (Product)

variações disponíveis para compra

Mídia de Valor de Atributo

imagens aos valores

Notas e Considerações

Valores de atributos são essenciais para a geração de variações de produtos.
A ordenação dos valores impacta diretamente na experiência do usuário.
Nem todo valor precisa possuir imagem, sendo isso opcional e configurável.
A exclusão de valores deve ser feita com cuidado, pois pode impactar produtos já configurados ⚠️.

Cadastro de valores de atributos

POST /products/attributes/{attributeId}/values

Permite que o lojista defina valores para um atributo já cadastrado

Descrição

Endpoint responsável por permitir que o lojista defina valores para um atributo já cadastrado 🧩.

Atua em contexto administrativo, possibilitando a criação de opções que serão utilizadas nas variações de produtos.

Por meio desse endpoint, é possível cadastrar valores associados a um atributo, que posteriormente poderão ser vinculados aos produtos.

Esses valores permitem gerar variações de um mesmo produto, oferecendo diferentes opções de escolha para o cliente final.

Dessa forma, o lojista consegue enriquecer o catálogo e melhorar a experiência de compra, permitindo combinações como tamanho, cor e outras características ⚙️.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
attributeId	integer	Sim	Identificador do atributo a receber novos valores

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
values	array	✅	Lista de valores de atributos a serem cadastrados
values.*.label	✅	Texto de exibição do valor
values.*.order	✅	Ordem de exibição do valor
values.*.color	❌	Cor definida para o valor

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/products/attributes/{attributeId}/values \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "values": [
6      {
7        "label": "P",
8        "color": null,
9        "order": 1
10      },
11      {
12        "label": "M",
13        "color": null,
14        "order": 2
15      },
16      {
17        "label": "G",
18        "color": null,
19        "order": 3
20      }
21    ]
22  }'
curl --request POST \
  --url {{MAIN_URL}}/products/attributes/{attributeId}/values \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "values": [
      {
        "label": "P",
        "color": null,
        "order": 1
      },
      {
        "label": "M",
        "color": null,
        "order": 2
      },
      {
        "label": "G",
        "color": null,
        "order": 3
      }
    ]
  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  [
3		{
4			"id": 1,
5			"label": "P",
6			"image": null,
7			"originalImage": null,
8			"color": null,
9			"order": 1
10		},
11		{
12			"id": 2,
13			"label": "M",
14			"image": null,
15			"originalImage": null,
16			"color": null,
17			"order": 2
18		},
19		{
20			"id": 3,
21			"label": "G",
22			"image": null,
23			"originalImage": null,
24			"color": null,
25			"order": 3
26		}
27	]
28}
{
  [
		{
			"id": 1,
			"label": "P",
			"image": null,
			"originalImage": null,
			"color": null,
			"order": 1
		},
		{
			"id": 2,
			"label": "M",
			"image": null,
			"originalImage": null,
			"color": null,
			"order": 2
		},
		{
			"id": 3,
			"label": "G",
			"image": null,
			"originalImage": null,
			"color": null,
			"order": 3
		}
	]
}

⚠️ Possíveis erros:

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

Atualização de valores de atributos

PUT /products/attributes/values/{attributeValueId}

Permite que o lojista atualize valores já cadastrados de atributos de produto

Descrição

Endpoint responsável por permitir que o lojista atualize valores já cadastrados de atributos de produto 🧩.

Atua em contexto administrativo, possibilitando a edição das informações relacionadas aos valores dos atributos.

Por meio desse endpoint, é possível alterar dados já cadastrados, como nome, ordem de exibição e outras configurações associadas ao valor.

Dessa forma, o lojista consegue manter os valores dos atributos atualizados e organizados, garantindo consistência nas variações e nas opções disponíveis para os produtos ⚙️.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
attributeValueId	integer	Sim	Identificador do valor de atributo a ser atualizado

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório
label	✅	Texto de exibição do valor
order	✅	Ordem de exibição do valor
color	❌	Cor definida para o valor

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/products/attributes/values/{attributeValueId} \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "label": "P",
6    "color": null,
7    "order": 1
8  }'
curl --request PUT \
  --url {{MAIN_URL}}/products/attributes/values/{attributeValueId} \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "label": "P",
    "color": null,
    "order": 1
  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "id": 1,
3  "label": "P",
4  "image": null,
5  "originalImage": null,
6  "color": "#ffa",
7  "order": 5
8}
{
  "id": 1,
  "label": "P",
  "image": null,
  "originalImage": null,
  "color": "#ffa",
  "order": 5
}

⚠️ Possíveis erros:

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

Atualizar imagem de valor de atributo

POST /products/attributes/values/{attributeValueId}/image

Permite atualizar imagem de um valor de atributo

Descrição

Endpoint responsável por realizar o upload de uma imagem para um valor de atributo 🖼️.

Atua em contexto administrativo, permitindo associar representações visuais aos valores de atributos.

Por meio desse endpoint, a imagem deve ser enviada no corpo da requisição.

Essa funcionalidade permite enriquecer visualmente os atributos, sendo especialmente útil em cenários como cores, texturas e variações visuais de produtos.

Dessa forma, o lojista consegue tornar a experiência de navegação mais intuitiva e atrativa, facilitando a escolha do cliente final ⚙️.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	multipart/form-data	Tipo do conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
attributeValueId	integer	Sim	Identificador do valor de atributo a receber imagem

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
`image`	file	✅	Imagem a ser enviada para o valor de atributo

Exemplo de Requisição

1curl --request POST \
2  --url {{MAIN_URL}}/products/attributes/values/{attributeValueId}/image \
3  --header "Authorization: Bearer userToken" \
4  --form 'image=@imagem.png' \
curl --request POST \
  --url {{MAIN_URL}}/products/attributes/values/{attributeValueId}/image \
  --header "Authorization: Bearer userToken" \
  --form 'image=@imagem.png' \

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  "id": 1,
3  "label": "Pequeno largo(SW)",
4  "image": "/upload/stores/1/upload/attribute-value/987654321987654321987654320.webp",
5  "originalImage": "/upload/stores/1/upload/attribute-value/987654321987654321987654320.png",
6  "color": null,
7  "order": 0
8}
{
  "id": 1,
  "label": "Pequeno largo(SW)",
  "image": "/upload/stores/1/upload/attribute-value/987654321987654321987654320.webp",
  "originalImage": "/upload/stores/1/upload/attribute-value/987654321987654321987654320.png",
  "color": null,
  "order": 0
}

⚠️ Possíveis erros:

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

Atualização da ordem dos valores de atributos

PUT /products/attributes/{attributeId}/values/order

Permite reordernar os valores de um atributo cadastrado

Descrição

Endpoint responsável por permitir que o lojista organize a ordem de exibição dos valores de um atributo 🔄.

Atua em contexto administrativo, possibilitando o controle de como os valores serão apresentados na interface da loja.

Por meio desse endpoint, é possível definir a ordem de exibição dos valores, garantindo uma organização mais estratégica para navegação e seleção.

Dessa forma, o lojista consegue priorizar valores mais relevantes ou utilizados, melhorando a experiência do usuário ao interagir com variações de produtos ⚙️.

⚠️ Importante: a ordenação é definida pela posição dos IDs no array enviado na requisição.

Exemplo: considerando os valores de atributo com IDs 1, 2 e 3.

Se a requisição enviar:

1{
2  "ids": [3, 1, 2]
3}
{
  "ids": [3, 1, 2]
}

A ordem de exibição será:

Valor 3

Valor 1

Valor 2

Ou seja, a posição de cada ID dentro do array determina sua ordem final de exibição 📌.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
attributeId	integer	Sim	Identificador do atributo cujo os valores devem ser reordenados

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
ids	array		Lista de ids dos valores de atributos que devem ser reordenados
ids.*	integer		Identificador do valor de atributo que deve ser reordenado

Exemplo de Requisição

1curl --request PUT \
2  --url {{MAIN_URL}}/products/attributes/{attributeId}/values/order \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "ids": [
6      1, 2, 3
7    ]
8  }'
curl --request PUT \
  --url {{MAIN_URL}}/products/attributes/{attributeId}/values/order \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "ids": [
      1, 2, 3
    ]
  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1true
true

⚠️ Possíveis erros:

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

Exclusão de valore de atributos

DELETE /Exclusão de valore de atributos

Permite o lojista excluir valores de atributos

Descrição

Endpoint responsável por permitir que o lojista remova valores de atributos cadastrados na loja 🗑️.

Atua em contexto administrativo, possibilitando a exclusão de valores que não são mais necessários para os atributos.

Por meio desse endpoint, é possível remover valores indesejados ou obsoletos, ajudando a manter a organização e a consistência das variações de produtos.

Dessa forma, o lojista consegue manter os atributos sempre atualizados, evitando opções que não serão mais utilizadas no catálogo ⚙️.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros do Corpo

Parâmetro	Tipo	Obrigatório	Descrição
ids	array	✅	Lista dos ids de valores de atributos que devem ser removidos
ids.*	integer	✅	Identificador do valor de atributo que deve ser excluído

Exemplo de Requisição

1curl --request DELETE \
2  --url {{MAIN_URL}}/products/attributes/values \
3  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
4  --data '{
5    "ids": [
6      1, 2, 3
7    ]
8  }'
curl --request DELETE \
  --url {{MAIN_URL}}/products/attributes/values \
  --header "Authorization: Bearer SEU_TOKEN_AQUI" \
  --data '{
    "ids": [
      1, 2, 3
    ]
  }'

✅ Resposta de Sucesso

HTTP Status: 200 OK

1{
2  [
3		{
4			"attributeValueId": 1,
5			"errorCode": null,
6			"errorMessage": null
7		},
8		{
9			"attributeValueId": 2,
10			"errorCode": null,
11			"errorMessage": null
12		}
13	]
14}
{
  [
		{
			"attributeValueId": 1,
			"errorCode": null,
			"errorMessage": null
		},
		{
			"attributeValueId": 2,
			"errorCode": null,
			"errorMessage": null
		}
	]
}

⚠️ Possíveis erros:

1{
2  "status": false,
3  "data": {
4    "code": 400,
5    "errorCode": "UAPPI_STORE_ATTRIBUTE_HAS_PRODUCT_LINK",
6    "message": "The requested attribute is linked to a product."
7  }
8}
{
  "status": false,
  "data": {
    "code": 400,
    "errorCode": "UAPPI_STORE_ATTRIBUTE_HAS_PRODUCT_LINK",
    "message": "The requested attribute is linked to a product."
  }
}

Exclusão da imagem de valores de atributos

DELETE /products/attributes/values/{attributeValueId}/image

Permite excluir imagem de valores de atributos

Descrição

Endpoint responsável por permitir que o lojista exclua imagens associadas aos valores de atributos 🗑️.

Atua em contexto administrativo, possibilitando a remoção de representações visuais vinculadas aos valores.

Por meio desse endpoint, é possível excluir imagens previamente cadastradas, permitindo ajustes ou correções na apresentação dos atributos.

Dessa forma, o lojista consegue manter as representações visuais atualizadas e consistentes, garantindo uma melhor experiência na navegação e seleção de variações de produtos ⚙️.

Parâmetros

Headers Obrigatórios

Header	Valor	Descrição
`Content-Type`	application/json	Tipo de conteúdo
`Authorization`	Bearer {userToken}	Token de autenticação

Parâmetros da URL

Parâmetro	Tipo	Obrigatório	Descrição
attributeValueId	integer	Sim	Identificador do valor de atributo a excluir a imagem

Exemplo de Requisição

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

✅ Resposta de Sucesso

HTTP Status: 200 OK

1true
true

⚠️ Possíveis erros:

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

Começando

Store Theme

Customização de Interface

Consumo de Dados

Tracking e SEO

Checkout

Consumo de Dados

Tracking e SEO

Ambiente de Pagamento

Área Restrita (Minha Conta)

Consumo de Dados

Tracking e SEO

SDK Público (public-sdk)

Modules

Api

Tracking

API Pública

Área Restrita (Minha Conta)

Carrinho de Compras

API Privada

Apps

Configurações Gerais

Clientes

Template

Avaliações

Notificações

ERPs

Filas

Grupo de Pedidos

Pedidos

Carrinhos

Pagamentos

Anti-Fraude

Produtos

Inteligência Artificial

Marcas

Categorias

Filtros

Atributos

Url

Relatórios

Render

Fretes

Usuários

Promocionais

Marketplace

Third Party

Datalogic

Busca

MCP

Documentação de Valores de Atributos

Visão Geral

Entidades Envolvidas

Notas e Considerações

Cadastro de valores de atributos

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Atualização de valores de atributos

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

✅ Resposta de Sucesso

⚠️ Possíveis erros:

Atualizar imagem de valor de atributo

Descrição

Parâmetros

Headers Obrigatórios

Parâmetros da URL

Parâmetros do Corpo

Exemplo de Requisição

✅ Resposta de Sucesso