Skip to main content

CartIncentive

Promotional incentive applied to the shopping cart.

Represents an active promotion, discount, or special offer that affects cart pricing or adds bonus items.

type CartIncentive {
  name: String!
  action: String!
  affectedItems: [CartBaseItem!]
  params: CartIncentiveParams!
}

Fields​

CartIncentive.name ● String! non-null scalar​

Display name of the incentive promotion.

Human-readable name describing the promotional offer or discount applied to the cart.

CartIncentive.action ● String! non-null scalar​

Type of incentive action being applied.

Describes the specific promotional action such as 'discount', 'bonus_item', 'free_shipping', etc.

CartIncentive.affectedItems ● [CartBaseItem!] list object​

Cart items affected by this incentive.

List of specific items in the cart that are subject to this promotional offer or discount.

CartIncentive.params ● CartIncentiveParams! non-null object​

Configuration parameters for the incentive.

Detailed settings that define how the incentive is calculated and applied, including discount amounts, quantities, and conditions.

Member Of​

Cart object