Skip to main content
Anchor to DiscountCodeApp

DiscountCodeApp

object

Requires Apps must have read_discounts access scope.

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.

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 appliesOncePerCustomerappliesOncePerCustomer
•Boolean!
non-null

Whether a customer can only use the discount once.

Anchor to appliesOnOneTimePurchaseappliesOnOneTimePurchase
•Boolean!
non-null

Whether the discount applies on regular one-time-purchase items.

Anchor to appliesOnSubscriptionappliesOnSubscription
•Boolean!
non-null

Whether the discount applies to subscriptions items.

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 codescodes
•DiscountRedeemCodeConnection!
non-null

A list codes that customers can use to redeem the discount.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•DiscountCodeSortKeys
Default:ID

Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.

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

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to times_used
•integer
Anchor to savedSearchIdsavedSearchId
•ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to codesCountcodesCount
•Count

The number of codes that a customer can use to redeem the discount.

Anchor to combinesWithcombinesWith
•DiscountCombinesWith!
non-null

The discount classes that you can use in combination with Shopify discount types.

Anchor to contextcontext
•DiscountContext!
non-null

The context defining which buyers can use the discount.

Anchor to createdAtcreatedAt
•DateTime!
non-null

The date and time when the discount was created.

Anchor to discountClassesdiscountClasses
•[DiscountClass!]!
non-null

The classes of the discount.

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 hasTimelineCommenthasTimelineComment
•Boolean!
non-null

Whether there are timeline comments associated with the discount.

Anchor to recurringCycleLimitrecurringCycleLimit
•Int

The number of billing cycles for which the discount can be applied, which is useful for subscription-based discounts. For example, if you set this field to 3, then the discount only applies to the first three billing cycles of a subscription. If you specify 0, then the discount applies indefinitely.

Anchor to shareableUrlsshareableUrls
•[DiscountShareableUrl!]!
non-null

A list of URLs that the app can use to share the discount.

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 totalSalestotalSales
•MoneyV2

The total sales from orders where the discount was used.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The date and time when the discount was updated.

Anchor to usageLimitusageLimit
•Int

The maximum number of times the discount can be redeemed. For unlimited usage, specify null.

Deprecated fields

Anchor to customerSelectioncustomerSelection
•DiscountCustomerSelection!
non-nullDeprecated
Anchor to discountClassdiscountClass
•DiscountClass!
non-nullDeprecated
Was this section helpful?

Anchor to MutationsMutations

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

Arguments

Anchor to codeAppDiscountcodeAppDiscount
•DiscountCodeAppInput!
required

The input data used to create the discount.

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

Arguments

Anchor to idid
•ID!
required

The ID of the discount to update.

Anchor to codeAppDiscountcodeAppDiscount
•DiscountCodeAppInput!
required

The input fields required to update the discount.

Was this section helpful?