Skip to main content
POST
/
v1
/
admin
/
catalog
/
orders
/
{id}
/
cancel
Cancel a catalog booking order
curl --request POST \
  --url https://{operatorDomain}/v1/admin/catalog/orders/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bookingId": "<string>",
  "entityModule": "<string>",
  "entityId": "<string>",
  "reason": "<string>"
}
'
{
  "id": "<string>",
  "bookingId": "<string>",
  "entityModule": "<string>",
  "entityId": "<string>",
  "sourceKind": "<string>",
  "status": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Staff session or API token issued by your Voyant app.

Path Parameters

​
id
string
required

Body

application/json
​
bookingId
string
required
​
entityModule
string
required
​
entityId
string
required
​
reason
string

Response

200 - application/json

Cancellation result

​
id
string
​
bookingId
string
​
entityModule
string
​
entityId
string
​
sourceKind
string
​
status
string
​
createdAt
string<date-time>