Commerce Webstore Order Summary Lookup

Look up details about an order summary, including its line items and relevant order amount fields. This API is available to both registered and guest users.

This API authenticates guest buyers using the verificationInput object (email, last name, or phone) or a session cookie. Session cookie authentication is available only on Salesforce-hosted stores.

Note

Resource

1/commerce/webstores/webstoreId/order-summaries/actions/lookup

Resource example

1https://yourInstance.salesforce.com/services/data/v63.0/commerce/webstores/0ZExx00000000l2/order-summaries/actions/lookup

Available version

58.0

HTTP methods

POST

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`deliveryGroupId`	String	ID of the delivery group associated with the order summary.	Optional	58.0
`effectiveAccountId`	String	ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user or, for guest users, the guest buyer profile ID of the current store.	Optional	58.0
`excludeAdjustmentAggregates`	Boolean	Specifies whether to exclude (`true`) or return (`false`) adjustment aggregates associated with an order summary. Adjustment aggregates include fields detailing promotional amounts by price, tax, and total. Aggregates are calculated asynchronously and result returned to the order summary. If unspecified, the default value is `false`.	Optional	58.0
`excludeAdjustments`	Boolean	Specifies whether to exclude (`true`) or return (`false`) adjustments associated with an order summary. Adjustments include promotional discounts. If unspecified, the default value is `false`.	Optional	58.0
`excludeDeliveryGroups`	Boolean	Specifies whether to exclude delivery groups from the response. If unspecified, the default value is `false`.	Optional	58.0
`excludeLineItems`	Boolean	Specifies whether to exclude line items from the response. If unspecified, the default value is `false`.	Optional	58.0
`excludePayments`	Boolean	Specifies whether to exclude payment information from the response. If unspecified, the default value is `false`.	Optional	63.0
`fields`	String	List of specific fields, including custom fields, to return in the response along with default fields. For example, `OrderSummary.TotalAmount`, `OrderItemSummary.Quantity`, `Product2.Description`, `OrderDeliveryGroupSummary.GrandTotalAmount`, `OrderDeliveryMethod.Carrier`.	Optional	58.0
`orderSummaryLookupInput`	Object	Contains the order summary ID or reference number and verification fields (`lastName`, `email`, `phoneNumber`) that provide shopper validation.	Required	58.0

Request body for POST

Root XML tag

<orderSummaryLookupInput>

JSON example

Here’s an example where order summary ID is included in the request for registered shoppers:

1{
2    "orderSummaryIdOrRefNumber":"1Osxx0000004DypCAE"
3}

Here’s an example where order summary reference number and verification details are included in the request for guest shoppers:

1{
2    "orderSummaryIdOrRefNumber":"GJA4C-MUVBN-6ZT4P-V6CSB",
3    "verification":{
4        "lastName":”Strosin”,
5        "email":”Ma**********@vi*****.info”,
6        "phoneNumber":"********7740"
7    }
8}

Properties

Name	Type	Description	Required or Optional	Available Version
`orderSummaryIdOrRefNumber`	String	Either the order summary ID or reference number value. For guest shoppers, use the order reference number.	Required	58.0
`verification`	Order Summary Verification Input	Verification attributes for guest shoppers.	Optional	58.0

Response body for POST

Order Summary Lookup Output

Connect REST API Developer Guide

Commerce Webstore Order Summary Lookup