Listar atributos

GET https://.account-name.krzlabs.io/api/v1/attributes

Realiza a listagem de atributos.

---

Request

paginação / link de referência

Entenda como aplicar paginação e ordenação na sua listagem

filtros / link de referência

Entenda como aplicar filtros na sua listagem

expansão / link de referência

Entenda como expandir entidades relacionadas nos documentos da listagem

---

Response

Resposta de sucesso

200

Successfully retrieved API registry entry.

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 de resposta em JSON

{
   "page": 1,
    "skip": 0,
    "limit": 10,
    "sort": {
        "campo": "asc"
    },
    "pages": 5,
    "total": 50,
    "next": true,
    "previous": "2",
    "nextUrl": "https://api.exemplo.com?page=2",
    "previousUrl": false,
    "filters": {
        "status": "ativo"
    },
    "data": [{
        "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"]
    }]
}

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