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 |
---|---|
| The ID of the loyalty program. |
| The name of the loyalty program. |
| The ID that indicates the shopper is a member of the loyalty program. |
| Indicates the status of the enrollment within the loyalty program. The status can be: |
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}
.