getTemplateByType

Récupération de tous les objets de modèle, regroupés par types.

Description

Cette méthode récupère un seul objet de modèle basé sur son identifiant (id) depuis l'API. Elle renvoie une Promesse qui se résout en un tableau d'objets Template indexés ITemplateEntity.

Templates.getTemplateByType(

type*, langCode

);

Parameters schema

Schema

type(obligatoire): Types
Le type de modèles à récupérer. Ce paramètre spécifie la catégorie ou la classification des modèles demandés
exemple : "product"

langCode: string
Code de langue. Par défaut : "en_US"
exemple : "en_US"

Examples

Minimal example

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

Example with attributes

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

Example response

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

Response schema

Schema: ITemplateEntity[]

id: number
L'identifiant unique de la position.
exemple : 12345

attributeSetIdentifier: string | null
Identifiant du set d'attributs.
exemple : "attribute_set_1"

title: string
Le nom du modèle.
exemple : "Modèle de Produit"

generalTypeId: number
Identifiant de l'entité de type général.
exemple : 67890

identifier: string
L'identifiant textuel pour le champ d'enregistrement.
exemple : "template_12345"

version: number
Le numéro de version de l'objet.
exemple : 1

generalTypeName: Types
Nom du type général.
exemple : "product"

attributeValues: AttributeType
Valeurs des attributs de l'index (représentées comme une paire d'identifiant d'attribut utilisateur : valeur d'attribut).
exemple :

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

position: number
La position de l'objet.
exemple : 1

---