Pular para o conteúdo principal

getTemplateByMarker

Obter um único template pelo seu marcador.

Descrição​

Busca um modelo pelo marcador e resolve para um ITemplateEntity. Se nenhum modelo tiver esse marcador, resolve para um IError com statusCode: 404.

.getTemplateByMarker(

,

);

Esquema de parâmetros​

Esquema

marker(obrigatório): string
Marcador do template a buscar.
exemplo: "template_12345"

langCode: string
Código do idioma. Padrão: o langCode passado para defineOneEntry ("en_US" se nenhum for passado).
exemplo: "en_US"

Exemplos​

Exemplo mínimo​

const response = await Templates.getTemplateByMarker('template');

Exemplo com langCode​

const response = await Templates.getTemplateByMarker('template', '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: number
ID do objeto.
exemplo: 12345

attributeSetIdentifier: string | null
Marcador do conjunto de atributos, ou null se nenhum estiver atribuído.
exemplo: "attribute_set_1"

title: string
Nome do template.
exemplo: "Template de Produto"

generalTypeId: number
ID do tipo geral.
exemplo: 67890

identifier: string
Identificador de texto (marcador) do objeto.
exemplo: "template_12345"

version: number
Número da versão do objeto; muda a cada atualização.
exemplo: 1

generalTypeName: BlockType
Nome do tipo geral.
exemplo: "produto"

attributeValues: IAttributeValues
Valores de atributos indexados por marcador; um objeto vazio quando não há nenhum.
exemplo:

{
  "color": {
    "type": "string",
    "value": "red",
    "isIcon": false,
    "position": 0,
    "additionalFields": {}
  }
}

position: number
Posição do objeto, usada para ordenação.
exemplo: 1