Newer Version Available

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

Preview Cart to Exchange Order

Generate preview details of an exchange order for specified order summary, exchange cart ID, and reference record ID.
To access, you need the following permissions.
  • Salesforce Order Management License or Salesforce B2B Commerce License

This object is available in API version 60.0 and later.

Supported REST HTTP Methods

URI
/services/data/v59.0/actions/standard/previewCartToExchangeOrder
Formats
JSON, XML
HTTP Methods
GET, HEAD, POST
Authentication
Authorization: Bearer token

Inputs

Input Details
orderSummaryId
Type
ID
Description
Required. The ID of the order summary record associated with the list of exchanges.
exchangeCartId
Type
ID
Description
Required. The ID of the cart record containing the items for the exchange order.
referenceId
Type
ID
Description
Required. The ID of the record that's related to the specified order summary. Only IDs from a return order record are supported.

Outputs

Output Details
changeBalances
Type
string
Description
A string that contains the calculated amounts resulting from the exchange order.
errors
Type
string
Description
Following a 400 error response, the error objects show information about the error that occurred. Contains a status code, message, and list of fields.
isSuccess
Type
boolean
Description
Shows whether the payment sale request was successful.
orderSummaryID
Type
ID
Description
The ID of the order summary record associated with the list of exchanges.