CartIncentiveParams

Configuration parameters for cart incentive calculations.

Contains the specific values and settings that define how a promotional incentive is calculated and applied to the cart.

type CartIncentiveParams {
  quantity: Int
  price: Float
  productId: Int
  discount: Float
  discountType: DiscountType
  valuePoints: Int
  repeat: YesNo
  actionCode: String
}

Fields

CartIncentiveParams.quantity ● Int scalar

Minimum quantity required to trigger the incentive.

Number of items that must be present in the cart for this incentive to become active.

CartIncentiveParams.price ● Float scalar

Fixed price override for incentive items.

Special price that replaces the regular item price when this incentive is applied.

CartIncentiveParams.productId ● Int scalar

Specific product identifier for targeted incentives.

Product ID that this incentive applies to, used for product-specific promotions.

CartIncentiveParams.discount ● Float scalar

Discount amount or percentage value.

The value of the discount applied, interpreted based on the discount type (fixed amount or percentage).

CartIncentiveParams.discountType ● DiscountType enum

Method of discount calculation.

Specifies whether the discount value represents a fixed amount (FLAT_FEE) or percentage (PERCENTAGE).

CartIncentiveParams.valuePoints ● Int scalar

Loyalty points awarded by this incentive.

Number of value points credited to the customer's account when this incentive is applied.

CartIncentiveParams.repeat ● YesNo enum

Whether the incentive can be applied multiple times.

Indicates if the incentive benefits can be repeated for multiple qualifying items or quantities.

CartIncentiveParams.actionCode ● String scalar

Promotional action code that triggered this incentive.

The specific promotion code or coupon that activated this incentive offer.

Member Of

CartIncentive object