Newer Version Available

This content describes an older version of this product. View Latest

Commerce Webstore Order Summary

Get an order summary. This API is available only to registered users.

We recommend using the enhanced Commerce Webstore Order Summary Lookup API, which is accessible to both registered and guest users.

Note

Resource
1/commerce/webstores/webstoreId/order-summaries/orderSummaryId
Available version
55.0
HTTP methods
GET
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
effectiveAccount​Id String ID of the account for which the request is made. If unspecified, defaults to the account ID for the context user. Optional 55.0
fields String[] List of up to 35 additional order summary fields to display in the UI in each item row.
These order summary fields are returned regardless of fields specified.
  • createdDate
  • orderSummaryId
  • orderNumber
  • orderedDate
  • ownerId
  • status
  • totalAmount
Optional 55.0
include​Adjustment​Details Boolean Specifies whether to return adjustment details (true) or not (false). If unspecified, the default value is false. Optional 55.0
Response body for GET
Order Summary