getTemplateByType

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

Description

Cette méthode récupère tous les objets de modèle du type spécifié. Elle renvoie une promesse qui se résout en un tableau d'objets ITemplateEntity.

Templates.getTemplateByType(

type*, langCode

);

Paramètres du schéma

Schéma

type(obligatoire): BlockType
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"

Exemples

Exemple minimal

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

Exemple avec des attributs

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

Exemple de réponse

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

Schéma de réponse

Schéma : ITemplateEntity[]

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

attributeSetIdentifier: string | null
Identifiant de l'ensemble 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: BlockType
Nom du type général.
exemple : "product"

attributeValues: IAttributeValues
Carte des valeurs d'attributs indexées par marqueur ; objet vide lorsqu'il n'y en a pas.
exemple :

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

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

---