| 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.
- This field is a relationship field.
- Relationship Name
- CartDeliveryGroup
- Relationship Type
- Lookup
- Refers To
- CartDeliveryGroup
|
| CartId |
- 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
- Lookup
- Refers To
- WebCart
|
| 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:
-
|
| DistributedAdjustmentAmount |
- Type
- currency
- Properties
- Defaulted on create, Filter, Nillable, Sort
- 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. This field is available in API version
52.0 and later.
- You receive $10 off, and there are 5 items in the cart.
The distributed adjustment is (-$2).
|
| DistributedAdjustmentTaxAmount |
- Type
- currency
- Properties
- Defaulted on create, Filter, Nillable, Sort
- 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. This field is
available in API version 52.0 and later.
- 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).
|
| GrossAdjustmentAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The gross amount of the price adjustment on the cart
item (tax inclusive). This is available in API version
55.0 and later.
|
| GrossUnitPrice |
- Type
- currency
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The gross amount of the unit price for a cart item (tax
inclusive). This is available in API version 55.0 and
later.
|
| 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.
|
| ListPrice |
- Type
- currency
- Properties
- Create, Filter, Nillable, Sort, Update
- 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. This
field is available in API version 52.0 and later.
|
| Name |
- Type
- string
- Properties
- Create, Filter, Group, idLookup, Sort, Update
- Description
- The name of this CartItem record.
Name can be up to 255
characters.
|
| NetAdjustmentAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- 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.
|
| NetUnitPrice |
- Type
- currency
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The net amount of the unit price for the cart item (tax
exclusive). This is available in API version 55.0 and
later.
|
| 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.
- This field is a relationship field.
- Relationship Name
- Product2
- Relationship Type
- Lookup
- Refers To
- Product2
|
| 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.
|
| TotalAdjustmentAmount |
- Type
- currency
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The total amount of all promotional adjustments on the
item, both distributed and itemized. This field is
available in API version 52.0 and later.
|
| 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.
|
| TotalLineGrossAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The total gross amount of the line item (tax inclusive).
This is available in API version 55.0 and later.
|
| TotalLineNetAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- The total net amount of the line item (tax exclusive).
This is available in API version 55.0 and later.
|
| 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.
-
|
| TotalPriceAfterAllAdjustments |
- Type
- currency
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Total price after all price adjustments are applied.
This field is available in API version 52.0 and
later.
-
|
| TotalPriceTaxAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total tax amount for a cart item before promotional
adjustments, including quantity-based adjustments. This
field is available in API version 56.0 and later.
|
| TotalPromoAdjustmentAmount |
- Type
- currency
- Properties
- Create, Defaulted on create, Filter, Nillable, Sort,
Update
- Description
- Total itemized and distributed adjustment amount in cart
(only for promotions). This field is available in API
version 52.0 and later.
|
| TotalPromoAdjustmentTaxAmount |
- Type
- currency
- Properties
- Filter, Nillable, Sort
- Description
- Total itemized and distributed adjustment tax amount in
cart (only for promotions). This field is available in
API version 52.0 and later.
|
| 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:
|
| 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.
|
j