CartDeliveryGroupMethod
Represents the selected delivery method for a cart delivery group used in Lightning B2B Commerce checkout.
Introduced in API version 49.0.
create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()
- The CartDeliveryGroupMethod object is available only if the B2B Commerce or D2C Commerce license is enabled.
- Type: currency
- Properties: Filter, Nillable, Sort
- Introduced: API version 60.0
- Description: Shipping fee, including
TotalAdjustmentAmount, for the delivery method.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 59.0
- Description: The carrier that the buyer chose for their delivery method. Values are defined based on the user’s shipping service.
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The unique ID used to identify your cart checkout session.
- Relationship name: CartCheckoutSession
- Relationship type: relationship
- Refers to: CartCheckoutSession
- Type: reference
- Properties: Create, Filter, Group, Sort, Update
- Description: The ID of the cart delivery group associated with the checkout session.
- Relationship name: CartDeliveryGroup
- Relationship type: relationship
- Refers to: CartDeliveryGroup
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 59.0
- Description: The carrier class of service that the buyer chose for their delivery method. Values are defined based on the user’s shipping service.
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The ID of the selected order delivery method.
- Relationship name: DeliveryMethod
- Relationship type: relationship
- Refers to: OrderDeliveryMethod
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Description: The ID of the external shipping method provider. Optional field.
- Type: boolean
- Properties: Create, Defaulted on create, Filter, Group, Sort, Update
- Introduced: API version 59.0
- Description: Assign new delivery groups to active delivery methods. The default value is
False. - Default value: false
- Type: string
- Properties: Create, Filter, Group, idLookup, Sort, Update
- Description: Name of the delivery method.
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 61.0
- 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.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 61.0
- Description: Unit of time used to define
ProcessTime. - Possible values:
- Days — Days
- Hours — Hours
- Weeks — Weeks
- Type: reference
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 59.0
- 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, the
ProductIdis selected from a non-variation product withShippingin its name. The termShippingin a product name isn’t localized. If no matching product is found, a random non-variation product is used. - Relationship name: Product
- Relationship type: relationship
- Refers to: Product2
- Type: string
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 59.0
- Description: Reference number for an external delivery method.
- Type: currency
- Properties: Create, Filter, Sort, Update
- Description: Shipping fee associated with the delivery method. Required field.
- Type: currency
- Properties: Filter, Nillable, Sort
- Introduced: API version 60.0
- Description: The adjustment amount of a promotion applicable to the delivery method.
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 61.0
- 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.
- Type: int
- Properties: Create, Filter, Group, Nillable, Sort, Update
- Introduced: API version 61.0
- 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.
- Type: picklist
- Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
- Introduced: API version 61.0
- Description: Unit of time used to define
TransitTimeMaxandTransitTimeMin. - Possible values:
- Days — Days
- Hours — Hours
- Weeks — Weeks
- Type: reference
- Properties: Create, Filter, Group, Sort
- Description: The ID of the WebCart associated with the cart delivery group method. Required field.
- Relationship name: WebCart
- Relationship type: masterdetail
- Refers to: WebCart
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.