Newer Version Available

This content describes an older version of this product. View Latest

Promotion Cart Item Price Adjustment

Price adjustments applied to a cart item.
Property Name Type Description Filter Group and Version Available Version
adjustmentAmount​Scope String Scope of the price adjustment amount. Values are:
  • Total—The adjustment scope is the total price.
  • Unit—The adjustment scope is the unit price.
  • UnproratedTotal—The adjustment scope is the unprorated total price.
Small, 56.0 56.0
adjustmentBasis​Reference String ID of the associated coupon, if applicable. Small, 56.0 56.0
adjustmentDescription String Description of the adjustment. Small, 56.0 56.0
adjustmentTargetType String Level of the promotion target. Values are:
  • Cart—The target is cart-level.
  • Item—The target is item-level.
Small, 56.0 56.0
adjustmentType String How the price adjustment amount is calculated. Values are:
  • AdjustmentAmount—The adjustment is a fixed amount.
  • AdjustmentPercentage—The adjustment is a percentage.
Small, 56.0 56.0
adjustmentValue String Value of the price adjustment. Small, 56.0 56.0
baseAmount String Total adjustment amount. Small, 56.0 56.0
cartAdjustment​GroupId String ID of the associated cart adjustment group. Small, 56.0 56.0
cartItemId String ID of the associated cart item. Small, 56.0 56.0
id String ID of the cart item price adjustment. Small, 56.0 56.0
priceAdjustment​CauseId String ID of the associated promotion. Small, 56.0 56.0
priority Integer Where in the sequence of adjustments this adjustment was applied. Small, 56.0 56.0