Pular para o conteúdo principal

getTemplateByType

Obtendo todos os objetos de template, agrupados por tipos.

Descrição​

Este método recupera todos os objetos de template do tipo especificado. Ele retorna uma Promise que resolve para um array de objetos ITemplateEntity.

Templates.getTemplateByType(

type*, langCode

);

Esquema de parâmetros​

Esquema

type(obrigatório): Tipos
O tipo de templates a serem recuperados. Este parâmetro especifica a categoria ou classificação dos templates solicitados
exemplo: "product"

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

Exemplos​

Exemplo mínimo​

const response = await Templates.getTemplateByType('forCatalogProducts');

Exemplo com atributos​

const response = await Templates.getTemplateByType('forCatalogProducts', 'en_US');

Exemplo de resposta​

[
  {
    "id": 4,
    "attributeSetIdentifier": null,
    "title": "Template",
    "generalTypeId": 4,
    "identifier": "template",
    "version": 0,
    "generalTypeName": "catalog_page",
    "attributeValues": {},
    "position": 1
  }
]

Esquema de resposta​

Esquema: ITemplateEntity[]

id: número
O identificador único da posição.
exemplo: 12345

attributeSetIdentifier: string | null
ID do conjunto de atributos.
exemplo: "attribute_set_1"

title: string
O nome do template.
exemplo: "Template de Produto"

generalTypeId: número
ID da entidade do tipo geral.
exemplo: 67890

identifier: string
O identificador textual para o campo do registro.
exemplo: "template_12345"

version: número
O número da versão do objeto.
exemplo: 1

generalTypeName: Tipos
Nome do tipo geral.
exemplo: "product"

attributeValues: IAttributeValues
Mapa de valores de atributos indexados por marcador; objeto vazio quando não houver.
exemplo:

{
  "id": 1,
  "value": "some"
}

position: número
A posição do objeto.
exemplo: 1