Skip to main content

Order request body restructuring

What's new

The request bodies for creating and updating orders have been restructured to use dedicated OrderCreate and OrderUpdate schemas via allOf composition, replacing the previous inline object definitions.

Impact

If you construct order requests manually, you need to update your request payloads to match the new schema structure. The response now also includes optional eligible_for_loyalty_points, eligible_for_reward_points, and rewards fields.

Changes

ResourceChange
create_orderRequest body now uses OrderCreate allOf schema; previous inline properties (items, player_id, locale, platform, metadata, back_to_game_url, back_to_store_url, redirect_settings, ui_settings, user_agent, price_template_id) moved into the schema reference
update_orderRequest body now uses OrderUpdate allOf schema; country property removed from inline definition
get_orderAdded optional eligible_for_loyalty_points, eligible_for_reward_points, and rewards response fields

Upgrade

  • Update any code that constructs POST /v1/orders request bodies to match the OrderCreate schema
  • Update any code that constructs PATCH /v1/orders/{order_id} request bodies to match the OrderUpdate schema
  • The country property is no longer accepted in update order requests

Need help?
Contact our integration team at [email protected]