Transactional mails
We recommand to use Mandrill for your transactional mails. Our services comes with it fully integrated.
How to sync
As soon as you get your account, you should provide us an API Key. You may find that in your Mandrill interface, in Settings.
That's the only thing we need.
Templates
Then, you should define templates in your account, in Outbound > Templates. You'll have to follow our standard we use for both templates names and variables within.
If you don't want to make your own template by yourself, we have a couple of standard ones. Just ask.
The Mandrill account isn't something we manage. It belongs to you and have no access to it. We only use the API Key to make it send mails, that's all.
Though if you need some help for the Mandrill configuration, we will help you.
Interface
Add a domain
To add a new domain, go to: Settings→ Sending domains
Add a template
To add a new template, go to: Settings→ Templates
Subscription
The mail that is sent when a customer register. He receive a link to your website, and has to click on it in ordre to validate his account.
See the Create customer and the Customer validation webservice for the back-end part.
Template name : WS_Subscription
Parameters | Type | Required |
|
---|---|---|---|
login | String |
|
|
String |
|
| |
title | String |
| not passed yet |
firstName | String |
| not passed yet |
prefix | String |
| not passed yet |
lastName | String |
| not passed yet |
extra1 | String |
|
|
extra2 | String |
|
|
extra3 | String |
|
|
customer_id | Long | v | The user parameter, required to generate the Customer validation WS call |
validation_key | String(26) | v | The validationKey parameter, required to generate the Customer validation WS call |
No names nor addresses information are available at this time. That's due to the fact addresses are handled appart.
Lost password
The mail that is sent when a customer ask for a new password.
See the complete procedure here.
Template name : WS_LostPassword
Parameters | Type | Required |
|
---|---|---|---|
login | String |
|
|
String |
|
| |
title | String |
| not passed yet |
firstName | String |
| not passed yet |
prefix | String |
| not passed yet |
lastName | String |
| not passed yet |
extra1 | String |
|
|
extra2 | String |
|
|
extra3 | String |
|
|
customer_id | Long | v | The customer parameter, required to generate the Password check / change WS calls |
validation_key | String(26) | v | The validationKey parameter, required to generate the Password check / change WS calls |
Order confirmation
The mail that is sent when a payment is received for an order.
Template name : WS_OrderConfirmation
Parameters | Type | Required |
|
---|---|---|---|
login | String |
|
|
String |
|
| |
language | Int |
|
|
title | String |
|
|
firstName | String |
|
|
prefix | String |
|
|
lastName | String |
|
|
extra1 | String |
|
|
extra2 | String |
|
|
extra3 | String |
|
|
deliv_title | String |
|
|
deliv_fname | String |
|
|
deliv_prefix | String |
|
|
deliv_lname | String |
|
|
deliv_addressline1 | String |
|
|
deliv_number | Int |
|
|
deliv_postbus | String |
|
|
deliv_addressline2 | String |
|
|
deliv_addressline3 | String |
|
|
deliv_postcode | String |
|
|
deliv_city | String |
|
|
deliv_phone | String |
|
|
deliv_cellphone | String |
|
|
deliv_country | String |
|
|
factu_title | String |
|
|
factu_fname | String |
|
|
factu_prefix | String |
|
|
factu_lname | String |
|
|
factu_addressline1 | String |
|
|
factu_number | Int |
|
|
factu_postbus | String |
|
|
factu_addressline2 | String |
|
|
factu_addressline3 | String |
|
|
factu_postcode | String |
|
|
factu_city | String |
|
|
factu_phone | String |
|
|
factu_cellphone | String |
|
|
factu_country | String |
|
|
orderdate | Date |
| Format : dd/MM/yyyy HH:mm |
order | Long |
| Order ID |
ordertotal | Double |
| Total of the order (inc. shipping) |
payement_method_type | String | ||
order_is_paid | Boolean | ||
shipping | Double |
| Shipping cost |
total_products | Double |
| Total of the order without shipping (= only products) |
delivery_type | Int |
|
|
message | String |
|
|
is_collection_point | Boolean |
|
|
packages | Array() |
| See content below |
products | Array() |
| See content below |
Array:Products | Type | Required |
|
---|---|---|---|
img | String |
|
|
author | String |
|
|
bktitle | String |
|
|
quantity | Integer |
|
|
price | Double |
|
|
total | Double |
| = quantity * price |
is_ebook | Boolean |
|
|
order_line_message | String |
|
|
link | String |
| Only in case of an eBook |
giftwrap | String |
| Only if a giftwrap is set |
Array:Packages | Type | Required |
|
---|---|---|---|
carrier_package_id | String |
|
|
tracking_number | String |
|
|
weight | String |
|
|
carrier_code | String |
|
|