Choose a version:

DiscountCodeFreeShipping

object

Requires Apps must have read_discounts access scope.

The DiscountCodeFreeShipping object lets you manage free shipping discounts that are applied on a cart and at checkout when a customer enters a code. Free shipping discounts are promotional deals that merchants offer to customers to waive shipping costs and encourage online purchases.

The DiscountCodeFreeShipping object stores information about free shipping 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.

Note

The DiscountAutomaticFreeShipping object has similar functionality to the DiscountCodeFreeShipping object, but discounts are automatically applied, without the need for customers to enter a code.

Anchor to FieldsFields

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 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 appliesOnSubscriptionappliesOnSubscription •Boolean! non-null: Whether the discount applies on subscription items. Subscriptions enable customers to purchase products on a recurring basis.
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.
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 destinationSelectiondestinationSelection •DiscountShippingDestinationSelection! non-null: 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 discountClassesdiscountClasses •[DiscountClass!]! non-null: The classes of 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 hasTimelineCommenthasTimelineComment •Boolean! non-null: Whether there are timeline comments associated with the discount.
Anchor to maximumShippingPricemaximumShippingPrice •MoneyV2: The maximum shipping price amount accepted to qualify for the discount.
Anchor to minimumRequirementminimumRequirement •DiscountMinimumRequirement: The minimum subtotal or quantity of items that are required for the discount to be applied.
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 shortSummaryshortSummary •String! non-null: An abbreviated version of the discount summary field.
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 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 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 that a customer can use the discount. For discounts with unlimited usage, specify null.

Deprecated fields

Anchor to customerSelectioncustomerSelection •DiscountCustomerSelection! non-nullDeprecated
Anchor to discountClassdiscountClass •ShippingDiscountClass! non-nullDeprecated

Was this section helpful?