Promotion Recommendations (POST)

Retrieve the list of promotions recommended for a customer or a loyalty program member based on the product and personalization point.

Resource

1/promotions/recommendation/product-promotion

Resource Example

1https://YOUR_INSTANCE.salesforce.com/services/data/v68.0/promotions/recommendation/product-promotion?count=3&promotionsPerProductLimit=4

Available Version

64.0

HTTP Methods

POST

Query Parameters

Name	Type	Description	Required or Optional	Available Version
`count`	Integer	The maximum number of promotion recommendations to retrieve.	Optional	64.0
`promotionsPerProductLimit`	Integer	The maximum number of promotions that can be recommended for a product. (Note: The count supersedes the limit, suggesting that in case we put a limit of 3 for each product but it doesn’t fullfill the count, it will display more promotions which depends on the count parameter)	Optional	64.0

Request Body for POST

1{
2  "personalizationPoint": "string",
3  "dataspace": "string",
4  "membershipNumber": "string",
5  "loyaltyProgramId": "string",
6  "loyaltyProgramMemberId": "string",
7  "individualId": "string",
8  "eligibleChannel": {
9    "channel": {
10      "id": "string",
11      "name": "string"
12    },
13    "retailStore": {
14      "id": "string",
15      "name": "string"
16    }
17  }
18}

Properties

Name	Type	Description	Required or Optional	Available Version
`dataspace`	String	The data space that defines the boundary of a personalization context. This API currently only works with your Data Cloud instance’s default data space.	Required	64.0
`eligibleChannel`	Channel Input	The details of a channel for which to retrieve eligible promotions.	Optional	64.0
`individualId`	String	The ID of the of the individual for whom to retrieve recommended promotions. Optional if membership number or loyalty program member ID is provided.	Optional if membership number or loyalty program member ID is provided.	64.0
`loyaltyProgramId`	String	The loyalty program that the loyalty program member belongs to. The loyalty program ID is required when membership number is specified.	Required when membership number is specified.	64.0
`loyaltyProgramMemberId`	String	The ID of the of the loyalty program member for whom to retrieve recommended promotions. Optional if membership number or contact ID is provided.	Optional if membership number or contact ID is provided.	64.0
`membershipNumber`	String	The membership number of the loyalty program member for whom to retrieve recommended promotions.	Optional	64.0
`personalizationPoint`	String	The API name of the personalization point. A personalization point is a connection between data, profile data, personalization type, and schema, used to deliver personalized content to customers.	Required	64.0

Response Body for POST

Promotion Recommendations