Rollout Connection
An auto-generated type for paginating through multiple Rollouts.
Anchor to Fields with this connectionFields with this connection
- •OBJECT
The
object stores information about automatic discounts that are managed by an app using Shopify Functions. Usewhen you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.Learn more about creating custom discount functionality.
NoteThe
object has similar functionality to theobject, with the exception thatstores information about discount codes that are managed by an app using Shopify Functions.API versions prior to
2025-10only return automatic discounts withcontextset toall, discounts with other values are filtered out.Note:The
object has similar functionality to theobject, with the exception thatstores information about discount codes that are managed by an app using Shopify Functions.API versions prior to
2025-10only return automatic discounts withcontextset toall, discounts with other values are filtered out.Note: The <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeApp"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code<wbr/>App</span></code></a> object has similar functionality to the <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Automatic<wbr/>App</span></code> object, with the exception that <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code<wbr/>App</span></code> stores information about discount codes that are managed by an app using Shopify Functions.</p> <p>API versions prior to <code>2025-10</code> only return automatic discounts with <code>context</code> set to <code>all</code>, discounts with other values are filtered out.
- •OBJECT
The
object lets you manage amount off discounts that are automatically applied on a cart and at checkout. Amount off discounts give customers a fixed value or a percentage off the products in an order, but don't apply to shipping costs.The
object stores information about automatic amount off discounts that apply to specific products and variants, collections, or all items in a cart.Learn more about working with Shopify's discount model, including limitations and considerations.
NoteNote: The <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeBasic"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code<wbr/>Basic</span></code></a> object has similar functionality to the <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Automatic<wbr/>Basic</span></code> object, but customers need to enter a code to receive a discount.</p> <p>API versions prior to <code>2025-10</code> only return automatic discounts with <code>context</code> set to <code>all</code>, discounts with other values are filtered out.
- •OBJECT
The
object lets you manage buy X get Y discounts (BXGY) that are automatically applied on a cart and at checkout. BXGY discounts incentivize customers by offering them additional items at a discounted price or for free when they purchase a specified quantity of items.The
object stores information about automatic BXGY discounts that apply to specific products and variants, collections, or all items in a cart.Learn more about working with Shopify's discount model, including limitations and considerations.
NoteNote: The <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeBxgy"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code<wbr/>Bxgy</span></code></a> object has similar functionality to the <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Automatic<wbr/>Bxgy</span></code> object, but customers need to enter a code to receive a discount.</p> <p>API versions prior to <code>2025-10</code> only return automatic discounts with <code>context</code> set to <code>all</code>, discounts with other values are filtered out.
- •OBJECT
The
object lets you manage free shipping discounts that are automatically applied on a cart and at checkout. Free shipping discounts are promotional deals that merchants offer to customers to waive shipping costs and encourage online purchases.The
object stores information about automatic free shipping discounts that apply to specific products and variants, collections, or all items in a cart.Learn more about working with Shopify's discount model, including limitations and considerations.
NoteNote: The <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeFreeShipping"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code<wbr/>Free<wbr/>Shipping</span></code></a> object has similar functionality to the <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Automatic<wbr/>Free<wbr/>Shipping</span></code> object, but customers need to enter a code to receive a discount.</p> <p>API versions prior to <code>2025-10</code> only return automatic discounts with <code>context</code> set to <code>all</code>, discounts with other values are filtered out.
- •OBJECT
The
object stores information about code discounts that are managed by an app using Shopify Functions. Usewhen you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.Learn more about creating custom discount functionality.
NoteNote: The <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticApp"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Automatic<wbr/>App</span></code></a> object has similar functionality to the <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code<wbr/>App</span></code> object, with the exception that <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Automatic<wbr/>App</span></code> stores information about automatic discounts that are managed by an app using Shopify Functions.
- •OBJECT
The
object lets you manage amount off discounts that are applied on a cart and at checkout when a customer enters a code. Amount off discounts give customers a fixed value or a percentage off the products in an order, but don't apply to shipping costs.The
object stores information about amount off code discounts that apply to specific products and variants, collections, or all items in a cart.Learn more about working with Shopify's discount model, including limitations and considerations.
NoteNote: The <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBasic"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Automatic<wbr/>Basic</span></code></a> object has similar functionality to the <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code<wbr/>Basic</span></code> object, but discounts are automatically applied, without the need for customers to enter a code.
- •OBJECT
The
object lets you manage buy X get Y discounts (BXGY) that are applied on a cart and at checkout when a customer enters a code. BXGY discounts incentivize customers by offering them additional items at a discounted price or for free when they purchase a specified quantity of items.The
object stores information about BXGY code discounts that apply to specific products and variants, collections, or all items in a cart.Learn more about working with Shopify's discount model, including limitations and considerations.
NoteNote: The <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticBxgy"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Automatic<wbr/>Bxgy</span></code></a> object has similar functionality to the <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code<wbr/>Bxgy</span></code> object, but discounts are automatically applied, without the need for customers to enter a code.
- •OBJECT
The
object lets you manage free shipping discounts that are applied on a cart and at checkout when a customer enters a code. Free shipping discounts are promotional deals that merchants offer to customers to waive shipping costs and encourage online purchases.The
object stores information about free shipping code discounts that apply to specific products and variants, collections, or all items in a cart.Learn more about working with Shopify's discount model, including limitations and considerations.
NoteNote: The <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticFreeShipping"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Automatic<wbr/>Free<wbr/>Shipping</span></code></a> object has similar functionality to the <code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code<wbr/>Free<wbr/>Shipping</span></code> object, but discounts are automatically applied, without the need for customers to enter a code.
Anchor to Queries with this connectionQueries with this connection
- rollouts (RolloutConnection!)
- •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 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:
- 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
Anchor to Possible returnsPossible returns
- edges ([RolloutEdge!]!)
- nodes ([Rollout!]!)
- pageInfo (PageInfo!)
- Anchor to edgesedges•[Rollout
Edge!]! 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 pageInfopage•Page
Info Info! non-null An object that’s used to retrieve cursor information about the current page.
Show fields