Discount Class
The discount class that's used to control how discounts can be combined.
Anchor to Valid valuesValid values
- ORDER
- PRODUCT
- SHIPPING
- Anchor to ORDERORDER
The discount is combined with an order discount class.
- Anchor to PRODUCTPRODUCT
The discount is combined with a product discount class.
- Anchor to SHIPPINGSHIPPING
The discount is combined with a shipping discount class.
Anchor to FieldsFields
- •OBJECT
The details about the app extension that's providing the discount type. This information includes the app extension's name and client ID, App Bridge configuration, discount class, function ID, and other metadata about the discount type, including the discount type's name and description.
- •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.
- •INPUT OBJECT
The input fields for creating or updating an automatic discount that's managed by an app.
Use these input fields when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.
- •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.
- Anchor to DiscountAutomaticFreeShipping.discountClassesDiscount•OBJECT
Automatic Free Shipping.discountClasses 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.
- •INPUT OBJECT
The input fields for creating or updating a code discount, where the discount type is provided by an app extension that uses Shopify Functions.
Use these input fields when you need advanced or custom discount capabilities that aren't supported by Shopify's native discount types.
- •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.
- •OBJECT
The platform discounts applied to the draft order.
- •OBJECT
A set of conditions, including entitlements and prerequisites, that must be met for a discount code to apply.
NoteUse the types and queries included our discount tutorials instead. These will replace the GraphQL Admin API's
object andunion, and the REST Admin API's deprecatedresource.Note:Use the types and queries included our discount tutorials instead. These will replace the GraphQL Admin API's
object andunion, and the REST Admin API's deprecatedresource.Note: Use the types and queries included our <a href="https://shopify.dev/docs/apps/selling-strategies/discounts/getting-started">discount tutorials</a> instead. These will replace the GraphQL Admin API's <a href="https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceRule"><code><span class="PreventFireFoxApplyingGapToWBR">Price<wbr/>Rule</span></code></a> object and <a href="https://shopify.dev/docs/api/admin-graphql/latest/unions/DiscountCode"><code><span class="PreventFireFoxApplyingGapToWBR">Discount<wbr/>Code</span></code></a> union, and the REST Admin API's deprecated<a href="https://shopify.dev/docs/api/admin-rest/unstable/resources/pricerule"><code><span class="PreventFireFoxApplyingGapToWBR">Price<wbr/>Rule</span></code></a> resource.
Deprecated fields
- : deprecated
- : deprecated
- : deprecated
- : deprecated
- : deprecated
- •OBJECTDeprecated
- •OBJECTDeprecated
- •OBJECTDeprecated
- •OBJECTDeprecated