Cancel the Order, counts are updated, does not execute refund
DELETE/order/:guid
This endpoint has been replaced by DELETE /order/{guid}/custom_refund
.
(Admin only) Cancel an Order, counts are updated, does not execute Refund.
Request
Path Parameters
The guid of the Order.
- application/json
Body
Input data
Possible values: non-empty
and <= 255 characters
A comment for the Refund.
Responses
- 200
- 404
- 406
Order cancelled successfully.
- 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"
}
Order or Shop of the Order 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, see error context for validation errors.
- application/json
- Schema
- Example (from schema)
Schema
The general error code.
The exact reason of failure.
{
"error_code": "string",
"error_description": "string"
}