Saltar al contenido principal

getTemplateByMarker

Obtén una única plantilla por su marcador.

Descripción​

Obtiene una plantilla por su marcador y se resuelve en un ITemplateEntity. Si ninguna plantilla tiene ese marcador, se resuelve en un IError con statusCode: 404.

.getTemplateByMarker(

,

);

Esquema de parámetros​

Esquema

marker(requerido): string
Marcador de la plantilla que se obtiene.
ejemplo: "template_12345"

langCode: cadena
Código de idioma. Predeterminado: el langCode pasado a defineOneEntry ("en_US" si no se pasó ninguno).
ejemplo: "en_US"

Ejemplos​

Ejemplo mínimo​

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

Ejemplo con langCode​

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

Ejemplo de respuesta​

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

Esquema de respuesta​

Esquema: ITemplateEntity

id: número
ID del objeto.
ejemplo: 12345

attributeSetIdentifier: cadena | null
Marcador del conjunto de atributos, o null si no hay ninguno asignado.
ejemplo: "attribute_set_1"

title: string
Nombre de la plantilla.
ejemplo: "Plantilla de Producto"

generalTypeId: number
ID del tipo general.
ejemplo: 67890

identifier: cadena
Identificador de texto (marcador) del objeto.
ejemplo: "template_12345"

version: número
Número de versión del objeto; cambia con cada actualización.
ejemplo: 1

generalTypeName: BlockType
Nombre del tipo general.
ejemplo: "producto"

attributeValues: IAttributeValues
Valores de atributos indexados por marcador; un objeto vacío si no hay ninguno.
ejemplo:

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

position: número
Posición del objeto, usada para ordenar.
ejemplo: 1