Order Summaries

Create an OrderSummary based on an order. That order is considered the original order for the OrderSummary. Subsequent change orders that apply to the OrderSummary are also represented as orders. You can specify whether the order is managed in Salesforce Order Management or by an external system. Most Salesforce Order Management APIs can run only on orders that it manages.

Resource

1/commerce/order-management/order-summaries

Available version

48.0

HTTP methods

POST

Request body for POST

Order Summary Input

Root XML tag

<orderSummaryInput>

JSON example

1{
2  "orderId": "801xx000003GbTgAAK"
3}

Properties

Name	Type	Description	Required or Optional	Available Version
`businessModel`	String	The order’s business model. It can have one of these values: B2B B2C	Optional	53.0
`externalReferenceIdentifier`	String	Used internally to prevent duplicate records. This value is case-sensitive.	Optional	56.0
`name`	String	Specifies an OrderNumber to assign to the order summary.	Optional	50.0
`orderId`	String	ID of the original order.	Required	48.0
`orderLifeCycleType`	String	Specifies whether the order is managed in Salesforce Order Management or by an external system. It can have one of these values: `MANAGED`—Managed in Salesforce Order Management. `UNMANAGED`—Managed by an external system. If no value is specified, the default is `MANAGED`.	Optional	49.0
`sourceProcess`	String	Describes the order process creating the OrderSummary. It can have one of these values: `Exchange—An Exchange process.` `OrderOnBehalf`—An Order on Behalf Of process. `Standard`—Any process other than Exchange or Order on Behalf Of. If no value is specified, the default is `Standard`.	Optional	57.0
`status`	String	Specifies a status to assign to the order summary. The value must match one of the picklist values on the Status field of the OrderSummary object.	Optional	50.0

Response body for POST

When the HTTP status code indicates success, the response body is an Order Summary Output. The response body can still indicate processing errors.
When the HTTP status code is in the 400 (client error) or 500 (server error) range, the response body is an Error with Output. The output property is an Order Summary Output, and the value of the enhancedErrorType property can be ignored.

Connect REST API Developer Guide

Order Summaries