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.

.getAttributeSetByMarker(

,

);

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,
  "createdDate": "2025-10-28T13:50:27.426Z",
  "updatedDate": "2025-02-26T17:18:11.275Z",
  "version": 0,
  "identifier": "admins",
  "title": "Admins",
  "schema": {
    "admin-text": {
      "id": 1,
      "type": "string",
      "original": true,
      "isVisible": true,
      "identifier": "admin-text",
      "initialValue": null,
      "localizeInfos": {
        "title": "Admins text"
      }
    }
  },
  "isVisible": true,
  "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

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"

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

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