Aller au contenu principal

getTemplateById

Obtenez un objet modèle par identifiant.

Templates.getTemplateById(id, langCode)

const value = await Templates.getTemplateById(1)
Schéma

id:* nombre
Identifiant du modèle
exemple : 1

langCode: chaîne
Paramètre optionnel pour le code de langue
exemple : en_US

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

Exemple de retour :

{
"id": 1764,
"generalTypeId": 4,
"generalTypeName": "forProductPreview",
"title": "Modèle de page",
"identifier": "marker",
"position": 1,
"version": 10,
"attributeValues": {
"marker": {
"value": "",
"type": "string",
"position": 1,
"isProductPreview": false,
"isIcon": false,
"attributeFields": {
"marker": {
"type": "string",
"value": "test"
}
}
}
},
"attributeSetIdentifier": "my-set"
}
Schéma

id: nombre
identifiant de l'objet
exemple : 1764

version nombre
numéro de version de modification de l'objet
exemple : 10

identifier: chaîne
identifiant textuel pour un champ dans l'enregistrement
exemple : catalog

generalTypeId: nombre
identifiant de type
exemple : 4

title: chaîne
nom du modèle
exemple : modèle de page

position objet
numéro de position
exemple : 0

generalTypeName chaîne
exemple : forProductPreview
nom de type général