OrderSummary

Represents the current properties and state of an order. Corresponds to one or more order 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(), search(), undelete(), update(), upsert()

Special Access Rules

This object is only available in Salesforce Order Management orgs.

Fields

Field	Details
AccountId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the account or person account associated with the OrderSummary. It represents the shopper in the storefront.
BillingAddress	Type address Properties Filter, Nillable Description Billing address associated with the OrderSummary.
BillingCity	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address city.
BillingCountry	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address country.
BillingEmailAddress	Type email Properties Create, Filter, Group, Nillable, Sort, Update Description Email address on the billing address.
BillingGeocodeAccuracy	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The accuracy of the geocode for the billing address. Possible values are: `Address` `Block` `City` `County` `ExtendedZip` `NearAddress` `Neighborhood` `State` `Street` `Unknown` `Zip`
BillingLatitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLongitude to specify the precise geolocation of the billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
BillingLongitude	Type double Properties Create, Filter, Nillable, Sort, Update Description Used with BillingLatitude to specify the precise geolocation of the billing address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
BillingPhoneNumber	Type phone Properties Create, Filter, Group, Nillable, Sort, Update Description Phone number of the billing address.
BillingPostalCode	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address postal code.
BillingState	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address state.
BillingStreet	Type textarea Properties Create, Filter, Group, Nillable, Sort, Update Description Billing address street.
ChangeOrderId	Type reference Properties Filter, Group, Nillable, Sort Description Reserved for future use.
Description	Type textarea Properties Create, Nillable, Update Description Description of the OrderSummary.
GrandTotalAmount	Type currency Properties Filter, Nillable, Sort Description Total amount, including adjustments and tax, of the OrderSummary.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed a record related to this record.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description The timestamp for when the current user last viewed this record. A null value can mean that this record has only been referenced (LastReferencedDate) and not viewed.
OrderNumber	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderSummary.
OrderedDate	Type dateTime Properties Filter, Nillable, Sort Description Date of the original order associated with this OrderSummary.
OriginalOrderId	Type reference Properties Filter, Group, Sort Description ID of the original order associated with this OrderSummary.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description The ID of the user who currently owns this OrderSummary. Default value is the user logged in to the API to perform the create.
PoNumber	Type string Properties Filter, Group, Nillable, Sort Description Purchase order number associated with this OrderSummary.
SalesChannelId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the SalesChannel associated with this OrderSummary.
Status	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Status of the order summary. Unlike the Status and Status Category fields on the order and FulfillmentOrder objects, this field is optional. We recommend that you use the same values in this picklist that you use in the Status picklist for the order object.
TotalAdjDistAmount	Type currency Properties Filter, Nillable, Sort Description Total of distributed adjustments applied to OrderItemSummaries belonging to this OrderSummary. Equal to TotalProductAdjDistAmount plus TotalDeliveryAdjDistAmount.
TotalAdjDistTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjDistAmount.
TotalAdjustedDeliveryAmount	Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of all OrderItemSummaries of type code Charge belonging to this OrderSummary.
TotalAdjustedDeliveryTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustedDeliveryAmount.
TotalAdjustedProductAmount	Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of all OrderItemSummaries of type code Product belonging to this OrderSummary.
TotalAdjustedProductTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustedProductAmount.
TotalAmount	Type currency Properties Filter, Nillable, Sort Description Total, including adjustments but not tax, of all OrderItemSummaries belonging to this OrderSummary. Equal to TotalAdjustedProductAmount plus TotalAdjustedDeliveryAmount.
TotalDeliveryAdjDistAmount	Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type code Charge belonging to this OrderSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header.
TotalDeliveryAdjDistTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalDeliveryAdjDistAmount.
TotalProductAdjDistAmount	Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type code Product belonging to this OrderSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header.
TotalProductAdjDistTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalProductAdjDistAmount.
TotalTaxAmount	Type currency Properties Filter, Nillable, Sort Description Total tax on all OrderItemSummaries belonging to this OrderSummary. Equal to TotalAdjustedDeliveryTaxAmount plus TotalAdjustedProductTaxAmount.

Object Reference for Salesforce and Lightning Platform

OrderSummary

Supported Calls

Special Access Rules

Fields

See Also