Discount Automatic App
Requires access scope.
The object stores information about automatic discounts
that are managed by an app using
Shopify Functions.
Use
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.
Anchor to FieldsFields
- Anchor to appDiscountTypeapp•App
Discount Type Discount Type!non-null 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.
- Anchor to asyncUsageCountasync•Int!non-null
Usage Count The number of times that the discount has been used. For example, if a "Buy 3, Get 1 Free" t-shirt discount is automatically applied in 200 transactions, then the discount has been used 200 times. This value is updated asynchronously. As a result, it might be lower than the actual usage count until the asynchronous process is completed.
- Anchor to combinesWithcombines•Discount
With Combines With!non-null The discount classes that you can use in combination with Shopify discount types.
- Anchor to createdAtcreated•Date
At Time!non-null The date and time when the discount was created.
- Anchor to discountClassdiscount•Discount
Class Class!non-null The discount class that's used to control how discounts can be combined.
- Anchor to discountIddiscount•ID!non-null
Id The globally-unique ID for the discount.
- Anchor to endsAtends•Date
At Time The date and time when the discount expires and is no longer available to customers. For discounts without a fixed expiration date, specify
null
.- Anchor to errorHistoryerror•Functions
History Error History The error history for the latest version of the discount type that the app provides.
- Anchor to startsAtstarts•Date
At Time!non-null The date and time when the discount becomes active and is available to customers.
- Anchor to statusstatus•Discount
Status!non-null The status of the discount that describes its availability, expiration, or pending activation.
- Anchor to titletitle•String!non-null
The discount's name that displays to merchants in the Shopify admin and to customers.
- Anchor to updatedAtupdated•Date
At Time!non-null The date and time when the discount was updated.
Anchor to MutationsMutations
- •mutation
Creates an automatic discount that's managed by an app. Use this mutation with Shopify Functions when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.
For example, use this mutation to create an automatic discount using an app's "Volume" discount type that applies a percentage off when customers purchase more than the minimum quantity of a product. For an example implementation, refer to our tutorial.
- Anchor to automaticAppDiscountautomatic•Discount
App Discount Automatic App Input!required The input data used to create the automatic discount.
Arguments
- Anchor to automaticAppDiscountautomatic•Discount
App Discount Automatic App The automatic discount that the app manages.
- Anchor to userErrorsuser•[Discount
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates an existing automatic discount that's managed by an app using Shopify Functions. Use this mutation when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.
For example, use this mutation to update a new "Volume" discount type that applies a percentage off when customers purchase more than the minimum quantity of a product. For an example implementation, refer to our tutorial.
- Anchor to automaticAppDiscountautomatic•Discount
App Discount Automatic App Input!required The input fields required to update the automatic discount.
- •ID!required
The ID of the automatic discount to update.
Arguments
- Anchor to automaticAppDiscountautomatic•Discount
App Discount Automatic App The updated automatic discount that the app provides.
- Anchor to userErrorsuser•[Discount
Errors User Error!]!non-null The list of errors that occurred from executing the mutation.
Fields