Oracle Commerce Cloud Service - Use endpoints with loyalty programs

Use endpoints with loyalty programs

Endpoints allow you to configure loyalty programs for a site and are used during nomination to loyalty flow for validation. During nomination, all programs that are linked to the profile are included in the payload of Register/Update shopper webhook.

The following properties are used by the profile endpoint to recognize and redeem loyalty point data:

Property	Description
`programId`	The ID of the loyalty program.
`programName`	The name of the loyalty program.
`membershipId`	The ID that indicates the shopper is a member of the loyalty program.
`status`	Indicates the status of the enrollment within the loyalty program. The status can be:`RequestForEnrollment` – The Oracle Commerce Cloud is awaiting a membership number from the integrated loyalty system.`Enrolled` – The profile has been successfully enrolled and has a membership number. This membership number can be saved in Oracle Commerce Cloud along with the loyalty program ID.`RequestForUnenrollment` – When a profile wishes to opt out of the loyalty program, this request is sent to the integrated loyalty system.`Unenrolled` – Indicates that the profile has been successfully removed from the loyalty system.`Failed` – Indicates that the loyalty system failed to enroll a program.

To create a new profile with loyalty data, issue a POST request in /ccadmin/v1/profile. For example:

{
  "firstName": "John",
  "lastName": "Doe",
  "profileType": "b2b_user",
  "roles": [
    {
      "function": "buyer",
      "relativeTo": {
        "id": "900004"
      }
    }
  ],
  "receiveEmail": "yes",
  "active": true,
  "parentOrganization": "900004",
  "email": "jdoe@example.com",
  "daytimeTelephoneNumber": "212-555-1977",
  "loyaltyPrograms": [
  {
    "programId": "program1",
    "membershipId": null,
    "programName":"XTRAMILES",
    "status":"RequestForEnrollment"
  },
  {
    "programId": "program2",
    "membershipId": null,
    "programName":"XTRAREWARDS",
    "status":"RequestForEnrollment"
  }
 ]
}

You can add loyalty programs at any time to an existing profile by issuing a PUT request in /ccadmin/v1/profile/{profile_id}.

Use endpoints with loyalty programs

Extending Oracle Commerce Cloud