--- schema_version: "1" id: 83eb58d1034ae89311a33c7f95482334fad761e7afb59527db9355f1ca72be81 title: OrderDeliveryGroupSummary collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/object_reference/sforce_api_objects_orderdeliverygroupsummary.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderdeliverygroupsummary.htm source_site: developer.salesforce.com content_type: documentation content_hash: b50fc4d7e1bbdb858d43cc5b334b1423de31f9892f57e33578567640437546ba description: Represents the current properties and state of a group of OrderItemSummaries, belonging to one OrderSummary, to be fulfilled using the same delivery method and delivered to the same address. A single shipment can include them all, but that isn’t guaranteed. Corresponds to one or more order delivery group objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. --- # OrderDeliveryGroupSummary Represents the current properties and state of a group of OrderItemSummaries, belonging to one OrderSummary, to be fulfilled using the same delivery method and delivered to the same address. A single shipment can include them all, but that isn’t guaranteed. Corresponds to one or more order delivery group objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later. ## Supported Calls create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert() ## Special Access Rules This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled. ## Fields | Field | Details | | --- | --- | | CurrencyIsoCode | Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description ISO code for the currency of the OrderSummary associated with the OrderDeliveryGroupSummary. The default value is USD. Possible values are: - DKK—Danish Krone - EUR—Euro - GBP—British Pound - USD—U.S. Dollar This field is available in API version 49.0 and later. | | DeliverToAddress | Type address Properties Filter, Nillable Description Address of the recipient. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | DeliverToCity | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address city. | | DeliverToCompanyName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | DeliverToCountry | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address country. | | DeliverToFullFirstName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | DeliverToFullLastName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description | | DeliverToFullName | Type string Properties Filter, Group, Nillable, Sort Description | | DeliverToFullSalutation | Type picklist Properties Create, Filter, Group, Nillable, Sort, Update Description Possible values are: - Dr. - Mr. - Mrs. - Ms. - Prof. | | DeliverTo​GeocodeAccuracy | Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Accuracy of the geocode for the recipient address. Possible values are: - Address - Block - City - County - ExtendedZip - NearAddress - Neighborhood - State - Street - Unknown - Zip | | DeliverToLatitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with FulfilledToLongitude to specify the precise geolocation of the recipient address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | DeliverToLongitude | Type double Properties Create, Filter, Nillable, Sort, Update Description Used with FulfilledToLatitude to specify the precise geolocation of the recipient address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places. | | DeliverToName | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Name on the recipient address. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | DeliverToPostalCode | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address postal code. | | DeliverToState | Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address state. | | DeliverToStreet | Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Recipient address street. | | DeliveryInstructions | Type textarea Properties Create, Nillable, Update Description Special instructions for the delivery. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | Description | Type textarea Properties Create, Nillable, Update Description Description of the OrderDeliveryGroupSummary. This field can be edited. | | DesiredDeliveryDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Desired date for delivery. This field is informational, available for customizations. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | EmailAddress | Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address of the recipient. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | GiftMessage | Type textarea Properties Create, Nillable, Update Description Gift message to include. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | GrandTotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments and tax, of the delivery charges associated with the OrderDeliveryGroupSummary. This value only includes OrderItemSummaries of type code Charge. | | IsGift | Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the OrderDeliveryGroupSummary represents a gift. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | OrderDeliveryGroup​SummaryNumber | Type string Properties Autonumber, Defaulted on create, Filter, idLookup, Sort Description ID of the OrderDeliveryGroupSummary. | | OrderDeliveryMethodId | Type reference Properties Filter, Group, Sort Description ID of the order delivery method specified for the OrderDeliveryGroupSummary. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | OrderSummaryId | Type reference Properties Filter, Group, Sort Description ID of the OrderSummary associated with the OrderDeliveryGroupSummary. | | OriginalOrderDelivery​GroupId | Type reference Properties Filter, Group, Nillable, Sort Description ID of the original order delivery group associated with this summary object. Nillable=true only if the associated order summary is unmanaged. For managed order summaries, nillable=false. | | PhoneNumber | Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the recipient. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | PromisedDeliveryDate | Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Promised date for delivery. This field is informational, available for customizations. Users with the Edit Delivery Information user permission can modify this field. If the OrderLifeCycleType field on the associated OrderSummary is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. | | TotalAdjustmentAmount | Type currency Properties Filter, Nillable, Sort Description Total price adjustments applied to delivery charges associated with the OrderDeliveryGroupSummary. This value only includes adjustments to OrderItemSummaries of type code Charge. | | TotalAdjustment​AmtWithTax | Type currency Properties Filter, Nillable, Sort Description Total amount of the price adjustments applied to the delivery charges associated with the OrderDeliveryGroupSummary, inclusive of tax. This amount is equal to TotalAdjustmentAmount + TotalAdjustmentTaxAmount. This field is available in API version 49.0 and later. | | TotalAdjustment​TaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustmentAmount. | | TotalAmount | Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of the delivery charges associated with the OrderDeliveryGroupSummary. This value only includes adjustments to OrderItemSummaries of type code Charge. | | TotalLineAmount | Type currency Properties Filter, Nillable, Sort Description Total, not including adjustments or tax, of the delivery charges associated with the OrderDeliveryGroupSummary. | | TotalLineAmt​WithTax | Type currency Properties Filter, Nillable, Sort Description Total of the delivery charges associated with the OrderDeliveryGroupSummary, inclusive of tax. This amount is equal to TotalLineAmount + TotalLineTaxAmount. This field is available in API version 49.0 and later. | | TotalLineTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalLineAmount. | | TotalTaxAmount | Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAmount. | ## Associated Objects 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 and later. [OrderDeliveryGroupSummaryChangeEvent](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") (API version 62.0) Change events are available for the object. #### See Also - [OrderDeliveryGroup](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderdeliverygroup.htm "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.") - [OrderItemSummary](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm "Represents the current properties and state of a product or charge on an OrderSummary. Corresponds to one or more order item objects, consisting of an original object and any change objects applicable to it. This object is available in API version 48.0 and later.")