Booking Cancel
BookingCancel operation allows the cancellation of a booking made with Stuba. The operation will calculate any applicable cancellation charges and confirm the chargeable amount that will be invoiced. Cancellation of a booking will cancel all rooms confirmed under the Stuba Booking ID. In the event that only a partial cancellation is required, this request must be actioned on the Stuba.com website using ‘Manage Bookings’
BookingCancel Request Syntax
Request Header
Content-Type: “text/xml; charset=utf-8”
Content-Length: [Length of the content]
Host: [Web service hostname]
Accept-Encoding “gzip”
| Name | Type | Description |
|---|---|---|
|
<Authority> |
Complex |
Authentication information, as |
|
<Org> |
String |
The organisation short code identifying the agent responsible for the request (Agency ID) |
|
<User> |
String |
The user’s logon, unique within the given organisation (User Name) |
|
<Password> |
String |
The given user’s password |
|
<Currency> |
String |
Choose the currency used to return selling prices; accepts an ISO-4217 / SWIFT three character currency code (e.g. USD, GBP, EUR). Your account has a configured billing currency. Only the configured currency can be specified here. |
|
<Version> |
String |
The current interface version is 1.28 |
|
<BookingId> |
Integer |
Numeric Id for the booking to cancel |
|
<CommitLevel> |
Enum |
Two-valued text enumeration: prepare – return details of the selected booking and reconfirms the cancellation policy, but does not cancel the booking. confirm – performs the booking cancellation |
Response Body Schema
| Name | Type | Description |
|---|---|---|
|
<CommitLevel> |
Enum |
Indicates the commit level with which the cancellation was performed |
|
<Booking> |
Complex |
A booking structure, containing details of the booking to cancel |
|
<Id> |
Integer |
Numeric Id for the booking and your BookingId for post booking operations |
|
<CreationDate> |
Date |
Date of booking creation |
|
<AgentReference> |
String |
A custom reference provided for booking with <Id> specified |
|
<HotelBooking> (1 or more) |
Complex |
A booking structure for each item associated with the booking |
|
<Id> |
Integer |
Numeric Id for the item |
|
<HotelId> |
Integer |
Numeric Id for the hotel |
|
<CreationDate> |
Date |
Date of booking creation |
|
<ArrivalDate> |
Date |
The date of the first night of the stay |
|
<Nights> |
Integer |
The duration of the stay as a number of nights. |
|
<TotalSellingPrice> |
Complex |
The total price for HotelBooking with <Id> specified |
|
<Status> |
Enum |
Current status of the HotelBooking with <Id> specified |
|
<Room> (1 or More) |
Complex |
Structure containing room requirement and occupant details |
|
<RoomType> |
Complex |
A text enumeration (as a <code>, <text> pair) identifying a specific room type. These codes are obtained dynamically from the hotel and are obtained individually per hotel. |
|
<MealType> |
Enum |
A text enumeration identifying the meal type for the room |
|
<Guests> |
Array |
An array of either <Adult> or <Child> elements representing the guests who will stay in this room |
|
<Messages> |
Complex |
Special notes provided by the hotel are provided here |
|
<Status> |
Enum |
Current status of the HotelBooking with <Id> specified |
|
<CanxFees> |
Complex |
A structure containing each of the cancellation <Fee> that apply to the rate booked |
|
<Charge> |
Complex |
A structure containing details of any cancellation charges that have been applied at the time of booking cancellation (Only included if CommitLevel ‘confirm’) |
XML Response Samples
Samples
