DiscountCodeFreeShipping - admin-graphql - OBJECT
Version: 2025-01
Description:
A code discount that offers customers free shipping on their order.
Access Scopes
Apps must have `read_discounts` access scope.
Fields
appliesOnOneTimePurchase :
Boolean! -
Whether the discount applies on regular one-time-purchase shipping lines.
appliesOnSubscription :
Boolean! -
Whether the discount applies on subscription shipping lines.
appliesOncePerCustomer :
Boolean! -
Whether the discount can be applied only once per customer.
asyncUsageCount :
Int! -
The number of times that the discount has been used.
codesCount :
Count -
The number of redeem codes for the discount.
combinesWith :
DiscountCombinesWith! -
Determines which discount classes the discount can combine with.
createdAt :
DateTime! -
The date and time when the discount was created.
customerSelection :
DiscountCustomerSelection! -
The customers that can use the discount.
destinationSelection :
DiscountShippingDestinationSelection! -
A shipping destination that qualifies for the discount.
discountClass :
ShippingDiscountClass! -
The class of the discount for combining purposes.
endsAt :
DateTime -
The date and time when the discount ends. For open-ended discounts, use `null`.
hasTimelineComment :
Boolean! -
Indicates whether there are any timeline comments on the discount.
maximumShippingPrice :
MoneyV2 -
The maximum shipping price amount accepted to qualify for the discount.
minimumRequirement :
DiscountMinimumRequirement -
The minimum subtotal or quantity that's required for the discount to be applied.
recurringCycleLimit :
Int -
The number of times a discount applies on recurring purchases (subscriptions).
shareableUrls :
DiscountShareableUrl! -
URLs that can be used to share the discount.
shortSummary :
String! -
A short summary of the discount.
startsAt :
DateTime! -
The date and time when the discount starts.
status :
DiscountStatus! -
The status of the discount.
summary :
String! -
A detailed summary of the discount.
title :
String! -
The title of the discount.
totalSales :
MoneyV2 -
The total sales from orders where the discount was used.
updatedAt :
DateTime! -
The date and time when the discount was updated.
usageLimit :
Int -
The maximum number of times that the discount can be used.
Connections
codes :
DiscountRedeemCodeConnection!
Related queries
Related mutations
Related Unions
Discount
A discount.
DiscountCode
The type of discount associated with the discount code. For example, the discount code might offer a basic discount of a fixed percentage, or a fixed amount, on specific products or the order. Alternatively, the discount might offer the customer free shipping on their order. A third option is a Buy X, Get Y (BXGY) discount, which offers a customer discounts on select products if they add a specific product to their order.
Examples