Rollout
Represents information about an rollout treatment on a shop.
Anchor to FieldsFields
- changes (RolloutChangeConnection!)
- id (ID!)
- rollout (Rollout)
- split (Int!)
- Anchor to changeschanges•Rollout
Change Connection! non-null The changes that this treatment makes to resources while it's served. Changes retain their
idand__typenamewhen an affected resource is deleted or the API client can't read it. Resource-specific fields arenullin that case. Usequeryto filter by a discount's numeric ID or GID, for exampleor. Filter by the exact publictype: RolloutDiscountActivateChange, RolloutDiscountExpireChange, RolloutCatalogActivateChange, RolloutCatalogDraftChange, RolloutThemePublishChange, or RolloutCheckoutAndAccountsConfigurationPublishChange. Type values can be unquoted or single- or double-quoted. Unknown typenames match no changes. Combinetypeandpredicates with uppercaseAND,OR, and parentheses. Whitespace between predicates meansAND.ANDbinds more tightly thanOR; use parentheses to group alternatives. For example,matches only additions of discount 42 and removals of discount 99. Useto scope both types to discount 42. Type-only branches preserve retained identities without requiring resource access; eachpredicate only matches readable, available discounts. Unreadable discounts do not suppress independent matching branches. Negation, ranges, and wildcards are not supported.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 discount_id•string
Filter by the discount's numeric ID or GID.
discount_id:1112223334discount_id:'gid://shopify/DiscountNode/1112223334'- Anchor to type•string
Filter by an exact, case-sensitive public change typename. Unknown typenames match no changes. Combine type and discount_id filters with uppercase AND, OR, and parentheses. Whitespace between predicates means AND. AND binds more tightly than OR; use parentheses to group alternatives. Each discount_id predicate matches only readable, available discounts within its branch. 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:
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 that this treatment is configured to receive. This is the configured split before other active rollouts on the same resources are taken into account.