This is what you set to determine the next step. Once you're finished with your logic, at some point, you should be doing something like this: #set($result = 'NameOfNextStep')

Useful for logging during logic steps to find out why your code isn't working. Try $logger.log($customer) as an example. Log often. It's very helpful. The output will show during a text execution on a separate tab in your editor window.

The most important object. See the docs below on the $customer object and how you can use it to make a logical decision (i.e. find order history, etc.)

Used to generate coupon codes to embed in emails. Although available to the logic step, its doubtful you'll ever use it here.

Used to generate gift certificates in emails. Although available to the logic step, its doubtful you'll ever use it here.

A utility to format and handle dates

This is a catalog object, and technically out of place here since a logic step has no item groups. However the group object has many utility functions for retrieving item information. So it's included in the logic toolset. See the catalog docs above for the group object.

Useful for logging during template creation to find out why your email isn't showing what you want. Try $logger.log($customer) as an example. Log often. It's very helpful. The output will show during a text execution on a separate tab in your editor window.

The most important object. See the docs below on the $customer object and how you can use it to personalize an email. (i.e. find order history, etc.)

Used to generate coupon codes to embed in emails

Used to generate gift certificates in emails

A utility to format and handle dates

This is a catalog object, and technically out of place here since a logic step has no item groups. However the group object has many utility functions for retrieving item information. So it's included in the logic toolset. See the catalog docs above for the group object.

Provides a list of steps the recipient has traveled. This might be useful to determine the path the recipient has taken.

$logger.log()

<nothing>

$logger.log($customer.getEmail())

#set($myReturnLink = $cart.getReturnLink())

a bitly url useful for directing a customer back to their checkout.

#if("$!{cart}" != "")

## The above line is preferred to just #if($cart)
Please complete your order! Here's a 20% off coupon that is good for the next 48 hours!
#set($cCode = $coupon.generateCode('MY_20_OFF', '48'))
$cart.addUniqueCouponCode($cCode)
#set($returnLink = $cart.getReturnLink())
<a href="${returnLink}">Your Order</a>
#end

## no indentations above if this is inside the text email, or indentations will show in final output!

getReturnLink(String returnUrl, String tokenParameter)

#set($myReturnLink = $cart.getReturnLink("www.myjavascriptcheckout.com/checkout.html", "returnCode")

$cart.addUniqueCouponCode($code)

true if successful, else false. If false, $cart.getErrors() will contain a list of errors.

see getReturnLink for example

$customer.getCampaignHistory()

a list of the recipient's history in this campaign

#set($history = $customer.getCampaignHistory())

$customer.getCountOfPurchasesInLastDays(days),
$customer.getCountOfPurchasesInLastDays(itemId, days)

a count of purchases made

#set($numberOfPurchases = $customer.getCountOfPurchasesInLastDays('BLACK_SHIRT', 30))

$customer.getCountOfShipmentsInLastDays(days),
$customer.getCountOfShipmentsInLastDays(itemId, days)

a count of shipments made

#set($numberOfShipments = $customer.getCountOfShipmentsInLastDays('BLACK_SHIRT', 30))

$customer.getDisplayName()

the name of the recipient, or if that wasn't collected, their email address

Welcome $customer.getDisplayName(), here's a coupon...

$customer.getEmail()

them email address of the recipient

This email was address to: $customer.getEmail()... blah blah blah

returns a string showing what the enrollment source is. Possible values:

Abandon Cart
Auto Order - Decline
Goto Step
Mail List
Manual
Purchased Product
Return Email

$customer.getLastOrder()

Retrieves the last order the customer made. You may wish to check if they've ordered anything first (hasPurchasedEver, etc)

#set($lastOrder = $customer.getLastOrder())

$customergetOrders()

Retrieves a list of orders for the customer.

#if($customer.getOrders().size() > 5)
Wow, you're a great customer!
#end

#set($recurringInfo = $customer.getRecurringInfomation())

returns the customer's meta information related to the recurring order (also known as 'auto order' or trial order). Always call isRecurring first to ensure you're dealing with a trial order. If there is no recurring information, this method returns null. Be sure to check for a null value before using the object. This method returns a RecurringInformation object.

#if($customer.isRecurring())
#set($recurringInfo = $customer.getRecurringInfomation())
#end

$customer.getTotalForAllOrders()

Total dollars the customer has ever spent. Useful to check for spending thresholds

This returns a BigDecimal object.

$customer.getTotalForAllPurchasesInLastDays(days)

Same as above, but filters on purchases within the last XX days.

This returns a BigDecimal object.

#if($customer.getTotalForAllPurchasesInLastDays(60) > 1000)
You've spent over $1000 in the last 2 months! Here's a coupon!
#end

$customer.getTotalForAllShipmentsInLastDays(days)

Same as above, but filters on shipments within the last XX days.

This returns a BigDecimal object.

#if($customer.getTotalForAllShipmentsInLastDays(60) > 1000)
We've shipped you over $1000 in the last 60 days! Here's a coupon!
#end

## do not send a coupon to any customers who are wholesale dealers of ours

## if they are members of the Wholesale pricing tier, exit them from the campaign.

#if($customer.hasPricingTier("Wholesale"))

#set($result = '_ENDCAMPAIGN_')

#end

$customer.hasPurchasedEver(itemId)

return true if the customer has ever purchased the item.

#if($customer.hasEverPurchased('BLACK_SHIRT'))
Congratulations, you are eligible for the Green Shirt!
#end

$customer.hasPurchasedEver([itemId1, itemId2, itemId3])

Same as above, but with a list.

#if($customer.hasEverPurchased(['BLACK_SHIRT','BLUE_SHIRT','GREEN_SHIRT']))
Wow, you've bought at least one of our really great shirts!
#end

$customer.hasPurchasedInLastDays(itemId, days)

Same as above, but with a days argument.

#if($customer.hasPurchasedInLastDays('BLACK_SHIRT', 90))
Congratulations, you are bought a black shirt within the last 3 months (90 days). Go for the Green Shirt with this coupon!
#end

hasPurchasedInLastDays[itemId1, itemId2, itemId3], days)

Same as above, but with a days argument.

#if($customer.hasPurchasedInLastDays(['BLACK_SHIRT','BLUE_SHIRT','GREEN_SHIRT'], 90))
Congratulations, you are bought at least one of three shirts within the last 3 months (90 days). Here's a special coupon!
#end

hasReviewedItem(itemId1)

#if($customer.hasReviewedItem('BLACK_SHIRT')

exit the 'please review this item campaign.

#else

send the customer to an step sending them a reminder email

#end

$customer.hasShipmentInLastDays(days)

see similar 'purchased' method. Some merchants prefer shipment dates over purchase dates.

#if($customer.hasShipmentInLastDays('BLACK_SHIRT', 90))
Congratulations, you are bought a black shirt within the last 3 months (90 days). Go for the Green Shirt with this coupon!
#end

$customer.hasShipmentInLastDays(itemId, days)

see similar 'purchased' method. Some merchants prefer shipment dates over purchase dates.

#if($customer.hasShipmentInLastDays(90))
Congratulations, you made a purchase within the last 3 months (90 days). Thanks!
#end

$customer.hasShipmentInLastDays([itemId1, itemId2, itemId3], days)

see similar 'purchased' method. Some merchants prefer shipment dates over purchase dates.

#if($customer.hasShipmentInLastDays(['BLACK_SHIRT','BLUE_SHIRT','GREEN_SHIRT'], 90))
Congratulations, you are bought at least one of three shirts within the last 3 months (90 days). Here's a special coupon!
#end

$customer.isRecurring()

returns true if the customer's underlying order was a recurring order (also known as 'auto order' or trial order). If this is true, then you may call getRecurringInformation for additional information

#if($customer.isRecurring())
#set($recurringInfo = $customer.getRecurringInfomation())
#end

$customer.lastOrderContains(itemId)

checks to see if the last order contained a specific item.

#if($customer.lastOrderContains('BLACK_SHIRT'))
Thanks for buying our best selling item!
#end

$customer.lastOrderContains([itemId1, itemId2, itemId3])

checks to see if the last order contains one of the items in the list

#if($customer.lastOrderContains(['BLACK_SHIRT','BLUE_SHIRT','GREEN_SHIRT']))
Congratulations, you are bought at least one of three shirts in your last order. Here's a special coupon!
#end

$coupon.generateCode('COUPONID', 'hoursToLive')

generates a unique coupon code based on the coupon id/code

#if($customer.getTotalForAllOrders() > 1000)
You've spent over $1000! Here's a 20% off coupon that is good for the next 48 hours!
Coupon Code: $coupon.generateCode('MY_20_OFF', '48')
#end

#set($ear = $externalAutoresponderFactory.getExternalAutoresponder($name))

An implementation of that particular external autoresponder.

#set($ear = $externalAutoresponderFactory.getExternalAutoresponder("LyrisHQ"))

#set($result = $externalAutoresponder.subscribeReturnEmail($cart, $listName, $couponCode))

true/false if subscription successful

#set($result = $externalAutoresponderFactory.getExternalAutoresponder("LyrisHQ").subscribeReturnEmail($cart, "MyList1", "MyCouponCode1"))

generate(amount)

creates a gift certificate for a certain amount

Dear $customer.getDisplayName(),
Here is a gift certificate for you to thank you for your business.
#set($giftCertificate = $giftCertificateManager.generate(25.00))
Please use the following code on your next purchase: $giftCertificate.getCode()
Amount of gift certificate: $giftCertificate.getRemainingBalance()
Thanks!

generate(amount, addToExisting)

same as above, but will see if the recipient already has an existing gift certificate and add to that amount, else a new certificate is created.

generate(amount, addToExisting, expirationDays)

same as above, but will see if the recipient already has an existing gift certificate and add to that amount, else a new certificate is created. The certificate will expire in the given days provided.

generate(amount, expirationDays)

creates a gift certificate for a certain amount that expires in a certain amount of days

The name of the campaign step.

the result of the step. will almost always be 'success', else the campaign would've ended and you wouldn't be running logic against the recipient.

when the step happened

String

NO

The Order ID

boolean

Not Possible

if false, this recurring order is dead/ended

String

NO

The unique code associated with this recurring order

int

Not Possible

The number of attempts to charge a card. If non-zero, then billing has failed at least one time (see failure reason for why)

java.sql.Timestamp

YES

The date when the next charge attempt will happen

Collection of RecurringItems

NO

A collection of recurring items. See RecurringItem for details.

String

YES

If cancelled, this field will contain the person who handled the cancellation.

java.sql.Timestamp

YES

If cancelled, this will be the datetime when of cancellation.

Integer

YES

If not null, this is the number of orders before cancellation.

String

YES

If not null, provides insight into why a recurring order failed. Do not program logic based on this field. UltraCart reserves the right to change this field's contents at whim.

java.sql.Timestamp

YES

If disabled, this is the datetime when the order was disabled/ended.

java.sql.Timestamp

YES

datetime of the next shipment

String

NO

a string showing the order frequency. do not code logic against these values. they may change.

Integer

YES

the number of orders left

BigDecimal

YES

The sales amount so far.

int

NO

The number of rebills done for this item.

BigDecimal

YES

The amount of rebills done for this item.

java.sql.Timestamp

YES

datetime of the last order

java.sql.Timestamp

YES

datetime of when no more orders will happen

BigDecimal

YES

If merchant has done an override, this is the new unit cost.

String

YES

If merchant has done an override, this is the new item id.

BigDecimal

YES

If merchant has done an override, this is the new quantity.

Integer

YES

If merchant has done an override, this is the new remaining orders.

String

YES

If merchant has done an override, this is the original item id.

BigDecimal

YES

If merchant has done an override, this is the original quantity.

Integer

YES

If merchant has done an override, this is the new schedule.

BigDecimal

YES

If merchant has done an override, this is the new discount.