OrderDeliveryGroup

A group of order items that share a delivery method and address. The delivery method and address are used during the fulfillment process, such as shipping as a gift, downloading, picking up in store, or shipping to a standard address

Introduced in API version 48.0.

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

  • To access Commerce Orders entities, your org must have a Salesforce Order Management license. Commerce Orders entities are available only in Lightning Experience.
  • Type: address
  • Properties: Filter, Nillable
  • Description: The delivery group’s order items are delivered to this address. Created based on the values of the other DeliverTo fields.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: City address value. Sent to DeliverToAddress.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 59.0
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Country address value. Sent to DeliverToAddress
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Sort, Update
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 59.0

  • Type: picklist

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

  • Possible values:

    • Dr. — Dr.
    • Mr. — Mr.
    • Mrs. — Mrs.
    • Ms. — Ms.
    • Prof. — Prof.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: Geocode accuracy address value. Sent to DeliverToAddress.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Latitude address value. Sent to DeliverToAddress.
  • Type: double
  • Properties: Create, Filter, Nillable, Sort, Update
  • Description: Longitude address value. Sent to DeliverToAddress.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Name of the delivery recipient. Sent to DeliverToAddress.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Postal Code address value. Sent to DeliverToAddress.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: State address value. Sent to DeliverToAddress.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Street address value. Sent to DeliverToAddress.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Introduced: API version 47.0
  • Description: Text field for users to add other delivery instructions.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: User-defined description for this delivery group.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 47.0
  • Description: The buyer’s target delivery date for the order items included in the delivery group.
  • Type: email
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: The buyer’s email address.
  • Type: textarea
  • Properties: Create, Nillable, Update
  • Description: An optional gift message that the buyer can define if they’re sending the order items as a gift to another recipient. Applies to all order items in the delivery group.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 47.0
  • Description: The sum of the group’s total delivery amount and total tax amount.
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Description: All items in the delivery group are gifts.
  • Default value: false
  • Type: string
  • Properties: Autonumber, Defaulted on create, Filter, idLookup, Sort
  • Description: Unique number used for referencing this order delivery group.
  • Type: reference
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: ID of the order delivery method related to this order delivery group.
  • Relationship name: OrderDeliveryMethod
  • Relationship type: relationship
  • Refers to: OrderDeliveryMethod
  • Type: reference
  • Properties: Create, Filter, Group, Sort
  • Description: ID of the parent order for this order delivery group. An order can have multiple order delivery groups.
  • Relationship name: Order
  • Relationship type: masterdetail
  • Refers to: Order
  • Type: phone
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Phone number of the buyer.
  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Merchant-defined date that the items in this group will be delivered to the customer. Usually defined based on an estimated date from the shipping provider.
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 47.0
  • Description: The original delivery group. Used for reference in change order scenarios.
  • Relationship name: RelatedDeliveryGroup
  • Relationship type: relationship
  • Refers to: OrderDeliveryGroup
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 47.0
  • Description: The sum of all adjustments (of type Delivery Charge) made to order items in the order delivery group.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 49.0

  • Description:

    The sum of all adjustments (of type Delivery Charge) made to order items in the order delivery group, including tax.

    This is a gross tax field.

    To access Commerce Orders fields, your org must have a Salesforce Order Management license. Commerce Orders fields are available only in Lightning Experience.

    This field is available in API v49.0 and later.

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 47.0
  • Description: The sum of all adjustments (of type Delivery Charge) made to tax lines for order items in the order delivery group.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The sum of all Total Amount fields (of type Delivery Charge) on order items within this delivery group. On an order item, the total amount equals the quantity multiplied by the unit price, including adjustments and tax.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 47.0
  • Description: The sum of order items (of the type Delivery Charge). On an order item, the total line amount equals the quantity multiplied by the unit price, before adjustments or tax.

  • Type: currency

  • Properties: Filter, Nillable, Sort

  • Introduced: API version 49.0

  • Description:

    The sum of all TotalLineAmtWithTax fields (of type Delivery Charge) on order items within this delivery group. On an order item, the total line amount with tax equals the quantity multiplied by the unit price, plus tax, before adjustments.

    This is a gross tax field.

    To access Commerce Orders fields, your org must have a Salesforce Order Management license. Commerce Orders fields are available only in Lightning Experience.

    This field is available in API v49.0 and later.

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 47.0
  • Description: The sum of all Total Line Tax Amount fields (of type Delivery Charge) on order items within this delivery group. On an order item, the total line tax amount equals the total tax for that line.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: The sum of all Total Tax Amount fields (of type Delivery Charge) on order items within this order delivery group.

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.