Create or update an order return.
PUT
/orderreturns/{returnID}
200Description
If an object with the same ID already exists, it will be overwritten.
Roles
At least one of the roles below is required to access this endpoint.
FullAccessOrderAdminShopper
Parameters
| Name | Type | Description | Possible Values | |
|---|---|---|---|---|
| returnID | Required | string | ID of the return. | --- |
Request Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| OrderID | Required | string | --- | --- | --- | |
| RefundAmount | number | float | --- | --- | ||
| Comments | string | --- | 2000 characters | --- | ||
| ItemsToReturn | array | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||
Response Body
| Property | Type | Format | Max Length | Possible Values | ||
|---|---|---|---|---|---|---|
| ID | string | --- | 100 characters | --- | ||
| OrderID | string | --- | --- | --- | ||
| PaymentIDs | Read Only | array | --- | --- | --- | |
| Status | Read Only | string | --- | --- | Unsubmitted, AwaitingApproval, Declined, Open, Completed, Canceled | |
| DateCreated | Read Only | string | date-time | --- | --- | |
| DateSubmitted | Read Only | string | date-time | --- | --- | |
| DateApproved | Read Only | string | date-time | --- | --- | |
| DateDeclined | Read Only | string | date-time | --- | --- | |
| DateCanceled | Read Only | string | date-time | --- | --- | |
| DateCompleted | Read Only | string | date-time | --- | --- | |
| LastUpdated | Read Only | string | date-time | --- | --- | |
| RefundAmount | number | float | --- | --- | ||
| Comments | string | --- | 2000 characters | --- | ||
| ItemsToReturn | array | --- | --- | --- | ||
| xp | object | --- | --- | --- | ||