Skip to main content
interface

A resource that can be included in rollouts. Use this interface to query the resource's rollouts with a reusable fragment.

•RolloutConnection!
non-null

The rollouts that include this resource. Walk treatments.changes to see what each treatment does to the resource. Use query to filter by rollout status.

Show fields

Arguments

•String

The elements that come after the specified cursor.

•String

The elements that come before the specified cursor.

•Int

The first n elements from the paginated list.

•Int

The last n elements from the paginated list.

•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
•string

Filter by rollout status. Values are case-insensitive. Range comparisons aren't supported.

Valid values:

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

Example:

  • status:ACTIVE
  • status:ACTIVE,SCHEDULED
•Boolean
Default:false

Reverse the order of the underlying list.



Was this section helpful?

Anchor to Types implemented inTypes implemented in

•OBJECT

The DiscountAutomaticApp object stores information about automatic discounts that are managed by an app using Shopify Functions. Use DiscountAutomaticAppwhen 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.


Note

The DiscountCodeApp object has similar functionality to the DiscountAutomaticApp object, with the exception that DiscountCodeApp stores information about discount codes that are managed by an app using Shopify Functions.

API versions prior to 2025-10 only return automatic discounts with context set to all, discounts with other values are filtered out.


Show fields
•OBJECT

The DiscountAutomaticBasic 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 DiscountAutomaticBasic 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.


Note

The DiscountCodeBasic object has similar functionality to the DiscountAutomaticBasic object, but customers need to enter a code to receive a discount.

API versions prior to 2025-10 only return automatic discounts with context set to all, discounts with other values are filtered out.


Show fields
•OBJECT

The DiscountAutomaticBxgy 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 DiscountAutomaticBxgy 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.


Note

The DiscountCodeBxgy object has similar functionality to the DiscountAutomaticBxgy object, but customers need to enter a code to receive a discount.

API versions prior to 2025-10 only return automatic discounts with context set to all, discounts with other values are filtered out.


Show fields
•OBJECT

The DiscountAutomaticFreeShipping 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 DiscountAutomaticFreeShipping 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.


Note

The DiscountCodeFreeShipping object has similar functionality to the DiscountAutomaticFreeShipping object, but customers need to enter a code to receive a discount.

API versions prior to 2025-10 only return automatic discounts with context set to all, discounts with other values are filtered out.


Show fields
•OBJECT

The DiscountCodeApp object stores information about code discounts that are managed by an app using Shopify Functions. Use DiscountCodeApp when 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.


Note

The DiscountAutomaticApp object has similar functionality to the DiscountCodeApp object, with the exception that DiscountAutomaticApp stores information about automatic discounts that are managed by an app using Shopify Functions.


Show fields
•OBJECT

The DiscountCodeBasic 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 DiscountCodeBasic 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.


Note

The DiscountAutomaticBasic object has similar functionality to the DiscountCodeBasic object, but discounts are automatically applied, without the need for customers to enter a code.


Show fields
•OBJECT

The DiscountCodeBxgy 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 DiscountCodeBxgy 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.


Note

The DiscountAutomaticBxgy object has similar functionality to the DiscountCodeBxgy object, but discounts are automatically applied, without the need for customers to enter a code.


Show fields
•OBJECT

The DiscountCodeFreeShipping 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 DiscountCodeFreeShipping 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.


Note

The DiscountAutomaticFreeShipping object has similar functionality to the DiscountCodeFreeShipping object, but discounts are automatically applied, without the need for customers to enter a code.


Show fields

Was this section helpful?