Skip to main content

RolloutChange now includes applyResult

As of GraphQL Admin API version 2027-01, the RolloutChange interface has an applyResult field. Applying a rollout makes a treatment's changes permanent for every buyer. applyResult shows the outcome of the latest attempt to apply each change, so your app can find changes that failed.

applyResult is null before the first attempt to apply the change. With an online access token, it's also null if the staff member can't read the changed resource. It uses the existing read_rollouts access scope.

query {
rollout(id: "gid://shopify/Rollout/1") {
treatments {
changes(first: 10) {
nodes {
id
applyResult {
status
completedAt
errorCode
}
}
}
}
}
}

RolloutChangeApplyResult has three fields:

  • status: IN_PROGRESS, SUCCESS or FAILURE.
  • completedAt: when the attempt finished. It's null while in progress, or if the time wasn't recorded.
  • errorCode: why the change failed, when known: RESOURCE_NOT_FOUND, VALIDATION_FAILED, LIMIT_EXCEEDED, INVALID_CHANGE or INTERNAL_ERROR.
Was this page helpful?