CartItem

Each row represents an item in a web cart that’s active in a store built with B2B Commerce or B2C Commerce This object is available in API version 66.0 and later.

Supported Calls

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

Special Access Rules

The CartItem object is available with CMERLMB2CAddOn license.

See Also

CartItem

Fields

BillingFrequency

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Defines the billing frequency for the subscription.
Possible values:
- Annual
- MilestonePlan—Milestone Plan
- Monthly
- Quarterly
- Semi-Annual

DiscountAmount

Type: currency
Properties: Create, Filter, Nillable, Sort, Update
Description: The monetary final discount that’s provided to the customer on the cart items.

DiscountPercentage

Type: percent
Properties: Create, Filter, Nillable, Sort, Update
Description: The discount percentage associated with the cart item.

EndDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The end date of the cart item.

PeriodBoundary

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The boundary delimiters for periods, determines when a period starts and ends.
Possible values:
- AlignToCalendar—Align to Calendar
- Anniversary
- DayOfPeriod—Day of Period
- LastDayOfPeriod—Last Day of Period

PeriodBoundaryDay

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number specifying the day when PeriodBoundary is a specific day in a week, month, or a year.

PeriodBoundaryStartMonth

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: The start month of a period when the Billing Frequency is greater than monthly, such as annual, semi-annual, or quarterly.
Possible values:
- 1—January
- 10—October
- 11—November
- 12—December
- 2—February
- 3—March
- 4—April
- 5—May
- 6—June
- 7—July
- 8—August
- 9—September

PriceWaterfallIdentifier

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The price waterfall identifier of the pricing execution associated with the waterfall data.

PricebookEntryId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the price book entry for the product. This field is a relationship field.
Relationship Name: PricebookEntry
Refers To: PricebookEntry

PricingTermCount

Type: double
Properties: Create, Filter, Nillable, Sort, Update
Description: A calculated field that indicates the number of pricing terms in the subscription.

ProductSellingModelId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The ID of the method by which a product is sold. This field is a relationship field.
Relationship Name: ProductSellingModel
Refers To: ProductSellingModel

ProrationPolicyId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
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
Refers To: ProrationPolicy

StartDate

Type: date
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The start date of the cart item.

SubscriptionTerm

Type: int
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The number of terms in the subscription.

ValidationResult

Type: picklist
Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description: Specifies the type of configuration warnings for a cart item.
Possible values:
- Warning

Associated Objects

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 and later.

CartItemChangeEvent: Change events are available for the object.
CartItemFeed: Feed tracking is available for the object.
CartItemHistory: History is available for tracked fields of the object.
CartItemOwnerSharingRule: Sharing rules are available for the object.
CartItemShare: Sharing is available for the object.