Saltar al contenido principal

getTemplateByMarker

Obteniendo un objeto de plantilla por marcador.

Descripción

Este método recupera un único objeto de plantilla basado en su identificador (marcador) desde la API. Devuelve una Promesa que se resuelve en un objeto de plantilla ITemplateEntity.

Templates.getTemplateByMarker(

marker, langCode

);

Esquema de parámetros

Esquema

marker(requerido): string
El marcador único de la plantilla a recuperar
ejemplo: "template_12345"

langCode: string
Código de idioma. Predeterminado: "en_US"
ejemplo: "en_US"

Ejemplos

Ejemplo mínimo

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

Ejemplo con atributo langCode

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

Ejemplo de respuesta

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

Esquema de respuesta

Esquema: ITemplateEntity

id: number
El identificador único de la posición.
ejemplo: 12345

attributeSetIdentifier: string | null
ID del conjunto de atributos.
ejemplo: "attribute_set_1"

title: string
El nombre de la plantilla.
ejemplo: "Plantilla de Producto"

generalTypeId: number
ID de la entidad de tipo general.
ejemplo: 67890

identifier: string
El identificador textual para el campo del registro.
ejemplo: "template_12345"

version: number
El número de versión del objeto.
ejemplo: 1

generalTypeName: Types
Nombre del tipo general.
ejemplo:

"product"

attributeValues: AttributeType
Valores de atributos del índice (representados como un par de ID de atributo de usuario: valor de atributo).

position: number
La posición del objeto.
ejemplo: NaN