CartItem

Represents an item in a WebCart that’s active in a store built with B2B. Cart item can be of type Product or Charge.

Introduced in API version 46.0.

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

  • The CartItem object is available only if the B2B Commerce license is enabled.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Non-itemized adjustments for this cart item.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The tax that’s calculated on the AdjustmentAmount.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 59.0
  • Description: Specifies how often a subscription is billed.
  • Possible values:
    • Annual — Annual
    • MilestonePlan — MilestonePlan
    • Monthly — Monthly
    • Quarterly — Quarterly
    • Semi-Annual — Semi-Annual
  • Type: reference

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

  • Introduced: API version 67.0

  • Relationship name: CartAction

  • Relationship type: relationship

  • Refers to: CartAction

  • Type: reference

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

  • Description:

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

    This field is a relationship field.

  • Relationship name: CartDeliveryGroup

  • Relationship type: relationship

  • Refers to: CartDeliveryGroup

  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

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

    This field is a relationship field.

  • Relationship name: Cart

  • Relationship type: masterdetail

  • Refers to: WebCart

  • Type: int
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 62.0
  • Description: The total number of child products associated with this cart item. If a child product is a bundle, its own ChildProductCount is included in this total. For simple products that don’t have any child products, the ChildProductCount value is zero.
  • Default value: 0
  • Type: currency

  • Properties: Defaulted on create, Filter, Nillable, Sort

  • Introduced: API version 52.0

  • Description:

    A calculated field that determines the amount of a cart-wide promotional adjustment when distributed across all items in the cart. This field is for display purposes only and is valid only during checkout.

    You receive $10 off, and there are 5 items in the cart. The distributed adjustment is (-$2).

  • Default value: 0

  • Type: currency

  • Properties: Defaulted on create, Filter, Nillable, Sort

  • Introduced: API version 52.0

  • Description:

    A calculated field that determines the amount of a cart-wide tax adjustment due to promotions when distributed across all items in the cart.

    EXAMPLE: Your discount causes a cart-wide tax reduction of (-$10), and there are 5 items in the cart. The distributed tax adjustment is (-$2).

  • Default value: 0

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 67.0
  • Description: Indicates the final asset quantity when the subscription is modified or when it ends.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: The tax for the first term price for term-based subscription products. The tax amount for a non-subscription product or a non-term subscription product.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The gross amount of the price adjustment on the cart item (tax inclusive). This is available in API version 55.0 and later.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 55.0
  • Description: The gross amount of the unit price for a cart item (tax inclusive). This is available in API version 55.0 and later.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 64.0
  • Description: Indicates whether shipping charges are applicable (true) or not (false) to the cart item. The default value is false.
  • Default value: false
  • Type: currency

  • Properties: Defaulted on create, Filter, Nillable, Sort

  • Introduced: API version 52.0

  • Description:

    A calculated field that determines the total amount of promotional adjustments that are specific to an item.

    EXAMPLE: One cart item has one discount code for $10 off. Your itemized adjustment amount is (-$10) for that item.

  • Default value: 0

  • Type: currency

  • Properties: Defaulted on create, Filter, Nillable, Sort

  • Introduced: API version 52.0

  • Description:

    A calculated field that determines the total amount of promotion-related tax adjustments that are specific to an item.

    EXAMPLE: One cart item has one discount code for $10 off. This reduces the tax on that item by (-$2). Your itemized adjustment tax amount is (-$2) for that item.

  • Default value: 0

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Description: The original price of the cart item. Typically shown with a line through it. List price is shown only when it’s higher than the negotiated price. If the list price is the same or lower, it isn’t shown to the buyer.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of this CartItem record. Name can be up to 255 characters.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The net amount of the price adjustment made on the cart item (tax exclusive). This is available in API version 55.0 and later.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 55.0
  • Description: The net amount of the unit price for the cart item (tax exclusive). This is available in API version 55.0 and later.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: The net unit price for a cart item, after all tier and promotional price adjustments are applied.
  • Type: reference

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

  • Introduced: API version 62.0

  • Description:

    The ID of the cart item’s parent CartItem. The value is empty if the item is a top-level cart item.

    This field is a relationship field.

  • Relationship name: ParentCartItem

  • Relationship type: relationship

  • Refers to: CartItem

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 62.0
  • Description: Weight per unit of this cart item, in the unit specified by WeightUnit.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 60.0
  • Description: The. Default value is .
  • Possible values:
    • AlignToCalendar — AlignToCalendar
    • Anniversary — Anniversary
    • DayOfPeriod — DayOfPeriod
    • LastDayOfPeriod — LastDayOfPeriod
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: The .
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 60.0
  • Description: The. Default value is .
  • Possible values:
    • 1 — 1 — January
    • 10 — 10 — October
    • 11 — 11 — November
    • 12 — 12 — December
    • 2 — 2 — February
    • 3 — 3 — March
    • 4 — 4 — April
    • 5 — 5 — May
    • 6 — 6 — June
    • 7 — 7 — July
    • 8 — 8 — August
    • 9 — 9 — September
  • Type: reference

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

  • Introduced: API version 60.0

  • Description:

    The ID of the price book entry for the product.

    This field is a relationship field.

  • Relationship name: PricebookEntry

  • Relationship type: relationship

  • Refers to: PricebookEntry

  • Type: reference

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

  • Introduced: API version 67.0

  • Relationship name: PricingContract

  • Relationship type: relationship

  • Refers to: Contract

  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 68.0
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 59.0
  • Description: A calculated field that indicates the number of pricing terms in the subscription.
  • Type: reference

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

  • Description:

    The ID of a product type cart item. Cart items can be of type PRODUCT or CHARGE.

    This field is a relationship field.

  • Relationship name: Product2

  • Relationship type: relationship

  • Refers to: Product2

  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 62.0
  • Description: The product class of the cart item. Default value is Simple.
  • Possible values:
    • Bundle — Bundle
    • Set — Set
    • Simple — Simple
    • Variation — Variation
    • VariationParent — VariationParent
  • Type: reference

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

  • Introduced: API version 62.0

  • Description:

    The ID of the cart item’s ProductRelatedComponent. The ProductRelatedComponent represents a product that is included in a product bundle, a set, or a product and an add-on. The ProductRelatedComponent is empty if the item is a top-level cart item.

    This field is a relationship field.

  • Relationship name: ProductRelatedComponent

  • Relationship type: relationship

  • Refers to: ProductRelatedComponent

  • Type: reference

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

  • Introduced: API version 65.0

  • Description:

    The ID of the product relationship type that defines the relationship between a product bundle and its child product.

    This field is a relationship field.

  • Relationship name: ProductRelationshipType

  • Relationship type: relationship

  • Refers to: ProductRelationshipType

  • Type: reference

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

  • Introduced: API version 59.0

  • Description:

    The ID of the model used to sell a product.

    This field is a relationship field.

  • Relationship name: ProductSellingModel

  • Relationship type: relationship

  • Refers to: ProductSellingModel

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 62.0
  • Description: The product validation key of the cart item.
  • Type: reference

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

  • Introduced: API version 60.0

  • Description:

    The ID of the proration policy, which defines how prices are calculated for each time period within a subscription term.

    This field is a relationship field.

  • Relationship name: ProrationPolicy

  • Relationship type: relationship

  • Refers to: ProrationPolicy

  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The number of a given cart item in a cart.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 66.0
  • Description: ID of the associated quote line item. Applicable only if the cart is created from a quote.
  • Relationship name: QuoteLineItem
  • Relationship type: relationship
  • Refers to: QuoteLineItem
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The discounted price of a cart item.
  • Type: picklist

  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 60.0

  • Description:

    The type of the product selling model associated with a term-based subscription product.

    The default value is OneTime.

  • Possible values:

    • Evergreen — Evergreen
    • OneTime — OneTime (default)
    • TermDefined — TermDefined
  • Default value: OneTime

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The Shelf-Keeping Unit ID of a cart item.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 67.0
  • Description: Indicates the initial asset quantity when the subscription starts.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 62.0
  • Description: Determines how inventory is assessed for a cart item that’s part of a bundle or set.
  • Possible values:
    • ChildProducts — ChildProducts — Inventory is assessed based on the child product or products.
    • ParentProduct — ParentProduct — Inventory is assessed based on the parent product.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 64.0
  • Description: Specifies the subtype of the product.
  • Possible values:
    • Bonus — Bonus — Bonus product.
    • GiftWrap — GiftWrap — Gift wrapped product.
  • Type: int
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 59.0
  • Description: The number of terms (years or months, for example) in the subscription.
  • Type: reference

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

  • Introduced: API version 63.0

  • Description:

    The ID of the related tax treatment for the cart item. This field is available with Subscription Management.

    This field is a relationship field.

  • Relationship name: TaxTreatment

  • Relationship type: relationship

  • Refers to: TaxTreatment

  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Description: The total amount of all promotional adjustments on the item, both distributed and itemized.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The total cost of this cart item, including taxes and adjustments.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Description: The total adjustment amount for the first payment of a term-based susbcription product. The TotalAdjustmentAmount for non-subscription products and non-term based subscription products.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Description: The first-payment amount for a term-based subscription product, based on the product’s ListPrice. This is the same value as TotalListPrice for non-subscription products or non-term based subscription products. This price is only for comparison, and not the price at which the buyer purchases a product.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Description: The first term price for term-based subscription products. The price of a line item for non-subscription products and non-term based subscription products. This price includes price adjustments and excludes taxes.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total amount for this cart item, based on sales price and quantity.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 63.0
  • Description: The first term price for term-based subscripiton products, calculated based on the sales price and quantity, before any price adjustments are made. This is the same value as TotalLineAmount for non-subscription products and non-term based subscription products.
  • Type: currency
  • Properties: Defaulted on create, Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Description: The tax on the first payment amount, after price adjustments, for term-based subscription products. The tax on the price of the product for non-subscription products and non-term based subscription products. Taxes are also calculated on the delivery charge items. This field is a calculated field.
  • Default value: 0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The total gross amount of the line item (tax inclusive). This is available in API version 55.0 and later.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 55.0
  • Description: The total net amount of the line item (tax exclusive). This is available in API version 55.0 and later.
  • Type: currency
  • Properties: Defaulted on create, Filter, Nillable, Sort
  • Description: Total tax amount for TotalLineAmount.
  • Default value: 0
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Total amount for this cart item, based on ListPrice. We provide this value for comparison. It’s not the price that the buyer is paying.
  • Type: currency

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

  • Description: Total amount for this cart item, including adjustments but excluding taxes.

    Although this field is Nillable, if you want to use Commerce Webstore Cart Promotions, this field is required.

  • Type: currency

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

  • Introduced: API version 52.0

  • Description: Total price after all price adjustments are applied.

    Although this field is Nillable, if you want to use Commerce Webstore Cart Promotions, this field is required.

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Total tax amount for a cart item before promotional adjustments, including quantity-based adjustments.
  • Type: currency
  • Properties: Create, Defaulted on create, Filter, Nillable, Sort, Update
  • Introduced: API version 52.0
  • Description: Total itemized and distributed adjustment amount in cart (only for promotions).
  • Default value: 0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 52.0
  • Description: Total itemized and distributed adjustment tax amount in cart (only for promotions).
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total tax amount for this cart item. This value includes taxes for both TotalLineAmount and AdjustmentAmount.
  • Type: double
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 62.0
  • Description: Total weight of this cart item, in the unit specified by WeightUnit.
  • Type: picklist
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The CartItem type.
  • Possible values:
    • Product — Product
    • Charge — Charge
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Price per quantity unit after a tier discount or surcharge is applied.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 61.0
  • Description: Unit price, including both tier and item level discounts, for the item.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 50.0
  • Description: Tier discount or surcharge to apply to a quantity unit. This amount is added to the SalesPrice to get the UnitAdjustedPrice.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 61.0
  • Description: Item level adjustments made to the unit price for the item.
  • Type: currency
  • Properties: Create, Filter, Nillable, Sort, Update
  • Introduced: API version 60.0
  • Description: The unit price for a cart item, after tier and promotional price adjustments are applied.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 62.0
  • Description: Unit of measurement for the weight of the cart item.
  • Possible values:
    • Grams — Grams
    • Kilograms — Kilograms
    • Ounces — Ounces
    • Pounds — Pounds

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.