Sitecore API catalog/OrderCloud/
/
Approve an order return

Approve an order return

Request

Security
OAuth2(Required scopes: FullAccessOrderAdmin)
Path
returnIDstringrequired

ID of the return.

Bodyapplication/jsonrequired
Commentsstring, <= 2000 characters

Comments to be saved with the order approval or denial.

Example:""
curl -i -X POST \
  'https://api.ordercloud.io/v1/orderreturns/{returnID}/approve' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "Comments": ""
  }'

Responses

Bodyapplication/json
IDstring, <= 100 characters
Example:""
OrderIDstring
Example:""
PaymentIDsArray of stringsread-only

IDs of payments associated with this order return.

Example:
[
  ""
]
Statusstring(OrderStatus)read-only
Enum:"Unsubmitted""AwaitingApproval""Declined""Open""Completed""Canceled"
Example:"Unsubmitted"
DateCreatedstring, (date-time)read-only
Example:"2018-01-01T00:00:00-06:00"
DateSubmittedstring, (date-time)read-only

Will be null until the order return passes from the buyer to the seller, including when Status is PendingApproval.

Example:"2018-01-01T00:00:00-06:00"
DateApprovedstring, (date-time)read-only
Example:"2018-01-01T00:00:00-06:00"
DateDeclinedstring, (date-time)read-only
Example:"2018-01-01T00:00:00-06:00"
DateCanceledstring, (date-time)read-only
Example:"2018-01-01T00:00:00-06:00"
DateCompletedstring, (date-time)read-only

Populated when payment to customer has been completed.

Example:"2018-01-01T00:00:00-06:00"
LastUpdatedstring, (date-time)read-only
Example:"2018-01-01T00:00:00-06:00"
RefundAmountnumber, (float)

Sum of all RefundAmounts for items. This value can be overridden by a user with the OrderAdmin role. To remove the override set the value to null.

Example:0
Commentsstring, <= 2000 characters
Example:""
ItemsToReturnArray of objects(OrderReturnItem)
Example:
[
  {
    "LineItemID": "",
    "Quantity": 0,
    "RefundAmount": 0,
    "Comments": ""
  }
]
xpobject
Example:
{}
Response
{
  "ID": "",
  "OrderID": "",
  "PaymentIDs": [
    ""
  ],
  "Status": "Unsubmitted",
  "DateCreated": "2018-01-01T00:00:00-06:00",
  "DateSubmitted": "2018-01-01T00:00:00-06:00",
  "DateApproved": "2018-01-01T00:00:00-06:00",
  "DateDeclined": "2018-01-01T00:00:00-06:00",
  "DateCanceled": "2018-01-01T00:00:00-06:00",
  "DateCompleted": "2018-01-01T00:00:00-06:00",
  "LastUpdated": "2018-01-01T00:00:00-06:00",
  "RefundAmount": 0,
  "Comments": "",
  "ItemsToReturn": [
    { … }
  ],
  "xp": {}
}