Utilizzo delle variabili nelle notifiche
Le notifiche e-mail sono progettate per fornire informazioni importanti sugli ordini ai clienti e al gestore del negozio. Tali notifiche vengono create con l’aiuto dei tag HTML e Freemarker e utilizzano variabili speciali per visualizzare dati pertinenti agli ordini nelle e-mail.
In questo articolo è riportato l’elenco delle variabili disponibili. È possibile trovare esempi di utilizzo delle variabili nell’articolo Modifica delle notifiche e-mail. Inoltre, è possibile usare le variabili nei codici di tracciamento personalizzati.
Variabili relative ai dati dei clienti
Nome | Descrizione |
${customer.name} | Visualizza il nome del cliente. |
${customer.email} | Visualizza l’indirizzo e-mail del cliente. |
${customer.membershipName} | Visualizza il nome del gruppo al quale è assegnato il cliente. |
${customer.membershipId} | Visualizza l’ID del gruppo al quale è assegnato il cliente. |
Variabili relative ai dati degli ordini
Nome | Descrizione |
<#list order.items as orderItem> </#list> | Visualizza l’elenco dei prodotti ordinati. |
${orderItem.name} | Visualizza il nome del prodotto. |
${orderItem.sku} | Visualizza il codice articolo del prodotto. |
${orderItem.description} | Visualizza la descrizione del prodotto. |
${orderItem.customerUrl} | Richiama l’URL della pagina del prodotto. |
${orderItem.imageUrl} | Visualizza l’immagine del prodotto. |
${orderItem.quantity} | Visualizza il numero di articoli ordinati. |
${orderItem.price} | Visualizza il prezzo del prodotto. |
${orderItem.priceWithoutTax} | Visualizza il prezzo del prodotto senza tasse. |
${orderItem.isShippingRequired} | |
${orderItem.weight} | Visualizza il peso del prodotto ordinato. |
${orderItem.subtotal} | Visualizza il subtotale per articolo (prezzo articolo x quantità ordinata). |
${orderItem.subtotalWithoutTax} | Visualizza il subtotale ordine senza tasse (prezzo articolo senza tasse x quantità ordinata). |
<#list orderItem.options as option> </#list> | Visualizza l’elenco delle opzioni di prodotto selezionate. |
${option.name} | Visualizza il nome dell’opzione. |
${option.value} | Visualizza il valore selezionato per l’opzione. |
<#list orderItem.attributes as attribute> </#list> | Visualizza l’elenco di tutti gli attributi impostati per il tipo di prodotto dell’articolo in questione. |
${attribute.name} | Visualizza il titolo dell’attributo. |
${attribute.value} | Visualizza il nome dell’attributo. |
<#list orderItem.visibleAttributes as visibleAttribute> </#list> | Visualizza l’elenco di tutti gli attributi visibili per il tipo di prodotto dell’articolo in questione. |
${visibleAttribute.name} | Visualizza il titolo dell’attributo visibile. |
${visibleAttribute.value} | Visualizza il nome dell’attributo visibile. |
<#list orderItem.files as file> </#list> | Visualizza l’elenco dei file allegati al prodotto. |
${file.description} | Visualizza la descrizione del file. |
${file.fileName} | |
${file.name} | Visualizza il nome del file. |
${file.type} | Visualizza il tipo del file. |
${file.size} | Visualizza la dimensione del file. |
${file.url} | Aggiunge il link per scaricare il file. |
<#list orderItem.taxes as tax> </#list> | Visualizza l’elenco delle tasse applicabili al prodotto. |
${tax.name} | Visualizza il nome della tassa. |
${tax.percentValue} | Visualizza l’aliquota fiscale. |
${tax.absoluteValue} | Visualizza l’importo della tassa per subtotale prodotto (l’importo della tassa per articolo x numero di articoli ordinati). |
${orderItem.taxesTotalPercentValue} | Visualizza il totale in percentuale di tutte le aliquote fiscali applicate al prodotto. |
${orderItem.taxesTotalAbsoluteValue} | Visualizza l’importo totale di tutte le tasse applicate al prodotto. |
${order.number} | Visualizza il numero dell’ordine. |
${order.customerUrl} | Aggiunge l’URL del profilo del cliente. Vuoto se l’ordine è stato effettuato in modo anonimo. |
<@orderLink/> | Aggiunge il numero dell’ordine. Se l’ordine è stato effettuato da un cliente registrato, contiene l’URL della cronologia degli ordini del cliente. Se non si tratta di un cliente registrato, il numero dell’ordine si visualizza come testo normale. |
${order.adminUrl} | Aggiunge il link della pagina dell’ordine nel pannello di controllo del negozio. |
${order.dateCreated} | Visualizza la data in cui l’ordine è stato effettuato. |
${order.paymentStatus} | Visualizza lo stato di pagamento attuale dell’ordine. |
<@paymentStatusColor/> | Modifica il colore dell’elemento ${order.paymentStatus} a seconda dello stato di pagamento. |
${order.extTransactionId} |
Visualizza l’ID transazione per l’ordine (se questo ordine ha un ID transazione). Un esempio di questa variabile nel codice del modello: |
${order.subtotal} | Visualizza il subtotale dell’ordine. |
${order.subtotalWithoutTax} | Visualizza il subtotale dell’ordine senza tasse (nessun costo di spedizione incluso). |
${order.total} | Visualizza il totale dell’ordine. |
${order.shippingMethod} | Visualizza il nome del metodo di spedizione. |
${order.shippingCost} | Visualizza il costo di spedizione dell’ordine. |
${order.weight} | Visualizza il peso totale degli articoli ordinati. |
<#list order.taxes as tax> </#list> | Visualizza l’elenco delle tasse applicate all’ordine. |
${tax.name} | Visualizza il nome della tassa. |
${tax.value} | Visualizza il valore della tassa. |
<#list order.discounts as discount> </#list> | Visualizza l’elenco degli sconti applicati all’ordine. |
${discount.name} | Visualizza il nome dello sconto. |
${discount.value} | Visualizza il valore dello sconto. |
${order.couponPercent} | Visualizza la percentuale del coupon sconto applicato all’ordine. |
${order.couponName} | Visualizza il nome del coupon sconto. |
${order.couponCode} | Visualizza il codice del coupon sconto. |
${order.totalDiscount} | Visualizza il valore totale dello sconto applicato all’ordine. |
${order.isShippingRequired} | |
${order.shippingAddress} | Visualizza l’indirizzo di spedizione completo dell’ordine. È possibile anche visualizzare separatamente ciascun elemento dell’indirizzo di spedizione. |
${order.shippingAddress.name} | Visualizza il nome del cliente. |
${order.shippingAddress.companyName} | Visualizza il nome dell’azienda specificata nell’indirizzo di spedizione. |
${order.shippingAddress.street} | Visualizza la via specificata nell’indirizzo di spedizione. |
${order.shippingAddress.city} | Visualizza la città specificata nell’indirizzo di spedizione. |
${order.shippingAddress.country} | Visualizza il Paese specificato nell’indirizzo di spedizione. |
${order.shippingAddress.countryCode} | Visualizza il codice del Paese specificato dal cliente nell’indirizzo di spedizione. |
${order.shippingAddress.postalCode} | Visualizza il codice postale (CAP) specificato nell’indirizzo di spedizione. |
${order.shippingAddress.state} | Visualizza lo stato specificato nell’indirizzo di spedizione. |
${order.shippingAddress.stateCode} | Visualizza il codice dello stato specificato dal cliente nell’indirizzo di spedizione. |
${order.shippingAddress.phone} | Visualizza il numero telefonico del cliente. |
${order.shippingAddress.province} | Visualizza la provincia specificata nell’indirizzo di spedizione. |
${order.shippingAddress.provinceCode} | Visualizza il codice della provincia specificata dal cliente nell’indirizzo di spedizione. |
${order.shipping.cost} | Visualizza il costo di spedizione con tasse incluse. |
${order.shipping.costWithoutTax} | Visualizza il costo di spedizione al netto delle tasse. |
${order.shipping.taxesTotalPercentValue} | Visualizza il totale in percentuale di tutte le tasse sulla spedizione. |
${order.shipping.taxesTotalAbsoluteValue} | Visualizza l’importo totale di tutte le tasse sulla spedizione. |
<#list order.shipping.taxes as shippingTax> </#list> | Visualizza l’elenco delle tasse sulla spedizione applicate all’ordine |
${shippingTax.name} | Visualizza il nome di una tassa sulla spedizione. |
${shippingTax.percentValue} | Visualizza l’aliquota percentuale della tassa sulla spedizione. |
${shippingTax.absoluteValue} | Visualizza l’importo della tassa sulla spedizione. |
${order.billingAddress} | Visualizza l’indirizzo di fatturazione completo dell’ordine. È possibile anche visualizzare separatamente ciascun elemento dell’indirizzo di fatturazione. |
${order.billingAddress.name} | Visualizza il nome del cliente. |
${order.billingAddress.companyName} | Visualizza il nome dell’azienda specificata nell’indirizzo di fatturazione. |
${order.billingAddress.street} | Visualizza la via specificata nell’indirizzo di fatturazione. |
${order.billingAddress.city} | Visualizza la città specificata nell’indirizzo di fatturazione. |
${order.billingAddress.country} | Visualizza il Paese specificato nell’indirizzo di fatturazione. |
${order.billingAddress.countryCode} | Visualizza il codice del Paese specificato dal cliente nell’indirizzo di fatturazione. |
${order.billingAddress.postalCode} | Visualizza il codice postale (CAP) specificato nell’indirizzo di fatturazione. |
${order.billingAddress.state} | Visualizza lo stato specificato nell’indirizzo di fatturazione. |
${order.billingAddress.stateCode} | Visualizza il codice dello stato specificato dal cliente nell’indirizzo di fatturazione. |
${order.billingAddress.phone} | Visualizza il numero telefonico specificato nell’indirizzo di fatturazione. |
${order.billingAddress.province} | Visualizza la provincia specificata nell’indirizzo di fatturazione. |
${order.billingAddress.provinceCode} | Visualizza il codice della provincia specificata dal cliente nell’indirizzo di fatturazione. |
${order.pickupTime} | Visualizza l’orario di ritiro scelto dal cliente. |
${order.isPaid} | |
${order.paymentMethod} | Visualizza il titolo “Metodo di pagamento:” e il nome del metodo di pagamento. |
${order.paymentMethod.isOnline} | |
${order.paymentMethod.instructionsTitle} | Visualizza il titolo delle istruzioni per il pagamento. |
${order.paymentMethod.instructions} | Visualizza il contenuto delle istruzioni per il pagamento. |
${order.paymentMethod.name} | Visualizza il nome del metodo di pagamento. |
${order.orderComments} | Visualizza i commenti all’ordine. |
${order.privateAdminNotes} | Visualizza le note per lo staff aggiunte all’ordine dal titolare del negozio. |
${order.isPaymentStatusUpdated} | |
${order.isFulfillmentStatusUpdated} | |
${order.fulfillmentStatus} | Visualizza lo stato di evasione dell’ordine. |
${order.trackingNumber} | Visualizza il numero di tracciamento dell’ordine, se abilitato. |
${order.trackingUrl} | Aggiunge l’URL della pagina di tracciamento dell’ordine per le opzioni di spedizione calcolate dal vettore. |
${order.affiliateID} | Visualizza l’ID partner dell’ordine. |
${order.extraFields} | |
<#list order.extraFields as extraField> </#list> | Visualizza l’elenco dei campi aggiuntivi dell’ordine. |
${extraField.key} | Visualizza la chiave del campo aggiuntivo. |
${extraField.value} | Visualizza il valore del campo aggiuntivo. |
${extraField.title} | Opzionale. Visualizza il titolo del campo aggiuntivo. |
${extraField.orderDisplaySection} | Opzionale. Visualizza il titolo del campo aggiuntivo. |
${extraField.type} | Visualizza il tipo del campo aggiuntivo. |
<#list order.surcharges as surcharge> | Visualizza l’elenco dei supplementi applicati all’ordine. |
${surcharge.id} | Visualizza l’ID del supplemento. |
${surcharge.value} | Visualizza il valore del supplemento. |
${surcharge.type} | Indica se il supplemento è espresso in percentuale o come valore assoluto |
${surcharge.description} | Visualizza la descrizione del supplemento |
${surcharge.total} | Visualizza il totale del supplemento |
${surcharge.taxable} | Indica se il supplemento è soggetto a imposte |
${surcharge.showZeroSurchargeInTotal} | Visualizza un supplemento totale pari a zero |
Funzioni utili per lavorare con i campi aggiuntivi negli ordini
Nome | Descrizione |
getOrderExtraField(key) | Ritorna l’intero oggetto ExtraField (con i campi chiave, valore, titolo, ecc.) |
getOrderExtraFieldValue(key) | Ritorna il campo valore dell’oggetto ExtraField |
Variabili relative ai dati dei prodotti
Nome | Descrizione |
${product.name} | Visualizza il nome del prodotto. |
${product.sku} | Visualizza il codice articolo del prodotto. |
${product.quantity} | Visualizza la quantità del prodotto. |
${product.adminUrl} | Visualizza l’URL della pagina del prodotto nel pannello di controllo. |
${product.customerUrl} | Aggiunge l’URL della pagina del prodotto. |
${product.imageUrl} | Visualizza l’immagine del prodotto. |
${product.warningLimit} | Visualizza il valore impostato come soglia per attivare l’invio della “Notifica di scorte in esaurimento”. |
${product.options} | |
<#list product.options as option> </#list> | Visualizza l’elenco delle opzioni del prodotto. |
${option.name} | Visualizza il nome dell’opzione. |
${option.value} | Visualizza il valore selezionato per l’opzione. |
${product.attributes} | |
<#list product.attributes as attribute> </#list> | Visualizza l’elenco di tutti gli attributi nascosti impostati per il prodotto. |
${attribute.name} | Visualizza il titolo dell’attributo nascosto. |
${attribute.value} | Visualizza il nome dell’attributo nascosto. |
<#list product.visibleAttributes as visibleAttribute> </#list> | Visualizza l’elenco di tutti gli attributi visibili impostati per il prodotto. |
${visibleAttribute.name} | Visualizza il titolo dell’attributo visibile. |
${visibleAttribute.value} | Visualizza il nome dell’attributo visibile. |
Variabili relative ai dati del negozio
Nome | Descrizione |
${store.id} | Visualizza l’ID del negozio. |
${store.name} | Visualizza il nome del negozio. |
${store.logoUrl} | Richiama l’URL del logo del negozio. |
<@storeLogo/> | Visualizza il logo del negozio. Se il logo non è specificato, visualizza il nome del negozio. |
${store.storeUrl} | Richiama l’URL della prima pagina del negozio. |
${store.companyEmail} | Visualizza l’indirizzo e-mail dell’azienda specificato nelle impostazioni del negozio. |
${store.customerOrdersPageUrl} | Richiama l’URL della pagina della cronologia degli ordini del cliente. |
<#list store.legalPages as page> </#list> | Visualizza l’elenco delle pagine contenenti informazioni legali. |
${page.name} | Visualizza il nome di una determinata pagina con informazioni legali. |
${page.url} | Richiama l’URL di una determinata pagina con informazioni legali. |
<@legalPages/> | Visualizza l’elenco delle pagine legali in una sola stringa. |
${store.controlPanelUrl} | Aggiunge l’URL del pannello di controllo del negozio. |
${store.egoodsLinkLifetime} | Visualizza la scadenza dei link dei prodotti digitali. |
${store.egoodsMaxDownloadAttempts} | Visualizza il numero massimo di tentativi per scaricare i prodotti digitali. |
${store.officeAddress} | Visualizza l’indirizzo fisico del negozio specificato nelle impostazioni del negozio. |
${store.resetPasswordUrl} | Aggiunge l’URL per reimpostare la password utente. |
${store.businessRegistrationID} | Visualizza l’ID di registrazione dell’azienda (Partita IVA). |
Variabili relative al marchio aziendale
Nome | Descrizione |
${brand.name} | Visualizza il nostro nome. |
${brand.logoUrl} | Richiama l’URL del nostro logo. |