Skip to main content
Anchor to rollouts

rollouts

query

Returns the list of rollouts in the shop.

Anchor to Arguments

RolloutConnection arguments

•RolloutConnection!
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 n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements 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 default
•string

Filter by rollout name.

Example:

  • query=holiday
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
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.

Valid values:

  • DRAFT
  • SCHEDULED
  • PAUSED
  • ACTIVE
  • CONCLUDED
  • ARCHIVED

Example:

  • status:ACTIVE
  • status:ACTIVE,DRAFT
Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•RolloutSortKeys
Default:ID

Sort the underlying list by the given key.

Show enum values
Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[RolloutEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Show fields
Anchor to nodesnodes
•[Rollout!]!
non-null

A list of nodes that are contained in RolloutEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Show fields
Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Show fields
Was this section helpful?