Pular para o conteúdo principal

getAttributesByMarker

Obtendo todos os atributos com dados do conjunto de atributos.

Descrição

Este método retorna todos os atributos com dados do conjunto de atributos. Ele retorna uma Promise que resolve para um array de objetos IAttributeSetsEntity.

AttributesSets.getAttributesByMarker(

marker*, langCode

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
Marcador de atributo
exemplo: "productAttributes"

langCode: string
Código do idioma. Padrão: "en_US"
exemplo: "en_US"

Exemplos

Exemplo mínimo

const response = await AttributesSets.getAttributesByMarker('my-marker');

Exemplo com atributos

const response = await AttributesSets.getAttributesByMarker('my-marker', 'en_US');

Exemplo de resposta

[
{
"type": "string",
"value": {},
"marker": "admin-text",
"position": 1,
"listTitles": [],
"validators": {},
"initialValue": null,
"localizeInfos": {
"title": "Admins text"
},
"additionalFields": {}
}
]

Esquema de resposta

Esquema: IAttributeSetsEntity[]

id: number
O identificador único da entidade do conjunto de atributos.
exemplo: 123

createdDate: string
A data em que o conjunto de atributos foi criado.
exemplo: "2023-10-01T12:00:00Z"

updatedDate: string
A data em que o conjunto de atributos foi atualizado pela última vez.
exemplo: "2023-10-01T12:00:00Z"

version: number
O número da versão do conjunto de atributos, usado para rastrear alterações ou atualizações.
exemplo: 1

identifier: string
Uma string que identifica exclusivamente o conjunto de atributos.
exemplo: "attributeSet1"

typeId: number
O identificador numérico representando o tipo do conjunto de atributos.
exemplo: 1

title: string
O título ou nome do conjunto de atributos.
exemplo: "Atributos do Produto"

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

isVisible: boolean
Indica se o conjunto de atributos é visível ou não.
exemplo: true

properties: Record<string, unknown>
Propriedades adicionais associadas ao conjunto de atributos; objeto vazio quando não houver.
exemplo:

{
"color": "red",
"size": "M"
}

type: string
O tipo do conjunto de atributos, que pode ser uma classificação ou categoria específica.
exemplo: "produto", "usuário", "etc"

position: number
O número da posição para ordenar o conjunto de atributos.
exemplo: 1