...
The most typical error returned by the Loyalty API is related to offer or reward evaluation rules. This section lists all possible rule evaluation errors that can be returned.
Subtotal or Total Below Minimum Spend
The basket subtotal or total is below the minimum spend required for at least one offer contained in the basket.
...
Incentive Exceeds Limit per Order
The offer or reward limit that can be placed in one order is exeded.
code: exceeds-limit-per-order
ruleId: limit-per-order
message: Limit per order exceeded
Incentive Max Redemption
The maximum redemption limit that was set for this offer or reward was reached.
code: exceeds-max-redemption
ruleId: max-redemption
message: `Invalid Invalid Incentive Object Provided. Max redemptions limit reached
Insufficient Point Balance
The user does not have enough loyalty points to redeem reward.
code: insufficient-point-balance
ruleId: point-balance
message: User does not have sufficient funds to redeem reward
Invalid Day of the week
The offer or reward was not redeemed on a valid week day.
code: invalid-day-of-the-week
ruleId: day-of-the-week
message: Promotion was not redeemed on a valid weekday
Invalid End Date
The end date configured in the offer or reward is invalid, compared to current date.
code: invalid-end-date
ruleId: date-span
message: Invalid Incentive Object Provided. Does not fall within end date parameters
Invalid Start Date
The start date configured in the offer or reward is invalid, compared to current date.
code: invalid-start-date
ruleId: date-span
message: Invalid Incentive Object Provided. Does not fall within starrt date parameters
Invalid Enrollment Start Date
User enrollment start date into the loyalty program is invalid.
code: invalid-enrollment-start-date
ruleId: user-enrollment
message: Invalid Incentive Object Provided. Does not fall within user enrollment start date
Invalid Enrollment End Date
User enrollment end date into the loyalty program is invalid.
code: invalid-enrollment-end-date
ruleId: user-enrollment
message: Invalid Incentive Object Provided. Does not fall within user enrollment end date
Invalid Payment Method
The selected payment method is not one of the accepted methods.
code: invalid-payment-method
ruleId: payment-method
message: Selected payment method is not one of the accepted methods.
Invalid
...
code: invalid-redemption-type-combination
ruleId: max-redemption-types
message: Invalid combination of offer redemption types. (Standard|Surprise|Swap) offers exceed limit.
notes: Note the "(Standard|Surprise|Swap)" in the message above. the actual rendered message will reflect only one of the offer types within that list.
Invalid Scope
Scope
Offer or reward cannot be used.
code: invalid-scope
ruleId: incentive-scope
message: Invalid Incentive Object Provided. Incentive of this type can not be used.
Invalid Service Mode
Service mode is not in the list of valid service modes for the offer or reward.
code: invalid-service-mode
ruleId: service-mode
message: Service mode is not in the list of valid modes
Invalid
...
code: invalid-stacking
ruleId: is-stackable
message: Invalid Incentive Object Provided. Offer can not be stacked on top of other offers.
Invalid Store IdStore Id
Restaurant number is in the list of invalid restaurants that this offer or reward can be redeemed on.
code: invalid-store-id
ruleId: store-restrictions
message: Store is in the list of invalid stores
User not logged in
User must be signed in to see this offer.
code: missing-user
ruleId: first-order
message: User must be logged in to see this incentive
Not user's first order
User must redeem this offer or reward in its first order.
code: not-first-order
ruleId: first-order
message: User has existing claimed transactions
Not user's birthday
User can only redeem offer or reward in its birthday.
code: not-user-birthday
ruleId: user-birthday
message: Birthday did not span within duration
Invalid Quest Activation Date
Quest (e.g. Invitation code on signup) start or end date is invalid.
code: quest-past-activation-date
ruleId: must-activate-by
message: Invalid Quest Activation date. Current date is past mustActivateBy parameter
Unsatisfied Cart Requirements
At least one of the cart requirement products set to that offer or reward was not satisfied.
code: unsatisfied-cart-requirements
ruleId: cart-requirement
message: At least one of the required entries was not satisfied
Unsatisfied Cart Requirements Exclusion
At least one of the excluded cart requirement products set to that offer or reward was not satisfied.
code: unsatisfied-cart-requirements-exclusion
ruleId: cart-requirement
message: At least one of the excluded entries was not satisfied
User is Within the Cooldown Period
Offer cooldown period was not reached yet.
code: within-cool-down-period
ruleId: cool-down
message: Invalid Incentive Object Provided. Cool down not reached yet.