Promotion Recommendations API

Use the Promotion Recommendations API to provide customers personalized promotions based on their product preferences. This API can retrieve recommended promotions for loyalty program members, individuals, and anonymous users. System integrators can integrate the API with external systems to show recommended promotions on their websites.

Required Editions

Available in: Lightning Experience

Available in: Enterprise, Unlimited, and Developer Editions with Real-Time Offer Management. Additionally, you need Data Cloud and Personalization.

Use the Promotion Recommendations API to retrieve relevant promotions for customers based on their product preferences. To use the API, provide these details.

The name of the personalization point for which to retrieve recommended promotions
Details of the individual, loyalty program member, or anonymous user for whom to retrieve recommended promotions

You can also specify the total number of promotions you want to retrieve and the maximum number of promotions you want to retrieve for each product. To learn more, see Promotion Recommendations API.

Note The total number of promotions to retrieve takes priority over the maximum promotions per product. If you request 10 promotions and set a maximum limit of 2 promotions per product, then up to 10 recommended promotions are retrieved. If you request 5 promotions and set a maximum limit of 7 promotions per product, then also 5 recommended promotions are retrieved.

You can define the boundaries of the personalization context by specifying a data space. To tailor promotions based on where they are displayed, you can specify the channel for which to retrieve promotions.

The Promotion Recommendations API calls Salesforce Personalization to get the list of recommended promotions. The API response includes a list of recommended promotions and a personalization ID from Salesforce Personalization. You can use the ID for tracking and analysis.

Example Cloud Kicks, a popular footwear retailer, wants to personalize promotions for its customers visiting their website. To make sure that the customers receive a variety of promotions tailored to their preferences, they aim to show 10 promotions for a specific customer, with a maximum limit of 2 promotions per product.

Here's how the Promotion Recommendations API's request looks like when the API is executed.


[
 {
  "personalizationPoint": "homepage_recommendations",
  "dataspace": "cloudkicks_dataspace",
  "membershipNumber": "CLK123",
  "loyaltyProgramId": "CKLoyaltyProgram",
  "eligibleChannel": {
   "channel": {
    "id": "web",
    "name": "Website"
  },
  "retailStore": {
   "id": "store_001",
   "name": "Cloud Kicks Main Store"
 }
 }, 
 "count": 10,
 "promotionsPerProductLimiy": 2
 }
}