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 or if the B2B Commerce license is enabled.

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. 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. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account
ActiveProcessExceptionCount	Type int Properties Filter, Group, Nillable, Sort Description Total number of active process exceptions on the OrderSummary. This field is available in API version 50.0 and later.
BillingAddress	Type address Properties Filter, Nillable Description Billing address associated with the OrderSummary. 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.
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.
BillToContactId	Type reference Properties Create, Filter, Group, Nillable, Sort Description ID of the Contact associated with the OrderSummary. It represents the shopper in the storefront when not using person accounts. If the OrderLifeCycleType field is set to UNMANAGED, then users with the Edit Unmanaged Order Summaries or B2B Commerce Integrator user permission can modify this field. This field is available in API version 49.0 and later.
BusinessModel	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description The business model of the OrderSummary. Possible values are: `B2B` `B2C` This field is available in API version 53.0 and later.
ChangeOrderId	Type reference Properties Filter, Group, Nillable, Sort Description Reserved for future use.
CurrencyIsoCode	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the original Order associated with the OrderSummary. Possible values are: `DKK`—Danish Krone `EUR`—Euro `GBP`—British Pound `USD`—U.S. Dollar The default value is `USD`. This field is available in API version 49.0 and later.
Description	Type textarea Properties Create, Nillable, Update Description Description of the OrderSummary. This field can be edited.
ExternalReferenceIdentifier	Type string Properties Filter, Group, idLookup, Nillable, Sort, Update Description Used internally to prevent duplicate records. This value is case-sensitive. In API version 56.0 and later, for orders ingested from B2C Commerce, this value is set to `B2C realm ID` + "_" + `B2C instance ID` + "@" + `B2C Commerce catalog/domain ID` + "@" + `B2C Commerce order number`. In API version 55.0, the standard B2C Commerce integration set this value to "SFDC" + "@" + `nanotime` + "@" + `UUID` and High Scale Orders set it to the value used in later versions. This field is available in API version 54.0 and later.
GrandTotalAmount	Type currency Properties Filter, Nillable, Sort Description Total amount, including adjustments and tax, of the OrderSummary.
IsSuspended	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Indicates whether the OrderSummary is suspended. The default value is false. This field is available in API version 50.0 and later.
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.
OrderedDate	Type dateTime Properties Filter, Nillable, Sort Description Date of the original order associated with this OrderSummary. 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.
OrderLifeCycleType	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Specifies whether the OrderSummary is managed by Salesforce Order Management (MANAGED) or by an external system (UNMANAGED). An unmanaged OrderSummary is stored in Salesforce for reference purposes. Some Order Management APIs reject input records that are associated with unmanaged OrderSummaries. Order Management does not update financial bucket fields on some records that are associated with unmanaged OrderSummaries. A user with the EditUnmanagedOrderSummaries or B2BCommerceIntegrator permission can edit certain fields on objects related to unmanaged OrderSummaries that are normally only accessible via APIs. Possible values are: `MANAGED`—Managed `UNMANAGED`—Unmanaged This field is available in API version 49.0 and later.
OrderNumber	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the OrderSummary.
OrderProductLineCount	Type int Properties Filter, Group, Nillable, Sort Description Total number of unique products ordered on this Order Summary. This field is available in API version 52.0 and later.
OriginalOrderId	Type reference Properties Filter, Group, Sort Description ID of the original order associated with this OrderSummary. This field is a relationship field. Relationship Name OriginalOrder Relationship Type Lookup Refers To Order
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. This field is a polymorphic relationship field. Relationship Name Owner Relationship Type Lookup Refers To Group, User
PoDate	Type dateTime Properties Create, Filter, Nillable, Sort, Update Description Purchase order date associated with this OrderSummary. 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. This field is available in API version 52.0 and later.
PoNumber	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Purchase order number associated with this OrderSummary. 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.
Pricebook2Id	Type reference Properties Filter, Group, Nillable, Sort Description ID of the pricebook associated with this OrderSummary. This field is available in API version 54.0 and later. This field is a relationship field. Relationship Name Pricebook2 Relationship Type Lookup Refers To Pricebook2
RoutingAttempts	Type int Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description The number of attempts that have been made to route the order summary to inventory locations. This field is available in API version 51.0 and later.
SalesChannelId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the SalesChannel associated with this OrderSummary. 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. This field is a relationship field. Relationship Name SalesChannel Relationship Type Lookup Refers To SalesChannel
SalesStoreId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the RetailStore or WebStore associated with this OrderSummary. 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. This field is a relationship field. Relationship Name SalesStore Relationship Type Lookup Refers To WebStore
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.
TaxLocaleType	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The system used to handle tax on the original Order associated with the OrderSummary. Gross usually applies to taxes like value-added tax (VAT), and Net usually applies to taxes like sales tax. Possible values are: `Gross` (displays most prices and taxes as combined values) `Net` (displays most prices and taxes as separate values) 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. This field is available in API version 49.0 and later.
TotalAdjDeliveryAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total amount of all OrderItemSummaries of type Delivery Charge belonging to this OrderSummary, inclusive of item-level adjustments and tax. This amount is equal to TotalAdjustedDeliveryAmount + TotalAdjustedDeliveryTaxAmount. This field is available in API version 49.0 and later.
TotalAdjDistAmount	Type currency Properties Filter, Nillable, Sort Description Total of distributed adjustments applied to OrderItemSummaries belonging to this OrderSummary. This amount is equal to TotalProductAdjDistAmount plus TotalDeliveryAdjDistAmount.
TotalAdjDistAmountWithTax	Type currency Properties Filter, Nillable, Sort Description Total of distributed adjustments applied to OrderItemSummaries belonging to this OrderSummary, inclusive of tax. This amount is equal to TotalAdjDistAmount plus TotalAdjDistTaxAmount. This field is available in API version 49.0 and later.
TotalAdjDistTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjDistAmount.
TotalAdjFeeAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total amount of all OrderItemSummaries of type Fee belonging to this OrderSummary, inclusive of item-level adjustments and tax. This amount is equal to TotalAdjustedFeeAmount plus TotalAdjustedFeeTaxAmount. This field is available in API version 56.0 and later.
TotalAdjProductAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total amount of all OrderItemSummaries of type code Product belonging to this OrderSummary, inclusive of item-level adjustments and tax. This amount is equal to TotalAdjustedProductAmount plus TotalAdjustedProductTaxAmount. This field is available in API version 49.0 and later.
TotalAdjustedDeliveryAmount	Type currency Properties Filter, Nillable, Sort Description Total, including item-level adjustments but not order-level adjustments or tax, of all OrderItemSummaries of type Delivery Charge belonging to this OrderSummary.
TotalAdjustedDeliveryTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustedDeliveryAmount.
TotalAdjustedFeeAmount	Type currency Properties Filter, Nillable, Sort Description Total, including item-level adjustments but not order-level adjustments or tax, of all OrderItemSummaries of type Fee belonging to this OrderSummary. This field is available in API version 56.0 and later.
TotalAdjustedFeeTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalAdjustedFeeAmount. This field is available in API version 56.0 and later.
TotalAdjustedProductAmount	Type currency Properties Filter, Nillable, Sort Description Total, including item-level adjustments but not order-level adjustments or 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 TotalAdjustedFeeAmount plus TotalAdjustedDeliveryAmount.
TotalDeliveryAdjDistAmount	Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type Delivery Charge belonging to this OrderSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header.
TotalDeliveryAdjDistAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type Delivery Charge belonging to this OrderSummary, inclusive of tax. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. It is equal to TotalDeliveryAdjDistAmount + TotalDeliveryAdjDistTaxAmount. This field is available in API version 49.0 and later.
TotalDeliveryAdjDistTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalDeliveryAdjDistAmount.
TotalDeliveryAmount	Type currency Properties Filter, Nillable, Sort Description Sum of the Total Line Amounts of all OrderItemSummaries of type Delivery Charge belonging to this OrderSummary, not including adjustments or tax. This field is available in API version 54.0 and later.
TotalDeliveryAmountWithTax	Type currency Properties Filter, Nillable, Sort Description Total of all OrderItemSummaries of type Delivery Charge belonging to this OrderSummary, including tax but not including adjustments. It is equal to TotalDeliveryAmount + TotalDeliveryTaxAmount. This field is available in API version 54.0 and later.
TotalDeliveryTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalDeliveryAmount. This field is available in API version 54.0 and later.
TotalFeeAdjDistAmount	Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type Fee belonging to this OrderSummary. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. This field is available in API version 56.0 and later.
TotalFeeAdjDistAmtWithTax	Type currency Properties Filter, Nillable, Sort Description Total of all order-level price adjustments applied to OrderItemSummaries of type Fee belonging to this OrderSummary, inclusive of tax. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. It is equal to TotalFeeAdjDistAmount + TotalFeeAdjDistTaxAmount. This field is available in API version 56.0 and later.
TotalFeeAdjDistTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalFeeAdjDistAmount. This field is available in API version 56.0 and later.
TotalFeeAmount	Type currency Properties Filter, Nillable, Sort Description Sum of the Total Line Amounts of all OrderItemSummaries of type Fee belonging to this OrderSummary, not including adjustments or tax. This field is available in API version 56.0 and later.
TotalFeeAmountWithTax	Type currency Properties Filter, Nillable, Sort Description Total of all OrderItemSummaries of type Fee belonging to this OrderSummary, including tax but not including adjustments. It is equal to TotalFeeAmount + TotalFeeTaxAmount. This field is available in API version 56.0 and later.
TotalFeeTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalFeeAmount. This field is available in API version 56.0 and later.
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.
TotalProductAdjDistAmtWithTax	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, inclusive of tax. This value includes OrderItemAdjustmentLineSummaries that belong to OrderAdjustmentGroupSummaries of type Header. It is equal to TotalProductAdjDistAmount + TotalProductAdjDistTaxAmount. This field is available in API version 49.0 and later.
TotalProductAdjDistTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalProductAdjDistAmount.
TotalProductAmount	Type currency Properties Filter, Nillable, Sort Description Sum of the Total Line Amounts of all OrderItemSummaries of type code Product belonging to this OrderSummary, not including adjustments or tax. This field is available in API version 54.0 and later.
TotalProductAmountWithTax	Type currency Properties Filter, Nillable, Sort Description Total of all OrderItemSummaries of type code Product belonging to this OrderSummary, including tax but not including adjustments. It is equal to TotalProductAmount + TotalProductTaxAmount. This field is available in API version 54.0 and later.
TotalProductTaxAmount	Type currency Properties Filter, Nillable, Sort Description Tax on the TotalProductAmount. This field is available in API version 54.0 and later.
TotalTaxAmount	Type currency Properties Filter, Nillable, Sort Description Total tax on all OrderItemSummaries belonging to this OrderSummary. Equal to TotalAdjustedDeliveryTaxAmount plus TotalAdjustedFeeTaxAmount plus TotalAdjustedProductTaxAmount.

Associated Objects

This object has the following associated objects. Unless noted, they are available in the same API version as this object.

OrderSummaryFeed: Feed tracking is available for the object.
OrderSummaryOwnerSharingRule: Sharing rules are available for the object.
OrderSummaryShare: Sharing is available for the object.

Object Reference for the Salesforce Platform

OrderSummary

Supported Calls

Special Access Rules

Fields

Associated Objects

See Also