Anchor to RolloutStatusRollout
enumRollout
The lifecycle status of a rollout.
Anchor to Valid valuesValid values
- ACTIVE
- ARCHIVED
- CONCLUDED
- DRAFT
- PAUSED
- SCHEDULED
- Anchor to ACTIVEACTIVE
The rollout is serving its treatments to buyers.
- Anchor to ARCHIVEDARCHIVED
The rollout is archived and can't be changed. It doesn't serve its treatments to buyers.
- Anchor to CONCLUDEDCONCLUDED
The rollout has ended and no longer serves its treatments to buyers.
- Anchor to DRAFTDRAFT
The rollout is being set up and doesn't serve its treatments to buyers.
- Anchor to PAUSEDPAUSED
The rollout was active and is stopped until it's resumed. It doesn't serve its treatments to buyers.
- Anchor to SCHEDULEDSCHEDULED
The rollout is set to start at a future date and doesn't serve its treatments to buyers yet.
Was this section helpful?
Anchor to FieldsFields
- •OBJECT
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.
Was this section helpful?