Newer Version Available

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

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

This object is available only if the B2B Commerce license is enabled.

Fields

Field Details
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.
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, 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.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the delivery method.
ShippingFee
Type
currency
Properties
Create, Filter, Sort, Update
Description
Shipping fee associated with the delivery method. Required field.
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.