Skip to navigation
GraphQLStorefrontTypesObjects

CheckoutCoupon

OBJECT
The checkout coupon.

Fields

entityIdIntegerRequired
The coupon ID.
promotionEntityIdIntegerRequired
The ID of the promotion that generated this coupon.
codeStringRequired
The coupon code.
discountedAmountMoneyRequired
The discounted amount applied within a given context.
discountedAmountInDisplayCurrencyMoneyRequired
Discounted amount in display currency.
hasMaxLimitReachedBooleanRequired
Indicates whether the coupon has reached its maximum limit.
couponTypeCouponTypeOptional
The coupon type.
displayNameStringOptional
The display name of the coupon.
statusCouponStatusOptional
The status of the coupon.
Allowed values: