Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Current »

Single Email Variables

Please note that for the email variables to work, users must add the @ in front of it.

For example:  @LastOrderCampaignPrimaryDomain

Campaign Details

Variable

Description

Composition

  LastOrderCampaignPrimaryDomain

LastOrderCampaignPolicyPageUrl

LastOrderCampaignPolicyPageUrl

Last order details

Variable

Description

Composition

LastOrderNumber

LastOrderDate

LastOrderShippingDate

LastOrderCampaignName

LastOrderProductName

LastOrderQty

WarrantyExpiryDate

WarrantyPeriodType

TrackingNumberList

ShipmentTrackingUrl

ShipmentTrackingNumber

ShipmentTrackingCourier

ShippingTrackingUrl

TrackingNumberUrlList

TrackingNumberLastStatusList

Descriptor

TypeOfPayment

PaymentInformation

ProductBrandedList

AddressVerificationUrl

Digital orders

Variable

Description

Composition

DigitalOrderFilePassword

DigitalOrderFileUrl

Customer details

Variable

Description

Composition

CustomerReferenceNumber          

CustomerEmail

CustomerLastName     

CustomerFirstName

CustomerFullName

CustomerPassword

Customer addresses

Variable

Description

Composition

CustomerBillingAddress

CustomerShippingAddress

Last order's price details              

Variable

Description

Composition

LastOrderAmount

LastOrderShippingAmount

LastOrderFullRetailPrice

LastOrderSavingsAmount

LastOrderFullPackagePrice

LastOrderDiscontedPackagePrice

LastOrderFullProductPrice

LastOrderDiscontedProductPrice

LastOrderTotalAmount

LastOrderSurchargeAmount

OrderAmountWithInstallment

TotalTaxAmount

Total Tax Amount

Variable

Description

Composition

ProductTaxAmount

ProductSavingsAmount(FullPrice-DiscountedPrice)

ProductSavingsAmount(FullPrice-DiscountedPrice-Coupon)

OrderSavingsAmount(FullPrice-DiscountedPrice)

OrderSavingsAmount(FullPrice-DiscountedPrice-Coupon

Continuity details

Variable

Description

Composition

NextCycleChargeAmount

NextCycleChargeDate

Pre-sale

All events

Variable

Description

Composition

PreSaleEvent

 PreSaleCurrencyCod

  PreSaleUnitPrice

PreSaleUnitUSDPrice     

PreSaleQuantity

 PreSaleTotalPrice

 PreSaleTotalUSDPrice

 PreSaleAmountSaved

Presale - Order Confirmation             

Variable

Description

Composition

PreSaleOCCurrencyCode

PreSaleOCPrice

PreSaleOCUSDPrice

PreSaleOCFirstCharge

PreSaleOCSecondCharge

PreSaleOCDiscount

PreSalePaidPrice

PreSaleFSWPrice

PreSaleFSWBillingDate

PreSaleFSWDescriptor

Presale - Intellectual Property                

Variable

Description

Composition

PreSaleIPCurrencyCode

PreSaleIPPrice

PreSaleIPUSDPrice

Presale - Factory Confirmation

Variable

Description

Composition

PreSaleFCCurrencyCode

PreSaleFCPrice

PreSaleFCUSDPrice

 Presale - Shipment Confirmation                

Variable

Description

Composition

PreSaleSCCurrencyCode

PreSaleSCPrice

PreSaleSCUSDPrice

Delivery estimates

Variable

Description

Composition

AddDateEN(1)

AddDateEU(1)

LastOrderDtAddDateEN(n)

 Estimate order date

gets LastOrderDtAddDateEN variable and add (n) days to it .

PreSaleEstimatedShippingDate

Presale Date

Get the estimated shipping date this field is configured into the presale configuration section at campaing.

this variable will be sum up with order date

Ex:

order date: 2021-02-02

PreSaleEstimatedShippingDate: 10

order date + PreSaleEstimatedShippingDate

PreSale Date = 2021-02-12

Product

Variable

Description

Composition

ProductImageUrl

Customer Service Template

Variable

Description

Composition

@CSTemplateHeadline

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable is to add the title of the email.

@CSTemplatePhoneNumber

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable is replaced by the Customer Service phone number.

@CSTemplateAddress

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable is to add the business address to the email.

@CSTemplateSubtitle

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable is to add the subtitle to the email.

@CSTemplateEmail

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable is replaced by the Customer Service email address.

@CSTemplateCallToActionButtonLabel

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable is to customize the name it goes on the CTA button (e.g. Submit, FAQs, etc).

@CSTemplateCallToActionButtonUrl

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable is to customize the CTA button by adding the link that the button will redirects to once clicked (e.g. Submit, FAQs, etc).

@CSTemplateUnsubscribeLabel

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable is to include the name it goes on the unsubscribe CTA button

@CSTemplateUnsubscribeUrl

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable is to customize the CTA button by adding the link that the button will redirects to once clicked.

@CSTemplateImageUrl

Check the following helpdesk article to know how and where to use them in CRM: Customer Service Templates.

This variable will be replcaed by an image, for instance users can add the brand of the product.

Email Template Generic Variables

Variable

Description

Composition

emailTemplateGenericVariables = new string[]

@HEADER_IMAGE_URL

@LOGO_IMAGE_URL

@CUSTOMER_SERVICE_ADDRESS

@CUSTOMER_SERVICE_PHONE

@FOOTER_IMAGE_URL

Bundled Email Variables

Please note that for the email variables to work, users must add the @ in front of it.

For example:  @LastOrderCampaignPrimaryDomain

Regular Order

Variable

Description

Composition

MasterOrderNumber

Get of Order Number of the Regular Order (New Template)

MainOrderNumber

Get of Order Number of the Regular Order

MainOrderDate

Get Date of Regular Order

EX: (MM/DD/YYYY)

MainOrderShippingDate

Get Shipping Date of Regular Order

EX: (MM/DD/YYYY)

MainOrderProductName

Get Product Name on Regular Order

Descriptor

Get Text of receipt on statement RegularOrder

TypeOfPayment

Get Payment Type Name

Ex: GiftCard, Visa, MasterCard ....

ShippingTrackingUrl

Get Tracking Numbers with Query Link Regular Order

IsTrialDisplay

Hide HTMLtag content

Will only display content if there are any trial products in the bundled

Last Order Details

Variable

Description

Composition

LastOrderNumber

Get the last order number linked to the Regular Order

LastOrderDate

Get the last Date (Create Date) linked to the Regular Order

EX: (MM/DD/YYYY)

Regular Order Campaign Details

Variable

Description

Composition

MainOrderCampaignName

Get the name of the regular order campaign

MainOrderCampaignUrl

Get the url of the landing page of Regular Order

MainOrderCampaignPrimaryDomain

Get the domain of the landing page of Regular Order

EX:
Landing Page: https://www.myCampaing.com/landingPage.html
Host: MyCampaing.com

MainOrderCampaignPolicyPageUrl

Get the url of the Policy page of Regular Order

Customer details

Variable

Descritpion

Composition

CustomerEmail

Get customer email the of regular order

CustomerFirstName

Get customer first name the of regular order

CustomerLastName

Get customer last name the of regular order

CustomerFullName

Get customer Name the of regular order

CustomerReferenceNumber

Get Reference Number of Customer

OrderId + Verifying digit, the same order number

Customer addresses

Variable

Description

Composition

CustomerBillingAddress

Get billing address information

EX:
FirstName Middle Name LastName
Address1
Address2 (If any)
City, State ZipCode
CountyCode

CustomerShippingAddress

Get shipping address information

EX:
FirstName Middle Name LastName
Address1
Address2 (If any)
City, State ZipCode
CountyCode

Order Aggregation

Variable

Description

Composition

LastOrderSavingsAmount

Get Sum OrderSavingsAmount

LastOrderAmount

Get Sum OrderAmount

TotalProductAmount

Get Sum OrderAmount

LastOrderTotalAmount

Get Sum OrderTotalAmount

TotalOrdersAmount

Get Sum OrderTotalAmount

TotalShippingAmount

Get Sum OrderShippingAmount

TotalSurchargeAmount

Get Sum OrderSurchargeAmount

TotalProductsQuantity

Number of orders in bundled

It is not the sum of items linked on orders

TotalPreSaleOCFirstCharge

Total amount paid on first charge

LastOrderTotalRemainingAmount

Total remaining amount to be paid

OrderSavingsAmount(FullPrice-DiscountedPrice)

Sum ProductSavingsAmount(FullPrice-DiscountedPrice)

OrderSavingsAmount(FullPrice-DiscountedPrice-Coupon)

Sum ProductSavingsAmount(FullPrice-DiscountedPrice-Coupon)

TotalAmountWithInstallment

Billing Attempt Amounts

TotalTaxAmount

Total taxes amount

Delivery estimates

Variable

Description

Composition

AddDateEN(n)

Estimate order date (MM/dd/yyyy)

Based on the date the email was sent gets AddDateEN variable and add (n) days to it .

AddDateEU(n)

Estimate order date (dd/MM/yyyy)

Based on the date the email was sent gets AddDateEU variable and add (n) days to it .

LastOrderDtAddDateEN(n)

Estimate order date (MM/dd/yyyy)

Based on order creation date. gets LastOrderDtAddDateEN variable and add (n) days to it .

LastOrderDtAddDateEU(n)

Estimate order date (dd/MM/yyyy)

Based on order creation date. gets LastOrderDtAddDateEU variable and add (n) days to it .

Top Picks

Please note that Variables only work within BeginTopPickLoop and EndTopPickLoop

Variable

Description

Composition

BeginTopPickLoop

TopPickTitle

GetTop Pick Title

TopPickSubTitle

Get Top Pick Sub Title

TopPickTooltip

Get Top Pick ToolTip

TopPickCallToActionImageUrl

Add action to top pick image

action must be defined in the email template (click, hover)

TopPickImageUrl

Get Image Top Pick

image size must be defined in the email template

EndTopPickLoop

Bundled emails Loop

Variables only work within BeginLoop and EndLoop     

Order Details

Variable

Description

Composition

OrderNumber

Get Order Number

OrderDate

Get Date (CreateDate)

EX: (MM/DD/YYYY)

OrderShippingDate

Get Shipping Date

EX: (MM/DD/YYYY)

OrderProductName

Get Product Name

OrderQty

Get Qty Products

LastOrderQty

Get Qty Products

LastOrderFullPackagePrice

Get Full Package Price 

LastOrderDiscontedPackagePrice

Get Discounted Package Price 

LastOrderFullProductPrice

Get Full Product Price 

LastOrderDiscontedProductPrice

Get Discounted Product Price 

OrderFullRetailPrice

Get Full Retail Price 

Ex:
When the Product for a package will return LastOrderFullPackagePrice
If not a package LastOrderFullProductPrice 

OrderTotalAmount

Get Order Amount

If there is a readjustment in the value, it will get the same

OrderSavingsAmount

Get Savings Amount

EX OrderFullRetailPrice - OrderTotalAmount

OrderAmount

Get Price of Product

OrderShippingAmount

Get Shipping Amount

OrderSurchargeAmount

Get Surcharge Amount

ProductImageUrl

Get Product Image

The result is a square with the image of size 135x135 px
If you don't have an image linked to the product, it doesn't display anything

ProductSavingsAmount(FullPrice-DiscountedPrice)

OrderCurrency = '$'
FullProductPrice = 100.00
DiscountedProductPrice = 25.00
ProductSavingsAmount(FullPrice-DiscountedPrice) = FullProductPrice - DiscountedProductPrice
//output
$ 75.00

ProductSavingsAmount(FullPrice-DiscountedPrice-Coupon)

OrderCurrency = '$'
ProductSavingsAmount = ProductSavingsAmount(FullPrice-DiscountedPrice)
ProductAmount= 25.00
DiscountedProductPrice = 25.00

ProductSavingsAmount(FullPrice-DiscountedPrice-Coupon) = ( DiscountedProductPrice - ProductAmount) + ProductSavingsAmount
//output
$ 75.00

Payments Details

Variable

Description

Composition

TypeOfPayment

Get Payment Type Name

Ex: GiftCard, Visa, MasterCard ....

Descriptor

Get Text of receipt on statement

PaymentInformation

Get Payment Information

Returns the last 4 digits of the card, if you do not have this information the Tracking Number is returned

Trial Details

Variable

Description

Composition

IsTrialDisplay

Hide HTMLtag content

Will only display the content if for the trial product

TrialDays

Trial period days duration limit

TrialRemainingAmount

Amount to be charged after trial period limit

Tax Details

Variable

Description

Composition

ProductTaxAmount

Get tax amount of product

Default is 0

Warranty Details

Variable

Descritption

Composition

WarrantyPeriodType

Get Warranty Type

EX: LIFETIME / Yearly / Monthly

WarrantyExpiryDate

Get Warranty Expiry Date

Warranty period starts on order create date

Continuity Details

Variable

Description

Composition

NextCycleChargeAmount

Get Next Charge Amount

NextCycleChargeDate

Get Next Charge Date

Shipping Details

Variable

Description

Composition

TrackingNumberList

Get Tracking Numbers

TrackingNumberLastStatusList

Get tracking Numbers with Status

If you don't have a status, the tracking number doesn't appear

TrackingNumberUrlList

Get Tracking Numbers with Query Link

If you don't have a status, the tracking number doesn't appear

ShippingTrackingUrl

Get Tracking Numbers with Query Link

Digital Details

Variable

Description

Composition

DigitalOrderFileUrl

DigitalOrderFilePassword

Pre-Sale Details     

Variable

Desciption

Composition

PreSaleCurrencyCode

Get Currency code for presale

PreSalePrice

Get first price for presale

PreSaleUSDPrice

Get first priceUSD for presale

OrderRemainingBalance

Get the remaining amount of the order

OrderCurrency = '$'
OrderAmount = 100.00
PreSaleFirstCharge = 25.00
OrderRemainingBalance = OrderAmount - PreSaleFistChage
//output
$ 75.00

PreSaleEstimatedShippingDate

Get an estimated shipping date

EX
Future Sale contains an estimated number of days for the example shipping 5 days

Based on the date of creation of the Order, 5 days are added to give the estimated date

Pre-Sale All Events Details     

Variable

Description

Composition

PreSaleFSWBillingDate

Get the billing date

PreSaleFSWPrice

Get the billing price

PreSaleFSWDescriptor

Get Text of receipt on statement

PaymentInformation

Get Payment Information

Returns the last 4 digits of the card, if you do not have this information the Tracking Number is returned

Refund Email Variables

Orders Details   

Variable

Description

Composition

MasterOrderNumber

Get of Order Number of the Regular Order (New Template)

MainOrderNumber

Get of Order Number of the Regular Order

CurrencyCode

Get Currency code

RefundAmount

Total amount refunded

TotalProductAmount

Get Sum Product Amount

TotalShippingAmount

Get Sum Product Shipping

Balance

Total amount remaining for refund

EX: @LastOrderTotalAmount - @RefundAmount

LastOrderTotalAmount

Get Sum OrderAmount

LastOrderDate

Get Date of Regular Order

EX: (MM/DD/YYYY)

Descriptor

Get Text of receipt on statement RegularOrder

Customer details

Variable

Descritpion

Composition

CustomerFirstName

Get customer first name the of regular order

CustomerLastName

Get customer last name the of regular order

CustomerFullName

Get customer Name the of regular order

Customer addresses

Variable

Description

Composition

CustomerBillingAddress

Get billing address information

EX:
FirstName Middle Name LastName
Address1
Address2 (If any)
City, State ZipCode
CountyCode

CustomerShippingAddress

Get shipping address information

EX:
FirstName Middle Name LastName
Address1
Address2 (If any)
City, State ZipCode
CountyCode

Refund emails Loop

Variables only work within BeginLoop and EndLoop     

Order Details

Variable

Description

Composition

OrderProductName

Get Product Name

OrderQty

Get Qty Products

OrderAmount

Get Price of Product with Currency Code

  • No labels