Storefront GraphQL APIReferenceObjects
Discount
type
DiscountFields
- fields
_id*ID!tenant?Stringtitle*String!type*DiscountType!Value in
PRODUCT_AMOUNTORDER_AMOUNTBUY_X_GET_YFREE_SHIPPINGmethod*DiscountMethod!Value in
CODEAUTOMATICcode?StringCustomer-entered code. Only set when method is CODE.
isActive*Boolean!startsAt?DateTimeA date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
endsAt?DateTimeA date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
value?Used by PRODUCT_AMOUNT and ORDER_AMOUNT discounts.
appliesTo?Products a PRODUCT_AMOUNT discount applies to.
buyXGetY?freeShipping?minimumRequirement?eligibility?usageLimit?IntTotal redemptions across all customers. Empty means no limit.
oncePerCustomer*Boolean!combinesWith?usageCount?IntOrders that used this discount. Resolved on read.
createdAt?DateTimeA date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
updatedAt?DateTimeA date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.
commits?isDemo?Booleantype Discount { _id: ID! tenant: String title: String! type: DiscountType! method: DiscountMethod! code: String isActive: Boolean! startsAt: DateTime endsAt: DateTime value: DiscountValue appliesTo: DiscountItemSelection buyXGetY: DiscountBuyXGetY freeShipping: DiscountFreeShipping minimumRequirement: DiscountMinimumRequirement eligibility: DiscountEligibility usageLimit: Int oncePerCustomer: Boolean! combinesWith: DiscountCombinesWith usageCount: Int createdAt: DateTime updatedAt: DateTime commits: [ResourceCommitHistoryReference!] isDemo: Boolean}