The statuses of the Loyalty objects are visible when using Loyalty APIs or Datahub. Understanding the statuses can help to understand issues, for example why a rule did not attribute points. Before each one, we are defining the object if necessary.
| Status | Program |
| Pending |
Before start date of the program:
|
| Running |
When start date has passed:
|
| Finished |
The end date of the program has passed:
|
What is the card code?
The card code is the primary key to the Loyalty table. It is linking a contact to its membership of the program.
- A card code can exist without being linked to a contact.
- A contact can have several card codes in the same program.
| Status | Card code of a loyalty member |
| Inactive |
The card code has been created, but the join date has not yet been reached:
|
| Active |
The join date has passed:
|
|
Card expiration date |
|
What is a rule?
A rule can attribute NQ and Q points, points multipliers and rewards. It is doing so using conditions, and the objects attributed are named outcomes.
| Status | Rules |
| Pending |
Before start date, the rule has been set up and saved but is not attributing points or rewards yet. |
| Running |
When start date has passed:
|
| Finished |
The end date of the rule has passed, (irrelevant if the rule is permanent):
|
To sum it up, for programs, card codes and rules to produce or interact with points and rewards, it requires two things:
- the start date is passed
- the end date is still in the future
What is a point instance?
A point instance is a batch of points attributed to a specific card code, due to the conversion rate or a rule. When a reward with a NQ point cost is granted to a card code, a negative points instance is created, and it never expires.
| Status | Points instances |
| Not processed |
The instance has been created (as a result of order or rule). A number of points has been defined, but none have been attributed to the loyalty card code. |
| Processing | After creation the engine assesses how many points it can give. |
| Valid |
After the holding period has passed, the card code point balance has been updated with the point instance.
|
| Expired |
After the validity period has passed, points have been removed from the card code, or have been used. |
What is the Master reward?
The Master Reward is created in the UX when using « New Reward », or with API. It creates instances by itself for attribution to members: Reward attribution.
| Status | Master Reward |
| Available |
There is stock left for this Reward. |
| No more stock |
There is no more stock. This is irrelevant if the Reward is on auto-generation mode, and if it has an unlimited stock. |
What is a reward attribution?
The Reward attribution is an instance of the Master Reward. It is created every time a reward is attributed to a member.
| Status | For the Reward attribution |
| Pending |
The attribution has been created in the database. |
| Attribution |
If the reward has a cost in NQ points, they are debited from the NQ point balance of the card code. |
| On hold |
The holding period is not over yet, the Reward cannot be burned. |
| Expired |
The validity period has finished, and the attribution has not been used. |
| Available |
The attribution is ready to be burned. |
| Burned |
The attribution has been successfully burned and is no longer available. |