To be able to customize your notification emails you need to know what variables are available, and what properties those objects have. Below is a list of all the Cratejoy notifications with references to their available variables.

All notifications

{{ store }} Your store Store
{{ customer }} The target customer Customer
{{ base_url }} The url of your store. Ex. 'http://yourstore.cratejoy.com/ String
{{time_now}} The current date and time Date

Customer notifications


Welcome Message

{{ referral_url }} Referral URL if you have an active referral campaign String

Order Receipt

{{ order }} The order that was placed Order

Shipment Notice

{{ shipment }} The shipment that was generated Shipment
{{ order }} The order that caused the shipment to get generated Order

Renewal Success / Renewal Failure

{{ subscription }} The subscription that renewed Subscription
{{ order }} The renewal order Order

Refunded Order

{{ order }} The order that was refunded Order

Cancelled Subscription

{{ subscription }} The subscription that was cancelled Subscription
{{ order }} The initial order of the subscription Order
{{ reason }} Cancellation reason String
{{ note }} Cancellation note String

Cancelled Shipment

{{ shipment }} The shipment that was cancelled Shipment

Subscription Change

{{ subscription }} The subscription that was changed Subscription
{{ order }} The initial order of the subscription Order

Subscription Renewal Skipped

{{ subscription }} The subscription that skipped renewal Subscription

Subscription End Date Updated by Merchant

{{ subscription }} The subscription that was updated Subscription

Admin notifications


User registered

{{ referral_url }} Referral URL if you have an active referral campaign String

Order Received

{{ order }} The order that was placed Order

Subscription Renewal / Renewal Failure

{{ subscription }} The subscription that renewed Subscription
{{ order }} The renewal order Order

Bulk Updates

{{ operation }} The bulk operation that was completed String

Cancelled Subscription

{{ subscription }} The subscription that was cancelled Subscription
{{ order }} The initial order of the subscription Order
{{ reason }} Cancellation reason String
{{ note }} Cancellation note String

Subscription Change

{{ subscription }} The subscription that was changed Subscription
{{ order }} The initial order of the subscription Order

Subscription Renewal Changed

{{ subscription }} The subscription that changed it's renewal date Subscription

Customer Info Changed

{{ address }} The address that changed, or None if address was not changed Address
{{ billing }} The billing info that changed, or None if billing was not changed CustomerPay
{{ changed }} A dictionary containing information about what changed Dictionary

Inventory Out Of Stock

{{ instance }} The product instance that's out of stock ProductInstance

Rebill Summary

{{ rebill_information }} Information about the upcoming rebilling RebillInformation

Gift Notifications


Received Gift Subscription

{{ gift }} Information about the gift Gift

Receiver Claimed Gift Subscription

{{ gift }} Information about the gift Gift

Receiver Gift Subscription Receipt

{{ order }} The gift recipients order Order

Referral Program Notifications


Referral Goal Met / Referral Progress

{{ ref_token }} The referral token ReferalToken

Referral Notification

{{ ref_token }} The referral token ReferalToken
{{ referral_url }} The URL you are referring people to String
{{ first_name }} The first name of the recipient String
{{ recipient }} The E-Mail address of the recipient String

Loyalty Program Notifications


Loyalty Progress Notification

{{ loyalty_award }} The amount of points awarded to the customer Integer
{{ loyalty_alias }} The name of your loyalty point system String

Loyalty Redemption Notification

{{ loyalty_reward }} Information about the reward the customer just redeemed points for LoyaltyReward
{{ loyalty_alias }} The name of your loyalty point system String
{{ loyalty_coupon }} The coupon code that was generated for the loyalty redemption LoyaltyCoupon

Object Reference


Store

{{ store.name }} The name of your store String
{{ store.settings }} The store settings object. StoreSettings

StoreSettings

{{ settings.support_email }} Your support email address String
{{ settings.support_display }} Customer support friendly name. Ex. 'Mike's Store Support' String
{{ settings.address }} The address of your store Address

Address

{{ address.to }} Recipient Ex. 'John Smith' String
{{ address.company }} Company. Ex. 'ACME Inc' String
{{ address.street }} Street. Ex. '3505 Main St.' String
{{ address.unit }} Unit, Apt, Street2. Ex. 'Unit #307' String
{{ address.city }} City. Ex. 'Austin' String
{{ address.zip_code }} Postal Code. Ex. '78701' String
{{ address.state }} State or province. Ex. 'TX' String
{{ address.country }} Country. Ex. 'USA' String

Customer

{{ customer.id }} Internal ID of the customer. Integer
{{ customer.first_name }} First name. Ex. 'John' String
{{ customer.last_name }} Last name. Ex. 'Smith' String
{{ customer.name }} Full name. Ex. 'John Smith' String
{{ customer.email }} E-mail address. Ex. '[email protected]' String

Order

{{ order.id }} Order reference number. Integer
{{ order.placed_at }} Date and time order was placed Date
{{ order.total }} Total of order. Including any taxes and shipping. [cents] Integer
{{ order.total_price }} Total of order before tax and shipping. [cents] Integer
{{ order.total_tax }} Total of the tax on this order. [cents] Integer
{{ order.total_shipping }} Total shipping cost. [cents] Integer
{{ order.total_refund }} The total amount of all refunds applied to this order. [cents] Integer
{{ order.ship_address }} Address where order is to be shipped to. Address
{{ order.products }} A list of products that were in the cart when the order was completed. [CartProduct, ...]
{{ order.coupons }} A list of coupons that were in the cart when the order was completed. [CartCoupon, ...]
{{ order.gifts }} A list of gifts that were in the cart when the order was completed. [CartGift, ...]
{{ order.transactions }} A list of transactions associated with this order. [Transaction, ...]

Shipment

{{ shipment.id }} Store-side Identifier for the shipment. Integer
{{ shipment.tracking_number }} Tracking number of the shipment, if available. String
{{ shipment.calc_is_partial_order() }} True if the shipment belongs to an order with multiple shipments. Boolean

CartProduct

{{ cart_product.price }} Price of the product, without tax or shipping. [cents] Integer
{{ cart_product.quantity }} The quantity of this product. Integer
{{ cart_product.instance }} The product instance. Ex. An XL, Red T-Shirt is the instance of a T-Shirt product. ProductInstance
{{ cart_product.subscription }} The resulting subscription of the product, if a subscription was being bought. Otherwise it's value is not set. Subscription

CartCoupon

{{ cart_coupon.discount_value }} The discount this coupon applied to the products in the cart. [cents] Integer
{{ cart_coupon.discount_name }} The name of the discount. Ex. '25% off on Sunday the 9th' String
{{ cart_product.code_used }} The code used to redeem this coupon. Ex. '25OFFSUNDAY' String

CartGift

{{ cart_gift.price }} Price of the gift. [cents] Integer
{{ cart_gift.instance }} The gift product instance. ProductInstance

Transaction

{{ transaction.created_at }} The date and time when the transaction was created. Date
{{ transaction.total }} The total of the transaction. [cents] Integer
{{ transaction.order }} The order the transaction belongs to. Order

ProductInstance

{{ product_instance.price }} Price of the product instance. [cents] Integer
{{ product_instance.sku }} The SKU of the instance String
{{ product_instance.product }} The product the instance belongs to. Product
{{ product_instance.variants }} A list of variants for this instance. Ex. Green, Large, Mint [ProductInstanceVariant, ...]

ProductInstanceVariant

{{ instance_variant.variant_type }} The type of the variant. Ex. Size ProductVariantType
{{ instance_variant.variant_value }} The value of the variant. Ex. Small ProductVariantValue

ProductVariantType

{{ variant_type.name }} Name of the variant. Ex. 'Size' String

ProductVariantValue

{{ variant_value.value }} Value of the variant. Ex. 'Large' String

Product

{{ product.name }} The name of product. Ex. 'T-Shirt' String
{{ product.description }} Description text. Ex. '100% Cotton' String

Subscription

{{ subscription.id }} The reference number for the subscription Integer
{{ subscription.customer }} The customer who the subscription belongs to Customer
{{ subscription.end_date }} Date when the subscription will renew or expire Date
{{ subscription.skipped_date }} A renewal date that will be skipped, if any Date
{{ subscription.status_string }} Status of subscription. Ex. 'active' String
{{ subscription.term }} The term of the subscription. Ex. Monthly, 3-Month prepay. SubscriptionTypeTerm
{{ subscription.autorenew }} True if the subscription is renewing automatically. Boolean
{{ subscription.orders }} A List of all orders associated with this subscription. [Order, ...]
{{ subscription.subscription_templates }} A list of the templates used for renewals. Most current one is at index [0] [SubscriptionTemplate, ...]
{{ subscription.current_template }} The current subscription template. SubscriptionTemplate
{{ subscription.previous_template }} The template previously used. SubscriptionTemplate
{{ subscription.old_end_date }} The original end date before it was updated by the merchant. Date

SubscriptionTemplate

{{ template.products }} A list of the products that will be in the next renewal [SubscriptionProduct, ...]
{{ template.coupons }} A list of the coupons that will be in the next renewal [SubscriptionCoupon, ...]
{{ template.current_total() }} The calculated total for next renewal. [cents] Integer

SubscriptionProduct

{{ sub_product.price }} The price of the product on next renewal. [cents] Integer
{{ sub_product.quantity }} The quantity to be used on next renewal. Integer
{{ sub_product.instance }} The product instance. ProductInstance

SubscriptionCoupon

{{ sub_coupon.code_used }} Coupon code to be applied on next renewal. String

SubscriptionTypeTerm

{{ term.name }} Name of the term, Ex. 'Month to Month' String
{{ term.num_cycles }} Length of term. If term is a 3 month prepay, then num_cycles is 3. Integer
{{ term.subscription_type }} Type of subscription. Monthly. SubscriptionType

SubscriptionType

{{ type.name }} Name of the type, Ex. 'Monthly' String
{{ type.cycle_days }} The number of days in a subscription cycle. Integer

ReferralToken

{{ ref_token.customer }} The customer who referred Customer
{{ ref_token.progress }} The progress of the referral Integer
{{ ref_token.campaign }} Reference to the campaign ReferralCampaign
{{ ref_token.started_on }} When the referral was sent out Date
{{ ref_token.completed_on }} When the referral was completed, or None Date

ReferralCampaign

{{ campaign.status }} Current status of the campaign. Integer
{{ campaign.goal }} The campaign goal. Integer

Gift

{{ gift.name }} Name of the gift recipient. String
{{ gift.gift_link }} Link the recipient needs to visit to claim their gift String
{{ gift.message }} The message sent to the recipient String
{{ gift.sending_order }} The gift sender's purchase order Order
{{ gift.receiving_order }} The gift recipients order, available once gift is claimed. Order
{{ gift.status_test }} The status of the gift. 'Pending', 'Unclaimed', 'Claimed' and 'Voided'

String

{{ gift.cart_gift }} The cart gift object.

cart_gift

LoyaltyReward

{{ loyalty_reward.name }} Name of the loyalty reward. String
{{ loyalty_reward.points }} Cost of the loyalty reward. Integer
{{ loyalty_reward.renewal }} Whether or not the loyalty reward is applied on renewal Boolean

LoyaltyCoupon

{{ loyalty_coupon.primary_code }} Code to manually use the loyalty coupon generated for loyalty redemption. String

Filters


date {{ order.placed_at | date }} Formats a date for more readability
length {{ order.products | length }} Gives you the length of a list
currency {{ order.total | currency }} Converts cents to a formatted currency string using the stores currency symbol. Ex. 1999 becomes $19.99