--- title: Rollout - GraphQL Admin description: |- A rollout on a shop. Merchants use rollouts to run sales events, permanent launches, and A/B tests by serving treatments to a configured share of buyers. api_version: 2026-10 source_url: html: 'https://shopify.dev/docs/api/admin-graphql/latest/objects/Rollout' md: 'https://shopify.dev/docs/api/admin-graphql/latest/objects/Rollout.md' api_name: admin api_type: graphql type: object --- # Rollout object Requires The app must have read\_rollouts access. A rollout on a shop. Merchants use rollouts to run sales events, permanent launches, and A/B tests by serving treatments to a configured share of buyers. ## Fields * archived​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The date and time at which the rollout was archived. * concluded​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The actual conclusion date and time of the rollout for public API requests. Use `schedule.concludeAt` for the planned conclusion date. * created​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time at which the rollout was created. * effective​Traffic​Allocation [Float!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Float) non-null The calculated percentage of new buyer traffic allocated to this rollout after accounting for other active rollouts competing for the same traffic. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) non-null The ID of the rollout. * name [String!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) non-null The name of the rollout. * schedule [Rollout​Schedule](https://shopify.dev/docs/api/admin-graphql/latest/objects/RolloutSchedule) The rollout's planned activation and conclusion dates. Returns null when neither date is set. * started​At [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) The actual start date and time of the rollout for public API requests. Use `schedule.activateAt` for the planned activation date. * status [Rollout​Status!](https://shopify.dev/docs/api/admin-graphql/latest/enums/RolloutStatus) non-null The status of the rollout. * traffic​Allocation [Int!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) non-null The percentage of buyer traffic that the rollout is configured to receive, as an integer from 0 to 100. This is the configured allocation before other active rollouts competing for the same traffic are taken into account, so it isn't the share of buyers that a treatment reaches. * treatments [\[Rollout​Treatment!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/RolloutTreatment) non-null The treatments of the rollout. Control treatments are included even when they have no changes. * updated​At [Date​Time!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime) non-null The date and time at which the rollout was last edited. This timestamp doesn't necessarily change when another rollout changes this rollout's effective traffic allocation. *** ## Map ### Fields and connections with this object * [DiscountAutomaticApp.rollouts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticApp#field-DiscountAutomaticApp.fields.rollouts) * [DiscountAutomaticBasic.rollouts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBasic#field-DiscountAutomaticBasic.fields.rollouts) * [DiscountAutomaticBxgy.rollouts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBxgy#field-DiscountAutomaticBxgy.fields.rollouts) * [DiscountAutomaticFreeShipping.rollouts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticFreeShipping#field-DiscountAutomaticFreeShipping.fields.rollouts) * [DiscountCodeApp.rollouts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeApp#field-DiscountCodeApp.fields.rollouts) * [DiscountCodeBasic.rollouts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeBasic#field-DiscountCodeBasic.fields.rollouts) * [DiscountCodeBxgy.rollouts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeBxgy#field-DiscountCodeBxgy.fields.rollouts) * [DiscountCodeFreeShipping.rollouts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeFreeShipping#field-DiscountCodeFreeShipping.fields.rollouts) * [HasRollouts.rollouts](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/HasRollouts#fields-rollouts) * [RolloutConnection.nodes](https://shopify.dev/docs/api/admin-graphql/latest/connections/RolloutConnection#returns-nodes) * [RolloutEdge.node](https://shopify.dev/docs/api/admin-graphql/latest/objects/RolloutEdge#field-RolloutEdge.fields.node) * [RolloutTreatment.rollout](https://shopify.dev/docs/api/admin-graphql/latest/objects/RolloutTreatment#field-RolloutTreatment.fields.rollout) *** ## Queries * [rollout](https://shopify.dev/docs/api/admin-graphql/latest/queries/rollout) query A rollout on a shop. * id [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID) required ### Arguments The ID of the rollout. *** * [rollouts](https://shopify.dev/docs/api/admin-graphql/latest/queries/rollouts) query Returns the list of rollouts in the shop. * after [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) ### Arguments The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * before [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql). * first [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * last [Int](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Int) The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql). * query [String](https://shopify.dev/docs/api/admin-graphql/latest/scalars/String) A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). * * default string * change\_type string * id id * name string - Filter by rollout name. - Example: * `query=holiday` Filter public root rollouts by an exact public change typename. Unknown identifiers match no rollouts. - Valid values: * `RolloutDiscountActivateChange` * `RolloutDiscountExpireChange` * `RolloutCatalogActivateChange` * `RolloutCatalogDraftChange` * `RolloutThemePublishChange` * `RolloutCheckoutAndAccountsConfigurationPublishChange` Example: * `change_type:RolloutDiscountActivateChange` * `change_type:RolloutThemePublishChange` Filter by `id` range. - Example: * `id:1234` * `id:>=1234` * `id:<=1234` Filter by rollout name. Matches rollouts whose name contains the search value. * status string Filter by rollout status. Values are case-insensitive; unknown values match no rollouts. Valid values: * `DRAFT` * `SCHEDULED` * `PAUSED` * `ACTIVE` * `CONCLUDED` * `ARCHIVED` Example: * `status:ACTIVE` * `status:ACTIVE,DRAFT` * reverse [Boolean](https://shopify.dev/docs/api/admin-graphql/latest/scalars/Boolean) Default:false Reverse the order of the underlying list. * sort​Key [Rollout​Sort​Keys](https://shopify.dev/docs/api/admin-graphql/latest/enums/RolloutSortKeys) Default:ID Sort the underlying list by the given key. *** *** ## Rollout Queries ### Queried by * [rollout](https://shopify.dev/docs/api/admin-graphql/latest/queries/rollout) * [rollouts](https://shopify.dev/docs/api/admin-graphql/latest/queries/rollouts) *** ## Interfaces * [Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node) interface *** ## Rollout Implements ### Implements * [Node](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Node)