Atributos Gerais

Atributos são, resumidamente, características ou propriedades que serão relacionadas ao seu produto ou serviço.

Atributes-fields

Field Type Description optional Searchable
groups Array(Object) Lista de grupos de atributos.
A lista de grupos de atributos é um array de objetos, contendo as seguintes propriedades:
'_id' - ID do grupo de atributos. - ObjectId
'required' - Indica se o grupo de atributos é obrigatório. - Boolean
not required false
categories Array(Object) Lista de categorias de atributos.
A lista de categorias de atributos é um array de objetos, contendo as seguintes propriedades:
'_id' - ID da categoria de atributos. - ObjectId
'required' - Indica se a categoria de atributos é obrigatória. - Boolean
not required false
key (unique) String Chave do atributo. required false
name Translate Nome do atributo. not required true
description Translate Descrição do atributo. not required true
type enum Tipos de atributos. not required false
type_config
Object Configuração do tipo do atributo.
O type config varia dependendo do type.
not required false
unique boolean Indica se o atributo é único. not required false
required boolean Indica se o atributo é obrigatório. not required false
sequence number Sequência do atributo. not required false
association enum Tipo de associação do atributo.
existem tres tipos de associação:
"sku"= "sku",
"product" = "product",
"product_and_sku" = "product_and_sku".
required false
enabled boolean Indica se o atributo está habilitado. not required false
protected_by_lgpd boolean Indica se o atributo está protegido pela LGPD. required false
tags Array(string) Tags associadas ao atributo. not required false
Exemplo em JSON
{
  "groups": [
    {
      "_id": "64f1a7b9c9d1a23b4f9e1234",
      "required": true
    }
  ],
  "categories": [
    {
      "_id": "64f1a7b9c9d1a23b4f9e5678",
      "required": false
    }
  ],
  "key": "attribute_code",
  "name": {
    "pt": "Nome do Atributo",
    "en": "Attribute Name"
  },
  "description": {
    "pt": "Descrição do atributo",
    "en": "Attribute description"
  },
  "type": "NUMERIC",
  "type_config": {
    "min": 0,
    "max": 100,
    "type": "INTEGER",
    "enable_ia_generation": true,
    "prompt_ia_instruction": "Gerar valores entre 0 e 100"
  },
  "unique": false,
  "required": true,
  "sequence": 1,
  "association": "PRODUCT",
  "enabled": true,
  "protected_by_lgpd": false,
  "tags": ["tamanho", "medida", "peso"]
}

Atributes-groups

Field Type Description optional Searchable
category_id ObjectId ID da categoria de atributos. not required false
key (unique) String Chave do grupo de atributos. required false
name Translate Nome do grupo de atributos. required true
description Translate Descrição do grupo de atributos. not required false
sequence number Sequência do grupo de atributos. not required false
enabled boolean Indica se o grupo de atributos está habilitado. not required false
users_groups Array(Object) Lista de usuários que podem acessar o grupo de atributos.
users_groups requer duas keys:
'_id' - ID do usuário. - Required - ObjectId
'not_allowed_users' - Indica se o usuário pode acessar o grupo de atributos. - Required - Array(String).
not required false
tags Array(String) Lista de tags associadas ao grupo de atributos. not required false
Exemplo em JSON
{
  "category_id": "64f1a7b9c9d1a23b4f9e1234",
  "key": "grupo_cores",
  "name": {
    "pt": "Grupo de Cores",
    "en": "Colors Group"
  },
  "description": {
    "pt": "Grupo de atributos relacionado às cores disponíveis do produto",
    "en": "Attribute group related to product colors"
  },
  "sequence": 1,
  "enabled": true,
  "users_groups": [
    {
      "_id": "64f1a7b9c9d1a23b4f9e5678",
      "not_allowed_users": ["user_123", "user_456"]
    }
  ],
  "tags": ["cores", "variação", "visual"]
}

Atributes-options

Field Type Description Optional Searchable
value string Valor da opção required false
label Translate Rótulo traduzível da opção required true
sequence number Ordem de exibição da opção not required false
enabled boolean Define se a opção está habilitada not required false
tags Array(string) Tags associadas à opção not required false
fields Array(ObjectId) Campos associados à opção not required false
Exemplo em JSON
{
  "value": "blue",
  "label": {
    "pt": "Azul",
    "en": "Blue"
  },
  "sequence": 1,
  "enabled": true,
  "tags": ["cor", "roupa", "primavera"],
  "fields": ["64f1a7b9c9d1a23b4f9e1234", "64f1a7b9c9d1a23b4f9e5678"]
}

Copyright © 2025 kruzer | All Rights Reserved