CartDeliveryGroup

Represents shipping information for the delivery of items in an order against a store built with B2B Commerce or D2C Commerce.

Introduced in API version 46.0.

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

  • The CartDeliveryGroup object is available only if the B2B Commerce or D2C Commerce license is enabled.
  • Type: reference

  • Properties: Create, Filter, Group, Sort

  • Description:

    The ID the [WebCart](./object-webcart.md) that’s associated with this delivery group.

    • This field is a relationship field.
    • Relationship Name: Cart
    • Relationship Type: Lookup
    • Refers To: WebCart
  • Relationship name: Cart

  • Relationship type: masterdetail

  • Refers to: WebCart

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 59.0
  • Description: Company name associated with a delivery.
  • Type: address
  • Properties: Filter, Nillable
  • Description: The address to which a buyer order is delivered.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The city to which a buyer order is delivered.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The country to which a buyer order is delivered.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 57.0
  • Description: The first name of the person set to receive an order.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The geocode location to which a buyer order is delivered.
  • Possible values:
    • Address — Address
    • Block — Block
    • City — City
    • County — County
    • ExtendedZip — ExtendedZip
    • NearAddress — NearAddress
    • Neighborhood — Neighborhood
    • State — State
    • Street — Street
    • Unknown — Unknown
    • Zip — Zip
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 57.0
  • Description: The last name of the person to whom a buyer order is delivered.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The latitude of a buyer delivery location.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The longitude of a buyer delivery location.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The name of the person to deliver a buyer order to. This field is set based on the Name field of the ContactPointAddress associated with this delivery group. ContactPointAddress.Name is generated by the system using the first and last names entered by a buyer during checkout.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The postal code to which to deliver a buyer order.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The state to which to deliver a buyer order.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The street to which to deliver a buyer order.
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Version: This field is deprecated in API version 64.0 and will be removed in API version 66.0.

  • Description:

    The ID for the delivery method to use to deliver a buyer order. Populated if the selected CartDeliveryGroupMethod only has the ShippingFee populated, but it has reference to an existing DeliveryMethodId which contains the fields Carrier, ClassOfService, and ReferenceNumber. If not, the SelectedDeliveryMethod field is used.

    This field is a relationship field. Instead, use the DeliveryMethodId field on the CartDeliveryGroupMethod object.

  • Relationship name: DeliveryMethod

  • Relationship type: relationship

  • Refers to: OrderDeliveryMethod

  • Type: datetime
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: The date that a buyer requests to have an order delivered.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Introduced: API version 64.0
  • Description: Personalized gift message for the order.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 64.0
  • Description: The name of the recipient for a gift order.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Sum of all cart items’ TotalAmount, or CartDeliveryGroup TotalAmount plus CartDeliveryGroup TotalTaxAmount.
  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 59.0

  • Description:

    Indicates if the delivery group is the default.

    The default value is false.

    B2B and D2C stores create a default delivery group, along with a WebCart, when a customer adds an item to cart and doesn’t have an existing cart. The default cart delivery group is needed to complete the checkout flow, and can’t be replaced by a non-default cart delivery group. If you customize the standard checkout flow, make sure that you don’t delete the default cart delivery group.

  • Default value: false

  • Type: boolean

  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update

  • Introduced: API version 64.0

  • Description:

    Indicates if the delivery group is a gift.

    The default value is false.

  • Default value: false

  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: The name of this CartDeliveryGroup record. Name can be up to 255 characters. In API version 62.0 and later, if IsDefault is true, the Name is Shipment1, a localized string. In prior API versions, the Name for a default delivery group was Cart Delivery Group. Due to this change, any queries intended to identify default delivery groups should use the IsDefault rather than Name field.
  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 59.0

  • Description:

    ID of the selected cart delivery group method. Populated if the selected CartDeliveryGroupMethod has the fields Carrier, ClassOfService, ReferenceNumber, and ShippingFee, but the DeliveryMethodId is null. If not, the DeliveryMethodId field is used.

    This field is a relationship field.

  • Relationship name: SelectedDeliveryMethod

  • Relationship type: relationship

  • Refers to: CartDeliveryGroupMethod

  • Type: phone
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 59.0
  • Description: Phone number associated with a delivery.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: Instructions for delivering an order.
  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 54.0

  • Description:

    The total amount of all promotional adjustments on the cart delivery group.

    For product bundles, this includes the aggregate adjustments of all child components.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 54.0

  • Description:

    The total tax amount for all promotional adjustments on the cart delivery group.

    For product bundles, this includes the aggregate of the tax amounts for all child components’ adjustments.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    The sum of all cart items TotalPrice, or TotalProductAmount plus TotalChargeAmount.

    For product bundles, this includes the aggregate of all child component prices.

  • Type: int

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 63.0

  • Description:

    The number of cart items, including their quantities, of the type PRODUCT in the delivery group.

    For product bundles, this count includes only the parent component.

    If the total quantity of cart items of type PRODUCT in the delivery group exceeds the system-defined maximum (INT_MAX), this field is set to INT_MAX.

  • Type: double
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 67.0
  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    The sum of all the cart items TotalPrice for all cart items of type CHARGE. Cart items can be of type Product or Charge.

    For product bundles, if a child component includes a cart item of type CHARGE, its amount is aggregated with the parent’s cart item’s total charge amount.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    The sum of all the cart items TotalTaxAmount for all cart items of type CHARGE. Cart items can be of type Product or Charge.

    For product bundles, this includes the aggregate of all tax amounts associated with bundle-level charges, including the taxes of individual child products.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    The sum of all the cart items TotalPrice for all cart items of type PRODUCT. Cart items can be of type Product or Charge.

    For product bundles, this includes the aggregate of all child component prices.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    The sum of all the cart items TotalTaxAmount for all cart items of type PRODUCT. Cart items can be of type Product or Charge.

    For product bundles, this includes the aggregate of all child component taxes based on their individual prices.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Description:

    The sum of all cart items TotalTaxAmount, or the combined value of TotalProductTaxAmount plus TotalChargeTaxAmount.

    For product bundles, this includes the aggregate of all child component taxes based on their individual prices.

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.