---
schema_version: "1"
id: c0565041d33b369edceef49308c80b113050f8a482835296f2ca89ff4f690b4c
title: CartDeliveryGroupMethod
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_cartdeliverygroupmethod.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_cartdeliverygroupmethod.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: e62557368ccef25ad104d7789a8ed609e9edf1481ad12e96a06e3c45f2acb34f
description: Represents the selected delivery method for a cart delivery group used in Lightning B2B Commerce checkout. This object is available in API version 49.0 and later.
---
# CartDeliveryGroupMethod

Represents the selected delivery method for a cart delivery group used in Lightning B2B Commerce checkout. 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 CartDeliveryGroupMethod object is available only if the B2B Commerce or D2C Commerce license is enabled.

## Fields

| Field | Details |
| --- | --- |
| AdjustedShippingFee | 
Type

currency

Properties

Filter, Nillable, Sort

Description

Shipping fee, including TotalAdjustmentAmount, for the delivery method.



 |
| Carrier | 

Type

picklist

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The carrier that the buyer chose for their delivery method. Values are defined based on the user’s shipping service. This field is available in API version 59.0 or later.



 |
| CartCheckoutSessionId | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The unique ID used to identify your cart checkout session.



 |
| CartDeliveryGroupId | 

Type

reference

Properties

Create, Filter, Group, Sort, Update

Description

The ID of the cart delivery group associated with the checkout session.



 |
| ClassOfService | 

Type

picklist

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The carrier class of service that the buyer chose for their delivery method. Values are defined based on the user’s shipping service. This field is available in API version 59.0 or later.



 |
| CurrencyIsoCode | 

Type

picklist

Properties

Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description

The currency used for your shipping fee. Default value is USD.

Possible values are:

- USD—U.S. Dollar





 |
| DeliveryMethodId | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The ID of the selected order delivery method.



 |
| ExternalProvider | 

Type

string

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

The ID of the external shipping method provider. Optional field.



 |
| IsActive | 

Type

boolean

Properties

Create, Defaulted on create, Filter, Group, Sort, Update

Description

Assign new delivery groups to active delivery methods. The default value is False. This field is available in API version 59.0 or later.



 |
| Name | 

Type

string

Properties

Create, Filter, Group, idLookup, Sort, Update

Description

Name of the delivery method.



 |
| ProcessTime | 

Type

int

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

Merchant-specified process time for the delivery method. Process time includes the time between when an order is placed and when the shipment is given to the shipping carrier.



 |
| ProcessTimeUnit | 

Type

picklist

Properties

Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description

Unit of time used to define ProcessTime.

Possible values are:

- Days
- Hours
- Weeks





 |
| ProductId | 

Type

reference

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

Optional. This product represents a delivery charge order product for a delivery using this delivery method. For example, you could create a product that represents an overnight express charge and assign it to an overnight express delivery method. If your store uses [Salesforce Native Shipping](https://help.salesforce.com/s/articleView?id=commerce.comm_set_up_native_shipping.htm&type=5&language=en_US), the ProductId is selected from a non-variation product with Shipping in its name. The term Shipping in a product name isn’t localized. If no matching product is found, a random non-variation product is used. This field is available in API version 59.0 or later.



 |
| ReferenceNumber | 

Type

string

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

Reference number for an external delivery method. This field is available in API version 59.0 or later.



 |
| ShippingFee | 

Type

currency

Properties

Create, Filter, Sort, Update

Description

Shipping fee associated with the delivery method. Required field.



 |
| TotalAdjustmentAmount | 

Type

currency

Properties

Filter, Nillable, Sort

Description

The adjustment amount of a promotion applicable to the delivery method.



 |
| TransitTimeMax | 

Type

int

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

Maximum estimate of transit time for the delivery method. Transit time includes the time between when a shipping carrier receives a shipment and when the shipment arrives at the delivery address.



 |
| TransitTimeMin | 

Type

int

Properties

Create, Filter, Group, Nillable, Sort, Update

Description

Minimum estimate of transit time for the delivery method. Transit time includes the time between when a shipping carrier receives a shipment and when the shipment arrives at the delivery address.



 |
| TransitTimeUnit | 

Type

picklist

Properties

Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

Description

Unit of time used to define TransitTimeMax and TransitTimeMin.

Possible values are:

- Days
- Hours
- Weeks





 |
| WebCartId | 

Type

reference

Properties

Create, Filter, Group, Sort

Description

The ID of the WebCart associated with the cart delivery group method. Required field.



 |

## Usage

Use the CartDeliveryGroupMethod object to give commerce buyers the ability to choose a delivery method for a cart delivery group. Shipping integrations populate the delivery options that are available for a cart delivery group.