DiscountCodeBasic
Requires Apps must have access scope.
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.
Anchor to Fields and connectionsFields and connections
- Anchor to appliesOncePerCustomerapplies•
Once Per Customer Boolean!non-null Whether a customer can only use the discount once.
- Anchor to asyncUsageCountasync•
Usage Count 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•Discount
Redeem non-nullCode Connection! A list codes that customers can use to redeem the discount.
- Anchor to codesCountcodes•
Count The number of codes that a customer can use to redeem the discount.
- Anchor to combinesWithcombines•
With DiscountCombines non-nullWith! The discount classes that you can use in combination with Shopify discount types.
- Anchor to createdAtcreated•
At DateTime! non-null The date and time when the discount was created.
- Anchor to customerGetscustomer•
Gets DiscountCustomer non-nullGets! The items in the order that qualify for the discount, their quantities, and the total value of the discount.
- Anchor to customerSelectioncustomer•
Selection DiscountCustomer non-nullSelection! The customers that can use the discount.
- Anchor to discountClassdiscount•
Class MerchandiseDiscount non-nullClass! The discount class that's used to control how discounts can be combined.
- Anchor to endsAtends•
At 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 hasTimelineCommenthas•
Timeline Comment Boolean!non-null Whether there are timeline comments associated with the discount.
- Anchor to minimumRequirementminimum•
Requirement The minimum subtotal or quantity of items that are required for the discount to be applied.
- Anchor to recurringCycleLimitrecurring•
Cycle Limit 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 specify0, then the discount applies indefinitely.- Anchor to shareableUrlsshareable•
Urls [DiscountShareable non-nullUrl!]! A list of URLs that the app can use to share the discount.
- Anchor to shortSummaryshort•
Summary String!non-null An abbreviated version of the discount
summaryfield.- Anchor to startsAtstarts•
At DateTime! 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 summarysummary•String!non-null
A detailed explanation of what the discount is, who can use it, when and where it applies, and any associated rules or limitations.
- Anchor to titletitle•String!non-null
The discount's name that displays to merchants in the Shopify admin and to customers.
- Anchor to totalSalestotal•
Sales The total sales from orders where the discount was used.
- Anchor to updatedAtupdated•
At DateTime! non-null The date and time when the discount was updated.
- Anchor to usageLimitusage•
Limit The maximum number of times that a customer can use the discount. For discounts with unlimited usage, specify
null.