PendingOrderSummary

Object representing a B2C Commerce order ingested via High Scale Orders before an OrderSummary is created for it. Optimized for online transaction processing (OLTP). This object is available in API version 55.0 and later.

Supported Calls

describeLayout(), query()

Special Access Rules

Fields

This object is only available in Salesforce Order Management orgs where the High Scale Orders feature is enabled.

Field	Details
AccountId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the account or person account associated with the PendingOrderSummary. It represents the shopper in the storefront. This field is a relationship field. Relationship Name Account Relationship Type Lookup Refers To Account
BillToContactId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the Contact associated with the PendingOrderSummary. It represents the shopper in the storefront when not using person accounts. This field is a relationship field. Relationship Name BillToContact Relationship Type Lookup Refers To Contact
BillingEmailAddress	Type email Properties Filter, Group, Sort Description Email address on the billing address.
BillingPhoneNumber	Type phone Properties Filter, Group, Nillable, Sort Description Phone number of the billing address.
CurrencyIsoCode	Type picklist Properties Defaulted on create, Filter, Group, Restricted picklist, Sort Description Available only for orgs with the multicurrency feature enabled. Contains the ISO code for the currency of the original Order associated with the PendingOrderSummary. Possible values are: `DKK`—Danish Krone `EUR`—Euro `GBP`—British Pound `USD`—U.S. Dollar The default value is `USD`.
Description	Type string Properties Filter, Group, Nillable, Sort Description Description of the PendingOrderSummary.
ExternalId	Type string Properties Filter, Group, Nillable, Sort Description This field is used internally. This field isn’t synced with ZOS, so you can’t use it in a query or insert operation.
ExternalReferenceIdentifier	Type string Properties Filter, Group, Sort Description Used internally to prevent duplicate records. This value is case-sensitive. On creation, this value is set to `B2C realm ID` + "_" + `B2C instance ID` + "@" + `B2C Commerce catalog/domain ID` + "@" + `B2C Commerce order number`. When the OrderSummary is created, this value is copied to its ExternalReferenceIdentifier field. If you ingest orders from multiple sources, you can maintain uniqueness by including a prefix based on the source.
GrandTotalAmount	Type currency Properties Filter, Sort Description Total amount, including adjustments and tax, of the PendingOrderSummary.
OrderNumber	Type string Properties Filter, Group, Sort Description Name of the PendingOrderSummary.
OrderedDate	Type dateTime Properties Filter, Sort Description Date of the original order associated with this PendingOrderSummary.
Payload	Type textarea Properties Description The order data payload.
PayloadType	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description The datatype of the Payload. Possible values are: `JSON_GZIP` `JSON_RAW`
ProcessingInstructions	Type textarea Properties Nillable Description Instructions about how the HSOI service should create the order summary. Options include using the default without customizations or using a custom flow. Also includes instructions about how the HSOI service should dedupe account and contact information using platform duplication and matching rules or by using simple email methods.
SalesChannelId	Type reference Properties Filter, Group, Nillable, Sort Description ID of the SalesChannel associated with this PendingOrderSummary. The SalesChannel Name matches the B2C Commerce catalog/domain ID. 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 PendingOrderSummary. This field is a relationship field. Relationship Name SalesStore Relationship Type Lookup Refers To WebStore
ShopperName	Type string Properties Filter, Group, Sort Description The first name and last name of the shopper that placed the original order.

Usage

If you need to view or service an ingested B2C Commerce order before the automated High Scale Orders process has created an OrderSummary for it, you can manually trigger creation of the OrderSummary. In Salesforce, open the PendingOrderSummaries list, find the record, and click Import.

PendingOrderSummary only supports certain methods and queries. It doesn’t support Apex triggers.

Supported Apex Methods:

Database.query(queryString)
Database.query(queryString, accessLevel)

Supported SOAP API Methods:

create()
delete()
describeLayout()
query()
queryMore()

Supported REST API Methods:

/services/data/vXX.X/sobjects/sObject/ GET
/services/data/vXX.X/sobjects/sObject/id/ GET
/services/data/vXX.X/sobjects/sObject/id/ DELETE
/services/data/vXX.X/sobjects/sObject/id/ POST
/services/data/vXX.X/sobjects/sObject/describe/compactLayouts/ GET
/services/data/vXX.X/sobjects/sObject/quickActions/ GET

Supported Queries:

convertCurrency() function: Example: SELECT Id, convertCurrency(AnnualRevenue) FROM Account
Child-to-Parent subquery: Example: SELECT ExternalReferenceIdentifier, Account.Name FROM PendingOrderSummary WHERE ExternalReferenceIdentifier = 'a'
Limit clause: Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE ExternalReferenceIdentifier = 'a' LIMIT 1
Filter by index: Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE ExternalReferenceIdentifier = 'a'
Filter by secondary index: Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE AccountId = 'xxx'
ORDER BY clause: When using ORDER BY, you don’t need to specify a direction. However, if you sort ASC, you can’t use NULLS LAST. If you sort DESC, you can only use NULLS LAST.; Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary ORDER BY ExternalReferenceIdentifier; Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary ORDER BY ExternalReferenceIdentifier ASC NULLS FIRST; Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary ORDER BY ExternalReferenceIdentifier DESC NULLS LAST
Equality filter: Range filters aren’t supported.; Example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE ExternalReferenceIdentifier = 'realm_tenant@storesite@0000001'; Invalid example: SELECT ExternalReferenceIdentifier FROM PendingOrderSummary WHERE ExternalReferenceIdentifier < 'a'

Login

Products

Experiences

Agentforce

CRM Products

Industries

Small Business

Data

Salesforce Platform

Customer Success

Partner Apps & Experts

Discover the #1 AI CRM

Discover the #1 AI CRM

Automotive

Communications

Engineering, Construction & Real Estate

Consumer Goods

Education

Energy & Utilities

Financial Services

Healthcare & Life Sciences

Manufacturing

Media

Nonprofit

Professional Services

Public Sector

Retail

Technology

Travel, Transportation & Hospitality

Explore Salesforce for industries.

Explore Salesforce for industries.

Customer Stories

Salesforce on Salesforce Stories

Trailblazer Stories

Explore success stories.

Explore success stories.

Learning on Trailhead

Events

Resources

Blogs

Become a Trailblazer.

Become a Trailblazer.

Help & Documentation

Communities

Services & Plans

Your Account

Questions? We can help.

Questions? We can help.

About Salesforce

Our Values

Our Impact

Careers

Newsroom

Legal

More Salesforce Brands

Hear our story.

Hear our story.

Events

Original Series

My List

Explore Salesforce+.

Explore Salesforce+.

Login

Products

Experiences

Contact Us

By phone

Online

Products

Experiences

Developer Centers

Salesforce Platform

Industries

Resources

Developer Tools

Build Skills

Extend Salesforce

Stay Up To Date

Community

Object Reference for the Salesforce Platform