Newer Version Available

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

WebCart

Represents an online shopping cart in a store built with B2B Commerce on Lightning, with total amounts for products, shipping and handling, and taxes. This object is available in API version 49.0 and later.

Supported Calls

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

Special Access Rules

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

Fields

Field Details
AccountId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
ID of the account that owns this WebCart.
BillingAddress
Type
address
Properties
Filter, Nillable
Description
The address to which to bill this WebCart.
BillingCity
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city of the billing address.
BillingCountry
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country of the billing address.
BillingGeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The accuracy rating of the geocode for the billing address. Possible values are:
  • Address
  • Block
  • City
  • County
  • ExtendedZip
  • NearAddress
  • Neighborhood
  • State
  • Street
  • Unknown
  • Zip
BillingLatitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The latitude of the geocode for the billing address.
BillingLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The longitude of the geocode for the billing address.
BillingPostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The postal code for the billing address.
BillingState
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The state of the billing address.
BillingStreet
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street of the billing address. Enter up to 255 characters.
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
GrandTotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Sum of all cart items’ TotalAmount, or WebCart TotalAmount plus WebCart TotalTaxAmount.
IsRepricingNeeded
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Whether the cart has changed since the last repricing. The default value is false.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort,
Description
The timestamp for when the current user last viewed a record related to this record.
LastRepricingDate
Type
datetime
Properties
Create, Filter, Nillable, Sort, Update
Description
Date when the last repricing was done.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of this WebCart record. Name can be up to 255 characters.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the owner of this WebCart.
PaymentGroupId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the WebCart payment group.
PaymentMethodId
Type
reference
Properties
Create, Filter, Group, Nillable,Sort, Update
Description
The method of payment for this WebCart.
PoNumber
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The purchase order number. Enter up to 80 characters.
Status
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The status of this WebCart. Possible values are:
  • Active
  • Checkout
  • Closed
  • Processing
TotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of all cart items’ TotalPrice, or TotalProductAmount plus TotalChargeAmount.
TotalChargeAmount
Type
currency
Properties
Defaulted on create, Filter, Nillable, Sort
Description
The sum of all cart items’ TotalPrice for cart items of the type Charge.
TotalChargeTaxAmount
Type
currency
Properties
Defaulted on create, Filter, Nillable, Sort
Description
The sum of all the cart items’ TotalTaxAmount for cart items of the type Charge.
TotalListAmount
Type
currency
Properties
Defaulted on create, Filter, Nillable, Sort
Description
Sum of all the cart items’ TotalListPrice.
TotalProductAmount
Type
currency
Properties
Defaulted on create, Filter, Nillable, Sort
Description
The sum of all the cart items’ TotalPrice for cart items of the type Product.
TotalProductCount
Type
double
Properties
Defaulted on create, Filter, Nillable, Sort
Description
A count of all the products in the WebCart.
TotalProductTaxAmount
Type
currency
Properties
Defaulted on create, Filter, Nillable, Sort
Description
The sum of all the cart items’ TotalTaxAmount for the CartItem type Product.
TotalTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The sum of all cart items’ TotalTaxAmount, or TotalProductTaxAmount plus TotalDeliveryTaxAmount.
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The WebCart type. Default value is Cart. Possible values are:
  • Cart
UniqueProductCount
Type
int
Properties
Defaulted on create, Filter, Group, Nillable, Sort
Description
The count of unique product SKUs in the WebCart.
WebStoreId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The store ID related to this WebCart.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.
WebCartHistory
History is available for tracked fields of the object.
WebCartOwnerSharingRule
Sharing rules are available for the object.
WebCartShare
Sharing is available for the object.