Expanded create_order request
What's new
The create_order endpoint now explicitly requires items and player_id in the request body, and gains a range of new optional fields for controlling checkout behavior: locale, platform, pricing, redirect settings, UI customization, metadata, and navigation URLs.
Impact
You can now configure the full checkout session in the order creation call. Order responses across all order endpoints are enriched with redirect_settings, ui_settings, and the required rewards/available field.
Changes
| Resource | Change |
|---|---|
| create_order | Added required items and player_id; added optional locale, platform, price_template_id, redirect_settings, ui_settings, metadata, back_to_game_url, back_to_store_url, user_agent |
| get_order | Added redirect_settings (mode, target, delay_seconds), ui_settings (mode, show_player_info), and required rewards/available to response |
| update_order | Added optional country to request body; added redirect_settings, ui_settings, and rewards/available to response |
| get_unconsumed_order_details | Schema inlined; no behavioral changes |
Upgrade
- Ensure
itemsandplayer_idare always provided when calling create_order. These were previously part of a wrapped schema and are now explicitly required at the top level. - All new fields are optional. Existing integrations continue to work without modification.
Need help?
Contact our integration team at [email protected]