Order Summaries, Create Credit Memo

Create a credit memo to represent the refund for one or more change orders associated with an OrderSummary.

Resource

1/commerce/order-management/order-summaries/orderSummaryId/actions/create-credit-memo

Available version

48.0

HTTP methods

POST

Request body for POST

Create Credit Memo Input

Root XML tag

<createCreditMemoInput>

JSON example

1{
2  "changeOrderIds": [
3    "801R0000000EAAkIAO"
4  ]
5}

Properties

Name	Type	Description	Required or Optional	Available Version
`changeOrderIds`	String[]	List of IDs of the change orders.	Required	48.0

Response body for POST

When the HTTP status code indicates success, the response body is a Create Credit Memo 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 a Create Credit Memo Output, and the value of the enhancedErrorType property can be ignored.

Connect REST API Developer Guide