Get Products
curl --request GET \
--url https://api.your-domain.com/example/zaymo/upsells/products \
--header 'X-Zaymo-API-Key: <api-key>'import requests
url = "https://api.your-domain.com/example/zaymo/upsells/products"
headers = {"X-Zaymo-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Zaymo-API-Key': '<api-key>'}};
fetch('https://api.your-domain.com/example/zaymo/upsells/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"data": {
"products": [
{
"id": "<string>",
"title": "<string>",
"price": 29.99,
"images": [
"<string>"
],
"compare_at_price": 39.99,
"description": "<string>"
}
]
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Upsells
Get Products
Retrieve product information for in-email product blocks. This endpoint should support two modes:
- Without
emailparameter: Return all available products. These are your general/default product recommendations shown to any customer. - With
emailparameter: Return personalized products tailored to the specific customer. Use the customer’s purchase history, preferences, or any other data to curate a relevant product list.
In both cases, the response format is the same — only the product selection should differ.
GET
/
zaymo
/
upsells
/
products
Get Products
curl --request GET \
--url https://api.your-domain.com/example/zaymo/upsells/products \
--header 'X-Zaymo-API-Key: <api-key>'import requests
url = "https://api.your-domain.com/example/zaymo/upsells/products"
headers = {"X-Zaymo-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Zaymo-API-Key': '<api-key>'}};
fetch('https://api.your-domain.com/example/zaymo/upsells/products', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"success": true,
"data": {
"products": [
{
"id": "<string>",
"title": "<string>",
"price": 29.99,
"images": [
"<string>"
],
"compare_at_price": 39.99,
"description": "<string>"
}
]
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Zaymo will authenticate requests using the API key you provide
Query Parameters
The email address of the customer opening the email. When this parameter is provided, the endpoint should return personalized product recommendations tailored to this specific customer (e.g., based on their purchase history or preferences). When omitted, the endpoint should return all available products as general recommendations suitable for any customer.
Was this page helpful?