Overview
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.
In the next pages, we define the different statuses for each Loyalty data object.
Understanding Loyalty program statuses
Status | Program |
Pending | Before the start date of the program:
|
Running | When the start date has passed:
|
Finished | The end date of the program has passed:
|
Understanding card code statuses
A card code can exist without being linked to a contact.
A contact can have several card codes in the same program.
Status | The 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 |
|
Understanding rule statuses
Status | Rules |
Pending | Before the start date, the rule has been set up and saved but is not granting points or rewards yet. |
Running | When the 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, requires two things:
the start date is passed
the end date is still in the future
Understanding point instance statuses
Status | Points instances |
Not processed | The instance has been created (as a result of a rule). A number of points have been defined, but none have been granted 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. |
Understanding master reward statuses
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. |
Understanding reward attribution statuses
Status | 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. |