Saltar al contenido principal

getTemplateByType

Obteniendo todos los objetos de plantilla, agrupados por tipos.

Descripción​

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

Templates.getTemplateByType(

type*, langCode

);

Esquema de parámetros​

Esquema

type(required): Tipos
El tipo de plantillas a recuperar. Este parámetro especifica la categoría o clasificación de las plantillas solicitadas
ejemplo: "product"

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

Ejemplos​

Ejemplo mínimo​

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

Ejemplo con atributos​

const response = await Templates.getTemplateByType('forCatalogProducts', '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
Conjunto de id 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: Tipos
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).
ejemplo:

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

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