Highlights field for items
What's new
A new optional highlights field has been added to all item types — regular items, lootboxes, subscriptions, and virtual currencies — enabling structured benefit descriptions to be stored and returned alongside each item.
Impact
You can now attach a highlights array to items when creating or updating them. The field appears in all responses that return item data, including store items, coupons, cashback rewards, daily rewards, and loyalty tiers.
Changes
| Resource | Change |
|---|---|
| create_item | Added optional highlights to request and response |
| update_item | Added optional highlights to request and response |
| get_item | Added optional highlights to response |
| get_items | Added optional highlights to all item subtypes in response |
| bulk_create_or_update_items | Added optional highlights to request |
| bulk_update_items | Added optional highlights to request and response |
| translate_item | Added optional highlights to response |
| get_store_items, get_all_store_items, get_user_store_items, get_campaign_store_items | Added optional highlights to all nested item subtypes in response |
| create_store_item, update_store_item | Added optional highlights to all nested item subtypes in response |
| bulk_update_store_items | Added optional highlights to all nested item subtypes in response |
| get_coupon, get_coupons, get_user_coupons | Added optional item/highlights to response |
| create_coupon, update_coupon, bulk_update_coupon | Added optional item/highlights to response |
| get_cashback_reward, get_cashback_rewards | Added optional item/highlights to response |
| create_cashback_reward, update_cashback_reward | Added optional item/highlights to response |
| get_daily_reward, get_daily_rewards | Added optional highlights to all nested item types in response |
| create_daily_reward, update_daily_reward, copy_daily_reward | Added optional highlights to all nested item types in response |
| get_loyalty_tiers, update_loyalty_tiers | Added optional highlights to tier item responses |
Upgrade
This is a backwards-compatible addition. No changes are required to existing integrations.
Need help?
Contact our integration team at [email protected]