getTemplateByMarker

Récupérer un objet de modèle par marqueur.

Description

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

Templates.getTemplateByMarker(

marker*, langCode

);

Parameters schema

Schema

marker(obligatoire): string
Le marqueur unique du modèle à récupérer
exemple : "template_12345"

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

Examples

Minimal example

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

Example with langCode attribute

const response = await Templates.getTemplateByMarker('my-marker', '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 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: Types
Nom du type général.
exemple : "produit"

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

---