Skip to content

docs: clarify qualifications sorting vs stacking and loyalty Total points #1297

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mintlify wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: clarify qualifications sorting vs stacking and loyalty Total points #1297

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion documentation/analyze/campaign-tracking.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The campaign dashboard shows:
- **Publications, messages delivered, redemptions by distributions**: Distribution performance.
- **Campaign point expiration**: Point expiration rules.
- **Total validations, redemptions, rollbacks, publications** chart.
- **Total points**: Aggregated points earned, redeemed, expired, and more.
- **Total points**: Aggregated point totals for the campaign, including points earned, redeemed, expired, subtracted, and pending. These figures sum activity across all loyalty cards in the campaign and match the [loyalty point balance types](/build/loyalty-points#loyalty-point-balance-types) tracked on individual cards.
- **Total vouchers created/deleted** chart.
- **Access settings**: Lists assigned areas and stores (enterprise feature available on demand).

Expand Down
10 changes: 10 additions & 0 deletions documentation/guides/checking-eligibility.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,16 @@ To specify the types of promotions and codes that you want to reveal to your cus

In the request, you can add [options](/api-reference/qualifications/check-eligibility) to configure the parameters returned in the response, e.g. filters for types of redeemables or sorting rules like `BEST_DEAL` or `LEAST_DEAL`.

<Note>
The `options.sorting_rule` parameter only controls the **order in which qualified redeemables are listed in the qualifications response**. It does not change the order in which incentives are applied at redemption.

- `DEFAULT` – sorts descending by `created_at`.
- `BEST_DEAL` – sorts descending by `total_applied_discount_amount` (the redeemable with the highest discount appears first).
- `LEAST_DEAL` – sorts ascending by `total_applied_discount_amount`.

The actual application order during validation and redemption is always governed by your project's [stacking rules](/orchestrate/stacking-rules) (for example, **Category hierarchy** or **Requested order**) and by the order of redeemables you pass in the redemption request. Sorting the qualifications response with `BEST_DEAL` does not override stacking configuration.
</Note>

## Use cases

The following scenarios show a couple of use cases that are possible with the qualifications API. Depending on the scenario, you send a slightly different API call and the results are returned in the context of the scenario.
Expand Down
Loading