DiscountAutomaticFreeShipping
Requires Apps must have access scope.
The object lets you manage
free shipping discounts
that are automatically applied on a cart and at checkout. Free shipping discounts are promotional deals that
merchants offer to customers to waive shipping costs and encourage online purchases.
The object stores information about automatic free shipping 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 FieldsFields
- Anchor to appliesOnOneTimePurchaseapplies•
On One Time Purchase Boolean!non-null Whether the discount applies on one-time purchases. A one-time purchase is a transaction where you pay a single time for a product, without any ongoing commitments or recurring charges.
- Anchor to appliesOnSubscriptionapplies•
On Subscription Boolean!non-null Whether the discount applies on subscription items. Subscriptions enable customers to purchase products on a recurring basis.
- 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 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 destinationSelectiondestination•
Selection The countries that qualify for the discount. You can define a list of countries or specify all countries to be eligible for the discount.
- Anchor to discountClassdiscount•
Class ShippingDiscount 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 maximumShippingPricemaximum•
Shipping Price The maximum shipping price amount accepted to qualify for the discount.
- Anchor to minimumRequirementminimum•
Requirement DiscountMinimum non-nullRequirement! The minimum subtotal or quantity of items that are required for the discount to be applied.
- Anchor to recurringCycleLimitrecurring•
Cycle Limit Int!non-null 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 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.