Admin APIReturns
Cancel a return.
Cancel a return.
AuthorizationBearer <token>
In: header
Path Parameters
id*string
The return's ID.
Request Body
application/json
no_notification?boolean
Whether to send the customer a notification about the return's cancelation.
Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X POST "https://{tenant}.api.myxclade.com/admin/returns/string/cancel" \ -H "Content-Type: application/json" \ -d '{}'{
"return": {
"id": "string",
"status": "canceled",
"refund_amount": 0,
"order_id": "string",
"items": [
{
"id": "string",
"quantity": 0,
"received_quantity": 0,
"damaged_quantity": 0,
"reason_id": "string",
"note": "string",
"item_id": "string",
"return_id": "string",
"metadata": {}
}
],
"created_at": "2019-08-24T14:15:22Z",
"canceled_at": "2019-08-24T14:15:22Z",
"exchange_id": "string",
"location_id": "string",
"claim_id": "string",
"order_version": 0,
"display_id": 0,
"no_notification": true,
"received_at": "string"
}
}{
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}"Unauthorized"{
"message": "Entity with id 1 was not found",
"type": "not_found"
}{
"code": "unknown_error",
"message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
"type": "QueryRunnerAlreadyReleasedError"
}{
"code": "invalid_request_error",
"message": "Discount with code TEST already exists.",
"type": "duplicate_error"
}{
"code": "api_error",
"message": "An error occured while hashing password",
"type": "database_error"
}