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.

For performance and data integrity reasons, CRUD operations on OrderSummary records don’t fire Apex triggers.

Introduced in API version 48.0.

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

  • This object is only available in Salesforce Order Management orgs or if the B2B Commerce license is enabled.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • 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: relationship

  • Refers to: Account

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 50.0
  • Description: Total number of active process exceptions on the OrderSummary.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 49.0

  • 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.

  • Relationship name: BillToContact

  • Relationship type: relationship

  • Refers to: Contact

  • 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.

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Billing address city.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Billing address country.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The ISO country code for the billing address. The default value is US.
  • Type: email
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Email address on the billing address.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The accuracy of the geocode for the billing address.
  • Possible values:
    • Address — Address
    • Block — Block
    • City — City
    • County — County
    • ExtendedZip — ExtendedZip
    • NearAddress — NearAddress
    • Neighborhood — Neighborhood
    • State — State
    • Street — Street
    • Unknown — Unknown
    • Zip — Zip
  • 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.
  • 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.
  • Type: phone
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Phone number of the billing address.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Billing address postal code.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Billing address state.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Description: The ISO state or province code for the billing address.
  • Type: textarea
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Billing address street.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 53.0
  • Description: The business model of the OrderSummary.
  • Possible values:
    • B2B — B2B
    • B2C — B2C
  • Type: reference
  • Properties: Filter, Group, Nillable, Sort
  • Description: Reserved for future use.
  • Relationship name: ChangeOrder
  • Relationship type: relationship
  • Refers to: Order

  • Type: textarea

  • Properties: Create, Nillable, Update

  • Description:

    Description of the OrderSummary.

    This field can be edited.

  • Type: date
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 64.0
  • Description: Date at which the order becomes effective. Label is Order Start Date.
  • Type: string
  • Properties: Filter, Group, idLookup, Nillable, Sort
  • Introduced: API version 66.0

  • Type: string

  • Properties: Filter, Group, idLookup, Nillable, Sort, Update

  • Introduced: API version 54.0

  • 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.

  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total amount, including adjustments and tax, of the OrderSummary.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: boolean
  • Properties: Create, Defaulted on create, Filter, Group, Sort, Update
  • Introduced: API version 50.0
  • Description: Indicates whether the OrderSummary is suspended. The default value is false.
  • Default value: false
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
  • Introduced: API version 63.0
  • Description: Current operation.
  • Possible values:
    • Cancellation — Cancellation
    • None — None

  • Type: picklist

  • Properties: Filter, Group, Restricted picklist, Sort

  • Introduced: API version 49.0

  • 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:

    • MANAGED — MANAGED
    • UNMANAGED — UNMANAGED
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 65.0
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the OrderSummary.
  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 52.0
  • Description: Total number of unique products ordered on this Order Summary.

  • Type: datetime

  • Properties: Create, Filter, Nillable, Sort, Update

  • 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.

  • Type: reference

  • Properties: Filter, Group, Sort

  • Description:

    ID of the original order associated with this OrderSummary. Label is Original Order.

    This field is a relationship field.

  • Relationship name: OriginalOrder

  • Relationship type: masterdetail

  • Refers to: Order

  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 64.0

  • Type: datetime

  • Properties: Create, Filter, Nillable, Sort, Update

  • Introduced: API version 52.0

  • 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.

  • 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.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 54.0

  • Description:

    ID of the pricebook associated with this OrderSummary.

    This field is a relationship field.

  • Relationship name: Pricebook2

  • Relationship type: relationship

  • Refers to: Pricebook2

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 68.0

  • Relationship name: Quote

  • Relationship type: relationship

  • Refers to: Quote

  • Type: int
  • Properties: Create, Defaulted on create, Filter, Group, Nillable, Sort, Update
  • Introduced: API version 51.0
  • Description: The number of attempts that have been made to route the order summary to inventory locations.

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • 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: relationship

  • Refers to: SalesChannel

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • 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: polymorphic

  • Refers to: RetailStore, WebStore

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort, Update

  • Introduced: API version 63.0

  • Relationship name: SavedPaymentMethod

  • Relationship type: relationship

  • Refers to: SavedPaymentMethod

  • Type: reference

  • Properties: Filter, Group, Nillable, Sort

  • Introduced: API version 60.0

  • Description:

    ID of the source order summary that’s associated with this OrderSummary.

    This field is populated when the SourceProcess of this OrderSummary is an exchange process.

  • Relationship name: SourceOrderSummary

  • Relationship type: relationship

  • Refers to: OrderSummary

  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 57.0
  • Description: Describes the order process that created the OrderSummary.
  • Possible values:
    • Exchange — Exchange
    • OrderOnBehalf — OrderOnBehalf
    • Standard — Standard

  • 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.

  • Type: picklist

  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort, Update

  • Introduced: API version 49.0

  • 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. Automatic taxes use currency to determine if the tax is added on top of the price (excluded) or included in the price.

    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.

  • Possible values:

    • Gross — Gross
    • Net — Net
    • Automatic — Automatic
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • 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.
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • Description: Total of distributed adjustments applied to OrderItemSummaries belonging to this OrderSummary, inclusive of tax. This amount is equal to TotalAdjDistAmount plus TotalAdjDistTaxAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalAdjDistAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • 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.
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalAdjustedDeliveryAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Total, including item-level adjustments but not order-level adjustments or tax, of all OrderItemSummaries of type Fee belonging to this OrderSummary.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Tax on the 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 code Product belonging to this OrderSummary.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalAdjustedProductAmount.
  • 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.
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalDeliveryAdjDistAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 54.0
  • Description: Sum of the Total Line Amounts of all OrderItemSummaries of type Delivery Charge belonging to this OrderSummary, not including adjustments or tax.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 54.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 54.0
  • Description: Tax on the TotalDeliveryAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Tax on the TotalFeeAdjDistAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Sum of the Total Line Amounts of all OrderItemSummaries of type Fee belonging to this OrderSummary, not including adjustments or tax.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Total of all OrderItemSummaries of type Fee belonging to this OrderSummary, including tax but not including adjustments. It is equal to TotalFeeAmount + TotalFeeTaxAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Tax on the TotalFeeAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 49.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Tax on the TotalProductAdjDistAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 54.0
  • Description: Sum of the Total Line Amounts of all OrderItemSummaries of type code Product belonging to this OrderSummary, not including adjustments or tax.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 54.0
  • 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.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 54.0
  • Description: Tax on the TotalProductAmount.
  • Type: currency
  • Properties: Filter, Nillable, Sort
  • Description: Total tax on all OrderItemSummaries belonging to this OrderSummary. Equal to TotalAdjustedDeliveryTaxAmount plus TotalAdjustedFeeTaxAmount plus TotalAdjustedProductTaxAmount.

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.