Requests
Syntax
TheTransaction (Property Data)
message uses the following syntax:
<?xml version="1.0" encoding="UTF-8"?> <Transaction timestamp="timestamp" id="message_ID" partner="partner_key"> <PropertyDataSet action="[overlay|delta]"> <!-- (Required) ID that matches the Hotel List Feed --> <Property>HotelID</Property> <RoomData> <!-- (Required) One room ID per RoomData element --> <RoomID>RoomID</RoomID> <Name> <Text text="room_name" language="language_code"/> </Name> <Description> <Text text="room_description" language="language_code"/> </Description> <!-- (Optional) Restricts the rate plans allowed for this room type to those listed here. If specified, don't specify AllowableRoomIDs. --> <AllowablePackageIDs> <AllowablePackageID>PackageID</AllowablePackageID> </AllowablePackageIDs> <Capacity>max_number_of_occupants</Capacity> <AdultCapacity>max_number_of_adult_occupants</AdultCapacity> <ChildCapacity>max_number_of_child_occupants</ChildCapacity> <OccupancySettings> <MinOccupancy>min_number_of_occupants</MinOccupancy> <MinAge>min_age_of_occupants</MinAge> </OccupancySettings> <PhotoURL> <Caption> <Text text="photo_description" language="language_code"/> </Caption> <URL>photo_location</URL> </PhotoURL> </RoomData> <PackageData> <!-- (Required) One package ID per PackageData element --> <PackageID>PackageID</PackageID> <Name> <Text text="package_name" language="language_code"/> </Name> <Description> <Text text="package_description" language="language_code"/> </Description> <!-- (Optional) Restricts the room types allowed for this rate plan to those listed here. If specified, don't specify AllowablePackageIDs. --> <AllowableRoomIDs> <AllowableRoomID>RoomID</AllowableRoomID> </AllowableRoomIDs> <Refundable available="[false|true]" refundable_until_days=" number_of_days" refundable_until_time="time"/> <!-- For these next 3 elements, boolean_value can be 0/1 or true/false --> <BreakfastIncluded>boolean_value</BreakfastIncluded> <InternetIncluded>boolean_value</InternetIncluded> <ParkingIncluded>boolean_value</ParkingIncluded> </PackageData> </PropertyDataSet> </Transaction>
Elements & Attributes
The Transaction (Property Data) message has the following elements and attributes:Element / @Attribute | Occurrences | Type | Description |
---|---|---|---|
Transaction | 1 | Complex element | In an ARI implementation, this is the root element for a message defining room types and packages for a single property. |
Transaction / @timestamp | 1 | DateTime | The creation date and time of this message. |
Transaction / @id | 1 | String | A unique identifier for this request message. This value is returned in the response message. Allowed characters are a-z, A-Z, 0-9, _ (underscore), and - (dash). |
Transaction / @partner | 1 | String | The partner account for this message. This string value is the
"Partner key" value listed on
the
Account settings page in Hotel Center.
Note: If you have a backend that provides feeds for
multiple accounts, this value needs to match the |
Transaction / PropertyDataSet | 1..n | PropertyDataSet | A container for defining room types and packages for a single property. |
Transaction / PropertyDataSet / @action | 0..1 | Enum | The type of update to apply to room rate definitions. Valid values are:
This attribute is optional and defaults to |
Transaction / PropertyDataSet / Property | 1 | String | The unique identifier for the property. This value must match the
Hotel ID specified using
<id> in the <listing> element
in the Hotel List Feed. The Hotel ID is also listed in Hotel Center. |
Transaction / PropertyDataSet / RoomData | 0..n | RoomData | Describes a room. Note: At least one of |
Transaction / PropertyDataSet / RoomData / RoomID | 1 | RoomID | A unique identifier for a type of room. This value is referenced using
the InvTypeCode attribute in the
<StatusApplicationControl> element in
<OTA_HotelAvailNotifRQ> and
<OTA_HotelRateAmountNotifRQ> messages. |
Transaction / PropertyDataSet / RoomData / Name | 1 | Name | Container for the name of the category of room in one or more languages. |
Transaction / PropertyDataSet / RoomData / Name / Text | 1..n | Text | Specifies the name of the category of room in one language. |
Transaction / PropertyDataSet / RoomData / Name / Text / @text | 1..n | String | The name of the category of room in the language specified by the
language attribute. |
Transaction / PropertyDataSet / RoomData / Description | 1 | Name | Container for the description of the category of room in one or more languages. |
Transaction / PropertyDataSet / RoomData / Description / Text | 1..n | Text | Specifies the description of the category of room in one language. |
Transaction / PropertyDataSet / RoomData / Description / Text / @text | 1..n | String | The description of the category of room in the language specified by the
language attribute. |
Transaction / PropertyDataSet / RoomData / Description / Text / @language | 1..n | String | A two-letter language code. |
Transaction / PropertyDataSet / RoomData / AllowablePackageIDs | 0..1 | AllowablePackageIDs | A container for <AllowablePackageID> elements.
If If |
Transaction / PropertyDataSet / RoomData / AllowablePackageIDs / AllowablePackageID | 1..n | AllowablePackageID | Specifies the PackageID of a rate plan that can be combined with this
room type. A rate plan is defined by a combination of
package, rates, and availability. The PackageID
corresponds to the RatePlanCode in the
OTA_HotelRateAmountNotifRQ and OTA_HotelAvailNotifRQ messages.
|
Transaction / PropertyDataSet / RoomData / Capacity | 0..1 | Integer | The maximum number of adults and children that a room can
physically accommodate. This should be greater than or equal to
any NumberOfGuests values that you send with rates.
The value of |
Transaction / PropertyDataSet / RoomData / AdultCapacity | 0..1 | Integer | The maximum number of adults that a room can physically
accommodate. This should be greater than or equal to any
NumberOfGuests values that you send with rates. This
value is only used in conjunction with
ExtraGuestCharges.
The value of |
Transaction / PropertyDataSet / RoomData / ChildCapacity | 0..1 | Integer | The maximum number of children that a room can physically
accommodate. This value is only used in conjunction with
ExtraGuestCharges.
The value of |
Transaction / PropertyDataSet / RoomData / OccupancySettings | 0..1 | OccupancySettings | Settings which can restrict or modify the occupancy requirements of a
room.
The
<OccupancySettings> <MinOccupancy>2</MinOccupancy> <MinAge>16</MinAge> </OccupancySettings> Not all child elements need to be included. |
Transaction / PropertyDataSet / RoomData / PhotoURL | 0..n | PhotoURL | A URL and optional caption for a photo of the given room or
Room Bundle. You can specify more than one <PhotoURL>
for a room or Room Bundle.
This element takes the following child elements:
<PhotoURL> <URL>http://www.foo.com/static/bar/image1234.jpg</URL> <Caption> <Text text="A bright and breezy way to enjoy your mornin' cuppa tea." language="en"/> <Text text="Une façon lumineuse et aérée pour profiter de votre journée tasse de thé." language="fr"/> </Caption> </PhotoURL> |
Transaction / PropertyDataSet / PackageData | 0..n | PackageData | Container for elements that describe rate features and terms that aren't part of the physical room description. Note: At least one of |
Transaction / PropertyDataSet / PackageData / PackageID | 1 | String | PackageID in these messages corresponds to the
RatePlanCode in the OTA_HotelRateAmountNotifRQ and
OTA_HotelAvailNotifRQ messages. |
Transaction / PropertyDataSet / PackageData / Name | 1 | Name | Container for the name of the category of package in one or more languages. |
Transaction / PropertyDataSet / PackageData / Name / Text | 1..n | Text | Specifies the name of the category of package in one language. |
Transaction / PropertyDataSet / PackageData / Name / Text / @text | 1..n | String | The name of the category of package in the language specified by the
language attribute. |
Transaction / PropertyDataSet / PackageData / Description | 1 | Name | Container for the description of the category of package in one or more languages. |
Transaction / PropertyDataSet / PackageData / Description / Text | 1..n | Text | Specifies the description of the category of package in one language. |
Transaction / PropertyDataSet / PackageData / Description / Text / @text | 1..n | String | The description of the category of package in the language specified by the
language attribute. |
Transaction / PropertyDataSet / PackageData / Description / Text / @language | 1..n | String | A two-letter language code. |
Transaction / PropertyDataSet / PackageData / AllowableRoomIDs | 0..1 | AllowableRoomIDs | A container for <AllowableRoomID> elements.
If If |
Transaction / PropertyDataSet / PackageData / AllowableRoomIDs / AllowableRoomID | 1..n | AllowableRoomID | Specifies the RoomID of a room type that can be combined with this
rate plan. A room type is defined in a <RoomData>
element.
|
Transaction / PropertyDataSet / PackageData / Refundable | 0..1 | Refundable | Enables listing a rate as being fully refundable or providing a free
cancellation. If not provided, no information about a refund is displayed.
Note: We recommend setting all of the attributes. A feed status warning message is generated when one or more attributes are not set. If you do not set any attributes, the rate does not display as refundable. When setting the attributes, note the following:
|
Transaction / PropertyDataSet / PackageData / Refundable / @available | 1 | Boolean | (Required) Set to 1 or
true to indicate if the rate allows a full
refund; otherwise set to 0 or false . |
Transaction / PropertyDataSet / PackageData / Refundable / @refundable_until_days | 0..1 | Integer | (Required if
available is true ) Specifies
the number of days in advance of check-in that a full refund can be
requested. The value of refundable_until_days
must be an integer between 0 and 330, inclusive. |
Transaction / PropertyDataSet / PackageData / Refundable / @refundable_until_time | 0..1 | Time | (Highly recommended if
available is true ) Specifies
the latest time of day, in the local time of the hotel, that a full
refund request will be honored. This can be combined with
refundable_until_days to specify, for
example, that "refunds are available until 4:00PM two days before
check-in". If refundable_until_time isn't set, the value
defaults to midnight. |
Transaction / PropertyDataSet / PackageData / BreakfastIncluded | 0..1 | Boolean | Specifies whether this room type includes breakfast.
Valid values are |
Transaction / PropertyDataSet / PackageData / InternetIncluded | 0..1 | Boolean | If the room includes internet access at no charge, while other rooms
don't include this amenity. Don't set this element in a hotel that
provides free internet to all rooms. This element doesn't apply to
in-room wired internet or wireless internet that is not available in
guest rooms. Valid values are 0 (or false )
and 1 (or true ).
|
Transaction / PropertyDataSet / PackageData / ParkingIncluded | 0..1 | Boolean | Whether a room includes parking at no charge, where
parking would otherwise be a paid service at this hotel. Do not specify
a value for this element for a hotel that offers free parking.
Valid values are 0 (or false ) and
1 (or true ). The default value is
false .
|
Examples
Example 1
The following is a basic example of how to define a property's room and
package data in a Transaction (Property Data) message. The
overlay
attribute is used to ensure that, if any data
unexpectedly exists already, all existing data is deleted and replaced
with the data in this message:
<?xml version="1.0" encoding="UTF-8"?> <Transaction timestamp="2020-05-18T16:20:00-04:00" id="12345678" partner="partner_key"> <PropertyDataSet action="overlay"> <Property>Property_1</Property> <RoomData> <RoomID>RoomID_1</RoomID> <Name> <Text text="King" language="en"/> </Name> <Description> <Text text="Room with a king bed" language="en"/> </Description> <Capacity>2</Capacity> <PhotoURL> <URL>http://www.foo.com/static/bar/image.jpg</URL> <Caption> <Text text="Room with a king bed" language="en"/> </Caption> </PhotoURL> </RoomData> <RoomData> <RoomID>RoomID_2</RoomID> <Name> <Text text="Double" language="en"/> </Name> <!-- Additional RoomData child elements omitted. --> </RoomData> <PackageData> <PackageID>PackageID_1</PackageID> <Name> <Text text="Standard" language="en"/> </Name> <Description> <Text text="Standard rate" language="en"/> </Description> <Refundable available="true" refundable_until_days="7" refundable_until_time="18:00:00"/> <BreakfastIncluded>0</BreakfastIncluded> </PackageData> <PackageData> <PackageID>PackageID_2</PackageID> <Name> <Text text="Free Breakfast" language="en"/> </Name> <Description> <Text text="Free breakfast rate" language="en"/> </Description> <Refundable available="true" refundable_until_days="7" refundable_until_time="18:00:00"/> <BreakfastIncluded>1</BreakfastIncluded> </PackageData> </PropertyDataSet> </Transaction>
Example 2
The following is an example of how to add a room type and package to
existing <Transaction>
data:
<?xml version="1.0" encoding="UTF-8"?> <Transaction timestamp="2020-07-18T16:20:00-04:00" id="12345678" partner="partner_key"> <PropertyDataSet action="delta"> <Property>Property_1</Property> <RoomData> <RoomID>RoomID_3</RoomID> <Name> <Text text="Queen" language="en"/> </Name> <!-- Additional RoomData child elements omitted. --> </RoomData> <PackageData> <PackageID>PackageID_3</PackageID> <Name> <Text text="Non-Refundable" language="en"/> </Name> <!-- Additional PackageData child elements omitted. --> <Refundable available="false"/> </PackageData> </PropertyDataSet> </Transaction>
Example 3
The following is an example of how to remove existing room types and packages. In this scenario, if the messages in Example 1 and Example 2 had been sent to Google previously, the King and Double room types would no longer exist once Google receives the message shown below. Note that removing package data affects the overall rate plan as defined across Transaction (Property Data), OTA_HotelRateAmountNotifRQ, and OTA_HotelAvailNotifRQ messages (by referencing the same PackageID value), and thus corresponding updates using the other message types may be required to reflect that PackageID_2 and PackageID_3 are no longer defined here.
<?xml version="1.0" encoding="UTF-8"?> <Transaction timestamp="2020-08-18T16:20:00-04:00" id="12345678" partner="partner_key"> <PropertyDataSet action="overlay"> <Property>Property_1</Property> <RoomData> <RoomID>RoomID_1</RoomID> <Name> <Text text="Queen" language="en"/> </Name> <!-- Additional RoomData child elements omitted. --> <Capacity>2</Capacity> <PhotoURL> <URL>http://www.foo.com/static/bar/image.jpg</URL> <Caption> <Text text="Room with a queen bed" language="en"/> </Caption> </PhotoURL> </RoomData> <PackageData> <PackageID>PackageID_1</PackageID> <Name> <Text text="Refundable" language="en"/> </Name> <!-- Additional PackageData child elements omitted. --> <Refundable available="true" refundable_until_days="7" refundable_until_time="18:00:00"/> <BreakfastIncluded>0</BreakfastIncluded> </PackageData> </PropertyDataSet> </Transaction>
Example 4
The following is an example of how to use the
<AllowablePackageIDs>
element to restrict the rate
plans allowed for a room type. In this example, the Queen room type
(RoomID_2) can only be combined with the package and rate plan
identified as PackageID_1.
<?xml version="1.0" encoding="UTF-8"?> <Transaction timestamp="2020-12-18T16:20:00-04:00" id="12345678" partner="partner_key"> <PropertyDataSet action="overlay"> <Property>Property_1</Property> <RoomData> <RoomID>RoomID_1</RoomID> <Name> <Text text="King" language="en"/> </Name> <!-- Additional RoomData child elements omitted. --> </RoomData> <RoomData> <RoomID>RoomID_2</RoomID> <Name> <Text text="Queen" language="en"/> </Name> <AllowablePackageIDs> <AllowablePackageID>PackageID_1</AllowablePackageID> </AllowablePackageIDs> <!-- Additional RoomData child elements omitted. --> </RoomData> <PackageData> <PackageID>PackageID_1</PackageID> <Name> <Text text="Standard" language="en"/> </Name> <!-- Additional PackageData child elements omitted. --> <Refundable available="true" refundable_until_days="7" refundable_until_time="18:00:00"/> <BreakfastIncluded>0</BreakfastIncluded> </PackageData> <PackageData> <PackageID>PackageID_2</PackageID> <Name> <Text text="Free Breakfast" language="en"/> </Name> <!-- Additional PackageData child elements omitted. --> <Refundable available="true" refundable_until_days="7" refundable_until_time="18:00:00"/> <BreakfastIncluded>1</BreakfastIncluded> </PackageData> </PropertyDataSet> </Transaction>
Example 5
The following is an example of how to use the
<Capacity>
, <AdultCapacity>
,
<ChildCapacity>
elements to set restrictions on room
capacities.
<?xml version="1.0" encoding="UTF-8"?> <Transaction timestamp="2020-12-18T16:20:00-04:00" id="12345678" partner="partner_key"> <PropertyDataSet action="overlay"> <Property>Property_1</Property> <RoomData> <RoomID>RoomID_1</RoomID> <Name> <Text text="Double" language="en"/> </Name> <Capacity>4</Capacity> <AdultCapacity>4</AdultCapacity> <ChildCapacity>3</ChildCapacity> <!-- Additional RoomData child elements omitted. --> </RoomData> </PropertyDataSet> </Transaction>
The Double room type (RoomID_1) may have up to 4 guests total. Additionally, it may have up to 4 adults and up to 3 children. All three capacity requirements must be satisfied in order for this room to be bookable. This configuration is representative of a typical room with two beds that each fit two people. The child capacity is one less than the total capacity because the room must have at least one adult present.
Responses
Syntax
TheTransactionResponse (Property Data)
message uses the following syntax:
<?xml version="1.0" encoding="UTF-8"?> <TransactionResponse timestamp="timestamp" id="message_ID" partner="partner_key"> <!-- Either Success or Issues will be populated. --> <Success/> <Issues> <Issue code="issue_code" status="issue_type">issue_description</Issue> </Issues> </TransactionResponse>
Elements & Attributes
TheTransactionResponse (Property Data)
message has the following
elements and attributes:
Element / @Attribute | Occurrences | Type | Description |
---|---|---|---|
TransactionResponse | 1 | Complex element | The root element indicating the success or issues for a received Transaction request message. |
TransactionResponse / @timestamp | 1 | DateTime | The creation date and time of this message. |
TransactionResponse / @id | 1 | String | The unique identifier from the associated Transaction message. |
TransactionResponse / @partner | 1 | String | The partner account for this message. |
TransactionResponse / Success | 0..1 | Success | Indicates that the Transaction message was processed successfully
without warnings, errors, or failures.
Either |
TransactionResponse / Issues | 0..1 | Issues | A container for one or more issues encountered while processing the
Transaction message.
Either |
TransactionResponse / Issues / Issue | 1..n | Issue | The description of a warning, error, or failure encountered while processing the Transaction message. Details on these issues can be found in Feed Status Error Messages. |
TransactionResponse / Issues / Issue / @code | 1 | Integer | The identifier for the issue. |
TransactionResponse / Issues / Issue / @status | 1 | Enum | The type of issue encountered. Valid values are warning, error, and failure. |
Examples
Success
The following is a response to a successfully processed Transaction message.
<?xml version="1.0" encoding="UTF-8"?> <TransactionResponse timestamp="2020-05-18T16:20:00-04:00" id="12345678" partner="partner_key"> <Success/> </TransactionResponse>
Issues
The following is a response to a Transaction message not processed due to errors.
<?xml version="1.0" encoding="UTF-8"?> <TransactionResponse timestamp="2020-05-18T16:20:00-04:00" id="12345678" partner="partner_key"> <Issues> <Issue code="1001" status="error">Example</Issue> </Issues> </TransactionResponse>