Aller au contenu principal

getTemplateByMarker

Obtenir un objet template par marqueur.

Description​

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

Templates.getTemplateByMarker(

marker*, langCode

);

Schéma des paramètres​

Schéma

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

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

Exemples​

Exemple minimal​

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

Exemple avec l'attribut langCode​

const response = await Templates.getTemplateByMarker('my-marker', '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 template.
exemple : "Template 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 : "produit"

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