Transactional API HTML examples

This page provides HTML examples that match the transactional API payload example. You can use these examples in your account for testing purposes.

Order confirmation

<html>
 <body>
  Order Confirmation - Example
  <br><br>
  Order Details:<br>
  Order ID:{{ details.orderID }}<br>
  Creation Date: {{ details.creationDate }}<br>
  Email Address: {{ details.email }}<br>
  Order Status: {{ details.status }}<br>
  Order Detail URL: {{ details.orderDetailsUrl }}<br>
  Order Coupons: {{ details.coupons }}<br>
  <br><br>
  Contact Details:<br>
  Billing Contact (Title / firstname / surname):{{ contact.title }} {{ contact.firstname }} {{
contact.surname }} <br>
  Billing Address 1:{{ billing.address1 }}<br>
  Billing City:{{ billing.city }} <br>
  Billing County:{{ billing.county }}<br>
  Billing Postal Code:{{ billing.postalCode }} <br>
  <br><br>
  Delivery details:<br>
  Shipping (firstname / surname): {{ shipping.firstname }} {{ shipping.surname }} <br>
  Shipping Address1: {{ shipping.address1 }}<br>
  Shipping City: {{ shipping.city }} <br>
  Shipping PostalCode: {{ shipping.postalCode }} <br>
  <br><br>
  Payment Total:<br>
  Subtotal: {{ totals.subTotal }}<br>
  VAT inc./ Taxes: {{ totals.totalTax }} <br>
  Shipping: {{ totals.totalShippingCost }} <br>
  Total: {{ totals.grandTotal }} <br>
  Payment Method: {{ payment.paymentMethod }}<br>
  Amount: {{ payment.amount}}<br>
  Last Four Digits: {{ payment.lastFour }}<br>
  <br><br>
  Order Items:
  {% set max_items = 25 %}
{% for x in range(max_items) %}
  {% if items[x] %}
  <br><br>
  Product Image: {{ items[x].imgUrl }}<br>
  Product Name: {{ items[x].productname }}<br>
  Quantity: {{ items[x].quantity }} <br>
  Product Code: {{ items[x].productID }}<br>
  Size:{{ items[x].sizeName }}<br>
  Price: {{ items[x].price }}<br>
  SKU: {{ items[x].sku }}<br>
  {% endif %}
{% endfor %}
  <!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Order shipping

<html>
 <body>
  Order Shipped - Example
  <br><br>
  Order Details:<br>
  Order ID:{{ details.orderID }}<br>
  Creation Date: {{ details.creationDate }}<br>
  Email Address: {{ details.email }}<br>
  Order Status: {{ details.status }}<br>
  Order Detail URL: {{ details.orderDetailsUrl }}<br>
  Order Coupons: {{ details.coupons }}<br>
  <br><br>
  Contact Details:<br>
  Billing Contact (Title / firstname / surname):{{ contact.title }} {{ contact.firstname }} {{
contact.surname }} <br>
  Billing Address 1:{{ billing.address1 }}<br>
  Billing City:{{ billing.city }} <br>
  Billing County:{{ billing.county }}<br>
  Billing Postal Code:{{ billing.postalCode }} <br>
  <br><br>
  Delivery details:<br>
  Shipping (firstname / surname): {{ shipping.firstname }} {{ shipping.surname }} <br>
  Shipping Address1: {{ shipping.address1 }}<br>
  Shipping City: {{ shipping.city }} <br>
  Shipping PostalCode: {{ shipping.postalCode }} <br>
  Shipping TrackingID: {{shipping.trackingID}} <br>
  <br><br>
  Payment Total:<br>
  Subtotal: {{ totals.subTotal }}<br>
  VAT inc./ Taxes: {{ totals.totalTax }} <br>
  Shipping: {{ totals.totalShippingCost }} <br>
  Total: {{ totals.grandTotal }} <br>
  Payment Method: {{ payment.paymentMethod }}<br>
  Amount: {{ payment.amount}}<br>
  Last Four Digits: {{ payment.lastFour }}<br>
  <br><br>
  Order Items:
  {% set max_items = 25 %}
{% for x in range(max_items) %}
  {% if items[x] %}
  <br><br>
  Product Image: {{ items[x].imgUrl }}<br>
  Product Name: {{ items[x].productname }}<br>
  Quantity: {{ items[x].quantity }} <br>
  Product Code: {{ items[x].productID }}<br>
  Size:{{ items[x].sizeName }}<br>
  Price: {{ items[x].price }}<br>
  SKU: {{ items[x].sku }}<br>
  {% endif %}
{% endfor %}
  <!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Order cancellation

<html>
 <body>
  Order Cancellation - Example
  <br><br>
  Order Details:<br>
  Order ID:{{details.orderID}}<br>
  Order Status: {{details.status}}<br>
  Order Detail URL: {{details.orderDetailsUrl}}<br>
  <br><br>
  Contact Details:<br>
  Billing Contact (Title / firstname / surname):{{ contact.title }} {{ contact.firstname }} {{
contact.surname }} <br>
   <br><br>
 Message:<br>
{{ message.message }}
<!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Review order

<html>
 <body>
  Review Order - Example
  <br><br>
  Contact Details:<br>
  Review Contact (firstname): {{ contact.firstname }} <br>
  Review Website: {{ contact.website }}
   <br><br>
 Review:<br>
Review URL: {{ review.reviewUrl }}<br>
Review Token:{{ review.reviewToken }}
<br><br>
Order Items:
  {% set max_items = 25 %}
{% for x in range(max_items) %}
  {% if items[x] %}
  <br><br>
  Product Image: {{ items[x].imgUrl }}<br>
  Product Name: {{ items[x].productname }}<br>
  Quantity: {{ items[x].quantity }} <br>
  Product Code: {{ items[x].productID }}<br>
  Size:{{ items[x].sizeName }}<br>
  Price: {{ items[x].price }}<br>
  SKU: {{ items[x].sku }}<br>
  {% endif %}
{% endfor %}
<!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Review success

<html>
 <body>
  Review Success - Example
  <br><br>
  Contact Details:<br>
  Review Contact (firstname): {{ contact.firstname }}
    <br><br>
  Review:<br>
Review URL: {{ review.reviewUrl }}
<!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Forgot password

<html>
 <body>
 Forgot Password - Example
  <br><br>
  Contact Details:<br>
  Password Contact (firstname): {{ contact.firstname }}<br>
  Password Email: {{ contact.email }}
   <br><br>
 Password:<br>
Password URL: {{ password.token }}
<!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Update password success

<html>
 <body>
  Update Password Success - Example
  <br><br>
  Contact Details:<br>
  Password Contact (firstname): {{ contact.firstname }}<br>
  Password Email: {{ contact.email }}
   <br><br>
  Website:<br>
Website URL: {{ contact.website }}
<!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Contact us

<html>
 <body>
  Contact us - Example
  <br><br>
  Contact Details:<br>
  Contact (firstname): {{ contact.firstname }}<br>
  Contact Email: {{ contact.email }}<br>
  Contact Country Code: {{ contact.countrycode }}<br>
  Website URL: {{ contact.website }}<br>
  Message: {{ contact.message }}
<!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Wish list

<html>
 <body>
  Wish List Success - Example
   <br><br>
   Contact Details:<br>
   Contact (firstname): {{ contact.firstname }}<br>
   Contact Email: {{ contact.email }}
<br><br>
  Referree:
  Referree (firstname): {{ referree.firstname }}<br>
  Referree Email: {{ referree.email }}
<br><br>
  Message: {{ message.message }}
<br><br>
Wish List Items:
  {% set max_items = 25 %}
{% for x in range(max_items) %}
  {% if items[x] %}
  <br><br>
  Product Image: {{ items[x].imgUrl }}<br>
  Product Name: {{ items[x].productname }}<br>
  Quantity: {{ items[x].quantity }} <br>
  Product Code: {{ items[x].productID }}<br>
  Size:{{ items[x].sizeName }}<br>
  Price: {{ items[x].price }}<br>
  SKU: {{ items[x].sku }}<br>
  {% endif %}
{% endfor %}
<!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Wish list success

<html> 
 <body>
  Wish List Success - Example
  <br><br>
  Contact Details:<br>
  Contact (firstname): {{ contact.firstname }}<br> 
  Contact Email: {{ contact.email }}
<br><br>
  Referree:
  Referree (firstname): {{ referree.firstname }}<br> 
  Referree Email: {{ referree.email }}
<br><br>
   Message: {{ message.message }}
<!-- <a href="{{unsub}}">Click Here</a> --> 
 </body>
</html>

Change email to new

<html> 
 <body>
  Email Change - Email to New Email Address - Example 
   <br><br>
   Contact Details:<br>
   Contact (firstname): {{ contact.firstname }}<br>
   Contact New Email: {{ contact.email }}<br>
   Contact Old Email: {{ contact.oldemail }} 
<!-- <a href="{{unsub}}">Click Here</a> -->
 </body> 
</html>

Change email to old

<html> 
 <body>
 Email Change - Email to Old Email Address - Example 
 <br><br>
 Contact Details:<br>
 Contact (firstname): {{ contact.firstname }}<br> 
 Contact New Email: {{ contact.newemail }}<br> 
 Contact Old Email: {{ contact.email }}
<!-- <a href="{{unsub}}">Click Here</a> --> 
 </body>
</html>

Your account

<html> 
 <body>
 Your Account - Example
  <br><br>
  Contact Details:<br>
  Contact (firstname): {{ contact.firstname }}<br> 
  Contact Account URL: {{ contact.accountURL }}
<!-- <a href="{{unsub}}">Click Here</a> --> 
  </body>
</html>

Catalogue request

<html> 
 <body>
  Catalogue Request - Example
  <br><br>
  Contact Details:<br>
  Contact (firstname): {{ contact.firstname }}<br> Contact Account URL: {{ contact.accountURL }}
<br><br>
Delivery details:<br>
  Shipping (firstname / surname): {{ shipping.firstname }} {{ shipping.surname }} <br> 
  Shipping Address1: {{ shipping.address1 }}<br>
  Shipping City: {{ shipping.city }} <br>
  Shipping PostalCode: {{ shipping.postalCode }} <br>
  <br><br>
<!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>

Out of stock

<html>
 <body>
  Stock Alert - FR
  <br><br>
  Contact Details:<br>
  <br><br>
  Stock Items:
  {% set max_items = 25 %}
{% for x in range(max_items) %}
  {% if items[x] %}
  <br><br>
  Product Image: {{ items[x].imgUrl }}<br>
  Product Name: {{ items[x].productname }}<br>
  Quantity: {{ items[x].quantity }} <br>
  Product Code: {{ items[x].productID }}<br>
  Size:{{ items[x].sizeName }}<br>
  Price: {{ items[x].price }}<br>
  SKU: {{ items[x].sku }}<br>
  {% endif %}
{% endfor %}
  <!-- <a href="{{unsub}}">Click Here</a> -->
 </body>
</html>