Entity List
The following entities are exposed via the APIs: (See API Entity Attributes and Properties for more specific information about the entities you will use).
Shopper
Description: A representation of a registered member of your loyalty program. Includes a wide range of attributes available for use in your applications.
Available Actions:
- Get
- Create
- Score
- Update
- Deactivate
- Get Point Balance for Shopper
Many retrieval keys are honored for this entity.
Programs
Description: Programs have benefits, creative assets, and other attributes. Currently, there are three programs: Main, Tier, and Club. Your enrolled customers can be members of either a tier (T) program or a main (M) program, but not both. If you have a main (M) program, each enrolled customer is enrolled in the main program. If you use a tier (T) program, each enrolled customer must belong to just one of the tiers. Whether you use the main or the tier program, you can also use club programs to further segment your customers and provide additional benefits. Customers can be enrolled in zero-to-many clubs.
Available Actions: Get, Join Shopper to Program.
UnregisteredShopper
Description: A representation of a customer who is not a member of your loyalty program.
Available Actions: Create, Update, Get.
RegisteredCard
Description: A credit or loyalty card (or other identifier) that is associated to a specific shopper.
Available Actions: Create, Get.
CustomAttributes
Description: A set of client-defined attributes describing a shopper. Maintained separate from the Shopper entity itself.
Available Actions: Get, Update Value.
Rewards
Description: A representation of the rewards available to a shopper.
Available Actions: Get
Authentication Token
Description: A session-specific identifier needed for every API interaction.
Available Actions: Get.
Offers
Description: A representation of the offers available to a shopper. Includes a qualification rule and an award.
Available Actions: Get, Update Status for Shopper.
Reminder
Description: A representation of the reminders set by a shopper.
Available Actions: Get, Update for Shopper.
Event Instance
Description: An instance of a generic event (i.e., an action taken by a customer).
Available Actions: Create event instance.