GET hotels/{hotelId}/reservations/guestprofile/cancellations?key={key}&fromDate={fromDate}&toDate={toDate}

Gets all Reservations for the hotel specified that have been cancelled on a specific date range (max. 60 days) and their related Guest Profiles.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
hotelId

Hotel-Id => checked against the calling applications permissions

string

Required

key

API - Key identifying the caller

string

Required

fromDate

Start of Date Range, Format YYYY-MM-DD

date

Required

toDate

End of Date Range, Format YYYY-MM-DD

date

Required

Body Parameters

None.

Response Information

Resource Description

List of reservationsGuestProfile

Collection of ReservationGuestProfile
NameDescriptionTypeAdditional information
AcceptGeneralEmail

Accept General Email - "Y" will be sent for yes, "N" will be sent for no (related to your "reservation email")

string

None.

AddressLine1

Guest's first address line

string

None.

AddressLine2

Guest's secound address line

string

None.

ArrivalDate

The date guest arrive to the hotel

string

None.

AvailableCredit

Guests available credit, Credit Limit minus already accured charges

decimal number

None.

BookingNumber

reservation number

string

None.

CancellationNumber

The Cancellation Number that is assigned to a Cancelled Reservation

integer

None.

Cell1

Guests main Cell phone

string

None.

Cell2

Guests secondary Cell-Phone (e.g. work)

string

None.

CentralReservationNumber

Central reservation Number

string

None.

City

Guest's city

string

None.

CompanyEmailAddress

Travel agency email address

string

None.

CompanyFaxNumber

Travel agency Fax number

string

None.

CompanyName

Tarvel agency name

string

None.

CompRate

Comp Rate ('Y' if $0 rate, or 'N')

string

None.

Contact

Travel agent contact

string

None.

ContactEmailAddress

Travel agent contact email address

string

None.

ContactFaxNumber

Travel agent contact fax number

string

None.

CountryCode

Guest's country code

string

None.

DepartureDate

The date guest does checking out

string

None.

DepositPaid

Deposit amount that guests pay

decimal number

None.

EmailAddress

Guest's email address

string

None.

FirstName

Guest's first name

string

None.

FolioNumber

Displays lowest Folio number being used on Guest Folio

integer

None.

GuestId

Guest Identifier

string

None.

GuestType

Client Type (System Configuration -> Client Type -> Name)

string

None.

IsGuestTaxExempt

Is guest tax excempt

boolean

None.

JoinLoyalty

Guest would like to join loyalty return one, if not zero.

integer

None.

LastName

Guest's last name

string

None.

LastUpdateDate

Last update date i.e.: date when the reservation was created in RoomKey database, checked-in, checked-out, cancelled - whichever is the most recent one

string

None.

LoyaltyNumber

Guests loyalty number

string

None.

MailToFlag

Guest wants to receive email

boolean

None.

MarketingCode

Associated with Client Type Grouping found in RoomKey under System Configuration -> Client Types

string

None.

MarketingOptIn

Marketing Opt In - "Y" will be sent for yes, "N" will be sent for no (related to your "marketing campaigns")

string

None.

MiddleInitial

[deprecated] Field not available in system

string

None.

NumberOfActualNights

Number of actual nights guest stay at the hotel

decimal number

None.

NumberOfAdults

Number of adults

integer

None.

NumberOfChildren

Number of childeren

integer

None.

NumberOfNights

Number of booked nights

integer

None.

OtherRevenue

Other revenue except room revenue

decimal number

None.

PackageCode

Code associated with Package booked - found under System Configuration -> Packages and Inclusions -> Short Name

string

None.

PaymentType

Type of payment

string

None.

Phone1

Guests main Phone

string

None.

Phone2

Guests secondary phone (e.g. work)

string

None.

PreferredContactMethod

Preferred Contact Method

string

None.

PromoCode

Code associated with Online Booking Promotion booked - found under System Configuration -> Online Booking Promotions -> Promo Name

string

None.

PropertyCode

Hotel code

string

None.

RateCode

Rate Code name

string

None.

RecordType

Record Type S = Guest Stay Data, R = reservation Data *Required if reservation Data is sent

string

None.

ReservationDate

Date the reservation is made

string

None.

ReservationRates

Reservation Daily Rates

Collection of ReservationRate

None.

ReservationServices

Reservation Guest Service Detail

Collection of ReservationService

None.

ReservationUniqueIDs

Reservation Guest Service Detail

Collection of ReservationUniqueID

None.

ResortFee

Resort Fee

decimal number

None.

RoomNumber

Room number

string

None.

RoomRate

Daily rate of the room

decimal number

None.

RoomRevenue

Room revenue

decimal number

None.

RoomTypeCode

Code of room type

string

None.

SourceOfBusiness

Source of business (SOB), e.g. "Application", "CallCentre", "Email", "Facebook", "Fax", "Instagram", ...

string

None.

StateCode

Guest's state or province

string

None.

Status

Reservation status, i.e. "In House", "Reserved", "Canceled", "Checked out" Endpoints that return only a specific reservation status usually return this field blank.

string

None.

Taxes

Total taxes

decimal number

None.

TelephoneNumber

[deprecated] Please use the Phone1 field

string

None.

TimeofCheckOut

The time guest does checking out

string

None.

Title

Guest's title

string

None.

TotalRevenue

Total revenue: room revenue + other revenue + taxes

decimal number

None.

TotalRevenueWithoutTaxes

Total revenue without taxes: room revenue + other revenue

decimal number

None.

TravelAgent

Travel Agent name

string

None.

TravelAgentEmailAddress

Travel agent email address

string

None.

TravelAgentFaxNumber

Travel agent fax number

string

None.

TravelAgentIATA

Travel Agent IATA Number

string

None.

VIP

VIP indicator

boolean

None.

VIPCode

VIP guest's code

string

None.

ZipCode

Guest's ZIP code

string

None.

VehicleLicensePlate

Guest Vehicle Licence plate #

string

None.

VehicleMake

Guest Vehicle Make

string

None.

VehicleModel

Guest Vehicle Model

string

None.

VehicleColor

Guest Vehicle Color

string

None.

GroupId

string

None.

GroupName

string

None.

CorporateId

string

None.

CorporateName

string

None.

WholeSalerId

string

None.

WholeSalerName

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AcceptGeneralEmail": "sample string 1",
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "ArrivalDate": "sample string 4",
    "AvailableCredit": 5.0,
    "BookingNumber": "sample string 6",
    "CancellationNumber": 1,
    "Cell1": "sample string 7",
    "Cell2": "sample string 8",
    "CentralReservationNumber": "sample string 9",
    "City": "sample string 10",
    "CompanyEmailAddress": "sample string 11",
    "CompanyFaxNumber": "sample string 12",
    "CompanyName": "sample string 13",
    "CompRate": "sample string 14",
    "Contact": "sample string 15",
    "ContactEmailAddress": "sample string 16",
    "ContactFaxNumber": "sample string 17",
    "CountryCode": "sample string 18",
    "DepartureDate": "sample string 19",
    "DepositPaid": 20.0,
    "EmailAddress": "sample string 21",
    "FirstName": "sample string 22",
    "FolioNumber": 23,
    "GuestId": "sample string 24",
    "GuestType": "sample string 25",
    "IsGuestTaxExempt": true,
    "JoinLoyalty": 27,
    "LastName": "sample string 28",
    "LastUpdateDate": "sample string 29",
    "LoyaltyNumber": "sample string 30",
    "MailToFlag": true,
    "MarketingCode": "sample string 32",
    "MarketingOptIn": "sample string 33",
    "MiddleInitial": "sample string 34",
    "NumberOfActualNights": 35.1,
    "NumberOfAdults": 36,
    "NumberOfChildren": 37,
    "NumberOfNights": 38,
    "OtherRevenue": 39.0,
    "PackageCode": "sample string 40",
    "PaymentType": "sample string 41",
    "Phone1": "sample string 42",
    "Phone2": "sample string 43",
    "PreferredContactMethod": "sample string 44",
    "PromoCode": "sample string 45",
    "PropertyCode": "sample string 46",
    "RateCode": "sample string 47",
    "RecordType": "sample string 48",
    "ReservationDate": "sample string 49",
    "ReservationRates": [],
    "ReservationServices": [],
    "ReservationUniqueIDs": [],
    "ResortFee": 50.0,
    "RoomNumber": "sample string 51",
    "RoomRate": 52.0,
    "RoomRevenue": 53.0,
    "RoomTypeCode": "sample string 54",
    "SourceOfBusiness": "sample string 55",
    "StateCode": "sample string 56",
    "Status": "sample string 57",
    "Taxes": 58.0,
    "TelephoneNumber": "sample string 59",
    "TimeofCheckOut": "sample string 60",
    "Title": "sample string 61",
    "TotalRevenue": 62.0,
    "TotalRevenueWithoutTaxes": 63.0,
    "TravelAgent": "sample string 64",
    "TravelAgentEmailAddress": "sample string 65",
    "TravelAgentFaxNumber": "sample string 66",
    "TravelAgentIATA": "sample string 67",
    "VIP": true,
    "VIPCode": "sample string 69",
    "ZipCode": "sample string 70",
    "VehicleLicensePlate": "sample string 71",
    "VehicleMake": "sample string 72",
    "VehicleModel": "sample string 73",
    "VehicleColor": "sample string 74",
    "GroupId": "sample string 75",
    "GroupName": "sample string 76",
    "CorporateId": "sample string 77",
    "CorporateName": "sample string 78",
    "WholeSalerId": "sample string 79",
    "WholeSalerName": "sample string 80"
  },
  {
    "AcceptGeneralEmail": "sample string 1",
    "AddressLine1": "sample string 2",
    "AddressLine2": "sample string 3",
    "ArrivalDate": "sample string 4",
    "AvailableCredit": 5.0,
    "BookingNumber": "sample string 6",
    "CancellationNumber": 1,
    "Cell1": "sample string 7",
    "Cell2": "sample string 8",
    "CentralReservationNumber": "sample string 9",
    "City": "sample string 10",
    "CompanyEmailAddress": "sample string 11",
    "CompanyFaxNumber": "sample string 12",
    "CompanyName": "sample string 13",
    "CompRate": "sample string 14",
    "Contact": "sample string 15",
    "ContactEmailAddress": "sample string 16",
    "ContactFaxNumber": "sample string 17",
    "CountryCode": "sample string 18",
    "DepartureDate": "sample string 19",
    "DepositPaid": 20.0,
    "EmailAddress": "sample string 21",
    "FirstName": "sample string 22",
    "FolioNumber": 23,
    "GuestId": "sample string 24",
    "GuestType": "sample string 25",
    "IsGuestTaxExempt": true,
    "JoinLoyalty": 27,
    "LastName": "sample string 28",
    "LastUpdateDate": "sample string 29",
    "LoyaltyNumber": "sample string 30",
    "MailToFlag": true,
    "MarketingCode": "sample string 32",
    "MarketingOptIn": "sample string 33",
    "MiddleInitial": "sample string 34",
    "NumberOfActualNights": 35.1,
    "NumberOfAdults": 36,
    "NumberOfChildren": 37,
    "NumberOfNights": 38,
    "OtherRevenue": 39.0,
    "PackageCode": "sample string 40",
    "PaymentType": "sample string 41",
    "Phone1": "sample string 42",
    "Phone2": "sample string 43",
    "PreferredContactMethod": "sample string 44",
    "PromoCode": "sample string 45",
    "PropertyCode": "sample string 46",
    "RateCode": "sample string 47",
    "RecordType": "sample string 48",
    "ReservationDate": "sample string 49",
    "ReservationRates": [],
    "ReservationServices": [],
    "ReservationUniqueIDs": [],
    "ResortFee": 50.0,
    "RoomNumber": "sample string 51",
    "RoomRate": 52.0,
    "RoomRevenue": 53.0,
    "RoomTypeCode": "sample string 54",
    "SourceOfBusiness": "sample string 55",
    "StateCode": "sample string 56",
    "Status": "sample string 57",
    "Taxes": 58.0,
    "TelephoneNumber": "sample string 59",
    "TimeofCheckOut": "sample string 60",
    "Title": "sample string 61",
    "TotalRevenue": 62.0,
    "TotalRevenueWithoutTaxes": 63.0,
    "TravelAgent": "sample string 64",
    "TravelAgentEmailAddress": "sample string 65",
    "TravelAgentFaxNumber": "sample string 66",
    "TravelAgentIATA": "sample string 67",
    "VIP": true,
    "VIPCode": "sample string 69",
    "ZipCode": "sample string 70",
    "VehicleLicensePlate": "sample string 71",
    "VehicleMake": "sample string 72",
    "VehicleModel": "sample string 73",
    "VehicleColor": "sample string 74",
    "GroupId": "sample string 75",
    "GroupName": "sample string 76",
    "CorporateId": "sample string 77",
    "CorporateName": "sample string 78",
    "WholeSalerId": "sample string 79",
    "WholeSalerName": "sample string 80"
  }
]

application/xml, text/xml

Sample:
<ArrayOfReservationGuestProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <ReservationGuestProfile>
    <AcceptGeneralEmail>sample string 1</AcceptGeneralEmail>
    <AddressLine1>sample string 2</AddressLine1>
    <AddressLine2>sample string 3</AddressLine2>
    <ArrivalDate>sample string 4</ArrivalDate>
    <AvailableCredit>5</AvailableCredit>
    <BookingNumber>sample string 6</BookingNumber>
    <CancellationNumber>1</CancellationNumber>
    <Cell1>sample string 7</Cell1>
    <Cell2>sample string 8</Cell2>
    <CentralReservationNumber>sample string 9</CentralReservationNumber>
    <City>sample string 10</City>
    <CompRate>sample string 14</CompRate>
    <CompanyEmailAddress>sample string 11</CompanyEmailAddress>
    <CompanyFaxNumber>sample string 12</CompanyFaxNumber>
    <CompanyName>sample string 13</CompanyName>
    <Contact>sample string 15</Contact>
    <ContactEmailAddress>sample string 16</ContactEmailAddress>
    <ContactFaxNumber>sample string 17</ContactFaxNumber>
    <CorporateId>sample string 77</CorporateId>
    <CorporateName>sample string 78</CorporateName>
    <CountryCode>sample string 18</CountryCode>
    <DepartureDate>sample string 19</DepartureDate>
    <DepositPaid>20</DepositPaid>
    <EmailAddress>sample string 21</EmailAddress>
    <FirstName>sample string 22</FirstName>
    <FolioNumber>23</FolioNumber>
    <GroupId>sample string 75</GroupId>
    <GroupName>sample string 76</GroupName>
    <GuestId>sample string 24</GuestId>
    <GuestType>sample string 25</GuestType>
    <IsGuestTaxExempt>true</IsGuestTaxExempt>
    <JoinLoyalty>27</JoinLoyalty>
    <LastName>sample string 28</LastName>
    <LastUpdateDate>sample string 29</LastUpdateDate>
    <LoyaltyNumber>sample string 30</LoyaltyNumber>
    <MailToFlag>true</MailToFlag>
    <MarketingCode>sample string 32</MarketingCode>
    <MarketingOptIn>sample string 33</MarketingOptIn>
    <MiddleInitial>sample string 34</MiddleInitial>
    <NumberOfActualNights>35.1</NumberOfActualNights>
    <NumberOfAdults>36</NumberOfAdults>
    <NumberOfChildren>37</NumberOfChildren>
    <NumberOfNights>38</NumberOfNights>
    <OtherRevenue>39</OtherRevenue>
    <PackageCode>sample string 40</PackageCode>
    <PaymentType>sample string 41</PaymentType>
    <Phone1>sample string 42</Phone1>
    <Phone2>sample string 43</Phone2>
    <PreferredContactMethod>sample string 44</PreferredContactMethod>
    <PromoCode>sample string 45</PromoCode>
    <PropertyCode>sample string 46</PropertyCode>
    <RateCode>sample string 47</RateCode>
    <RecordType>sample string 48</RecordType>
    <ReservationDate>sample string 49</ReservationDate>
    <ReservationRates />
    <ReservationServices />
    <ReservationUniqueIDs />
    <ResortFee>50</ResortFee>
    <RoomNumber>sample string 51</RoomNumber>
    <RoomRate>52</RoomRate>
    <RoomRevenue>53</RoomRevenue>
    <RoomTypeCode>sample string 54</RoomTypeCode>
    <SourceOfBusiness>sample string 55</SourceOfBusiness>
    <StateCode>sample string 56</StateCode>
    <Status>sample string 57</Status>
    <Taxes>58</Taxes>
    <TelephoneNumber>sample string 59</TelephoneNumber>
    <TimeofCheckOut>sample string 60</TimeofCheckOut>
    <Title>sample string 61</Title>
    <TotalRevenue>62</TotalRevenue>
    <TotalRevenueWithoutTaxes>63</TotalRevenueWithoutTaxes>
    <TravelAgent>sample string 64</TravelAgent>
    <TravelAgentEmailAddress>sample string 65</TravelAgentEmailAddress>
    <TravelAgentFaxNumber>sample string 66</TravelAgentFaxNumber>
    <TravelAgentIATA>sample string 67</TravelAgentIATA>
    <VIP>true</VIP>
    <VIPCode>sample string 69</VIPCode>
    <VehicleColor>sample string 74</VehicleColor>
    <VehicleLicensePlate>sample string 71</VehicleLicensePlate>
    <VehicleMake>sample string 72</VehicleMake>
    <VehicleModel>sample string 73</VehicleModel>
    <WholeSalerId>sample string 79</WholeSalerId>
    <WholeSalerName>sample string 80</WholeSalerName>
    <ZipCode>sample string 70</ZipCode>
  </ReservationGuestProfile>
  <ReservationGuestProfile>
    <AcceptGeneralEmail>sample string 1</AcceptGeneralEmail>
    <AddressLine1>sample string 2</AddressLine1>
    <AddressLine2>sample string 3</AddressLine2>
    <ArrivalDate>sample string 4</ArrivalDate>
    <AvailableCredit>5</AvailableCredit>
    <BookingNumber>sample string 6</BookingNumber>
    <CancellationNumber>1</CancellationNumber>
    <Cell1>sample string 7</Cell1>
    <Cell2>sample string 8</Cell2>
    <CentralReservationNumber>sample string 9</CentralReservationNumber>
    <City>sample string 10</City>
    <CompRate>sample string 14</CompRate>
    <CompanyEmailAddress>sample string 11</CompanyEmailAddress>
    <CompanyFaxNumber>sample string 12</CompanyFaxNumber>
    <CompanyName>sample string 13</CompanyName>
    <Contact>sample string 15</Contact>
    <ContactEmailAddress>sample string 16</ContactEmailAddress>
    <ContactFaxNumber>sample string 17</ContactFaxNumber>
    <CorporateId>sample string 77</CorporateId>
    <CorporateName>sample string 78</CorporateName>
    <CountryCode>sample string 18</CountryCode>
    <DepartureDate>sample string 19</DepartureDate>
    <DepositPaid>20</DepositPaid>
    <EmailAddress>sample string 21</EmailAddress>
    <FirstName>sample string 22</FirstName>
    <FolioNumber>23</FolioNumber>
    <GroupId>sample string 75</GroupId>
    <GroupName>sample string 76</GroupName>
    <GuestId>sample string 24</GuestId>
    <GuestType>sample string 25</GuestType>
    <IsGuestTaxExempt>true</IsGuestTaxExempt>
    <JoinLoyalty>27</JoinLoyalty>
    <LastName>sample string 28</LastName>
    <LastUpdateDate>sample string 29</LastUpdateDate>
    <LoyaltyNumber>sample string 30</LoyaltyNumber>
    <MailToFlag>true</MailToFlag>
    <MarketingCode>sample string 32</MarketingCode>
    <MarketingOptIn>sample string 33</MarketingOptIn>
    <MiddleInitial>sample string 34</MiddleInitial>
    <NumberOfActualNights>35.1</NumberOfActualNights>
    <NumberOfAdults>36</NumberOfAdults>
    <NumberOfChildren>37</NumberOfChildren>
    <NumberOfNights>38</NumberOfNights>
    <OtherRevenue>39</OtherRevenue>
    <PackageCode>sample string 40</PackageCode>
    <PaymentType>sample string 41</PaymentType>
    <Phone1>sample string 42</Phone1>
    <Phone2>sample string 43</Phone2>
    <PreferredContactMethod>sample string 44</PreferredContactMethod>
    <PromoCode>sample string 45</PromoCode>
    <PropertyCode>sample string 46</PropertyCode>
    <RateCode>sample string 47</RateCode>
    <RecordType>sample string 48</RecordType>
    <ReservationDate>sample string 49</ReservationDate>
    <ReservationRates />
    <ReservationServices />
    <ReservationUniqueIDs />
    <ResortFee>50</ResortFee>
    <RoomNumber>sample string 51</RoomNumber>
    <RoomRate>52</RoomRate>
    <RoomRevenue>53</RoomRevenue>
    <RoomTypeCode>sample string 54</RoomTypeCode>
    <SourceOfBusiness>sample string 55</SourceOfBusiness>
    <StateCode>sample string 56</StateCode>
    <Status>sample string 57</Status>
    <Taxes>58</Taxes>
    <TelephoneNumber>sample string 59</TelephoneNumber>
    <TimeofCheckOut>sample string 60</TimeofCheckOut>
    <Title>sample string 61</Title>
    <TotalRevenue>62</TotalRevenue>
    <TotalRevenueWithoutTaxes>63</TotalRevenueWithoutTaxes>
    <TravelAgent>sample string 64</TravelAgent>
    <TravelAgentEmailAddress>sample string 65</TravelAgentEmailAddress>
    <TravelAgentFaxNumber>sample string 66</TravelAgentFaxNumber>
    <TravelAgentIATA>sample string 67</TravelAgentIATA>
    <VIP>true</VIP>
    <VIPCode>sample string 69</VIPCode>
    <VehicleColor>sample string 74</VehicleColor>
    <VehicleLicensePlate>sample string 71</VehicleLicensePlate>
    <VehicleMake>sample string 72</VehicleMake>
    <VehicleModel>sample string 73</VehicleModel>
    <WholeSalerId>sample string 79</WholeSalerId>
    <WholeSalerName>sample string 80</WholeSalerName>
    <ZipCode>sample string 70</ZipCode>
  </ReservationGuestProfile>
</ArrayOfReservationGuestProfile>