Variables de notification
Les notifications par e-mail sont conçues pour fournir au client et au propriétaire de la boutique des informations importantes liées aux commandes. Ces notifications sont créées à l’aide de balises HTML et Freemarker et utilisent des variables spéciales pour afficher les informations des commandes dans les e-mails.
Cet article décrit la liste des variables disponibles. Vous trouverez des exemples de leur utilisation dans l’article Modifier les notifications par e-mail. Vous pouvez également utiliser des variables dans un code de suivi personnalisé.
Variables pour les informations du client
| Nom | Description |
| ${customer.name} | Affiche le nom du client. |
| ${customer.email} | Affiche l’adresse e-mail du client. |
| ${customer.membershipName} | Affiche le nom du groupe du client. |
| ${customer.membershipId} | Affiche l’identifiant du groupe du client. |
Variables pour les informations de la commande
| Nom | Description |
| <#list order.items as orderItem> </#list> | Affiche la liste des produits commandés. |
| ${orderItem.name} | Affiche le nom du produit. |
| ${orderItem.sku} | Affiche l’UGS du produit. |
| ${orderItem.description} | Affiche la description du produit. |
| ${orderItem.customerUrl} | Appelle l’adresse de la page du produit. |
| ${orderItem.imageUrl} | Affiche l’image du produit. |
| ${orderItem.quantity} | Affiche la quantité d’articles commandés. |
| ${orderItem.price} | Affiche le prix du produit. |
| ${orderItem.priceWithoutTax} | Affiche le prix du produit sans taxes. |
| ${orderItem.isShippingRequired} | |
| ${orderItem.weight} | Affiche le poids du produit commandé. |
| ${orderItem.subtotal} | Affiche le sous-total de l’article commandé (prix de l’article x quantité d’articles commandés). |
| ${orderItem.subtotalWithoutTax} | Affiche le sous-total de la commande sans taxes (prix de l’article sans taxes x quantité d’articles commandés). |
| <#list orderItem.options as option> </#list> | Affiche la liste des options sélectionnées pour le produit. |
| ${option.name} | Affiche le nom de l’option. |
| ${option.value} | Affiche la sélection de l’option. |
| <#list orderItem.attributes as attribute> </#list> | Affiche la liste de tous les attributs définis pour le type de produit de l’article. |
| ${attribute.name} | Affiche le titre de l’attribut. |
| ${attribute.value} | Affiche le nom de l’attribut. |
| <#list orderItem.visibleAttributes as visibleAttribute> </#list> | Affiche la liste des attributs visibles définis pour le type de produit de l’article. |
| ${visibleAttribute.name} | Affiche le titre de l’attribut visible. |
| ${visibleAttribute.value} | Affiche le nom de l’attribut visible. |
| <#list orderItem.files as file> </#list> | Affiche la liste des fichiers attachés au produit. |
| ${file.description} | Affiche la description du fichier. |
| ${file.fileName} | |
| ${file.name} | Affiche le nom du fichier. |
| ${file.type} | Affiche le type de fichier. |
| ${file.size} | Affiche la taille du fichier. |
| ${file.url} | Ajoute un lien de téléchargement pour le fichier. |
| <#list orderItem.taxes as tax> </#list> | Affiche la liste des taxes appliquées au produit. |
| ${tax.name} | Affiche le nom de la taxe. |
| ${tax.percentValue} | Affiche la valeur en pourcentage de la taxe. |
| ${tax.absoluteValue} | Affiche la valeur absolue de la taxe pour le sous-total du produit (la valeur absolue de la taxe x nombre d’articles du produit dans la commande). |
| ${orderItem.taxesTotalPercentValue} | Affiche la somme de toutes les valeurs de taxe en pourcentage appliquées au produit. |
| ${orderItem.taxesTotalAbsoluteValue} | Affiche la somme de toutes les valeurs de taxe absolues appliquées au produit. |
| ${order.number} | Affiche le numéro de la commande. |
| ${order.customerUrl} | Ajoute l’adresse URL au profil du client. Vide si la commande a été faite anonymement. |
| <@orderLink/> | Ajoute le numéro de commande. Si la commande a été passée par un client enregistré, elle contient une adresse URL vers l’historique des commandes du client. Si le client n’est pas enregistré, le numéro de commande sera affiché en texte clair. |
| ${order.adminUrl} | Ajoute un lien vers la commande dans le panneau de contrôle de la boutique. |
| ${order.dateCreated} | Affiche la date de placement de la commande. |
| ${order.paymentStatus} | Affiche l’état du paiement actuel de la commande. |
| <@paymentStatusColor/> | Change la couleur de l’élément ${order.paymentStatus} en fonction du statut du paiement. |
| ${order.extTransactionId} |
Affiche l’ID de transaction de la commande (si cette commande a un ID de transaction). Un exemple de cette variable dans le code du modèle : |
| ${order.subtotal} | Affiche le sous-total de la commande. |
| ${order.subtotalWithoutTax} | Affiche le sous-total de la commande hors taxe (frais de port non inclus). |
| ${order.total} | Affiche le total de la commande. |
| ${order.shippingMethod} | Affiche le nom du mode de livraison. |
| ${order.shippingCost} | Affiche le tarif de livraison de la commande. |
| ${order.weight} | Affiche le poids total des articles commandés. |
| <#list order.taxes as tax> </#list> | Affiche une liste des taxes appliquées à la commande. |
| ${tax.name} | Affiche le nom de la taxe. |
| ${tax.value} | Affiche la valeur de la taxe. |
| <#list order.discounts as discount> </#list> | Affiche une liste des remises appliquées à la commande. |
| ${discount.name} | Affiche le nom de la remise. |
| ${discount.value} | Affiche la valeur de la remise. |
| ${order.couponPercent} | Affiche le pourcentage du coupon de réduction appliqué à la commande. |
| ${order.couponName} | Affiche le nom du coupon de réduction. |
| ${order.couponCode} | Affiche le code du coupon de réduction. |
| ${order.totalDiscount} | Affiche le montant total de la remise appliquée à la commande. |
| ${order.isShippingRequired} | |
| ${order.shippingAddress} | Affiche l’adresse de livraison complète de la commande. Il est également possible d’afficher chaque élément de l’adresse de livraison séparément. |
| ${order.shippingAddress.name} | Affiche le nom du client. |
| ${order.shippingAddress.companyName} | Affiche le nom de l’entreprise indiqué dans l’adresse de livraison |
| ${order.shippingAddress.street} | Affiche la rue indiquée dans l’adresse de livraison. |
| ${order.shippingAddress.city} | Affiche la ville indiquée dans l’adresse de livraison. |
| ${order.shippingAddress.country} | Affiche le pays indiqué dans l’adresse de livraison. |
| ${order.shippingAddress.countryCode} | Affiche le code du pays indiqué dans l’adresse de livraison du client |
| ${order.shippingAddress.postalCode} | Affiche le code postal (ZIP) indiqué dans l’adresse de livraison. |
| ${order.shippingAddress.state} | Affiche l’État indiqué dans l’adresse de livraison. |
| ${order.shippingAddress.stateCode} | Affiche le code de l’État indiqué dans l’adresse de livraison du client |
| ${order.shippingAddress.phone} | Affiche le numéro de téléphone du client. |
| ${order.shippingAddress.province} | Affiche la province indiquée dans l’adresse de livraison. |
| ${order.shippingAddress.provinceCode} | Affiche le code de la province indiqué dans l’adresse de livraison du client |
| ${order.shipping.cost} | Affiche les frais de livraison avec les taxes. |
| ${order.shipping.costWithoutTax} | Affiche les frais de livraison sans les taxes. |
| ${order.shipping.taxesTotalPercentValue} | Affiche la somme des valeurs en pourcentage de toutes les taxes de livraison. |
| ${order.shipping.taxesTotalAbsoluteValue} | Affiche la somme des valeurs absolues de toutes les taxes de livraison. |
| <#list order.shipping.taxes as shippingTax> </#list> | Affiche une liste des taxes de livraison appliquées à la commande |
| ${shippingTax.name} | Affiche le nom d’une taxe de livraison. |
| ${shippingTax.percentValue} | Affiche la valeur en pourcentage de la taxe de livraison. |
| ${shippingTax.absoluteValue} | Affiche la valeur absolue de la taxe de livraison. |
| ${order.billingAddress} | Affiche l’adresse de facturation complète de la commande. Il est également possible d’afficher chaque élément de l’adresse de livraison séparément. |
| ${order.billingAddress.name} | Affiche le nom du client. |
| ${order.billingAddress.companyName} | Affiche le nom de l’entreprise indiqué dans l’adresse de facturation. |
| ${order.billingAddress.street} | Affiche la rue indiquée dans l’adresse de facturation. |
| ${order.billingAddress.city} | Affiche la ville indiquée dans l’adresse de facturation. |
| ${order.billingAddress.country} | Affiche le pays indiqué dans l’adresse de facturation. |
| ${order.billingAddress.countryCode} | Affiche le code du pays indiqué dans l’adresse de facturation du client |
| ${order.billingAddress.postalCode} | Affiche le code postal (ZIP) indiqué dans l’adresse de facturation. |
| ${order.billingAddress.state} | Affiche l’État indiqué dans l’adresse de facturation. |
| ${order.billingAddress.stateCode} | Affiche le code de l’État indiqué dans l’adresse de livraison du client |
| ${order.billingAddress.phone} | Affiche le numéro de téléphone indiqué dans l’adresse de facturation. |
| ${order.billingAddress.province} | Affiche la province indiquée dans l’adresse de facturation. |
| ${order.billingAddress.provinceCode} | Affiche le code de la province indiqué dans l’adresse de livraison du client |
| ${order.pickupTime} | Affiche l’heure de ramassage sélectionnée par le client |
| ${order.isPaid} | |
| ${order.paymentMethod} | Affiche le titre « Mode de paiement » et le nom du mode de paiement. |
| ${order.paymentMethod.isOnline} | |
| ${order.paymentMethod.instructionsTitle} | Affiche le titre des instructions de paiement. |
| ${order.paymentMethod.instructions} | Affiche le contenu des instructions de paiement. |
| ${order.paymentMethod.name} | Affiche le nom du mode de paiement. |
| ${order.orderComments} | Affiche les commentaires de la commande. |
| ${order.privateAdminNotes} | Affiche les notes de commande ajoutées par le propriétaire de la boutique. |
| ${order.isPaymentStatusUpdated} | |
| ${order.isFulfillmentStatusUpdated} | |
| ${order.fulfillmentStatus} | Affiche l’état actuel de la commande. |
| ${order.trackingNumber} | Affiche le numéro de suivi de la commande, si l’option est activée. |
| ${order.trackingUrl} | Ajoute l’adresse URL de la page de suivi des commandes pour les options de livraison calculées par le transporteur. |
| ${order.affiliateID} | Affiche l’identifiant d’affilié de la commande. |
| ${order.extraFields} | |
| <#list order.extraFields as extraField> </#list> | Affiche la liste des champs supplémentaires de la commande. |
| ${extraField.key} | Affiche la clé de champ supplémentaire. |
| ${extraField.value} | Affiche la valeur du champ supplémentaire. |
| ${extraField.title} | En option. Affiche le titre du champ supplémentaire. |
| ${extraField.orderDisplaySection} | En option. Affiche le titre du champ supplémentaire. |
| ${extraField.type} | Affiche le type du champ supplémentaire. |
| <#list order.surcharges as surcharge> | Affiche la liste des suppléments de commande. |
| ${surcharge.id} | Affiche l’ID d’un supplément |
| ${surcharge.value} | Affiche la valeur d’un supplément |
| ${surcharge.type} | Affiche si un supplément est exprimé en valeur absolue ou en pourcentage |
| ${surcharge.description} | Affiche la description d’un supplément |
| ${surcharge.total} | Affiche le total d’un supplément |
| ${surcharge.taxable} | Affiche si le supplément est imposable |
| ${surcharge.showZeroSurchargeInTotal} | Affiche un supplément nul au total |
Fonctions utiles pour travailler avec des champs de commande supplémentaires
| Nom | Description |
| getOrderExtraField(key) | Renvoie l’ensemble de l’objet ExtraField (avec les champs clé, valeur, titre, etc.) |
| getOrderExtraFieldValue(key) | Renvoie le champ valeur de l’objet ExtraField |
Variables pour les informations des produits
| Nom | Description |
| ${product.name} | Affiche le nom du produit. |
| ${product.sku} | Affiche l’UGS du produit. |
| ${product.quantity} | Affiche la quantité du produit. |
| ${product.adminUrl} | Affiche l’adresse URL de la page du produit dans le panneau de contrôle de la boutique. |
| ${product.customerUrl} | Ajoute l’adresse URL de la page du produit. |
| ${product.imageUrl} | Affiche l’image du produit. |
| ${product.warningLimit} | Affiche la quantité d’articles en stock qui déclenche la « notification de stock faible ». |
| ${product.options} | |
| <#list product.options as option> </#list> | Affiche la liste des options du produit. |
| ${option.name} | Affiche le nom de l’option. |
| ${option.value} | Affiche la valeur de l’option sélectionnée. |
| ${product.attributes} | |
| <#list product.attributes as attribute> </#list> | Affiche la liste des attributs cachés définis pour le produit. |
| ${attribute.name} | Affiche le titre de l’attribut caché. |
| ${attribute.value} | Affiche le nom de l’attribut caché. |
| <#list product.visibleAttributes as visibleAttribute> </#list> | Affiche la liste des attributs définis pour le produit. |
| ${visibleAttribute.name} | Affiche le titre de l’attribut. |
| ${visibleAttribute.value} | Affiche le nom de l’attribut. |
Variables disponibles pour les informations de stockage
| Nom | Description |
| ${store.id} | Affiche l’identifiant de la boutique. |
| ${store.name} | Affiche le nom de la boutique. |
| ${store.logoUrl} | Appelle l’adresse URL du logo de la boutique. |
| <@storeLogo/> | Affiche le logo de la boutique. Si le logo n’est pas spécifié, affiche le nom de la boutique. |
| ${store.storeUrl} | Appelle l’adresse URL de la page d’accueil de la boutique. |
| ${store.companyEmail} | Affiche l’adresse e-mail de l’entreprise, qui est spécifiée dans les paramètres de la boutique. |
| ${store.customerOrdersPageUrl} | Appelle l’adresse URL de la page d’historique des commandes du client. |
| <#list store.legalPages as page> </#list> | Affiche la liste des pages juridiques. |
| ${page.name} | Afficher le nom de certaines pages juridiques. |
| ${page.url} | Appelle l’adresse URL de la page juridique. |
| <@legalPages/> | Affiche la liste des pages juridiques dans une même chaîne. |
| ${store.controlPanelUrl} | Ajoute l’adresse URL du panneau de contrôle de la boutique au message. |
| ${store.egoodsLinkLifetime} | Affiche la durée de vie du lien des e-marchandises. |
| ${store.egoodsMaxDownloadAttempts} | Affiche la quantité maximale de tentatives de téléchargement pour les produits numériques ou e-marchandises. |
| ${store.officeAddress} | Affiche l’adresse physique de la boutique spécifiée dans les paramètres de la boutique. |
| ${store.resetPasswordUrl} | Ajoute l’adresse URL de réinitialisation du mot de passe d’un client au message. |
| ${store.businessRegistrationID} | Affiche l’identifiant d’enregistrement d’entreprise de la boutique (TVA). |
Variables pour les informations de la marque
| Nom | Description |
| ${brand.name} | Affiche notre nom. |
| ${brand.logoUrl} | Appelle l’adresse URL de notre logo. |