Rollout
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.
Anchor to FieldsFields
- archivedAt (DateTime)
- concludedAt (DateTime)
- createdAt (DateTime!)
- effectiveTrafficAllocation (Float!)
- id (ID!)
- name (String!)
- schedule (RolloutSchedule)
- startedAt (DateTime)
- status (RolloutStatus!)
- trafficAllocation (Int!)
- treatments ([RolloutTreatment!]!)
- updatedAt (DateTime!)
- Anchor to archivedAtarchived•Date
At Time The date and time at which the rollout was archived.
- Anchor to concludedAtconcluded•Date
At Time The actual conclusion date and time of the rollout for public API requests. Use
for the planned conclusion date.- Anchor to createdAtcreated•Date
At Time! non-null The date and time at which the rollout was created.
- Anchor to effectiveTrafficAllocationeffective•Float!
Traffic Allocation non-null The effective percentage of total traffic this rollout receives for new buyer assignments, accounting for mutex group constraints with other active rollouts.
- •ID!non-null
The ID of the rollout.
- Anchor to namename•String!non-null
The name of the rollout.
- Anchor to scheduleschedule•Rollout
Schedule The rollout's planned activation and conclusion dates. Returns null when neither date is set.
Show fields
- Anchor to startedAtstarted•Date
At Time The actual start date and time of the rollout for public API requests. Use
for the planned activation date.- Anchor to statusstatus•Rollout
Status! non-null The status of the rollout.
Show enum values
- Anchor to trafficAllocationtraffic•Int!
Allocation 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 on the same resources are taken into account, so it isn't the share of buyers that a treatment reaches.
- Anchor to treatmentstreatments•[Rollout
Treatment!]! non-null The treatments of the rollout. Control treatments are included even when they have no changes.
Show fields
- Anchor to updatedAtupdated•Date
At Time! 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.
Anchor to QueriesQueries
- rollout (Rollout)
- rollouts (RolloutConnection!)
- •query
A rollout on a shop.
Show fields
- •ID!required
The ID of the rollout.
Arguments
- •ID!
- •query
Returns the list of rollouts in the shop.
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 change_type•string
Filter public root rollouts by an exact public change typename. Unknown identifiers match no rollouts.
RolloutDiscountActivateChangeRolloutDiscountExpireChangeRolloutCatalogActivateChangeRolloutCatalogDraftChangeRolloutThemePublishChangeRolloutCheckoutAndAccountsConfigurationPublishChangechange_type:RolloutDiscountActivateChangechange_type:RolloutThemePublishChange- Anchor to name•string
Filter by rollout name. Matches rollouts whose name contains the search value.
- Anchor to status•string
Filter by rollout status. Values are case-insensitive; unknown values match no rollouts.
DRAFTSCHEDULEDPAUSEDACTIVECONCLUDEDARCHIVEDstatus:ACTIVEstatus:ACTIVE,DRAFT
Valid values:
Example:
Valid values:
Example:
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Rollout
Key Sort Keys Default:ID Sort the underlying list by the given key.
Show enum values
Arguments