Choose a version:

DiscountUserError

object

An error that occurs during the execution of a discount mutation.

Anchor to FieldsFields

Anchor to codecode •DiscountErrorCode: The error code.
Anchor to extraInfoextraInfo •String: Extra information about this error.
Anchor to fieldfield •[String!]: The path to the input field that caused the error.
Anchor to messagemessage •String! non-null: The error message.

Was this section helpful?

Anchor to MutationsMutations

Anchor to discountAutomaticActivate discountAutomaticActivate •mutation: Activates an automatic discount.
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.
Anchor to discountAutomaticBasicCreate discountAutomaticBasicCreate •mutation: Creates an amount off discount that's automatically applied on a cart and at checkout.

Note
To create code discounts, use the discountCodeBasicCreate mutation.
Anchor to discountAutomaticBasicUpdate discountAutomaticBasicUpdate •mutation: Updates an existing amount off discount that's automatically applied on a cart and at checkout.

Note
To update code discounts, use the discountCodeBasicUpdate mutation instead.
Anchor to discountAutomaticBulkDelete discountAutomaticBulkDelete •mutation: Asynchronously delete automatic discounts in bulk if a search or saved_search_id argument is provided or if a maximum discount threshold is reached (1,000). Otherwise, deletions will occur inline. Warning: All automatic discounts will be deleted if a blank search argument is provided.
Anchor to discountAutomaticBxgyCreate discountAutomaticBxgyCreate •mutation: Creates a buy X get Y discount (BXGY) that's automatically applied on a cart and at checkout.

Note
To create code discounts, use the discountCodeBxgyCreate mutation.
Anchor to discountAutomaticBxgyUpdate discountAutomaticBxgyUpdate •mutation: Updates an existing buy X get Y discount (BXGY) that's automatically applied on a cart and at checkout.

Note
To update code discounts, use the discountCodeBxgyUpdate mutation instead.
Anchor to discountAutomaticDeactivate discountAutomaticDeactivate •mutation: Deactivates an automatic discount.
Anchor to discountAutomaticDelete discountAutomaticDelete •mutation: Deletes an automatic discount.
Anchor to discountAutomaticFreeShippingCreate discountAutomaticFreeShippingCreate •mutation: Creates a free shipping discount that's automatically applied on a cart and at checkout.

Note
To create code discounts, use the discountCodeFreeShippingCreate mutation.
Anchor to discountAutomaticFreeShippingUpdate discountAutomaticFreeShippingUpdate •mutation: Updates an existing free shipping discount that's automatically applied on a cart and at checkout.

Note
To update code discounts, use the discountCodeFreeShippingUpdate mutation instead.
Anchor to discountCodeActivate discountCodeActivate •mutation: Activates a code discount.
Anchor to discountCodeAppCreate discountCodeAppCreate •mutation: Creates a code discount. The discount type must be provided by an app extension that uses Shopify Functions. Functions can implement order, product, or shipping discount functions. Use this mutation with Shopify Functions when you need custom logic beyond Shopify's native discount types.

For example, use this mutation to create a code 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 automatic discounts with custom logic, use discountAutomaticAppCreate.
Anchor to discountCodeAppUpdate discountCodeAppUpdate •mutation: Updates a code discount, where the discount type is provided by an app extension that uses Shopify Functions. Use this mutation when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.

Note
To update automatic discounts, use discountAutomaticAppUpdate.
Anchor to discountCodeBasicCreate discountCodeBasicCreate •mutation: Creates an amount off discount that's applied on a cart and at checkout when a customer enters a code. Amount off discounts can be a percentage off or a fixed amount off.

Note
To create discounts that are automatically applied on a cart and at checkout, use the discountAutomaticBasicCreate mutation.
Anchor to discountCodeBasicUpdate discountCodeBasicUpdate •mutation: Updates an amount off discount that's applied on a cart and at checkout when a customer enters a code. Amount off discounts can be a percentage off or a fixed amount off.

Note
To update discounts that are automatically applied on a cart and at checkout, use the discountAutomaticBasicUpdate mutation.
Anchor to discountCodeBulkActivate discountCodeBulkActivate •mutation: Activates multiple code discounts asynchronously using one of the following:

A search query

A saved search ID

A list of discount code IDs

For example, you can activate discounts for all codes that match a search criteria, or activate a predefined set of discount codes.
Anchor to discountCodeBulkDeactivate discountCodeBulkDeactivate •mutation: Deactivates multiple code-based discounts asynchronously using one of the following:

A search query

A saved search ID

A list of discount code IDs

For example, you can deactivate discounts for all codes that match a search criteria, or deactivate a predefined set of discount codes.
Anchor to discountCodeBulkDelete discountCodeBulkDelete •mutation: Deletes multiple code-based discounts asynchronously using one of the following:

A search query

A saved search ID

A list of discount code IDs

For example, you can delete discounts for all codes that match a search criteria, or delete a predefined set of discount codes.
Anchor to discountCodeBxgyCreate discountCodeBxgyCreate •mutation: Creates a buy X get Y discount (BXGY) that's applied on a cart and at checkout when a customer enters a code.

Note
To create discounts that are automatically applied on a cart and at checkout, use the discountAutomaticBxgyCreate mutation.
Anchor to discountCodeBxgyUpdate discountCodeBxgyUpdate •mutation: Updates a buy X get Y discount (BXGY) that's applied on a cart and at checkout when a customer enters a code.

Note
To update discounts that are automatically applied on a cart and at checkout, use the discountAutomaticBxgyUpdate mutation.
Anchor to discountCodeDeactivate discountCodeDeactivate •mutation: Deactivates a code discount.
Anchor to discountCodeDelete discountCodeDelete •mutation: Deletes a code discount.
Anchor to discountCodeFreeShippingCreate discountCodeFreeShippingCreate •mutation: Creates an free shipping discount that's applied on a cart and at checkout when a customer enters a code.

Note
To create discounts that are automatically applied on a cart and at checkout, use the discountAutomaticFreeShippingCreate mutation.
Anchor to discountCodeFreeShippingUpdate discountCodeFreeShippingUpdate •mutation: Updates a free shipping discount that's applied on a cart and at checkout when a customer enters a code.

Note
To update a free shipping discount that's automatically applied on a cart and at checkout, use the discountAutomaticFreeShippingUpdate mutation.
Anchor to discountCodeRedeemCodeBulkDelete discountCodeRedeemCodeBulkDelete •mutation: Asynchronously delete discount codes in bulk that customers can use to redeem a discount.
Anchor to discountRedeemCodeBulkAdd discountRedeemCodeBulkAdd •mutation: Asynchronously add discount codes in bulk that customers can use to redeem a discount. You can use the discountRedeemCodeBulkAdd mutation to automate the distribution of discount codes through emails or other marketing channels.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to DisplayableError DisplayableError •interface

Was this section helpful?