Loyalty Management Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Coupon Objects in Loyalty Management
Loyalty Management Associated Objects
Apex Reference
Loyalty Management Business APIs
REST Reference
Resources
Club Member Enrollment
Club Member Profile
Club Membership Renewal
Corporate Member Enrollments
Individual Member Enrollments
Member Benefits
Member Profile
Member Engagement Trail
Member Vouchers
Redeem Voucher
Transaction History
Transaction Ledger Summary
Transaction Journals Execution
Transaction Journals Simulation
Loyalty Program Process
Gamification
Promotion
Eligible Promotions
Promotion Configuration
Clone Promotion
Coupon Usage Increase
Coupon Usage Decrease
Promotions Creation
Promotion Details (GET, PUT)
Recommended Promotion
Request Bodies
Response Bodies
Loyalty Management Connect API Interchangeable Request Fields
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
PDF

Recommended Promotion

Retrieve the list of promotions recommended for a customer or a loyalty program member based on the product and personalization point.
Resource
/promotions/recommendation/product-promotion
Resource Example
/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. 64.0
promotions​PerProduct​Limit 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) 64.0
Request body for POST
{
  "personalizationPoint": "string",
  "dataspace": "string",
  "membershipNumber": "string",
  "loyaltyProgramId": "string",
  "loyaltyProgramMemberId": "string",
  "individualId": "string",
  "eligibleChannel": {
    "channel": {
      "id": "string",
      "name": "string"
    },
    "retailStore": {
      "id": "string",
      "name": "string"
    }
  }
}
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. 64.0
eligible​Channel Channel Input The details of a channel for which to retrieve eligible promotions. 64.0
individual​Id 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. 64.0
loyalty​ProgramId String The loyalty program that the loyalty program member belongs to. The loyalty program ID is required when membership number is specified. 64.0
loyalty​Program​MemberId 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. 64.0
membership​Number String The membership number of the loyalty program member for whom to retrieve recommended promotions. 64.0
personalization​Point 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. 64.0
Response body for POST
Promotion Recommendations