DiscountAutomaticApp

object

Requires read_discounts access scope.

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.

Anchor to FieldsFields

Anchor to appDiscountTypeappDiscountType • AppDiscountType!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 asyncUsageCountasyncUsageCount • Int!non-null: 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 combinesWithcombinesWith • DiscountCombinesWith!non-null: The discount classes that you can use in combination with Shopify discount types.
Anchor to createdAtcreatedAt • DateTime!non-null: The date and time when the discount was created.
Anchor to discountClassdiscountClass • DiscountClass!non-null: The discount class that's used to control how discounts can be combined.
Anchor to discountIddiscountId • ID!non-null: The globally-unique ID for the discount.
Anchor to endsAtendsAt • DateTime: 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 errorHistoryerrorHistory • FunctionsErrorHistory: The error history for the latest version of the discount type that the app provides.
Anchor to startsAtstartsAt • DateTime!non-null: The date and time when the discount becomes active and is available to customers.
Anchor to statusstatus • DiscountStatus!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 updatedAtupdatedAt • DateTime!non-null: The date and time when the discount was updated.

Was this section helpful?

Anchor to MutationsMutations

Anchor to discountAutomaticAppCreate discountAutomaticAppCreate • 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.

Note
To create code discounts with custom logic, use the discountCodeAppCreate mutation.
Anchor to discountAutomaticAppUpdate discountAutomaticAppUpdate • 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.

Note
To update code discounts with custom logic, use the discountCodeAppUpdate mutation instead.

Was this section helpful?