getAttributes
Obter todos os conjuntos de atributos e a contagem total.
Descrição
Resolve para um IAttributesSetsResponse: os conjuntos de atributos e sua contagem total, que você pode usar para paginação. Uma loja on-line, por exemplo, pode ter um conjunto de atributos para roupas (tamanho, cor, material) e outro para eletrônicos.
O conjunto de atributos não inclui os valores dos atributos; eles ficam em entidades específicas, como páginas e produtos. A única exceção é o tipo de atributo
timeInterval, que pode carregar valores quando a opção correspondente está marcada no painel de administração (abre em uma nova aba).
.getAttributes(
,
,
,
,
);
Esquema de parâmetros
Esquema
langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"
offset: number
Número de registros a pular. Padrão: 0. offset + limit não pode ultrapassar 200; uma janela maior é rejeitada com 400.
exemplo: 0
limit: number
Número máximo de registros a retornar. Padrão: 30.
exemplo: 30
typeId: number
ID do tipo de conjunto de atributos para filtrar. Padrão: null.
sortBy: string
Campo de ordenação: id ou position. Padrão: "id".
exemplo: "id"
Limite de registros. Se a permissão do grupo de usuários para este método permitir apenas leitura restrita, a API retorna no máximo o número de registros definido nas configurações do projeto (10 por padrão), seja qual for o limit informado. Com acesso total de leitura, limit funciona normalmente. Veja Module permissions (abre em uma nova aba).
Enquanto esse limite estiver em vigor, a API atualmente ignora offset: toda requisição retorna os primeiros registros novamente.
Exemplos
Exemplo mínimo
const response = await AttributesSets.getAttributes();
Exemplo com todos os parâmetros
const response = await AttributesSets.getAttributes('en_US', 0, 30, null, 'id');
Exemplo de resposta
{
"total": 21,
"items": [
{
"id": 38,
"createdDate": "2026-06-09T06:06:13.667Z",
"updatedDate": "2026-06-09T06:12:00.790Z",
"version": 0,
"identifier": "subscription",
"title": "Subscription",
"schema": {
"price": {
"id": 2,
"type": "integer",
"isPrice": true,
"original": true,
"isVisible": true,
"splitUnit": "percent",
"identifier": "price",
"isCurrency": false,
"splitPrice": false,
"initialValue": null,
"localizeInfos": {
"title": "price"
},
"value": null
},
"currency_products": {
"id": 4,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"splitUnit": false,
"identifier": "currency_products",
"isCurrency": true,
"splitPrice": false,
"validators": {
"defaultValueValidator": {
"customErrorText": "Custom error",
"fieldDefaultValue": "usd",
"fieldDefaultValue2": ""
}
},
"initialValue": null,
"localizeInfos": {
"title": "Currency"
}
}
},
"isVisible": true,
"type": {
"id": 5,
"type": "forProducts"
},
"position": 1
},
{
"id": 33,
"createdDate": "2026-04-22T16:28:05.346Z",
"updatedDate": "2026-04-23T10:57:26.245Z",
"version": 1,
"identifier": "percent_split",
"title": "Percent split",
"schema": {
"s0": {
"id": 1,
"type": "float",
"isPrice": true,
"original": true,
"isVisible": true,
"splitUnit": "percent",
"identifier": "s0",
"splitParts": [
2,
3
],
"splitPrice": true,
"localizeInfos": {
"title": "s0"
},
"value": null
},
"s1": {
"id": 2,
"type": "float",
"isPrice": false,
"original": true,
"isVisible": true,
"splitUnit": false,
"identifier": "s1",
"splitParts": false,
"splitPrice": false,
"localizeInfos": {
"title": "s1"
},
"value": null
},
"s2": {
"id": 3,
"type": "float",
"isPrice": false,
"original": true,
"isVisible": true,
"splitUnit": false,
"identifier": "s2",
"splitParts": false,
"localizeInfos": {
"title": "s2"
},
"value": null
},
"currency": {
"id": 4,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"splitUnit": false,
"identifier": "currency",
"isCurrency": true,
"validators": {
"defaultValueValidator": {
"fieldDefaultValue": "usd",
"fieldDefaultValue2": ""
}
},
"localizeInfos": {
"title": "currency"
}
}
},
"isVisible": true,
"type": {
"id": 5,
"type": "forProducts"
},
"position": 2
},
{
"id": 31,
"createdDate": "2026-03-14T14:53:28.721Z",
"updatedDate": "2026-03-14T14:53:52.760Z",
"version": 0,
"identifier": "discounts",
"title": "Discounts",
"schema": {
"example_discount": {
"id": 1,
"type": "string",
"original": true,
"isVisible": true,
"identifier": "example_discount",
"localizeInfos": {
"title": "example_discount"
}
}
},
"isVisible": true,
"type": {
"id": 11,
"type": "forDiscounts"
},
"position": 3
}
]
}
Esquema de resposta
Esquema: IAttributesSetsResponse
total: number
Número total de conjuntos de atributos.
exemplo: 100
items: IAttributeSetsEntity[]
Conjuntos de atributos nesta resposta.
exemplo:
[
{
"id": 1,
"identifier": "set1"
},
{
"id": 2,
"identifier": "set2"
}
]
items.id: number
ID do conjunto de atributos.
exemplo: 123
items.createdDate: string
Data de criação do conjunto de atributos.
exemplo: "2023-10-01T12:00:00Z"
items.updatedDate: string
Data da última atualização do conjunto de atributos.
exemplo: "2023-10-01T12:00:00Z"
items.version: number
Número da versão do conjunto de atributos; muda a cada atualização.
exemplo: 1
items.identifier: string
Marcador do conjunto de atributos.
exemplo: "attributeSet1"
items.title: string
Nome do conjunto de atributos.
exemplo: "Atributos do Produto"
items.schema: Record<string, IAttributeSchemaItem>
Campos do esquema indexados por marcador.
exemplo:
{
"attribute1": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"identifier": "string",
"localizeInfos": {
"en_US": {
"title": "String"
}
}
}
}
items.isVisible: boolean
Se o conjunto de atributos está visível.
exemplo: true
items.type: string
Tipo do conjunto de atributos.
example: "product"
items.position: number
Índice do conjunto na resposta, a partir de 1 (1 para um único conjunto).
exemplo: 1