Admin APIReturns
Get a Return
Retrieve a return by its ID. You can expand the return's relations or select the fields that should be returned.
AuthorizationBearer <token>
In: header
Path Parameters
id*string
The return's ID.
Query Parameters
fields?string
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X GET "https://{tenant}.api.myxclade.com/admin/returns/string"{
"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"
}