Unified item source enum across catalog and order responses
What's new
The two per-domain ItemSource schemas (one for catalog items, one for order items) have been consolidated into a single shared ItemSource enum. The combined enum now spans every channel through which a player can receive an item: order, bonus, bundle, coupon, lootbox, free_item, liveops, daily_reward, loyalty_reward, progression_program, rolling_offer, and pick_one_offer.
Impact
- Order and payment item responses can now surface
bundle,coupon,lootbox, and the new liveops/reward sources — previously they only reportedorderorbonus. - Catalog item responses (items, store items, coupons, daily rewards, cashback rewards, loyalty tiers, pages) gain the new liveops/reward
sourcevalues to describe items distributed through dailies, free-item drops, liveops events, loyalty rewards, progression programs, rolling offers, and pick-one offers. - On catalog responses,
sourcenow reports a default value oforderwhen no explicit source is set. - In order and payment responses, the nested item
sourceis now a required field.
Changes
| Resource | Change |
|---|---|
| Components | Removed aghanim__item__schemas__ItemSource and aghanim__s2s__order__schemas__ItemSource; added a single shared ItemSource |
| get_order | Item source adds bundle, coupon, lootbox, daily_reward, free_item, liveops, loyalty_reward, pick_one_offer, progression_program, rolling_offer; nested item source is now required |
| update_order | Same as get_order |
| get_payments | Nested payment item source is now required |
| Catalog endpoints (items, store items, coupons, daily rewards, cashback rewards, loyalty tiers, pages) | Item source adds the seven new values: daily_reward, free_item, liveops, loyalty_reward, pick_one_offer, progression_program, rolling_offer; source defaults to order |
Upgrade
- If you reference
aghanim__item__schemas__ItemSourceoraghanim__s2s__order__schemas__ItemSourcein generated client types, regenerate against the new spec and switch to the sharedItemSource. - Widen any switch statements or validators on item
sourceto accept the new enum values; treat unknown values as a forward-compatible fallback to keep new sources from breaking older clients. - For order and payment responses, treat the nested item
sourceas guaranteed to be present.
Need help?
Contact our integration team at [email protected]