Criar grupo de atributos

POST https://.account-name.krzlabs.io/api/v1/attribute-groups

Realiza a criação de um grupo de atributos.


Body Params

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"]
}

Responses

Resposta de sucesso

200
Successfully retrieved API registry entry.
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

Resposta de erro

400
Bad Request
Field Type Description
code Number Código da resposta http
kind String Tipo de mensagem
name String Nome da exceção lançada pela plataforma
title String Titulo do erro lançado pela plataforma
message String Mensagem indicando o probloma ocorrido
solution String Mensagem indicando uma possível solução para o problema

Copyright © 2025 kruzer | All Rights Reserved