CartVoucher

Voucher or gift certificate applied to the shopping cart.

Represents a redeemable voucher code with its current status, value, and usage restrictions.

type CartVoucher {
  code: String!
  name: String!
  description: String!
  ruleId: Int!
  redeemed: YesNo!
  combinable: YesNo!
  partialRedemption: YesNo!
  available: Float!
  remaining: Float!
}

Fields

CartVoucher.code ● String! non-null scalar

Unique voucher code identifier.

The code that customers enter to redeem this voucher for discounts or credit.

CartVoucher.name ● String! non-null scalar

Display name of the voucher promotion.

Human-readable name describing the voucher or the promotion rule that generated it.

CartVoucher.description ● String! non-null scalar

Detailed description of the voucher benefits.

Explanation of what the voucher provides, including terms and conditions.

CartVoucher.ruleId ● Int! non-null scalar

Identifier of the promotion rule that created this voucher.

Links the voucher back to the specific promotional campaign or rule configuration.

CartVoucher.redeemed ● YesNo! non-null enum

Whether the voucher has been fully used.

Indicates if the voucher has been completely redeemed and cannot be used again.

CartVoucher.combinable ● YesNo! non-null enum

Whether this voucher can be used with other vouchers.

Indicates if multiple vouchers can be applied to the same cart simultaneously.

CartVoucher.partialRedemption ● YesNo! non-null enum

Whether the voucher supports partial redemption.

Indicates if the voucher value can be used across multiple orders when it represents a monetary amount.

CartVoucher.available ● Float! non-null scalar

Total monetary value available on the voucher.

Original amount or credit value that can be redeemed using this voucher.

CartVoucher.remaining ● Float! non-null scalar

Remaining monetary value after partial use.

Amount still available for redemption when the voucher supports partial redemption.

Member Of

Cart object