Variabelen in meldingen
E-mailmeldingen zijn ontworpen om de klant en de winkeleigenaar belangrijke informatie over bestellingen te verstrekken. Deze meldingen worden opgesteld met behulp van HTML en Freemarker-tags en gebruiken speciale variabelen om in de e-mails de feitelijke informatie van de bestelling weer te geven.
In dit artikel wordt de lijst van beschikbare variabelen beschreven. Voorbeelden van het gebruik ervan zijn te vinden in het artikel E-mail meldingen bewerken. U kunt variabelen ook gebruiken in een aangepaste trackingcode.
Variabelen voor informatie over klanten
| Naam | Beschrijving |
| ${customer.name} | De naam van de klant. |
| ${customer.email} | Het e-mailadres van de klant. |
| ${customer.membershipName} | De naam van de klantgroep. |
| ${customer.membershipId} | De ID van de klantgroep. |
Variabelen voor informatie over bestellingen
| Naam | Beschrijving |
| <#list order.items as orderItem> </#list> | De lijst van bestelde producten. |
| ${orderItem.name} | De naam van het product. |
| ${orderItem.sku} | Het artikelnummer van het product. |
| ${orderItem.description} | De productomschrijving. |
| ${orderItem.customerUrl} | Hiermee wordt de URL van de productpagina opgeroepen. |
| ${orderItem.imageUrl} | De productafbeelding. |
| ${orderItem.quantity} | De hoeveelheid bestelde artikelen. |
| ${orderItem.price} | De productprijs. |
| ${orderItem.priceWithoutTax} | De productprijs excl. belastingen. |
| ${orderItem.costPrice} | De kostprijs van het product. |
| ${orderItem.isShippingRequired} | |
| ${orderItem.weight} | Het gewicht van het bestelde product. |
| ${orderItem.subtotal} | Het subtotaal van het bestelde artikel (artikelprijs x hoeveelheid van het bestelde artikel). |
| ${orderItem.subtotalWithoutTax} | Het subtotaal van de bestelling excl. belastingen (artikelprijs excl. belastingen x hoeveelheid van het bestelde artikel). |
| <#list orderItem.options as option> </#list> | De lijst met voor het product geselecteerde opties en invoervelden. |
| ${option.name} | De naam van de optie of het invoerveld. |
| ${option.value} | De selectie van de optie of het invoerveld. |
| <#list orderItem.attributes as attribute> </#list> | De lijst van alle ingestelde attributen voor het producttype van het artikel. |
| ${attribute.name} | De titel van het attribuut. |
| ${attribute.value} | De naam van het attribuut. |
| <#list orderItem.visibleAttributes as visibleAttribute> </#list> | De lijst van zichtbare ingestelde attributen voor het producttype van het artikel. |
| ${visibleAttribute.name} | De titel van het zichtbare attribuut. |
| ${visibleAttribute.value} | De naam van het zichtbare attribuut. |
| <#list orderItem.files as file> </#list> | De lijst met aan het product gekoppelde bestanden. |
| ${file.description} | De beschrijving van het bestand. |
| ${file.fileName} | |
| ${file.name} | De naam van het bestand. |
| ${file.type} | Het type van het bestand. |
| ${file.size} | De grootte van het bestand. |
| ${file.url} | Voegt een downloadlink toe voor het bestand. |
| <#list orderItem.taxes as tax> </#list> | De lijst met over het product geheven belastingen. |
| ${tax.name} | De naam van de belasting. |
| ${tax.percentValue} | Het belastingtarief in procenten. |
| ${tax.absoluteValue} | De absolute waarde van de belastingen voor het subtotaal van de producten (het absolute bedrag aan belastingen x het aantal artikelen van het product in de bestelling). |
| ${orderItem.taxesTotalPercentValue} | De som van alle procentuele belastingwaarden die over het product worden geheven. |
| ${orderItem.taxesTotalAbsoluteValue} | De som van alle over het product geheven absolute belastingbedragen. |
| ${order.number} | Het nummer van de bestelling. |
| ${order.customerUrl} | Voegt een URL toe aan het profiel van de klant. Dit is leeg als de bestelling anoniem is geplaatst. |
| <@orderLink/> | Voegt een bestelnummer toe. Als de bestelling is geplaatst door een geregistreerde klant, bevat dit een URL naar de bestelgeschiedenis van de klant. Als de klant niet geregistreerd is, wordt het bestelnummer als platte tekst weergegeven. |
| ${order.adminUrl} | Voegt een link naar de bestelling toe in het bedieningspaneel van de winkel. |
| ${order.dateCreated} | De datum waarop de bestelling is geplaatst. |
| ${order.paymentStatus} | De huidige betaalstatus van de bestelling. |
| <@paymentStatusColor/> | Wijzigt de kleur van het onderdeel ${order.paymentStatus} afhankelijk van de status van de betaling. |
| ${order.extTransactionId} |
De transactie-ID voor de bestelling (voor zover deze bestelling een transactie-ID heeft). Een voorbeeld van deze variabele in de sjablooncode: |
| ${order.subtotal} | Het subtotaal van de bestelling. |
| ${order.subtotalWithoutTax} | Het subtotaal van de bestelling excl. belastingen (zonder verzendkosten). |
| ${order.total} | Het totaal van de bestelling. |
| ${order.shippingMethod} | De naam van de verzendmethode. |
| ${order.shippingCost} | Het verzendtarief voor de bestelling. |
| ${order.weight} | Het totale gewicht van de bestelde artikelen. |
| <#list order.taxes as tax> </#list> | Een lijst van de belastingen die over de bestelling worden geheven. |
| ${tax.name} | De naam van de belasting. |
| ${tax.value} | Het bedrag van de belasting. |
| <#list order.discounts as discount> </#list> | Een lijst met op de bestelling toegepaste kortingen. |
| ${discount.name} | De naam van de korting. |
| ${discount.value} | Het bedrag van de korting. |
| ${order.couponPercent} | Het op de bestelling toegepaste percentage van de kortingscoupon. |
| ${order.couponName} | De naam van de kortingscoupon. |
| ${order.couponCode} | De code van de kortingscoupon. |
| ${order.totalDiscount} | De totale waarde van de korting op de bestelling. |
| ${order.isShippingRequired} | |
| ${order.shippingAddress} | Het volledige verzendadres voor de bestelling. Het is ook mogelijk om elk onderdeel van het verzendadres apart weer te geven. |
| ${order.shippingAddress.name} | De naam van de klant. |
| ${order.shippingAddress.companyName} | De in het verzendadres opgegeven bedrijfsnaam. |
| ${order.shippingAddress.street} | De in het verzendadres opgegeven straat. |
| ${order.shippingAddress.city} | De in het verzendadres opgegeven plaats. |
| ${order.shippingAddress.country} | Het in het verzendadres opgegeven land. |
| ${order.shippingAddress.countryCode} | De landcode die is opgegeven in het verzendadres van de klant |
| ${order.shippingAddress.postalCode} | De in het verzendadres opgegeven postcode. |
| ${order.shippingAddress.state} | De in het verzendadres opgegeven staat. |
| ${order.shippingAddress.stateCode} | De code van de staat die is opgegeven in het verzendadres van de klant. |
| ${order.shippingAddress.phone} | Het telefoonnummer van de klant. |
| ${order.shippingAddress.province} | De in het verzendadres opgegeven provincie. |
| ${order.shippingAddress.provinceCode} | De provinciecode die is opgegeven in het verzendadres van de klant |
| ${order.shipping.cost} | De verzendkosten incl. belastingen. |
| ${order.shipping.costWithoutTax} | De verzendkosten excl. belastingen. |
| ${order.shipping.taxesTotalPercentValue} | De som van de procentuele waarden van alle belastingen over verzendkosten. |
| ${order.shipping.taxesTotalAbsoluteValue} | De som van alle belastingen over verzendkosten als absoluut bedrag. |
| <#list order.shipping.taxes as shippingTax> </#list> | Een lijst van de belastingen over de verzendkosten van de bestelling. |
| ${shippingTax.name} | De naam van de verzendkostenbelasting. |
| ${shippingTax.percentValue} | De procentuele waarde van de belasting over verzendkosten. |
| ${shippingTax.absoluteValue} | De absolute waarde van de belasting over verzendkosten. |
| ${order.billingAddress} | Het volledige factuuradres voor de bestelling. Het is ook mogelijk om elk onderdeel van het factuuradres apart weer te geven. |
| ${order.billingAddress.name} | De naam van de klant. |
| ${order.billingAddress.companyName} | De in het factuuradres opgegeven bedrijfsnaam. |
| ${order.billingAddress.street} | De in het factuuradres opgegeven straat. |
| ${order.billingAddress.city} | De in het factuuradres opgegeven plaats. |
| ${order.billingAddress.country} | Het in het factuuradres opgegeven land. |
| ${order.billingAddress.countryCode} | De landcode die is opgegeven in het factuuradres van de klant |
| ${order.billingAddress.postalCode} | De in het factuuradres opgegeven postcode. |
| ${order.billingAddress.state} | De in het factuuradres opgegeven staat. |
| ${order.billingAddress.stateCode} | De code van de staat die is opgegeven in het factuuradres van de klant. |
| ${order.billingAddress.phone} | Het in het factuuradres opgegeven telefoonnummer. |
| ${order.billingAddress.province} | De in het factuuradres opgegeven provincie. |
| ${order.billingAddress.provinceCode} | De provinciecode die is opgegeven in het factuuradres van de klant. |
| ${order.pickupTime} | Het door de klant gekozen tijdstip voor ophalen. |
| ${order.isPaid} | |
| ${order.paymentMethod} | De titel 'Betaalmethode:' en de naam van de betaalmethode. |
| ${order.paymentMethod.isOnline} | |
| ${order.paymentMethod.instructionsTitle} | De titel van de betaalinstructies. |
| ${order.paymentMethod.instructions} | De inhoud van de betaalinstructies. |
| ${order.paymentMethod.name} | De naam van de betaalmethode. |
| ${order.orderComments} | De opmerkingen bij de bestelling. |
| ${order.privateAdminNotes} | Toont de bestelnotities voor het personeel die zijn toegevoegd door de winkeleigenaar. |
| ${order.isPaymentStatusUpdated} | |
| ${order.isFulfillmentStatusUpdated} | |
| ${order.fulfillmentStatus} | De huidige afhandelstatus van de bestelling. |
| ${order.trackingNumber} | Het trackingnummer van de bestelling indien ingeschakeld. |
| ${order.trackingUrl} | Voegt de URL van de trackingpagina toe bij door de vervoerder berekende verzendopties. |
| ${order.affiliateID} | De affiliate-ID van de bestelling. |
| ${order.extraFields} | |
| <#list order.extraFields as extraField> </#list> | De lijst van extra velden van de bestelling. |
| ${extraField.key} | De sleutel van het extra veld. |
| ${extraField.value} | De waarde van het extra veld. |
| ${extraField.title} | Optioneel. De titel van het extra veld. |
| ${extraField.orderDisplaySection} | Optioneel. De plaats van het veld in de bestelgegevens. |
| ${extraField.type} | Het type van het extra veld. |
| <#list order.surcharges as surcharge> | De lijst van toeslagen voor de bestelling. |
| ${surcharge.id} | De ID van een toeslag. |
| ${surcharge.value} | De waarde van een toeslag. |
| ${surcharge.type} | Of een toeslag absoluut of een percentage is. |
| ${surcharge.description} | De beschrijving van een toeslag. |
| ${surcharge.total} | Het totaal van een toeslag. |
| ${surcharge.taxable} | Of de toeslag belastbaar is. |
| ${surcharge.showZeroSurchargeInTotal} | Een nultoeslag in het totaal. |
Nuttige functies voor extra velden van bestellingen
| Naam | Beschrijving |
| getOrderExtraField(key) | Retourneert het hele ExtraField-object (met de velden sleutel, waarde, titel enz.) |
| getOrderExtraFieldValue(key) | Retourneert het veld waarde van het ExtraField-object |
Variabelen voor informatie over producten
| Naam | Beschrijving |
| ${product.name} | De naam van het product. |
| ${product.sku} | Het artikelnummer van het product. |
| ${product.quantity} | De hoeveelheid van het product. |
| ${product.adminUrl} | De URL van de productpagina in het bedieningspaneel van de winkel. |
| ${product.customerUrl} | Hiermee wordt de URL van de productpagina toegevoegd. |
| ${product.imageUrl} | De productafbeelding. |
| ${product.warningLimit} | Het aantal artikelen op voorraad dat de 'Melding van lage voorraad' activeert. |
| ${product.options} | |
| <#list product.options as option> </#list> | De lijst met productopties en invoervelden. |
| ${option.name} | De naam van de optie of het invoerveld. |
| ${option.value} | De waarde van de geselecteerde optie/het geselecteerde invoerveld. |
| ${product.attributes} | |
| <#list product.attributes as attribute> </#list> | De lijst van verborgen attributen die zijn ingesteld voor het product. |
| ${attribute.name} | De titel van het verborgen attribuut. |
| ${attribute.value} | De naam van het verborgen attribuut. |
| <#list product.visibleAttributes as visibleAttribute> </#list> | De lijst van attributen die zijn ingesteld voor het product. |
| ${visibleAttribute.name} | De titel van het attribuut. |
| ${visibleAttribute.value} | De naam van het attribuut. |
Beschikbare variabelen voor informatie over de winkel
| Naam | Beschrijving |
| ${store.id} | De winkel-ID. |
| ${store.name} | De naam van de winkel. |
| ${store.logoUrl} | Hiermee wordt de URL van het winkellogo opgeroepen. |
| <@storeLogo/> | Het logo van de winkel. Als er geen logo is opgegeven, wordt de naam van de winkel weergegeven. |
| ${store.storeUrl} | Hiermee wordt de URL van de winkeletalage opgeroepen. |
| ${store.companyEmail} | Het e-mailadres van het bedrijf, dat is opgegeven in de winkelinstellingen. |
| ${store.customerOrdersPageUrl} | Hiermee wordt de URL van de pagina met de bestelgeschiedenis van de klant opgeroepen. |
| <#list store.legalPages as page> </#list> | De lijst van juridische pagina's. |
| ${page.name} | De naam van een bepaalde juridische pagina. |
| ${page.url} | Hiermee wordt de URL van een bepaalde juridische pagina opgeroepen. |
| <@legalPages/> | De lijst van juridische pagina's in één tekenreeks. |
| ${store.controlPanelUrl} | Voegt de URL van het bedieningspaneel van de winkel toe aan het bericht. |
| ${store.egoodsLinkLifetime} | De levensduur van een link naar e-goederen. |
| ${store.egoodsMaxDownloadAttempts} | Het maximale aantal pogingen voor het downloaden van e-goederen. |
| ${store.officeAddress} | Het fysieke adres van de winkel dat is opgegeven in de winkelinstellingen. |
| ${store.resetPasswordUrl} | Voegt een URL voor het resetten van het wachtwoord van een klant toe aan het bericht. |
| ${store.businessRegistrationID} | De ID van de inschrijving van de winkel (btw-nummer). |
Variabelen voor informatie over het merk
| Naam | Beschrijving |
| ${brand.name} | Onze naam. |
| ${brand.logoUrl} | Hiermee wordt de URL van ons logo opgeroepen. |