Newer Version Available

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

CartItem

Represents an item in a WebCart that’s active in a store built with B2B Commerce on Lightning Experience. Cart item can be of type Product or Charge. This object is available in API version 49.0 and later.

Supported Calls

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

Special Access Rules

The CartItem object is available only if the B2B Commerce on Lightning Experience license is enabled.

Fields

Field Details
AdjustmentAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Non-itemized adjustments for this cart item
AdjustmentTaxAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The tax that’s calculated on the AdjustmentAmount.
CartDeliveryGroupId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The ID of the CartDeliveryGroup that’s associated with a cart item.
CartId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the WebCart that’s associated with a cart item.
CurrencyIsoCode
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The ISO code for the currency that’s specified on the buyer’s account. Default value is USD. Possible values are:
  • EUR—Euro
  • USD—U.S. Dollar
ItemizedAdjustmentAmount
Type
currency
Properties
Defaulted on create, Filter, Nillable, Sort
Description
A calculated field that determines the total amount of promotional adjustments that are specific to an item. This field is available in API version 52.0 and later.
EXAMPLE: One cart item has one discount code for $10 off. Your itemized adjustment amount is (-$10) for that item.
ItemizedAdjustmentTaxAmount
Type
currency
Properties
Defaulted on create, Filter, Nillable, Sort
Description
A calculated field that determines the total amount of promotion-related tax adjustments that are specific to an item. This field is available in API version 52.0 and later.
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.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of this CartItem record. Name can be up to 255 characters.
Product2Id
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.
Quantity
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The number of a given cart item in a cart.
SalesPrice
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The discounted price of a cart item.
Sku
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The Shelf-Keeping Unit ID of a cart item.
TotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total cost of this cart item, including taxes and adjustments.
TotalLineAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Total amount for this cart item, based on sales price and quantity.
TotalLineTaxAmount
Type
currency
Properties
Defaulted on create, Filter, Nillable, Sort
Description
Total tax amount for TotalLineAmount.
TotalListPrice
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
TotalPrice
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Total amount for this cart item, including adjustments but excluding taxes.
TotalTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total tax amount for this cart item. This value includes taxes for both TotalLineAmount and AdjustmentAmount.
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The CartItem type. Possible values are:
  • Product
  • Charge
UnitAdjustedPrice
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Price per quantity unit after a discount or surcharge is applied. This field is available in API version 50.0 and later.
UnitAdjustmentAmount
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
Discount or surcharge to apply to a quantity unit. This amount is added to the SalesPrice to get the UnitAdjustedPrice. This field is available in API version 50.0 and later.