/bookings/{booking-reference}/cancel

v1.0.0

Submits a cancellation request for the specified booking

For information on how to use this service, see:

Note:

This service <u>requires</u> to be included as a header parameter. Please speak to your account manager if you have not yet been issued an exp-api-key.
The base URL for the server for this endpoint is different from the older endpoints described in this document. Use https://api.sandbox.viator.com/partner/bookings/{booking-reference}/cancel

Input

{
  "type": "object",
  "properties": {
    "Accept-Language": {
      "type": "string"
    },
    "booking-reference": {
      "type": "string"
    },
    "reasonCode": {
      "type": "string",
      "description": "Machine-interpretable identification code for this cancellation reason, retrieved from [cancellationReasons](#operation/cancellationReasons)"
    }
  },
  "required": [
    "Accept-Language",
    "booking-reference"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "bookingId": {
      "type": "string",
      "description": "Booking reference number for this booking, prepended with `BR-`"
    },
    "reason": {
      "type": "string",
      "enum": [
        "ALREADY_CANCELLED",
        "NOT_CANCELLABLE"
      ]
    },
    "status": {
      "type": "string",
      "description": "String indicating the outcome of the booking cancellation request.\n\n  * `ACCEPTED`: The cancellation was successful\n  * `DECLINED`: The cancellation failed\n",
      "enum": [
        "ACCEPTED",
        "DECLINED"
      ]
    }
  }
}