ReferenceAvailability and Rates API

Response

The Availability and Rates response message (AR RS) is returned synchronously and allows Expedia Group to update the property’s system with the status of the Availability and Rates request (AR RQ). The status can either be Success or Error. If successful, it can contain a warning.

Note: Success messages may include warnings that require your action. You need to monitor these warnings and make any necessary corrections to the availability and rates request parameters.
Availability and Rates API response schema overview

AR RS XML MESSAGE

AvailRateUpdateRS element

The <AvailRateUpdateRS> element is the root container for fields passed from Expedia Group to the partner to indicate whether or not the availability and rates updates submitted with the Availability and Rates request (AR RQ) have been successful or not. <AvailRateUpdateRS> is the root element, and it requires the xmlns attribute, which is the namespace to which this message belongs. This namespace is used to validate the version of the schema the message is based on. Current namespace for requests is http://www.expediaconnect.com/EQC/AR/2007/02.

For response messages with errors returned, see the Error messaging section for full details.

Syntax

1<?xml version="1.0" encoding="UTF-8"?>
2<AvailRateUpdateRS xmlns=" http://www.expediaconnect.com/EQC/AR/2007/02 ">
3 <Success />
4</AvailRateUpdateRS>

Child elements

Name

Description

<Success>

Element appears if the request to update availability and rates was successful. The node will be empty. Not everything from the request was successfully processed if warnings are also returned.

If this element is present, the <Error> element cannot be present.

<Warning>

This element appears in the Availability and Rates response if the update request was successfully received by Expedia Group, but the update request could only be partially applied. Example: if one of the rates provided violates the rate verification threshold, that specific rate will not be applied, but the rest of the updates will be successful.

Each warning code may be repeated up to 20 times. Warning text may be up to 1024 characters per warning.

All warning scenarios are described in Availability and Rates Response Business Warnings

Attributes:

  • code- Code for the warning. Data type: integer, between 7,000 and 8,000.
Examples

This section contains sample messages illustrating Availability and Rates responses.

Success

The following is a sample success response message.

1<?xml version="1.0" encoding="UTF-8"?>
2<!--Success message for AR update request-->
3<AvailRateUpdateRS xmlns="http://www.expediaconnect.com/EQC/AR/2007/02">
4 <Success/>
5</AvailRateUpdateRS>
Success with warning

The following is a sample success request/response pair with a list of warnings returned in the response due to the Availability and Rates request message containing rates that violate our Rate Verification logic. Note that in this example, the restriction and rate change indicator updates would be successfully applied, and the rate updates where rates equal 71 and 61 EUR respectively would also be successful. Only the rates equal to 0.00 EUR are ignored/refused/not processed.

Request:

1<?xml version="1.0" encoding="UTF-8"?>
2<!--Sample AR request message:updating rates and restrictions, triggering warnings in the response, for August 2012-->
3<AvailRateUpdateRQ xmlns="http://www.expediaconnect.com/EQC/AR/2011/06">
4 <Authentication username="testuser" password="testpass"/>
5 <Hotel id="4223"/>
6 <AvailRateUpdate>
7 <DateRange from="2019-08-01" to="2019-08-05"/>
8 <RoomType id="32241">
9 <RatePlan id="23123">
10 <Rate currency="EUR">
11 <PerDay rate="0.00"/>
12 </Rate>
13 <Restrictions closedToArrival="false" closedToDeparture="true"/>
14 </RatePlan>
15 <RatePlan id="52333">
16 <Rate currency="EUR">
17 <PerDay rate="0.00"/>
18 </Rate>
19 <Restrictions closedToArrival="false" closedToDeparture="true"/>
20 </RatePlan>
21 </RoomType>
22 </AvailRateUpdate>
23 <AvailRateUpdate>
24 <DateRange from="2019-08-06" to="2019-08-15"/>
25 <RoomType id="32241">
26 <RatePlan id="23123">
27 <Rate currency="EUR" rateChangeIndicator="true">
28 <PerDay rate="71.00"/>
29 </Rate>
30 </RatePlan>
31 <RatePlan id="52333">
32 <Rate currency="EUR" rateChangeIndicator="true">
33 <PerDay rate="61.00"/>
34 </Rate>
35 </RatePlan>
36 </RoomType>
37 </AvailRateUpdate>
38</AvailRateUpdateRQ>

Response:

1<?xml version="1.0" encoding="UTF-8"?>
2<!--AR Success message with warning due to rates failing our Rate Verification logic-->
3<AvailRateUpdateRS xmlns="http://www.expediaconnect.com/EQC/AR/2007/02">
4 <Success>
5 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 23123; Stay Date 2019-08-01] One or more costs provided are out of threshold for an identified room type.</Warning>
6 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 23123; Stay Date 2019-08-02] One or more costs provided are out of threshold for an identified room type.</Warning>
7 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 23123; Stay Date 2019-08-03] One or more costs provided are out of threshold for an identified room type.</Warning>
8 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 23123; Stay Date 2019-08-04] One or more costs provided are out of threshold for an identified room type.</Warning>
9 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 23123; Stay Date 2019-08-05] One or more costs provided are out of threshold for an identified room type.</Warning>
10 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 52333; Stay Date 2019-08-01] One or more costs provided are out of threshold for an identified room type.</Warning>
11 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 52333; Stay Date 2019-08-02] One or more costs provided are out of threshold for an identified room type.</Warning>
12 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 52333; Stay Date 2019-08-03] One or more costs provided are out of threshold for an identified room type.</Warning>
13 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 52333; Stay Date 2019-08-04] One or more costs provided are out of threshold for an identified room type.</Warning>
14 <Warning code="7013">[Room Type ID 32241; Rate Plan ID 52333; Stay Date 2019-08-05] One or more costs provided are out of threshold for an identified room type.</Warning>
15 </Success>
16</AvailRateUpdateRS>

Please note that when Availability and Rates requests generate more than 20 different warnings per warning code, the Availability and Rates response will only contain the first twenty.