Newer Version Available

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

CartDeliveryGroup

Represents shipping information for the delivery of items in an order against a store built with B2B or B2B2C Commerce. 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 CartDeliveryGroup object is available only if the B2B Commerce or B2B2C Commerce license is enabled.

Fields

Field Details
CartId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID the WebCart that’s associated with this delivery group.
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:
  • USD—U.S. Dollar
DeliverToAddress
Type
address
Properties
Filter, Nillable
Description
The address to which a buyer order is delivered.
DeliverToCity
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The city to which a buyer order is delivered.
DeliverToCountry
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The country to which a buyer order is delivered.
DeliverToFirstName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The first name of the person set to receive an order. This field is available in API version 57.0 and later.
DeliverToGeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The geocode location to which a buyer order is delivered. Possible values are:
  • Address
  • Block
  • City
  • County
  • ExtendedZip
  • NearAddress
  • Neighborhood
  • State
  • Street
  • Unknown
  • Zip
DeliverToLastName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The last name of the person to whom a buyer order is delivered. This field is available in API version 57.0 and later.
DeliverToLatitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The latitude of a buyer delivery location.
DeliverToLongitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
The longitude of a buyer delivery location.
DeliverToName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The name of the person to which to deliver a buyer order.
DeliverToPostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The postal code to which to deliver a buyer order.
DeliverToState
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The state to which to deliver a buyer order.
DeliverToStreet
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The street to which to deliver a buyer order.
DeliveryMethodId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID for the delivery method to use to deliver a buyer order.
This field is a relationship field.
Relationship Name
DeliveryMethod
Relationship Type
Lookup
Refers To
OrderDeliveryMethod
DesiredDeliveryDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date that a buyer requests to have an order delivered.
GrandTotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Sum of all cart items’ TotalAmount, or CartDeliveryGroup TotalAmount plus CartDeliveryGroup TotalTaxAmount.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
The name of this CartDeliveryGroup record. Name can be up to 255 characters.
ShippingInstructions
Type
textarea
Properties
Create, Nillable, Update
Description
Instructions for delivering an order.
TotalAdjustmentAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total amount of all promotional adjustments on the cart delivery group. This field is available in API version 54.0 and later.
TotalAdjustmentTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
The total tax amount for all promotional adjustments on the cart delivery group. This field is available in API version 54.0 and later.
TotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Sum of all cart items TotalPrice, or TotalProductAmount plus TotalChargeAmount.
TotalChargeAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Cart items can be of type Product or Charge. This field contains the sum of all the cart items TotalPrice for all cart items of the CHARGE type.
TotalChargeTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Cart items can be of type Product or Charge. This field contains the Sum of all the cart items TotalTaxAmount for all cart items of the CHARGE type.
TotalProductAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Cart items can be of type Product or Charge. This field contains the sum of all the cart items TotalPrice for all cart items of the PRODUCT type.
TotalProductTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Cart items can be of type Product or Charge. Sum of all the cart items TotalTaxAmount for all cart items of the PRODUCT type.
TotalTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Sum of all cart items TotalTaxAmount, or TotalProductTaxAmount plus TotalChargeTaxAmount.