Aller au contenu principal

getTemplateByMarker

Récupérer un modèle par son marqueur.

Description​

Récupère un modèle par son marqueur et renvoie un ITemplateEntity. Si aucun modèle ne porte ce marqueur, elle renvoie un IError avec statusCode: 404.

.getTemplateByMarker(

,

);

Schéma des paramètres​

Schema

marker(obligatoire): string
Marqueur du modèle à récupérer.
exemple : "template_12345"

langCode: string
Code de langue. Par défaut : le langCode passé à defineOneEntry ("en_US" s'il n'y en a pas).
exemple : "en_US"

Exemples​

Exemple minimal​

const response = await Templates.getTemplateByMarker('template');

Exemple avec langCode​

const response = await Templates.getTemplateByMarker('template', '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
ID de l'objet.
exemple : 12345

attributeSetIdentifier: string | null
Marqueur de l'ensemble d'attributs, ou null si aucun n'est attribué.
exemple : "attribute_set_1"

title: string
Nom du modèle.
exemple : "Template Produit"

generalTypeId: number
ID du type général.
exemple : 67890

identifier: string
Identifiant textuel (marqueur) de l'objet.
exemple : "template_12345"

version: number
Numéro de version de l'objet ; change à chaque mise à jour.
exemple : 1

generalTypeName: BlockType
Nom du type général.
exemple : "produit"

attributeValues: IAttributeValues
Valeurs d'attributs indexées par marqueur ; un objet vide s'il n'y en a aucune.
exemple :

{
  "color": {
    "type": "string",
    "value": "red",
    "isIcon": false,
    "position": 0,
    "additionalFields": {}
  }
}

position: number
Position de l'objet, utilisée pour le tri.
exemple : 1