Reward eligibility and virtual currency rewards on order responses
What's new
Order responses now expose three new optional fields describing the rewards a player is eligible to receive for an order: eligible_for_reward_points (integer), eligible_for_loyalty_points (integer), and rewards, a structured object listing the available virtual currency rewards along with each reward's issue status.
Impact
You can surface the reward points, loyalty points, and virtual currency rewards a player will earn from an order without computing them yourself, and follow the lifecycle of each virtual currency reward via the new issue_status (issued, revoked, issue_failed, revoke_failed).
Changes
| Resource | Change |
|---|---|
| get_order | Added optional eligible_for_reward_points, eligible_for_loyalty_points, and rewards (an OrderRewards with available list of OrderVirtualCurrencyReward) on the response |
| update_order | Same additions as get_order |
| Components | Added OrderRewards, OrderVirtualCurrencyReward, and RewardIssueStatus schemas |
Upgrade
- No action required. Read
eligible_for_reward_pointsandeligible_for_loyalty_pointsto display the points a player will earn, and iteraterewards.availablefor any virtual currency rewards tied to the order. - When showing virtual currency rewards, branch on
issue_statusto distinguish issued, revoked, and failed states.
Need help?
Contact our integration team at [email protected]