Rollout
Requires The app must have read_rollouts access.
A treatment in a rollout. Each treatment receives a share of the rollout's traffic and makes a set of changes to resources for the buyers it serves.
Anchor to FieldsFields
- changes (RolloutChangeConnection!)
- id (ID!)
- rollout (Rollout)
- split (Int!)
- Anchor to changeschanges•Rollout
Change Connection! non-null The changes this treatment makes to resources while it's served. Changes retain their
idand__typenameif the affected resource is deleted or inaccessible. Usequeryto filter by exact publictype,,,, or(numeric ID or quoted GID). Theme IDs match the publish target; checkout and accounts configuration IDs match either swap source or publish target. Each resource-ID filter matches only readable, available resources.Show fields
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to queryquery•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.
Show filters
- Anchor to catalog_id•string
Filter by the catalog's numeric ID or quoted Catalog or concrete catalog GID (for example, MarketCatalog). Matches activate and draft changes.
catalog_id:1112223334catalog_id:'gid://shopify/MarketCatalog/1112223334'catalog_id:42 AND type:RolloutCatalogDraftChange- Anchor to checkout_and_accounts_configuration_id•string
Filter by either the swap source or publish target configuration's numeric ID or quoted CheckoutAndAccountsConfiguration GID.
checkout_and_accounts_configuration_id:1112223334checkout_and_accounts_configuration_id:'gid://shopify/CheckoutAndAccountsConfiguration/1112223334'checkout_and_accounts_configuration_id:42 AND type:RolloutCheckoutAndAccountsConfigurationPublishChange- Anchor to discount_id•string
Filter by the discount's numeric ID or GID.
discount_id:1112223334discount_id:'gid://shopify/DiscountNode/1112223334'- Anchor to theme_id•string
Filter by the publish target theme's numeric ID or quoted OnlineStoreTheme GID. Does not match the swap source.
theme_id:1112223334theme_id:'gid://shopify/OnlineStoreTheme/1112223334'theme_id:42 AND type:RolloutThemePublishChange- Anchor to type•string
Filter by an exact, case-sensitive public change typename. Unknown typenames match no changes. Combine type and resource-ID filters with uppercase AND, OR, and parentheses. Whitespace between predicates means AND. OR binds more tightly than AND, following the standard search syntax; use parentheses to group predicates. Each resource-ID predicate matches only readable, available resources within its branch. Quote GIDs with single or double quotes. Negation, ranges, and wildcards are not supported.
RolloutDiscountActivateChangeRolloutDiscountExpireChangeRolloutCatalogActivateChangeRolloutCatalogDraftChangeRolloutThemePublishChangeRolloutCheckoutAndAccountsConfigurationPublishChangetype:RolloutThemePublishChangetype:RolloutDiscountActivateChange OR type:RolloutDiscountExpireChangetype:RolloutDiscountExpireChange AND discount_id:1112223334(type:RolloutDiscountActivateChange AND discount_id:42) OR (type:RolloutDiscountExpireChange AND discount_id:99)discount_id:42 AND (type:RolloutDiscountActivateChange OR type:RolloutDiscountExpireChange)
Example:
Example:
Example:
Example:
Valid values:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- •ID!non-null
The ID of the rollout treatment.
- Anchor to rolloutrollout•Rollout
The rollout this treatment belongs to.
Show fields
- Anchor to splitsplit•Int!non-null
The percentage of the rollout's traffic, from 0 to 100, that this treatment is configured to receive. The splits of a rollout's treatments add up to 100.