Refund a Product
DELETE/order/:guid/products/:order_product_guid/return
Refund a Product. This endpoint has been replaced by DELETE /order/{guid}/custom_refund
.
Request
Path Parameters
The guid of the Order.
The guid of the Product of the Order.
- application/json
Body
Input data
Possible values: non-empty
and <= 255 characters
A comment for the Refund.
Whether to include the services fees.
Responses
- 200
- 403
- 404
- 406
Product refunded successfully. This returns an empty response.
- application/json
- Schema
- Example (from schema)
Schema
fatals
object
The type of object which throws the fatal, error or notice.
The guid of the object which threw the fatal, error or notice.
In the case the error is about reservation, this will be the reservation key of the object that was used.
The reason why the fatal, error or notice occurred.
Potentially some extra information about the fatal, error or notice.
This is the child error and has the same schema as this schema. It recurses on every child fatal, error or notice that gets added.
errors
object
required
The type of object which throws the fatal, error or notice.
The guid of the object which threw the fatal, error or notice.
In the case the error is about reservation, this will be the reservation key of the object that was used.
The reason why the fatal, error or notice occurred.
Potentially some extra information about the fatal, error or notice.
This is the child error and has the same schema as this schema. It recurses on every child fatal, error or notice that gets added.
notices
object
required
The type of object which throws the fatal, error or notice.
The guid of the object which threw the fatal, error or notice.
In the case the error is about reservation, this will be the reservation key of the object that was used.
The reason why the fatal, error or notice occurred.
Potentially some extra information about the fatal, error or notice.
This is the child error and has the same schema as this schema. It recurses on every child fatal, error or notice that gets added.
The redirect URL to where the user should continue.
In case this field is returned, it is the amount of the created Order in cents.
The guid of the created Order.
{
"fatals": {
"subjectType": "string",
"guid": "string",
"reservation": "string",
"reason": "string",
"extra": {},
"parentOf": {}
},
"errors": {
"subjectType": "string",
"guid": "string",
"reservation": "string",
"reason": "string",
"extra": {},
"parentOf": {}
},
"notices": {
"subjectType": "string",
"guid": "string",
"reservation": "string",
"reason": "string",
"extra": {},
"parentOf": {}
},
"redirectUrl": "string",
"amount": 0,
"order_id": "string"
}
Unauthorized. You do not have permission to manage the Order.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
Order or Product not found.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}
Request is invalid, there was no paid Payment found.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}