Submit Cart to Exchange Order

Creates an exchange order summary, based on the return order and the cart used for exchanges. The new exchange order summary is attached to the original order summary (created before any exchanges occurred). You can also provide optional payment information and optional information about order summary sequences, which affect the newly created exchange order summary.

Resource

1/commerce/order-management/exchanges/actions/submit-cart-to-exchange-order

Available version

60.0

HTTP methods

POST

Request body for POST

Submit Cart to Exchange Order Input

Root XML tag

<submitCartToExchangeOrderInput>

JSON example

1{
2  "orderSummaryId": "1Osxx0000000000",
3  "exchangeCartId": "0a6xx0000000000",
4  "referenceId": "2oNxx0000000000",
5  "orderNumber": "My exchange order",
6  "paymentInfoList": {
7    "paymentInfoItems": [
8      {
9        "paymentIds": [
10          "0aQxx0000000000",
11          "0aQxx0000000001"
12        ],
13        "name": "VISA-1234",
14        "paymentMethodId": "0aaxx0000000001",
15        "lastPaymentGatewayLogId": "0Xtxx0000000001"
16      },
17      {
18        "paymentAuthorizationId": "0Xcxx0000000002",
19        "name": "VISA-4567",
20        "paymentMethodId": "0aaxx0000000002",
21        "lastPaymentGatewayLogId": "0Xtxx0000000002"
22      },
23      {
24        "paymentIds": [
25          "0aQxx0000000003",
26          "0aQxx0000000004"
27        ],
28        "paymentAuthorizationId": "0Xcxx0000000003",
29        "name": "VISA-9123",
30        "paymentMethodId": "0aaxx0000000003",
31        "lastPaymentGatewayLogId": "0Xtxx0000000003"
32      }
33    ]
34  },
35  "sequences": {
36    "sequences": [
37      {
38        "orderPaymentSummaryId": "0bMxx0000000000",
39        "amount": 10
40      },
41      {
42        "orderPaymentSummaryId": "0bMxx0000000001",
43        "amount": 20
44      },
45      {
46        "orderPaymentSummaryId": "0bMxx0000000002"
47      }
48    ]
49  }
50}

Properties

Name	Type	Description	Required or Optional	Available Version
`exchangeCartId`	String	ID of the cart used for adding items to the exchange order.	Required	60.0
`orderNumber`	String	Order number.	Optional	60.0
`orderSummaryId`	String	Order summary ID.	Required	60.0
`paymentInfoList`	Payment Info Input[]	List of payment information when additional funds are needed for the newly created exchange order.	Optional	60.0
`referenceId`	String	Return order ID.	Optional	60.0
`reservationType`	String	The reservation that's created by the submit API. The possible values are Full, which means there’s a reservation against the exchange cart, or None if there’s no reservation.	Optional	61.0
`sequences`	Shared Order Payment Summary Sequence Input[]	Ordered list of order payment summaries and reserved balance amounts to apply them to.	Optional	60.0

Response body for POST

Submit Cart to Exchange Order

Connect REST API Developer Guide

Submit Cart to Exchange Order