Cancel Reservations

This operation allows a Confirmed status reservation to be Cancelled. In certain cases, a cancellation is not possible. Examples include, but are not limited to, the following situations:

Reservation status is different than Confirmed
Reservation is already cancelled
Reservation cancel policy does not allow it
Package cancel policy does not allow it
Payment is pending

REST Method/Endpoint

Method	Endpoint
POST	/v1/api/reservation/cancel

Request attribute definitions:

Attribute	Description	Data Type	Required	Default
Hotel @Id	Unique ID for the hotel in SynXis CRS	Integer	Yes
CrsConfirmationNumber	CRS Confirmation Number for the Reservation. This is the identifier of the reservation within the Hotel.	String	Yes
Channels/PrimaryChannel @Code	The code that identifies the Primary Channel that is cancelling the reservation.	String	No
Channels/SecondaryChannel @Code	The code that identifies the Secondary Channel that is cancelling the reservation.	String	No
Channels @SubSourceCode	The Sub Source Code related to the cancellation. This is considered the Third level Channel.	String	No
SuppressGuestEmail	Indicates that an email should not be sent to the Guest upon cancellation.	Boolean	No	False
SuppressBookerEmail	Indicates that an email should not be sent to the Booker upon cancellation.	Boolean	No	False
CancellationDetails @AuthorizationNote	Administrative action notes for the cancelled reservation.	String	No
CancellationDetails @CallerName	Specifies the name of the caller requested to cancel the reservation.	String	No
CancellationDetails @ContactNumber	Specifies the contact number of the caller.	String	No
CancellationDetails @Comment	Comments associated to the cancelled reservation.	String	No
CancellationDetails @ReasonCode	Reason code associated to the cancelled reservation.	String	No
OnPropertyStatus	Conveys a secondary status associated with a reservation. Used by Property Management Systems. Possible values: None, CheckedOut, NoShow, TurnAway	String	No
Overrides	Array of relevant override type(s) for the cancellation. Possible values: ReturnCanceledPointsOverride	Array/String	No

Sample request body:

{
  "Hotel": {
    "Id": 11113
  },

  "CrsConfirmationNumber": "11113EC000239",
  "Channels": {
    "PrimaryChannel": {
      "Code": "WEB"

    },
    "SecondaryChannel": {
      "Code": "SYNXISWS_BE"
    },
    "SubSourceCode": "KYK"
  },
  "SuppressGuestEmail": false,
  "SuppressBookerEmail": false,
  "CancellationDetails": {
    "AuthorizationNote": "string",
    "CallerName": "Jane Doe",
    "ContactNumber": "555-123-4567",
    "Comment": "Family issues",
    "ReasonCode": "C001"
  },
  "OnPropertyStatus": "NoShow",
  "Overrides": [
    "ReturnCanceledPointsOverride"
  ]
}

Successful response:

{
  "CrsCancellationNumber": "11113X000239"
}