Newer Version Available

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

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 is not 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.

Fields

Field Details
DeliverToAddress
Type
address
Properties
Filter, Nillable
Description
Address of the recipient.
DeliverToCity
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Recipient address city.
DeliverToCountry
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Recipient address country.
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, Sort, Update
Description
Name on the recipient address.
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.
Description
Type
textarea
Properties
Create, Nillable, Update
Description
Description of the OrderDeliveryGroupSummary.
DesiredDeliveryDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Desired date for delivery. This field is informational, available for customizations.
EmailAddress
Type
email
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Email address of the recipient.
GiftMessage
Type
textarea
Properties
Create, Nillable, Update
Description
Gift message to include.
GrandTotalAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Total, including adjustments and tax, of the delivery charges on the OrderDeliveryGroupSummary. This value only includes OrderItemSummaries of type code Charge.
IsGift
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort
Description
Indicates whether the OrderDeliveryGroupSummary represents a gift.
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.
OrderSummaryId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the OrderSummary associated with the OrderDeliveryGroupSummary.
OriginalOrderDelivery​GroupId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the original order delivery group associated with this summary object.
PhoneNumber
Type
phone
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Phone number of the recipient.
PromisedDeliveryDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
Promised date for delivery. This field is informational, available for customizations.
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​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. This value only includes adjustments to OrderItemSummaries of type code Charge.
TotalLineTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Tax on the TotalLineAmount.
TotalTaxAmount
Type
currency
Properties
Filter, Nillable, Sort
Description
Tax on the TotalAmount.