Pular para o conteúdo principal

getAttributeSetByMarker

Obtendo um único objeto de conjunto de atributos por marcador.

Descrição

Este método retorna um atributo com dados do conjunto de atributos. Ele retorna uma Promise que resolve para um objeto IAttributeSetsEntity.

AttributesSets.getAttributeSetByMarker(

marker, langCode

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
marcador do objeto do conjunto de atributos
exemplo: "productAttributes"

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

Exemplos

Exemplo mínimo

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

Exemplo com atributos

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

Exemplo de resposta

{
"id": 27,
"updatedDate": "2025-02-26T17:18:11.275Z",
"version": 0,
"identifier": "admins",
"typeId": 1,
"title": "Admins",
"schema": {
"admin-text": {
"id": 1,
"type": "string",
"isPrice": false,
"original": true,
"isVisible": true,
"identifier": "admin-text",
"localizeInfos": {
"title": "Texto dos Admins"
}
}
},
"isVisible": true,
"properties": {},
"type": {
"id": 1,
"type": "forAdmins"
},
"position": 1
}

Esquema de resposta

Esquema: IAttributeSetsEntity

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

updatedDate: string
A data em que o conjunto de atributos foi atualizado pela última vez, representada como uma string.
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 que representa o tipo do conjunto de atributos.
exemplo: 1

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

schema: object
A definição do esquema associada ao conjunto de atributos. Isso pode representar a estrutura ou regras para os dados.
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: object
Propriedades adicionais associadas ao conjunto de atributos, que podem ser de qualquer tipo.
exemplo:

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

type: any
O tipo do conjunto de atributos, que pode ser uma classificação ou categoria específica.
exemplo: "product", "user", "etc"

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