An automatic 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.
asyncUsageCount:
Int! -
The number of times that the discount has been used. This value is updated asynchronously and can be different than the actual usage count.
combinesWith:
DiscountCombinesWith! -
Determines which discount classes the discount can combine with.
createdAt:
DateTime! -
The date and time when the discount was created.
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).
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.
DiscountAutomatic
The type of discount associated to the automatic discount. For example, the automatic discount might offer a basic discount using a fixed percentage, or a fixed amount, on specific products from the order. The automatic discount may also be a BXGY discount, which offers customer discounts on select products if they add a specific product to their order.