Merge Tags

Standard Merge Tags

Below is a list of standard merge tags.

Merge TagDescriptionAvailability
{order_id}The unique ID for the customer's order.Successful Order,
Successful Order Authorization,
Offer Ordered,
Order Abandoned,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning,
Shipment Posted to Fulfillment,
Shipment Shipped,
Shipment Delivered,
Shipment Return Request,
Shipment Return Received,
Gift Claimed,
Gift Claimed Notice,
Reward Profile Progress,
Reward Profile Cycle
{sale_id}The unique ID associated with the sale.Successful Order,
Successful Order Authorization,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder
{customer_id}The unique ID for the customer.Successful Order,
Successful Order Authorization,
Offer Ordered,
Order Abandoned,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning,
Shipment Posted to Fulfillment,
Shipment Shipped,
Shipment Delivered,
Shipment Return Request,
Shipment Return Received,
Gift Claimed,
Gift Claimed Notice,
Reward Profile Progress,
Reward Profile Cycle
{customer_telephone}The customer's telephone number.Successful Order,
Successful Order Authorization,
Offer Ordered,
Order Abandoned,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning,
Shipment Posted to Fulfillment,
Shipment Shipped,
Shipment Delivered,
Shipment Return Request,
Shipment Return Received,
Gift Claimed,
Gift Claimed Notice,
Reward Profile Progress,
Reward Profile Cycle
{customer_email}The customer's email address.Successful Order,
Successful Order Authorization,
Offer Ordered,
Order Abandoned,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning,
Shipment Posted to Fulfillment,
Shipment Shipped,
Shipment Delivered,
Shipment Return Request,
Shipment Return Received,
Gift Claimed,
Gift Claimed Notice,
Account Activation,
Reward Profile Progress,
Reward Profile Cycle
{customer_first_name}The customer's first name.Successful Order,
Successful Order Authorization,
Offer Ordered,
Order Abandoned,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning,
Shipment Posted to Fulfillment,
Shipment Shipped,
Shipment Delivered,
Shipment Return Request,
Shipment Return Received,
Gift Received,
Gift Claimed,
Gift Claimed Notice,
Account Activation,
Reward Profile Referral,
Reward Profile Progress,
Reward Profile Cycle
{customer_last_name}The customer's last name.Successful Order,
Successful Order Authorization,
Offer Ordered,
Order Abandoned,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning,
Shipment Posted to Fulfillment,
Shipment Shipped,
Shipment Delivered,
Shipment Return Request,
Shipment Return Received,
Gift Received,
Gift Claimed,
Gift Claimed Notice,
Account Activation,
Reward Profile Referral,
Reward Profile Progress,
Reward Profile Cycle
{transaction_id}The unique ID for the transaction.Successful Order,
Successful Order Authorization,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder
{current_datetime}The date and time when the message is sent.Available on almost all events.
{order_offer_id}The unique ID for a specific offer within an order.Offer Ordered,
Successful Transaction,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning,
Gift Claimed,
Gift Claimed Notice
{line_item_id}The unique ID for a line item.Offer Ordered,
Successful Transaction
{item_name}The name of the item.Offer Ordered,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning
{item_image}The image URL for the item.Offer Ordered,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning
{offer_name}The internal name of the offer.Offer Ordered,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning
{offer_title}The public-facing title of the offer.Offer Ordered,
Subscription Renewal Reminder,
Subscription Cancelled,
Subscription Reactivated,
Subscription Paused,
Subscription Unpaused,
Subscription Expired,
Subscription Expiring Warning
{next_charge_date}The date of the next scheduled charge for a subscription.Offer Ordered,
Successful Transaction,
Subscription Reactivated,
Subscription Unpaused
{shipment_id}The unique ID for the shipment.Shipment Posted to Fulfillment,
Shipment Shipped,
Shipment Delivered,
Shipment Return Request,
Shipment Return Received
{tracking_number}The shipment's tracking number.Shipment Shipped,
Shipment Delivered

Looping Merge Tags

Looping merge tags allow you to iterate through objects when there might be multiple, for instance if there is a shipment with items. It will allow you style flexibility. Note: You must have a starting and closing tag.

Example

{%each::line_item%}
  <img src="{line_item_image}"/>
  {line_item_name}
  {line_item_price}
{%/each::line_item%}

Name

Merge Tag

Description

Availability

Line Items

{%each::line_item%}
{line_item_image}
{line_item_name}
{line_item_offer_name}
{line_item_offer_title}
{line_item_quantity}
{line_item_price}
{%each::line_item:option%}
{line_item_option_name}
{line_item_option_value}
{%/each::line_item%}

Use to iterate through all line items in an order.

Successful Order
Successful Order Authorization
Order Abandoned
Successful Transaction
Declined Transaction

Shipment Items

{%each::shipment_item%}
{shipment_item_image}
{shipment_item_name}
{shipment_item_quantity}
{%each::shipment_item:option%}
{shipment_item_option_name}
{shipment_item_option_value}
{%/each::shipment_item:option%}
{%/each::shipment_item%}

Use to iterate through all items in a shipment.

Shipment Posted to Fulfillment
Shipment Shipped
Shipment Delivered
Shipment Return Request
Shipment Return Received

Conditional Merge Tags


Conditional merge tags allow you to show or hide sections if there is a value. For instance, if you are creating a responder that is an Order Receipt and you don't want to show the Shipping section when you sold a digital item, you can use conditional merge tags to hide the section. Note: You must have an opening and closing tag.

Example

{%if::shipping%}
  Shipping Details
  {shipping_firstname} {shipping_lastname}
  {shipping_address}
  {shipping_city}, {shipping_state}, {shipping_zipcode}
{%/if::shipping%}

Merge Tag

Description

Availability

{%if::shipping%}
{%/if::shipping%}

Shows content only if a shipping cost is applied to the order.

Successful Order,
Successful Order Authorization,
Offer Ordered,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder

{%if::discount%}
{%/if::discount%}

Shows content only if a discount is applied to the order.

Successful Order,
Successful Order Authorization,
Offer Ordered,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
Subscription Renewal Reminder

{%if::shipping_address%}
{%/if::shipping_address%}

Shows content only if a shipping address is present on the order.

Successful Order,
Successful Order Authorization,
Offer Ordered,
Order Abandoned,
Successful Transaction,
Declined Transaction,
Refund Issued,
Void Issued,
and most Subscription and Shipment events.

{%if::next_charge_date%}
{%/if::next_charge_date%}

Shows content only if there is a next scheduled charge date.

Offer Ordered,
Successful Transaction,
Subscription Reactivated,
Subscription Unpaused

Custom Merge Tags

When using the API method /reference/post_responders_id_send you are able to define custom responders over the API. When the responder event is created, it will use all the system merge tags, as well as the custom merge tags sent along with the post.