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 This object is available in API version 48.0 and later.

Supported Calls

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

Special Access Rules

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

Fields

Field	Details
DeliverToAddress	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.
DeliverToCity	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description City address value. Sent to DeliverToAddress.
DeliverToCountry	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Country address value. Sent to DeliverToAddress
DeliverToGeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Geocode accuracy address value. Sent to DeliverToAddress.
DeliverToLatitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Latitude address value. Sent to DeliverToAddress.
DeliverToLongitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Longitude address value. Sent to DeliverToAddress.
DeliverToName	Type string Properties Create, Filter, Group, Sort, Update Description Name of the delivery recipient. Sent to DeliverToAddress.
DeliverToPostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Postal Code address value. Sent to DeliverToAddress.
DeliverToState	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description State address value. Sent to DeliverToAddress.
DeliverToStreet	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Street address value. Sent to DeliverToAddress.
DeliveryInstructions	Type textarea Properties Create, Nillable, Update Description Text field for users to add other delivery instructions.
Description	Type textarea Properties Create, Nillable, Update Description User-defined description for this delivery group.
DesiredDeliveryDate	Type date Properties Create, Filter, Group, Nillable, Sort, Update Description The buyer’s target delivery date for the order items included in the delivery group.
EmailAddress	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description The buyer’s email address.
GiftMessage	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.
GrandTotalAmount	Type currency Properties Filter, Nillable, Sort Description The sum of the group’s total delivery amount and total tax amount.
IsGift	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description All items in the delivery group are gifts.
OrderDeliveryGroupNumber	Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description Unique number used for referencing this order delivery group.
OrderDeliveryMethodId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description ID of the order delivery method related to this order delivery group.
OrderId	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.
PhoneNumber	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the buyer.
PromisedDeliveryDate	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.
RelatedDeliveryGroupId	Type reference Properties Filter, Group, Nillable, Sort Description The original delivery group. Used for reference in change order scenarios.
TotalAdjustmentAmount	Type currency Properties Filter, Nillable, Sort Description The sum of all adjustments made to order items in the order delivery group.
TotalAdjustmentAmtWithTax	Type currency Properties Filter, Nillable, Sort Description The sum of all adjustments 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.
TotalAdjustmentTaxAmount	Type currency Properties Filter, Nillable, Sort Description The sum of all adjustments made to tax lines for order items in the order delivery group.
TotalAmount	Type currency Properties Filter, Nillable, Sort Description The sum of all Total Amount fields 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.
TotalLineAmount	Type currency Properties Filter, Nillable, Sort Description The sum of order items of the delivery type. On an order item, the total line amount equals the quantity multiplied by the unit price, before adjustments or tax.
TotalLineAmtWithTax	Type currency Properties Filter, Nillable, Sort Description The sum of all TotalLineAmtWithTax fields 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.
TotalLineTaxAmount	Type currency Properties Filter, Nillable, Sort Description The sum of all Total Line Tax Amount fields on order items within this delivery group. On an order item, the total line tax amount equals the total tax for that line.
TotalTaxAmount	Type currency Properties Filter, Nillable, Sort Description The sum of all Total Tax Amount fields on order items within this order delivery group.

Object Reference for the Salesforce Platform

OrderDeliveryGroup

Supported Calls

Special Access Rules

Fields