Skip to content

Getting Started

Getting started with Apptus Email Recommendations and the Email app is quick and easy. The first step is to verify that the pre-requirements are met followed by a quick three-step base configuration.

Disclaimer

App design and features are subject to change without notice. Screenshots, including simulated data visible, are for illustrative purposes only.

Pre-requirements

Apptus Email Recommendations and the Email app are available as add-ons for retailers using Apptus eSales Cloud.

To enable images of recommended products, product data entities in eSales should have an attribute specifying an image path. The path can be relative or absolute to the Image path prefix.

To enable links to recommended products from an e-mail, products are required to have a URL attribute configured in eSales.

Retailer requirements

The following are requirements for a retailer's eSales configuration to enable Apptus Email Recommendations.

  • A data model where only one locale is present per market and where a product is only present on one market.
  • A normal number of eSales customer keys, customerKey.
  • Notifications are correctly set-up and used.
  • A normal ratio of eSales customer keys to session IDs.
  • The Apptus eSales Admin app must be configured with correct image path prefixes and markets.
  • An Email app user should be familiar with HTML and CSS syntax to create product templates. Mustache templates are used to enable inclusion of attributes from Apptus eSales.
  • The eSales cluster used by the retailer must be hosted in Europe. For cluster information, please contact Apptus support.

A retailer must use an email service provider supporting technical requirements for utilising Apptus Email Recommendations.

Email service provider requirements

The email service provider must support the following requirements.

  • Timestamp for a generated email with a format supporting Unix timestamp e.g. 1548374400, or yyyy-mm-dd e.g. 2019-01-25.
  • Support for customisable data to retrieve an eSales customerKey dynamically and create dynamic links with url parameters, e.g. https://email-service.esales.apptus.com/product-link?campaign=44&position=1&timestamp={{message.sendtime}}&customer_key={{contact.esalescustomerkey}}.
  • Customisable email templates with variables.

Configuration

Email Recommendations requires a base configuration before templates and campaigns can be created. The Configuration tab is only available to users with Email app Admin access.

Email Recommendations - Getting Started - Configuration tab

General settings

The general settings define the image path prefix, the product URL template, and the recommended image dimensions.

The image path prefix should be the same as present in the Apptus eSales Admin app.

The product URL template describes the URL format to a product (and variant) on a retailers site. The product URL template uses Mustache to describe variables. The variable format is based on the attributes configured in eSales.

The recommended image dimensions can be set to either Use original size or Scale where a fixed width and height will be the default.

Image path prefix

The image path prefix defines where the product images will fetched from. The image path prefix should be the same as present in the Apptus eSales Admin app.

Image path prefix examples
https://www.storeurl.com/product/images/
https://www.storeurl.com/{{product.product_market}}/images/
https://www.externalimagehost.com/storeurl/{{product.product_market}}/images/

Default product URL template

The default product URL template must be defined to correctly point to the product and variant. Variables are included by use of Mustache-tags together with product attributes.

If the exact attribute format is not known, it is recommended to leave them blank during the initial configuration. The product template editor can be used to retrieve the correct attribute format followed by an update to the product URL template.

Product URL template examples
{{product.product_url}}
https://www.storeurl.com/{{product.site_product_category_path}}/{{product.site_product_id}}
https://www.storeurl.com/product/{{product.product_key}}/{{product.variant_key}}

URL parameters

URL parameters for timestamp and customer key can be added as variables to a product URL. The format of the variables are dependent on the template formatting of email service providers.

Timestamp

The timestamp is a required URL parameter. It is used to ensure that new images will be generated when consecutive emails with the same template id have been sent to an end customer. The timestamp is based on UNIX epoch time.

Customer key

The customer key is used as a URL parameter to enable personalised recommendations. If omitted or no customer key is found, top selling products will be returned.

Excluded products

A global product exclusion can be set to always leave out a specified set of products in the recommendations. This feature is useful when certain products are not in season, for example winter clothing in the summer, or in general is deemed not desired for recommendations, such as products below a certain price range or spare parts.

The exclusion filtering is based on the existing product attributes in a retailer's eSales cluster and can have multiple rule sets, each with several exclusion layers of products. The global product exclusion will override any campaign product inclusions.

Email Recommendations - Getting Started - Excluded products

Update configuration

The configuration can be updated at any time. An updated configuration does not affect the embedded code of active campaigns, but it is not recommended to change configuration during active campaigns. Only updated or new campaigns will use the latest saved configuration.

×