Pular para o conteúdo principal

getTemplateByMarker

Obtendo um objeto de template por marcador.

Descrição

Este método recupera um único objeto de template com base em seu identificador (marcador) da API. Ele retorna uma Promise que resolve para um objeto de template ITemplateEntity.

Templates.getTemplateByMarker(

marker, langCode

);

Esquema de parâmetros

Esquema

marker(obrigatório): string
O marcador único do template a ser recuperado
exemplo: "template_12345"

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

Exemplos

Exemplo mínimo

const response = await Templates.getTemplateByMarker('my-marker');

Exemplo com atributo langCode

const response = await Templates.getTemplateByMarker('my-marker', '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
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: number
ID da entidade do tipo geral.
exemplo: 67890

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

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

generalTypeName: Types
Nome do tipo geral.
exemplo:

"product"

attributeValues: AttributeType
Valores dos atributos do índice (representados como um par de ID de atributo do usuário: valor do atributo).

position: number
A posição do objeto.
exemplo: NaN