Rollouts queries and webhooks in the Admin GraphQL API

Summary

Apps can now discover Rollouts, inspect their schedules, traffic allocation, and resource changes, and receive notifications when they change. These capabilities help apps understand and respond to coordinated launches, experiments, and temporary events across discounts, catalogs, themes, and checkout and accounts configurations.

What's new

• Discover and read Rollouts. Use the root rollouts query to list and search Rollouts, and rollout(id:) to fetch a Rollout directly by ID.
• See what a Rollout changes. Read how each treatment affects discounts, catalogs, themes, and checkout and accounts configurations.
• Understand schedules and allocation. Read planned activation and conclusion times, configured trafficAllocation, current effectiveTrafficAllocation, and treatment split values. Configured allocation alone does not determine effective reach.
• Stay up to date. Subscribe to Rollout webhooks for lifecycle, effective-allocation, and resource-change notifications. Refetch affected Rollouts to keep your integration current.

Access Rollout data

Request read_rollouts to access Rollout data. Existing resource scopes apply to the underlying resource payloads, and existing installations may need merchant reauthorization.

See the Rollout API reference for details.

If your app reads discounts, see Update your app to account for discount Rollouts for discount-specific integration guidance and compatibility behavior.