CartItemPriceAdjustment

Price adjustment for a cart item.

Introduced in API version 52.0.

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

  • The CartItemPriceAdjustment object is available only if the B2B Commerce or D2C Commerce license is enabled.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 54.0
  • Description: Scope of the adjustment amount for a promotion.
  • Possible values:
    • Total — Total — The amount off the total price.
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 54.0

  • Description:

    Coupon code of the coupon associated with a promotion.

    This is a relationship field.

  • Relationship name: AdjustmentBasisReference

  • Relationship type: relationship

  • Refers to: Coupon

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Price adjustment type.
  • Possible values:
    • Discretionary — Discretionary
    • Promotion — Promotion
    • System — System
  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Target for the price adjustment (the cart itself or individual items).
  • Possible values:
    • Cart — Cart
    • Item — Item
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 67.0

  • Relationship name: AdjustmentTier

  • Relationship type: relationship

  • Refers to: PromotionTier

  • Type: picklist
  • Properties: Create, Filter, Group, Restricted picklist, Sort, Update
  • Description: Indicates if the price adjustment is applied as percentage or an absolute amount.
  • Possible values:
    • AdjustmentAmount — AdjustmentAmount
    • AdjustmentPercentage — AdjustmentPercentage
  • Type: double
  • Properties: Create, Filter, Sort, Update
  • Description: Numeric value of the adjustment (for example, 10 if the price adjustment is either 10% off or $10 off).
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 55.0

  • Description:

    The ID of the WebCart that’s associated with a cart item.

    This is a relationship field.

  • Relationship name: Cart

  • Relationship type: relationship

  • Refers to: WebCart

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    ID of the parent cart item to which this adjustment belongs.

    This is a relationship field.

  • Relationship name: CartItem

  • Relationship type: masterdetail

  • Refers to: CartItem

  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Description of the price adjustment.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the price adjustment.
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    ID of entity that caused this adjustment (for example, a promotion ID). If unspecified, then Description populates the display name.

    This is a relationship field.

  • Relationship name: PriceAdjustmentCause

  • Relationship type: relationship

  • Refers to: Promotion

  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: If there are multiple price adjustments, sequence in which the price adjustments are applied.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total price after applying price adjustments.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The total gross amount (tax inclusive) after applying price adjustments.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The total net amount (tax exclusive) after applying price adjustments.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the total adjusted price.
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Description:

    ID of the cart’s adjustment group.

    This is a relationship field.

  • Relationship name: WebCartAdjustmentGroup

  • Relationship type: relationship

  • Refers to: WebCartAdjustmentGroup

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.