Fetch email content from API endpoint
In this article we present functionality that allows Voyado users to fetch data from external platforms to populate emails.
The data model presented below is a fixed model and designed for product information but can also be used for populating emails with for instance related products, campaign information or other types of copy that is defined in other systems.
Field definitions
It's possible to include any fields in the API-answer but these definitions should be included when using Voyados standard email modules for products. The images returned in the response will we displayed as-is in the outgoing emails. Hence, the format of the image (size and aspect ratio) needs to match the format set up in the mail template module to ensure desired appearance.
The specification of image format should be decided together with the person responsible for your email template as well as Voyado’s technical application specialist.
Field name | Example value | Instructions |
|---|---|---|
productNumber | 23874625 | |
description | Superproduct 2000 Ultra, matte black | |
discountPrice | 1 549 kr | |
imageUrl | https://www.customerdomain.com/product/1234.jpg | |
link | https://www.customerdomain.com/product/1234 | |
name | Superproduct 2000 Ultra | |
originalPrice | 1 699 kr | OriginalPrice should ONLY be used when product is on sale |
price | 1 699 kr | |
fromPrice | 899 kr | |
discountPrice | 1099 kr | |
sellText | Looking for Superproducts latest groundbreaking innovation? With the 2000 Ultra Superproduct has done it again. The 2000 Ultra offers… |
Request URL (GET method)
The custom endpoint should be able to handle a search query with multiple product id´s comma separated like in this example, other than that the actual URL can be determined by you:
https://[customerdomain].com/api/endpoint/1234_1,1234_2
Adding several parameters to request url
It is also possible to add several parameters to the request url where you in the UI can input a value and personalise the url. The example below contains a parameter called locale which enables you to dynamically call for an endpoint connected to a specific country/language.
Note
These extra parameters needs to be decided in the project and configured by a product specialist at Voyado
Response JSON
This is an example of how the response model should look like to match Voyados format:
[
{
"productNumber": "12334",
"description": "Superproduct 2000 Ultra, matte black",
"imageUrl": https://customerimages.imgix.net/71303.jpg",
"originalPrice": "1 699 kr",
"discountPrice": "1 549 kr",
"discount": "- 9 %",
"link": "https://www.customerdomain.com/product/71303",
"fromPrice": "1 699 kr",
"name": "Superproduct 2000 Ultra",
"price": "1 549 kr",
"sellText": "Looking for Superproducts latest groundbreaking innovation? With the 2000 Ultra Superproduct has done it again. The 2000 Ultra offers..."
},
{
"productNumber": "12335"
"description": "Superproduct 2003 Ultra, matte white",
"imageUrl": "https://customerimages.imgix.net/product/71304.jpg",
"originalPrice": "1 699 kr",
"discountPrice": "1 549 kr",
"discount": "- 9 %",
"link": "https://www.customerdomain.com/product/71304",
"fromPrice": "1 699 kr",
"name": "Superproduct 2000 Ultra",
"price": "1 549 kr",
"sellText": "Looking for Superproducts latest groundbreaking innovation? With the 2000 Ultra Superproduct has done it again. The 2000 Ultra offers..."
}
]