1. Overview

The API allows Agoda’s connectivity partners to create new properties and update existing properties.

  • It has support for both Hotel and Non-Hotel (Vacation rental) properties.

  • Presently it supports textual content in English language only. Text in other languages will be ignored. The content added in English will be translated into multiple languages.

  • Field types:

    • required: must always be sent, this is required to make the property sellable.

    • optional:

      • Unless otherwise specified, all fields are overwritten. When no value is sent, this disables the function and in some instances applies a default e.g. if a particular Service is not provided in the request, it is assumed that this service is not offered, and if MinLengthOfStay/MaxLengthOfStay is not provided, then a default of '-1' i.e. no limit will be set.

      • Where a field is indicated as (Overlay): If no value is sent, no update will be made and existing data will be retained e.g. NumberOfBathroom or MaxChildrenInRoom.

  • For Direct Connects:

    • If the contract configuration is on Supplier level then contract sign flow is not required. Please avoid following paths:

      • Get Contract

      • Sign Contract

      • Get Host Contracts

      • Sign Host Contract

    • FeePolicies will not be created or updated via Content API. It can only created or updated via ELMO tool.

  • For RatePlan:

    • Typically, in the Agoda system, the Name in Description of the RatePlan is combined with the RatePlanID given by our partners prior to saving. For example:

    • RatePlanID: "RP000001"

    • Description: "Special Rate"

    • Description save in Agoda System: "(RP000001) Special Rate"

    • Description while fetch by partner from Agoda System: "(RP000001) Special Rate"

    • Description while create/update: "Special Rate"

1.1. Version information

Version : 1.0.15

1.2. URI scheme

Host : content-push.agoda.com
BasePath : /
Schemes : HTTPS, HTTP

1.3. Tags

  • CodeLists

  • Contracts

  • ErrorCodes

  • Host Contracts

  • HotelProducts

  • Properties

  • PropertyInfo

  • PropertyOverallStatus

  • PropertyStatus

  • RatePlanStatus

  • RatePlans

  • RoomStatus

  • Rooms

2. Change logs

Release Date Version Change logs

2024-11-26

1.0.16

  • Add support for PartnerDsaContract in Property TPA_Extensions

2021-10-08

1.0.15

2021-07-15

1.0.14

  • Add support for the Delta (partial update) request in managing properties, rooms, and rate plans route. This is applicable for 1-many fields only. Please check the FAQ for more details.

2021-02-18

1.0.13

  • Add support for the room status in get property details response

2021-01-21

1.0.12

  • Add new endpoint to activate / deactivate / delete property’s rooms

2021-01-20

1.0.11

  • Add new endpoint to activate / deactivate / delete property’s rateplans

2021-01-08

1.0.10

  • Add support to the following fields in get property details response

  • Add Channels, GuestInfo (MinGuestAge, MaxInfantAge, MaxChildAge, ChildStayFreeTypeId, ChildStayFree, ChildAgeTo), and HotelProducts (RoomTypes, RatePlans, ValueAddInclusions, PolicyInfo) to Property TPA_Extensions

  • Add RoomConfiguration (SizeMeasurement, NumberOfBedroom, NumberOfBathroom, MinimumRate, MaximumRate, MaxChildrenInRoom, ChildrenAllowedForFree, BabyCots) to Room TPA_Extensions

  • Add Channels to RatePlan TPA_Extensions

2020-12-03

1.0.9

  • Add FAQ section

2020-11-25

1.0.8

  • Expose new endpoint for getting customer segment group list

  • Deprecate endpoint for getting customer segment list

2020-09-17

1.0.7

  • Change room information and configuration from overwrite to be overlay in room route upon update (NumberOfBathroom, NumberOfBedroom, SizeMeasurement, RoomViewCode, MaxExtraBeds, MaxInfantsInRoom, MaximumRate, MinimumRate, RackRate, and StandardRate)

  • Add support BabyCots, AllowChildrenInRoom and ChildrenAllowedForFree attributes (overlay) in RoomConfiguration

  • Deprecate attribute MaxChildrenInRoom and replace with AllowChildrenInRoom in RoomConfiguration. The value of MaxChildrenInRoom is ignored, we still keep it here for technical backward compatibility.

2020-09-09

1.0.6

  • Change child policy from overwrite to be overlay in property route upon update (MaxInfantAge, ChildAgeTo, ChildStayFree, MinGuestAge, MaxChildAge, and ChildStayFreeTypeId)

2020-07-21

1.0.5

  • Add support property’s status fields in get property details routes (PropertyIDCreated, PhotosIngested, ContractSigned, FraudCheckPassed, PropertyLived)

2020-07-13

1.0.4

  • Exposed new endpoint for getting room view list

2020-05-26

1.0.3

  • Add support for more fields in room route (RoomViewCode, MaxExtraBeds, MaxInfantsInRoom, MaxChildrenInRoom, MinimumRate, MaximumRate, RackRate, StandardRate)

2020-05-15

1.0.2

  • Exposed new endpoint for getting customer segment list

2020-04-22

1.0.1

  • Add support for more fields in property route (brandId, ChildAgeTo, InfantAge, ChildStayFree, MaxChildAge, ChildStayFreeTypeId, MinGuestAge)

2020-04-01

1.0.0

Content API will now allow you to create and modify content (Hotels and Vacation Rentals) for Agoda.

Following features are available in this version

  • Create and update new properties with multimedia support

  • Create and update new rooms with multimedia support

  • Create and update new rate-plans

  • Create Room and Rate-plan mapping using HotelProduct API

  • Fetch Property Content

  • Get Contract of the property created

  • Sign Contract for the property

  • Disable or Deactivate property

3. Security

3.1. apiKey

Type : apiKey
Name : apiKey
In : HEADER

4. Paths

4.1. Managing Properties

POST /cm/properties

Description

This section outlines the ability to create and update a property. For Overlay request, property’s address cannot be updated. If property’s location is changed, it will need to be onboarded as a new property.

Body parameter

HotelDescriptiveContent in OTA2017B format which need to be created

Name : body
Flags : required
Type : OTA_HotelDescriptiveContentNotifRQ

Responses

HTTP Code Description Schema

200

The request has been accepted for processing

OTA_HotelDescriptiveContentNotifRS

400

The request content was malformed

OTA_HotelDescriptiveContentNotifRS

401

The supplier was unauthorized

OTA_HotelDescriptiveContentNotifRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • Properties

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/properties
Request for create a hotel property
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveContentNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelDescriptiveContentNotifRQ.xsd">
  <HotelDescriptiveContents>
    <HotelDescriptiveContent BrandCode="123" ChainCode="0" CurrencyCode="USD" HotelDescriptiveContentNotifType="New" HotelName="Orlando Tropical Breeze" ID="Hotel123" LanguageCode="en-US">
      <HotelInfo>
        <CategoryCodes>
          <HotelCategory Code="34"/>
        </CategoryCodes>
        <Descriptions>
          <DescriptiveText>The Best Hotel Ever</DescriptiveText>
        </Descriptions>
        <Position Latitude="12.513994" Longitude="99.965228"/>
        <Services>
          <Service Code="5"/>
          <Service Code="367"/>
          <Service Code="79"/>
          <Service Code="52"/>
        </Services>
      </HotelInfo>
      <Policies>
        <Policy>
          <CancelPolicy>
            <CancelPenalty PolicyCode="13" Start="2019-01-01" End="2019-12-31"/>
            <CancelPenalty PolicyCode="254" Start="2020-01-01" End="2020-03-31"/>
            <CancelPenalty PolicyCode="98" Start="2020-04-01"/>
          </CancelPolicy>
          <PolicyInfo CheckInTime="14:00:00" CheckOutTime="12:00:00"/>
        </Policy>
      </Policies>
      <AffiliationInfo>
        <Awards>
          <Award Provider="HotelStarRate" Rating="3.5"/>
        </Awards>
      </AffiliationInfo>
      <MultimediaDescriptions>
        <MultimediaDescription>
          <ImageItems>
            <ImageItem>
              <ImageFormat Sort="1" Main="true">
                <URL>https://www.example.com/photo/01.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>1</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="2">
                <URL>https://www.example.com/photo/02.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>2</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="3">
                <URL>https://www.example.com/photo/03.jpg</URL>
              </ImageFormat>
            </ImageItem>
          </ImageItems>
        </MultimediaDescription>
      </MultimediaDescriptions>
      <ContactInfos>
        <ContactInfo ContactProfileType="PhysicalLocation">
          <Addresses>
            <Address Language="en-US">
              <AddressLine>213 Street Name.</AddressLine>
              <CityName>Bangkok</CityName>
              <PostalCode>10250</PostalCode>
              <CountryName>TH</CountryName>
            </Address>
          </Addresses>
        </ContactInfo>
        <ContactInfo ContactProfileType="general">
          <Names>
            <Name>
              <GivenName>John</GivenName>
              <Surname>Smith</Surname>
            </Name>
          </Names>
          <Phones>
            <Phone PhoneNumber="+123456789"/>
          </Phones>
          <Emails>
            <Email>admin@test-hotel.com</Email>
          </Emails>
        </ContactInfo>
      </ContactInfos>
      <TPA_Extensions>
        <TaxDriverSettings
          LengthOfStay="1"
          NightNumber="2"
          BedAndBreakfastFacility="true"
          CommunityOwnedHotels="false"
          AverageDailyRate="1.24"
          FacilityConstructionDate="2022-05-31"
          NewOrleansTourismSupportAssessment="true"
          CertifiedInns="true"
          LodgingRevenueThreshold="1.234"
        />
        <Channels>
          <Channel ChannelCode="1"/>
          <Channel ChannelCode="7"/>
        </Channels>
        <ChildAgeBands>
          <ChildAgeBand AgeFrom="1" AgeTo="5"/>
          <ChildAgeBand AgeFrom="6" AgeTo="10"/>
        </ChildAgeBands>
        <GuestInfo ChildAgeTo="12" ChildStayFree="true" ChildStayFreeTypeId="1" MaxChildAge="12" MaxInfantAge="2" MinGuestAge="18"/>
        <OTAReferences>
          <OTAReference ID="12345" OTAName="Booking.com"/>
        </OTAReferences>
        <PartnerDsaContract
          PartnerType="PrivateHost"
          BusinessType="Business"
          Name="Trading Name"
          Email="mail@mail.com"
          PhoneNumber="8145678943"
          AddressLine1="Address Line 1"
          AddressLine2="Address Line 2"
          CityId="19900"
          StateId="2"
          CountryId="86"
          PostalCode="10500"
          TradingLicense="ABC1234"
        />
      </TPA_Extensions>
    </HotelDescriptiveContent>
  </HotelDescriptiveContents>
</OTA_HotelDescriptiveContentNotifRQ>
Request for create a vacation rental property
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveContentNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelDescriptiveContentNotifRQ.xsd">
  <HotelDescriptiveContents>
    <HotelDescriptiveContent BrandCode="123" ChainCode="0" CurrencyCode="USD" HotelDescriptiveContentNotifType="New" HotelName="vacation rental property" ID="NHA001" LanguageCode="en-US">
      <HotelInfo>
        <CategoryCodes>
          <HotelCategory Code="29"/>
          <GuestRoomInfo Quantity="1"/>
        </CategoryCodes>
        <Descriptions>
          <DescriptiveText>The Best Vacation Rental Ever</DescriptiveText>
        </Descriptions>
        <Position Latitude="12.513994" Longitude="99.965228"/>
        <Services>
          <Service Code="5"/>
          <Service Code="367"/>
          <Service Code="79"/>
          <Service Code="52"/>
        </Services>
        <TPA_Extensions>
          <LocalRecommendations>
            <LocalRecommendation>LocalRecommendation1</LocalRecommendation>
            <LocalRecommendation>LocalRecommendation2</LocalRecommendation>
          </LocalRecommendations>
          <HouseRules>
            <HouseRule>HouseRule1</HouseRule>
            <HouseRule>HouseRule2</HouseRule>
          </HouseRules>
          <Directions>
            <Direction>Direction1</Direction>
            <Direction>Direction2</Direction>
          </Directions>
          <RentalLicense>RentalLicense123</RentalLicense>
        </TPA_Extensions>
      </HotelInfo>
      <Policies>
        <Policy>
          <CancelPolicy>
            <CancelPenalty PolicyCode="98" Start="2021-04-01"/>
          </CancelPolicy>
          <PolicyInfo CheckInTime="14:00:00" CheckOutTime="12:00:00"/>
          <FeePolicies>
            <FeePolicy Amount="1000" Code="34" DecimalPlaces="2" EffectiveDate="2020-01-01" ExpireDate="2020-12-31"/>
          </FeePolicies>
        </Policy>
      </Policies>
      <AffiliationInfo>
        <Awards>
          <Award Provider="HotelStarRate" Rating="3.5"/>
        </Awards>
      </AffiliationInfo>
      <MultimediaDescriptions>
        <MultimediaDescription>
          <ImageItems>
            <ImageItem>
              <ImageFormat Sort="1" Main="true">
                <URL>https://www.example.com/photo/01.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>1</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="2">
                <URL>https://www.example.com/photo/02.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>2</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="3">
                <URL>https://www.example.com/photo/03.jpg</URL>
              </ImageFormat>
            </ImageItem>
          </ImageItems>
        </MultimediaDescription>
      </MultimediaDescriptions>
      <ContactInfos>
        <ContactInfo ContactProfileType="PhysicalLocation">
          <Addresses>
            <Address Language="en-US">
              <AddressLine>213 Street Name.</AddressLine>
              <CityName>Bangkok</CityName>
              <PostalCode>10250</PostalCode>
              <CountryName>TH</CountryName>
            </Address>
          </Addresses>
        </ContactInfo>
        <ContactInfo ContactProfileType="general">
          <Names>
            <Name>
              <GivenName>John</GivenName>
              <Surname>Smith</Surname>
            </Name>
          </Names>
          <Phones>
            <Phone PhoneNumber="+123456789"/>
          </Phones>
          <Emails>
            <Email>admin@test-hotel.com</Email>
          </Emails>
        </ContactInfo>
      </ContactInfos>
      <TPA_Extensions>
        <TaxDriverSettings
          LengthOfStay="1"
          NightNumber="2"
          BedAndBreakfastFacility="true"
          CommunityOwnedHotels="false"
          AverageDailyRate="1.24"
          FacilityConstructionDate="2022-05-31"
          NewOrleansTourismSupportAssessment="true"
          CertifiedInns="true"
          LodgingRevenueThreshold="1.234"
        />
        <Channels>
          <Channel ChannelCode="1"/>
        </Channels>
        <ChildAgeBands>
          <ChildAgeBand AgeFrom="1" AgeTo="5"/>
          <ChildAgeBand AgeFrom="6" AgeTo="10"/>
        </ChildAgeBands>
        <GuestInfo ChildAgeTo="12" ChildStayFree="true" ChildStayFreeTypeId="1" MaxChildAge="12" MaxInfantAge="2" MinGuestAge="18"/>
        <OTAReferences>
          <OTAReference ID="12345" OTAName="Booking.com"/>
        </OTAReferences>
      </TPA_Extensions>
    </HotelDescriptiveContent>
  </HotelDescriptiveContents>
</OTA_HotelDescriptiveContentNotifRQ>
Request for partial update a hotel property
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveContentNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelDescriptiveContentNotifRQ.xsd">
  <HotelDescriptiveContents>
    <HotelDescriptiveContent HotelCode="203088969" CurrencyCode="USD" HotelDescriptiveContentNotifType="Delta" HotelName="Orlando Tropical Breeze" LanguageCode="en-US">
      <HotelInfo>
        <CategoryCodes>
          <HotelCategory Code="34"/>
        </CategoryCodes>
        <Descriptions>
          <DescriptiveText>The Best Hotel Ever with 5 stars rating</DescriptiveText>
        </Descriptions>
        <Position Latitude="12.513994" Longitude="99.965228"/>
        <Services>
          <Service Code="5" Status="Active"/>
          <Service Code="367" Status="Active"/>
          <Service Code="79" Status="Active"/>
          <Service Code="52" Status="Inactive"/>
        </Services>
      </HotelInfo>
      <Policies>
        <Policy>
          <CancelPolicy>
            <CancelPenalty PolicyCode="13" Start="2019-01-01" End="2019-12-31" Status="Active"/>
            <CancelPenalty PolicyCode="254" Start="2020-01-01" End="2020-03-31" Status="Active"/>
            <CancelPenalty PolicyCode="98" Status="Inactive"/>
          </CancelPolicy>
          <PolicyInfo CheckInTime="14:00:00" CheckOutTime="12:00:00"/>
        </Policy>
      </Policies>
      <AffiliationInfo>
        <Awards>
          <Award Provider="HotelStarRate" Rating="4.5"/>
        </Awards>
      </AffiliationInfo>
      <MultimediaDescriptions>
        <MultimediaDescription>
          <ImageItems>
            <ImageItem>
              <ImageFormat Sort="1" Main="true">
                <URL>https://www.example.com/photo/01.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>1</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="2">
                <URL>https://www.example.com/photo/02.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>2</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="3">
                <URL>https://www.example.com/photo/03.jpg</URL>
              </ImageFormat>
            </ImageItem>
          </ImageItems>
        </MultimediaDescription>
      </MultimediaDescriptions>
      <ContactInfos>
        <ContactInfo ContactProfileType="PhysicalLocation">
          <Addresses>
            <Address Language="en-US">
              <AddressLine>213 Street Name.</AddressLine>
              <CityName>Bangkok</CityName>
              <PostalCode>10250</PostalCode>
              <CountryName>TH</CountryName>
            </Address>
          </Addresses>
        </ContactInfo>
        <ContactInfo ContactProfileType="general">
          <Names>
            <Name>
              <GivenName>John</GivenName>
              <Surname>Smith</Surname>
            </Name>
          </Names>
          <Phones>
            <Phone PhoneNumber="+123456789"/>
          </Phones>
          <Emails>
            <Email>admin@test-hotel.com</Email>
          </Emails>
        </ContactInfo>
      </ContactInfos>
      <TPA_Extensions>
        <TaxDriverSettings
          LengthOfStay="1"
          NightNumber="2"
          BedAndBreakfastFacility="true"
          CommunityOwnedHotels="false"
          AverageDailyRate="1.24"
          FacilityConstructionDate="2022-05-31"
          NewOrleansTourismSupportAssessment="true"
          CertifiedInns="true"
          LodgingRevenueThreshold="1.234"
        />
        <Channels>
          <Channel ChannelCode="1" Status="Active"/>
          <Channel ChannelCode="7" Status="Inactive"/>
        </Channels>
        <ChildAgeBands>
          <ChildAgeBand AgeFrom="1" AgeTo="5" Status="Active"/>
          <ChildAgeBand AgeFrom="6" AgeTo="10" Status="Inactive"/>
        </ChildAgeBands>
        <GuestInfo ChildAgeTo="12" ChildStayFree="true" ChildStayFreeTypeId="1" MaxChildAge="12" MaxInfantAge="2" MinGuestAge="18"/>
        <OTAReferences>
          <OTAReference ID="12345" OTAName="Booking.com"/>
        </OTAReferences>
      </TPA_Extensions>
    </HotelDescriptiveContent>
  </HotelDescriptiveContents>
</OTA_HotelDescriptiveContentNotifRQ>
Request for partial update a vacation rental property
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveContentNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelDescriptiveContentNotifRQ.xsd">
  <HotelDescriptiveContents>
    <HotelDescriptiveContent HotelCode="203094262" CurrencyCode="USD" HotelDescriptiveContentNotifType="Delta" HotelName="vacation rental property" LanguageCode="en-US">
      <HotelInfo>
        <CategoryCodes>
          <HotelCategory Code="29"/>
          <GuestRoomInfo Quantity="1"/>
        </CategoryCodes>
        <Descriptions>
          <DescriptiveText>The Best Vacation Rental Ever</DescriptiveText>
        </Descriptions>
        <Position Latitude="12.513994" Longitude="99.965228"/>
        <Services>
          <Service Code="5" Status="Active"/>
          <Service Code="367" Status="Active"/>
          <Service Code="79" Status="Active"/>
          <Service Code="52" Status="Inactive"/>
        </Services>
        <TPA_Extensions>
          <LocalRecommendations>
            <LocalRecommendation>LocalRecommendation1</LocalRecommendation>
            <LocalRecommendation>LocalRecommendation2</LocalRecommendation>
          </LocalRecommendations>
          <HouseRules>
            <HouseRule>HouseRule1</HouseRule>
            <HouseRule>HouseRule2</HouseRule>
          </HouseRules>
          <Directions>
            <Direction>Direction1</Direction>
            <Direction>Direction2</Direction>
          </Directions>
          <RentalLicense>RentalLicense123</RentalLicense>
        </TPA_Extensions>
      </HotelInfo>
      <Policies>
        <Policy>
          <CancelPolicy>
            <CancelPenalty PolicyCode="13" Start="2019-01-01" End="2019-12-31" Status="Active"/>
            <CancelPenalty PolicyCode="254" Start="2020-01-01" End="2020-03-31" Status="Active"/>
            <CancelPenalty PolicyCode="98" Status="Inactive"/>
          </CancelPolicy>
          <PolicyInfo CheckInTime="14:00:00" CheckOutTime="12:00:00"/>
          <FeePolicies>
            <FeePolicy Amount="1000" Code="34" DecimalPlaces="2" EffectiveDate="2020-01-01" ExpireDate="2020-12-31"/>
          </FeePolicies>
        </Policy>
      </Policies>
      <AffiliationInfo>
        <Awards>
          <Award Provider="HotelStarRate" Rating="4.5"/>
        </Awards>
      </AffiliationInfo>
      <MultimediaDescriptions>
        <MultimediaDescription>
          <ImageItems>
            <ImageItem>
              <ImageFormat Sort="1" Main="true">
                <URL>https://www.example.com/photo/01.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>1</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="2">
                <URL>https://www.example.com/photo/02.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>2</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="3">
                <URL>https://www.example.com/photo/03.jpg</URL>
              </ImageFormat>
            </ImageItem>
          </ImageItems>
        </MultimediaDescription>
      </MultimediaDescriptions>
      <ContactInfos>
        <ContactInfo ContactProfileType="PhysicalLocation">
          <Addresses>
            <Address Language="en-US">
              <AddressLine>213 Street Name.</AddressLine>
              <CityName>Bangkok</CityName>
              <PostalCode>10250</PostalCode>
              <CountryName>TH</CountryName>
            </Address>
          </Addresses>
        </ContactInfo>
        <ContactInfo ContactProfileType="general">
          <Names>
            <Name>
              <GivenName>John</GivenName>
              <Surname>Smith</Surname>
            </Name>
          </Names>
          <Phones>
            <Phone PhoneNumber="+123456789"/>
          </Phones>
          <Emails>
            <Email>admin@test-hotel.com</Email>
          </Emails>
        </ContactInfo>
      </ContactInfos>
      <TPA_Extensions>
        <TaxDriverSettings
          LengthOfStay="1"
          NightNumber="2"
          BedAndBreakfastFacility="true"
          CommunityOwnedHotels="false"
          AverageDailyRate="1.24"
          FacilityConstructionDate="2022-05-31"
          NewOrleansTourismSupportAssessment="true"
          CertifiedInns="true"
          LodgingRevenueThreshold="1.234"
        />
        <Channels>
          <Channel ChannelCode="1" Status="Active"/>
          <Channel ChannelCode="7" Status="Inactive"/>
        </Channels>
        <ChildAgeBands>
          <ChildAgeBand AgeFrom="1" AgeTo="5" Status="Active"/>
          <ChildAgeBand AgeFrom="6" AgeTo="10" Status="Inactive"/>
        </ChildAgeBands>
        <GuestInfo ChildAgeTo="12" ChildStayFree="true" ChildStayFreeTypeId="1" MaxChildAge="12" MaxInfantAge="2" MinGuestAge="18"/>
        <OTAReferences>
          <OTAReference ID="12345" OTAName="Booking.com"/>
        </OTAReferences>
      </TPA_Extensions>
    </HotelDescriptiveContent>
  </HotelDescriptiveContents>
</OTA_HotelDescriptiveContentNotifRQ>
Request for update a hotel property
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveContentNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelDescriptiveContentNotifRQ.xsd">
  <HotelDescriptiveContents>
    <HotelDescriptiveContent HotelCode="203088969" CurrencyCode="USD" HotelDescriptiveContentNotifType="Overlay" HotelName="Orlando Tropical Breeze" LanguageCode="en-US">
      <HotelInfo>
        <CategoryCodes>
          <HotelCategory Code="34"/>
        </CategoryCodes>
        <Descriptions>
          <DescriptiveText>The Best Hotel Ever with 5 stars rating</DescriptiveText>
        </Descriptions>
        <Position Latitude="12.513994" Longitude="99.965228"/>
        <Services>
          <Service Code="5"/>
          <Service Code="367"/>
          <Service Code="79"/>
          <Service Code="52"/>
        </Services>
      </HotelInfo>
      <Policies>
        <Policy>
          <CancelPolicy>
            <CancelPenalty PolicyCode="13" Start="2019-01-01" End="2019-12-31"/>
            <CancelPenalty PolicyCode="254" Start="2020-01-01" End="2020-03-31"/>
            <CancelPenalty PolicyCode="98" Start="2020-04-01"/>
          </CancelPolicy>
          <PolicyInfo CheckInTime="14:00:00" CheckOutTime="12:00:00"/>
        </Policy>
      </Policies>
      <AffiliationInfo>
        <Awards>
          <Award Provider="HotelStarRate" Rating="4.5"/>
        </Awards>
      </AffiliationInfo>
      <MultimediaDescriptions>
        <MultimediaDescription>
          <ImageItems>
            <ImageItem>
              <ImageFormat Sort="1" Main="true">
                <URL>https://www.example.com/photo/01.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>1</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="2">
                <URL>https://www.example.com/photo/02.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>2</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="3">
                <URL>https://www.example.com/photo/03.jpg</URL>
              </ImageFormat>
            </ImageItem>
          </ImageItems>
        </MultimediaDescription>
      </MultimediaDescriptions>
      <ContactInfos>
        <ContactInfo ContactProfileType="PhysicalLocation">
          <Addresses>
            <Address Language="en-US">
              <AddressLine>213 Street Name.</AddressLine>
              <CityName>Bangkok</CityName>
              <PostalCode>10250</PostalCode>
              <CountryName>TH</CountryName>
            </Address>
          </Addresses>
        </ContactInfo>
        <ContactInfo ContactProfileType="general">
          <Names>
            <Name>
              <GivenName>John</GivenName>
              <Surname>Smith</Surname>
            </Name>
          </Names>
          <Phones>
            <Phone PhoneNumber="+123456789"/>
          </Phones>
          <Emails>
            <Email>admin@test-hotel.com</Email>
          </Emails>
        </ContactInfo>
      </ContactInfos>
      <TPA_Extensions>
        <TaxDriverSettings
          LengthOfStay="1"
          NightNumber="2"
          BedAndBreakfastFacility="true"
          CommunityOwnedHotels="false"
          AverageDailyRate="1.24"
          FacilityConstructionDate="2022-05-31"
          NewOrleansTourismSupportAssessment="true"
          CertifiedInns="true"
          LodgingRevenueThreshold="1.234"
        />
        <Channels>
          <Channel ChannelCode="1"/>
          <Channel ChannelCode="7"/>
        </Channels>
        <ChildAgeBands>
          <ChildAgeBand AgeFrom="1" AgeTo="5"/>
          <ChildAgeBand AgeFrom="6" AgeTo="10"/>
        </ChildAgeBands>
        <GuestInfo ChildAgeTo="12" ChildStayFree="true" ChildStayFreeTypeId="1" MaxChildAge="12" MaxInfantAge="2" MinGuestAge="18"/>
        <OTAReferences>
          <OTAReference ID="12345" OTAName="Booking.com"/>
        </OTAReferences>
        <PartnerDsaContract
          PartnerType="PrivateHost"
          BusinessType="Business"
          Name="Trading Name"
          Email="mail@mail.com"
          PhoneNumber="8145678943"
          AddressLine1="Address Line 1"
          AddressLine2="Address Line 2"
          CityId="19900"
          StateId="2"
          CountryId="86"
          PostalCode="10500"
          TradingLicense="ABC1234"
        />
      </TPA_Extensions>
    </HotelDescriptiveContent>
  </HotelDescriptiveContents>
</OTA_HotelDescriptiveContentNotifRQ>
Request for update a vacation rental property
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveContentNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelDescriptiveContentNotifRQ.xsd">
  <HotelDescriptiveContents>
    <HotelDescriptiveContent HotelCode="203094262" CurrencyCode="USD" HotelDescriptiveContentNotifType="Overlay" HotelName="vacation rental property" LanguageCode="en-US">
      <HotelInfo>
        <CategoryCodes>
          <HotelCategory Code="29"/>
          <GuestRoomInfo Quantity="1"/>
        </CategoryCodes>
        <Descriptions>
          <DescriptiveText>The Best Vacation Rental Ever</DescriptiveText>
        </Descriptions>
        <Position Latitude="12.513994" Longitude="99.965228"/>
        <Services>
          <Service Code="5"/>
          <Service Code="367"/>
          <Service Code="79"/>
          <Service Code="52"/>
        </Services>
        <TPA_Extensions>
          <LocalRecommendations>
            <LocalRecommendation>LocalRecommendation1</LocalRecommendation>
            <LocalRecommendation>LocalRecommendation2</LocalRecommendation>
          </LocalRecommendations>
          <HouseRules>
            <HouseRule>HouseRule1</HouseRule>
            <HouseRule>HouseRule2</HouseRule>
          </HouseRules>
          <Directions>
            <Direction>Direction1</Direction>
            <Direction>Direction2</Direction>
          </Directions>
          <RentalLicense>RentalLicense123</RentalLicense>
        </TPA_Extensions>
      </HotelInfo>
      <Policies>
        <Policy>
          <CancelPolicy>
            <CancelPenalty PolicyCode="98" Start="2021-04-01"/>
          </CancelPolicy>
          <PolicyInfo CheckInTime="14:00:00" CheckOutTime="12:00:00"/>
          <FeePolicies>
            <FeePolicy Amount="1000" Code="34" DecimalPlaces="2" EffectiveDate="2020-01-01" ExpireDate="2020-12-31"/>
          </FeePolicies>
        </Policy>
      </Policies>
      <AffiliationInfo>
        <Awards>
          <Award Provider="HotelStarRate" Rating="4.5"/>
        </Awards>
      </AffiliationInfo>
      <MultimediaDescriptions>
        <MultimediaDescription>
          <ImageItems>
            <ImageItem>
              <ImageFormat Sort="1" Main="true">
                <URL>https://www.example.com/photo/01.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>1</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="2">
                <URL>https://www.example.com/photo/02.jpg</URL>
              </ImageFormat>
              <TPA_Extensions>
                <CaptionCode>2</CaptionCode>
              </TPA_Extensions>
            </ImageItem>
            <ImageItem>
              <ImageFormat Sort="3">
                <URL>https://www.example.com/photo/03.jpg</URL>
              </ImageFormat>
            </ImageItem>
          </ImageItems>
        </MultimediaDescription>
      </MultimediaDescriptions>
      <ContactInfos>
        <ContactInfo ContactProfileType="PhysicalLocation">
          <Addresses>
            <Address Language="en-US">
              <AddressLine>213 Street Name.</AddressLine>
              <CityName>Bangkok</CityName>
              <PostalCode>10250</PostalCode>
              <CountryName>TH</CountryName>
            </Address>
          </Addresses>
        </ContactInfo>
        <ContactInfo ContactProfileType="general">
          <Names>
            <Name>
              <GivenName>John</GivenName>
              <Surname>Smith</Surname>
            </Name>
          </Names>
          <Phones>
            <Phone PhoneNumber="+123456789"/>
          </Phones>
          <Emails>
            <Email>admin@test-hotel.com</Email>
          </Emails>
        </ContactInfo>
      </ContactInfos>
      <TPA_Extensions>
        <TaxDriverSettings
          LengthOfStay="1"
          NightNumber="2"
          BedAndBreakfastFacility="true"
          CommunityOwnedHotels="false"
          AverageDailyRate="1.24"
          FacilityConstructionDate="2022-05-31"
          NewOrleansTourismSupportAssessment="true"
          CertifiedInns="true"
          LodgingRevenueThreshold="1.234"
        />
        <Channels>
          <Channel ChannelCode="1"/>
        </Channels>
        <ChildAgeBands>
          <ChildAgeBand AgeFrom="1" AgeTo="5"/>
          <ChildAgeBand AgeFrom="6" AgeTo="10"/>
        </ChildAgeBands>
        <GuestInfo ChildAgeTo="12" ChildStayFree="true" ChildStayFreeTypeId="1" MaxChildAge="12" MaxInfantAge="2" MinGuestAge="18"/>
        <OTAReferences>
          <OTAReference ID="12345" OTAName="Booking.com"/>
        </OTAReferences>
      </TPA_Extensions>
    </HotelDescriptiveContent>
  </HotelDescriptiveContents>
</OTA_HotelDescriptiveContentNotifRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveContentNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
  <UniqueID ID="123" Type="10"/>
</OTA_HotelDescriptiveContentNotifRS>
Response 400
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveContentNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
      <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</OTA_HotelDescriptiveContentNotifRS>
Response 401
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveContentNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="497" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</OTA_HotelDescriptiveContentNotifRS>

4.2. Managing Property Status

POST /cm/property/status

Description

This section outlines the ability to deactivate or delete a property

Body parameter

HotelSummary in OTA2017B format which specifies the property and status

Name : body
Flags : required
Type : OTA_HotelSummaryNotifRQ

Responses

HTTP Code Description Schema

200

The request has been accepted for processing

OTA_HotelSummaryNotifRS

400

The request content was malformed

OTA_HotelSummaryNotifRS

401

The supplier was unauthorized

OTA_HotelSummaryNotifRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • PropertyStatus

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/property/status
Request body
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelSummaryNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" HotelCode="9612080" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelSummaryNotifRQ.xsd">
  <HotelSummaryMessages>
    <HotelSummaryMessage StatusType="Closed"/>
  </HotelSummaryMessages>
</OTA_HotelSummaryNotifRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelSummaryNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
</OTA_HotelSummaryNotifRS>
Response 400
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelSummaryNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
      <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</OTA_HotelSummaryNotifRS>
Response 401
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelSummaryNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="497" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</OTA_HotelSummaryNotifRS>

4.3. Get Property Status

POST /cm/property-status

Description

Fetch property overall status either by list of property ids or with pagination. Please check the example of requests in the Example HTTP request section below.

Body parameter

HotelStatusRQ

Name : body
Flags : required
Type : AG_HotelStatusRQ

Responses

HTTP Code Description Schema

200

The successful response containing overall status of properties.

AG_HotelStatusRS

400

The request content was malformed

AG_HotelStatusRS

401

The supplier was unauthorized

AG_HotelStatusRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • PropertyOverallStatus

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/property-status
Request to get overall property status by property lists
<AG_HotelStatusRQ>
    <Criterion>
        <HotelRefs>
            <HotelRef HotelCode="12345"/>
            <HotelRef HotelCode="98765"/>
        </HotelRefs>
    </Criterion>
</AG_HotelStatusRQ>
Request to get overall property status with pagination
<AG_HotelStatusRQ>
    <Criterion Page="1" PageSize="100"/>
</AG_HotelStatusRQ>

Example HTTP response

Response 200
<AG_HotelStatusRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
    <Properties>
        <Property
                Code="12345"
                Name="The Best Hotel"
                CurrencyCode="EUR">
            <PropertyStatus
                    Created="2023-11-19 07:13:06"
                    LastChange="2024-02-01 16:41:53"
                    StatusType="Active">
                <ReprocessRequired>No</ReprocessRequired>
                <ContractSigned>Yes</ContractSigned>
                <PhotosIngested>Yes</PhotosIngested>
                <FraudCheckPassed>Yes</FraudCheckPassed>
                <PropertyLived>Yes</PropertyLived>
                <PropertyReady>Yes</PropertyReady>
                <RoomsAvailable>Yes</RoomsAvailable>
                <RatePlansAvailable>Yes</RatePlansAvailable>
            </PropertyStatus>
        </Property>
    </Properties>
</AG_HotelStatusRS>
Response 400
<AG_HotelStatusRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
    <Errors>
        <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
    </Errors>
</AG_HotelStatusRS>
Response 401
<AG_HotelStatusRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
    <Errors>
        <Error Code="321" ShortText="Authorization error" Status="NotProcessed"/>
    </Errors>
</AG_HotelStatusRS>

4.4. Managing Rooms

POST /cm/rooms

Description

Build new or modify rooms for properties which are authorized under your API credentials

Body parameter

List of rooms in OTA2017B format which need to be created

Name : body
Flags : required
Type : OTA_HotelInvNotifRQ

Responses

HTTP Code Description Schema

200

The request has been accepted for processing

OTA_HotelInvNotifRS

400

The request content was malformed

OTA_HotelInvNotifRS

401

The supplier was unauthorized

OTA_HotelInvNotifRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • Rooms

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/rooms
Request for create property’s room
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelInvNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelInvNotifRQ.xsd">
  <SellableProducts HotelCode="203088984">
    <SellableProduct InvNotifType="New">
      <Description>
        <Text>Beachfront</Text>
      </Description>
      <GuestRoom>
        <Occupancy MaxOccupancy="2"/>
        <Room NumberOfBathroom="1" NumberOfBedroom="1" RoomID="Room898" RoomViewCode="2" SizeMeasurement="30"/>
        <Amenities>
          <Amenity AmenityCode="25"/>
          <Amenity AmenityCode="26"/>
        </Amenities>
        <Description Language="en-US">
          <Text Language="en-US">Beach Front Rooms are 30 sqm with sea views. Saikaew Beach Resort provides all rooms, designed to offer you easy living by the sea among natural beauty, therefore, large windows in each room allow you to admire tropical garden or the beach right from your bed.</Text>
          <Image CaptionCode="1">https://images.sample.com/room/room-image-1.jpeg</Image>
        </Description>
        <TPA_Extensions>
          <RoomConfiguration AllowChildrenInRoom="true" BabyCots="true" ChildrenAllowedForFree="2" MaxExtraBeds="2" MaxInfantsInRoom="1" MaxAdultsOccupancy="2" MaxChildrenOccupancy="2" MaximumRate="500.0" MinimumRate="100.0" RackRate="400.0" StandardRate="400.0"/>
          <SubRooms>
            <SubRoom RoomType="BedRoom">
              <Amenities>
                <Amenity AmenityCode="10" Value="1"/>
              </Amenities>
            </SubRoom>
            <SubRoom RoomType="LivingRoom">
              <Amenities>
                <Amenity AmenityCode="1" Value="1"/>
                <Amenity AmenityCode="2" Value="1"/>
              </Amenities>
            </SubRoom>
          </SubRooms>
        </TPA_Extensions>
      </GuestRoom>
    </SellableProduct>
  </SellableProducts>
</OTA_HotelInvNotifRQ>
Request for partial update property’s room
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelInvNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelInvNotifRQ.xsd">
  <SellableProducts HotelCode="203088984">
    <SellableProduct InvCode="1201474686" InvNotifType="Delta">
      <Description>
        <Text>Beachfront</Text>
      </Description>
      <GuestRoom>
        <Occupancy MaxOccupancy="2"/>
        <Room NumberOfBathroom="2" NumberOfBedroom="1" RoomViewCode="2" SizeMeasurement="30"/>
        <Amenities>
          <Amenity AmenityCode="25" Status="Active"/>
          <Amenity AmenityCode="26" Status="Active"/>
          <Amenity AmenityCode="87" Status="Inactive"/>
        </Amenities>
        <Description Language="en-US">
          <Text Language="en-US" Status="Active">Example room description in English</Text>
          <Text Language="ja-JP" Status="Inactive">Example room description in Japanese</Text>
          <Image CaptionCode="1">https://images.sample.com/room/room-image-1.jpeg</Image>
        </Description>
        <TPA_Extensions>
          <RoomConfiguration AllowChildrenInRoom="true" BabyCots="true" ChildrenAllowedForFree="2" MaxExtraBeds="2" MaxInfantsInRoom="1" MaxAdultsOccupancy="2" MaxChildrenOccupancy="2" MaximumRate="500.0" MinimumRate="100.0" RackRate="500.0" StandardRate="400.0"/>
          <SubRooms>
            <SubRoom RoomType="BedRoom">
              <Amenities>
                <Amenity AmenityCode="5" Value="1"/>
                <Amenity AmenityCode="10" Value="1"/>
              </Amenities>
            </SubRoom>
            <SubRoom RoomType="LivingRoom">
              <Amenities>
                <Amenity AmenityCode="1" Value="1"/>
                <Amenity AmenityCode="2" Value="1"/>
                <Amenity AmenityCode="3" Value="1"/>
              </Amenities>
            </SubRoom>
          </SubRooms>
        </TPA_Extensions>
      </GuestRoom>
    </SellableProduct>
  </SellableProducts>
</OTA_HotelInvNotifRQ>
Request for update property’s room
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelInvNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelInvNotifRQ.xsd">
  <SellableProducts HotelCode="203088984">
    <SellableProduct InvCode="1201474686" InvNotifType="Overlay">
      <Description>
        <Text>Beachfront</Text>
      </Description>
      <GuestRoom>
        <Occupancy MaxOccupancy="2"/>
        <Room NumberOfBathroom="2" NumberOfBedroom="1" RoomViewCode="2" SizeMeasurement="30"/>
        <Amenities>
          <Amenity AmenityCode="25"/>
          <Amenity AmenityCode="26"/>
          <Amenity AmenityCode="87"/>
        </Amenities>
        <Description Language="en-US">
          <Text Language="en-US">Beach Front Rooms are 30 sqm with sea views. Saikaew Beach Resort provides all rooms, designed to offer you easy living by the sea among natural beauty, therefore, large windows in each room allow you to admire tropical garden or the beach right from your bed.</Text>
          <Image CaptionCode="1">https://images.sample.com/room/room-image-1.jpeg</Image>
        </Description>
        <TPA_Extensions>
          <RoomConfiguration AllowChildrenInRoom="true" BabyCots="true" ChildrenAllowedForFree="2" MaxExtraBeds="2" MaxInfantsInRoom="1" MaxAdultsOccupancy="2" MaxChildrenOccupancy="2" MaximumRate="500.0" MinimumRate="100.0" RackRate="500.0" StandardRate="400.0"/>
          <SubRooms>
            <SubRoom RoomType="BedRoom">
              <Amenities>
                <Amenity AmenityCode="5" Value="1"/>
                <Amenity AmenityCode="10" Value="1"/>
              </Amenities>
            </SubRoom>
            <SubRoom RoomType="LivingRoom">
              <Amenities>
                <Amenity AmenityCode="1" Value="1"/>
                <Amenity AmenityCode="2" Value="1"/>
                <Amenity AmenityCode="3" Value="1"/>
              </Amenities>
            </SubRoom>
          </SubRooms>
        </TPA_Extensions>
      </GuestRoom>
    </SellableProduct>
  </SellableProducts>
</OTA_HotelInvNotifRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelInvNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
  <InventoryCrossRefs>
    <InventoryCrossRef RequestInvCode="Room898" ResponseInvCode="101"/>
  </InventoryCrossRefs>
</OTA_HotelInvNotifRS>
Response 400
<OTA_HotelInvNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</OTA_HotelInvNotifRS>
Response 401
<OTA_HotelInvNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="497" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</OTA_HotelInvNotifRS>

4.5. Managing Room Status

POST /cm/room/status

Description

This section outlines the ability to active / inactive / delete property’s room

Body parameter

List of Rooms in OTA2017B format which specifies the property and room’s status

Name : body
Flags : required
Type : OTA_HotelInvNotifRQ

Responses

HTTP Code Description Schema

200

The request has been accepted for processing

OTA_HotelInvNotifRS

400

The request content was malformed

OTA_HotelInvNotifRS

401

The supplier was unauthorized

OTA_HotelInvNotifRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • RoomStatus

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/room/status
Request body
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelInvNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelInvNotifRQ.xsd">
  <SellableProducts HotelCode="111">
    <SellableProduct InvCode="123" InvNotifType="Overlay" InvStatusType="Active"/>
    <SellableProduct InvCode="345" InvNotifType="Overlay" InvStatusType="Inactive"/>
    <SellableProduct InvCode="456" InvNotifType="Overlay" InvStatusType="Deleted"/>
  </SellableProducts>
</OTA_HotelInvNotifRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelInvNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
</OTA_HotelInvNotifRS>
Response 400
<OTA_HotelInvNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</OTA_HotelInvNotifRS>
Response 401
<OTA_HotelInvNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="497" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</OTA_HotelInvNotifRS>

4.6. Managing Rates

POST /cm/rateplans

Description

Build new or modify rates for properties which are authorized under your API credentials

Body parameter

List of RatePlans in OTA2017B format which need to be created

Name : body
Flags : required
Type : OTA_HotelRatePlanNotifRQ

Responses

HTTP Code Description Schema

200

The request has been accepted for processing

OTA_HotelRatePlanNotifRS

400

The request content was malformed

OTA_HotelRatePlanNotifRS

401

The supplier was unauthorized

OTA_HotelRatePlanNotifRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • RatePlans

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/rateplans
Request for create property’s rates
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelRatePlanNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelRatePlanNotifRQ.xsd">
  <RatePlans HotelCode="9612080">
    <RatePlan RatePlanID="RatePlan12" RatePlanNotifType="New" RatePlanType="1">
      <Description Name="Standard Rate"/>
      <TPA_Extensions>
        <Channels>
          <Channel ChannelCode="1"/>
        </Channels>
      </TPA_Extensions>
    </RatePlan>
    <RatePlan RatePlanID="RatePlan13" RatePlanNotifType="New" RatePlanType="2">
      <Description Name="Exclusive Rate"/>
      <TPA_Extensions>
        <Channels>
          <Channel ChannelCode="1"/>
        </Channels>
      </TPA_Extensions>
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>
Request for partial update property’s rates
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelRatePlanNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelRatePlanNotifRQ.xsd">
  <RatePlans HotelCode="9612080">
    <RatePlan RatePlanCode="3236124" RatePlanNotifType="Delta">
      <Description Name="Standard Rate updated"/>
      <TPA_Extensions>
        <Channels>
          <Channel ChannelCode="1" Status="Active"/>
          <Channel ChannelCode="6" Status="Inactive"/>
        </Channels>
      </TPA_Extensions>
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>
Request for update property’s rates
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelRatePlanNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelRatePlanNotifRQ.xsd">
  <RatePlans HotelCode="9612080">
    <RatePlan RatePlanCode="3236124" RatePlanNotifType="Overlay">
      <Description Name="Standard Rate updated"/>
    </RatePlan>
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelRatePlanNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
  <RatePlanCrossRefs>
    <RatePlanCrossRef RequestRatePlanCode="RatePlan12" ResponseRatePlanCode="123"/>
  </RatePlanCrossRefs>
</OTA_HotelRatePlanNotifRS>
Response 400
<OTA_HotelRatePlanNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</OTA_HotelRatePlanNotifRS>
Response 401
<OTA_HotelRatePlanNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="497" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</OTA_HotelRatePlanNotifRS>

4.7. Managing Rate Status

POST /cm/rateplan/status

Description

This section outlines the ability to activate / deactivate / delete property’s rateplans

Body parameter

List of RatePlans in OTA2017B format which specifies the property and rateplan’s status

Name : body
Flags : required
Type : OTA_HotelRatePlanNotifRQ

Responses

HTTP Code Description Schema

200

The request has been accepted for processing

OTA_HotelRatePlanNotifRS

400

The request content was malformed

OTA_HotelRatePlanNotifRS

401

The supplier was unauthorized

OTA_HotelRatePlanNotifRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • RatePlanStatus

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/rateplan/status
Request body
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelRatePlanNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelRatePlanNotifRQ.xsd">
  <RatePlans HotelCode="111">
    <RatePlan RatePlanCode="123" RatePlanNotifType="Overlay" RatePlanStatusType="Active"/>
    <RatePlan RatePlanCode="456" RatePlanNotifType="Overlay" RatePlanStatusType="Inactive"/>
    <RatePlan RatePlanCode="789" RatePlanNotifType="Overlay" RatePlanStatusType="Deleted"/>
  </RatePlans>
</OTA_HotelRatePlanNotifRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelRatePlanNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
</OTA_HotelRatePlanNotifRS>
Response 400
<OTA_HotelRatePlanNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</OTA_HotelRatePlanNotifRS>
Response 401
<OTA_HotelRatePlanNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="497" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</OTA_HotelRatePlanNotifRS>

4.8. Managing Product

POST /cm/hotelproducts

Description

Build new or modify product mappings for properties which are authorized under your API credentials

Body parameter

HotelProductContent in OTA2017B format which need to be created

Name : body
Flags : required
Type : OTA_HotelProductNotifRQ

Responses

HTTP Code Description Schema

200

The request has been accepted for processing

OTA_HotelProductNotifRS

400

The request content was malformed

OTA_HotelProductNotifRS

401

The supplier was unauthorized

OTA_HotelProductNotifRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • HotelProducts

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/hotelproducts
Request body
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelProductNotifRQ
        xmlns="http://www.opentravel.org/OTA/2003/05"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelProductNotifRQ.xsd">
    <HotelProducts HotelCode="9612080">
        <HotelProduct>
            <RoomTypes>
                <RoomType RoomTypeCode="123"/>
            </RoomTypes>
            <RatePlans>
                <RatePlan RatePlanCode="111">
                    <SellDateRange End="2019-12-31" Start="2019-01-10"/>
                    <StayDateRange End="2019-12-31" Start="2019-01-10"/>
                </RatePlan>
            </RatePlans>
            <ValueAddInclusions>
                <Benefit BenefitCode="1"/>
                <RoomUseExtension CheckInTime="12:00:00" CheckOutTime="17:00:00"/>
            </ValueAddInclusions>
            <PolicyInfo>
                <CancelPolicy>
                    <CancelPenalty PolicyCode="13"/>
                </CancelPolicy>
                <BookingRules>
                    <BookingRule MaxAdvancedBookingOffset="P0Y0M10D" MaxLengthOfStay="P0Y0M2D" MinAdvancedBookingOffset="P0Y0M12D" MinLengthOfStay="P0Y0M3D"/>
                </BookingRules>
            </PolicyInfo>
            <TPA_Extensions>
                <PaymentModel>4</PaymentModel>
            </TPA_Extensions>
        </HotelProduct>
    </HotelProducts>
</OTA_HotelProductNotifRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelProductNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
  <UniqueID ID="123" Type="10"/>
</OTA_HotelProductNotifRS>
Response 400
<OTA_HotelProductNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</OTA_HotelProductNotifRS>
Response 401
<OTA_HotelProductNotifRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="497" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</OTA_HotelProductNotifRS>

4.9. Get Property Details

POST /cm/property-info

Description

Get property information including room and rate plans

Body parameter

OTA_HotelDescriptiveInfoRQ in OTA2017B format. Only HotelCode of the first HotelDescriptiveInfo must be supplied.

Name : body
Flags : required
Type : OTA_HotelDescriptiveInfoRQ

Responses

HTTP Code Description Schema

200

The response has been retrieved successfully

OTA_HotelDescriptiveInfoRS

400

The request content was malformed

OTA_HotelDescriptiveInfoRS

401

The supplier was unauthorized

OTA_HotelDescriptiveInfoRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • PropertyInfo

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/property-info
Request body
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveInfoRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/2017B/OTA_HotelDescriptiveInfoRQ.xsd">
  <HotelDescriptiveInfos>
    <HotelDescriptiveInfo HotelCode="123"/>
  </HotelDescriptiveInfos>
</OTA_HotelDescriptiveInfoRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelDescriptiveInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
  <HotelDescriptiveContents>
    <HotelDescriptiveContent BrandCode="0" ChainCode="0" CurrencyCode="USD" HotelCode="123"
        HotelName="Orlando Tropical Breeze" ID="Hotel123" LanguageCode="en-US">
      <HotelInfo>
        <CategoryCodes>
          <HotelCategory Code="34"/>
          <GuestRoomInfo Quantity="1"/>
        </CategoryCodes>
        <Descriptions>
          <MultiMediaDescriptions>
            <MultimediaDescription>
              <TextItems>
                <TextItem>
                  <URL>https://agoda.com</URL>
                  <Description>Agoda.com url.</Description>
                </TextItem>
              </TextItems>
            </MultimediaDescription>
          </MultiMediaDescriptions>
          <DescriptiveText>The Best Hotel Ever</DescriptiveText>
        </Descriptions>
        <Position Latitude="12.513994" Longitude="99.965228"/>
        <Services>
          <Service Code="261">
            <DescriptiveText>mini golf course</DescriptiveText>
          </Service>
        </Services>
      </HotelInfo>
      <FacilityInfo>
        <GuestRooms>
          <GuestRoom Code="123" ExtraBedChildAge="12" ID="HIL" MaxExtraBeds="1" MaxOccupancy="2"
              NumberOfBedrooms="2" RoomTypeName="Premier Room" YcsExtraBedFlag="true"
              IsActive="true">
            <Amenities>
              <Amenity RoomAmenityCode="25">
                <DescriptiveText>air conditioning</DescriptiveText>
              </Amenity>
            </Amenities>
            <DescriptiveText>Beach Front Rooms are 30 sqm with sea views.</DescriptiveText>
            <TPA_Extensions>
              <RoomConfiguration SizeMeasurement="45" NumberOfBedroom="3" NumberOfBathroom="1"
                MinimumRate="100.0" MaximumRate="999999.0" MaxChildrenInRoom="31"
                MaxAdultsOccupancy="6" MaxChildrenOccupancy="4"
                ChildrenAllowedForFree="2" BabyCots="true" />
              <SubRooms>
                <SubRoom RoomType="BedRoom">
                  <Amenities>
                    <Amenity AmenityCode="10" Value="1"/>
                  </Amenities>
                </SubRoom>
                <SubRoom RoomType="LivingRoom">
                  <Amenities>
                    <Amenity AmenityCode="1" Value="1"/>
                    <Amenity AmenityCode="2" Value="1"/>
                  </Amenities>
                </SubRoom>
              </SubRooms>
            </TPA_Extensions>
          </GuestRoom>
        </GuestRooms>
      </FacilityInfo>
      <Policies>
        <Policy>
          <CancelPolicy>
            <CancelPenalty End="2019-12-31" PolicyCode="13" Start="2019-01-01" Description = "Cancel Policy Description"/>
          </CancelPolicy>
          <PolicyInfo CheckInTime="14:00:00" CheckOutTime="12:00:00"/>
          <FeePolicies>
            <FeePolicy Amount="1000.0" Code="34" DecimalPlaces="2" EffectiveDate="2020-01-01" ExpireDate="2020-12-31"/>
          </FeePolicies>
        </Policy>
      </Policies>
      <AffiliationInfo>
        <Awards>
          <Award Provider="HotelStarRate" Rating="3.5"/>
        </Awards>
      </AffiliationInfo>
      <ContactInfos>
        <ContactInfo ContactProfileType="PhysicalLocation">
          <Addresses>
            <Address Language="en-US">
              <AddressLine>213 Street Name.</AddressLine>
              <CityName>Bangkok</CityName>
              <PostalCode>10250</PostalCode>
              <CountryName>TH</CountryName>
            </Address>
          </Addresses>
        </ContactInfo>
        <ContactInfo ContactProfileType="general">
          <Names>
            <Name>
              <GivenName>John</GivenName>
              <Surname>Smith</Surname>
            </Name>
          </Names>
          <Phones>
            <Phone PhoneNumber="+123456789"/>
          </Phones>
          <Emails>
            <Email>admin@test-hotel.com</Email>
          </Emails>
        </ContactInfo>
      </ContactInfos>
      <RatePlans>
        <RatePlan IsActive="true" RatePlanCode="123" RatePlanID="RatePlan12" RatePlanType="1">
          <Description Name="Standard Rate"/>
          <TPA_Extensions>
            <Channels>
              <Channel ChannelCode="2"/>
              <Channel ChannelCode="6"/>
            </Channels>
          </TPA_Extensions>
        </RatePlan>
      </RatePlans>
      <TPA_Extensions>
        <PropertyStatus>
          <PropertyIDCreated>Yes</PropertyIDCreated>
          <PhotosIngested>No</PhotosIngested>
          <ContractSigned>No</ContractSigned>
          <FraudCheckPassed>Yes</FraudCheckPassed>
          <PropertyLived>No</PropertyLived>
        </PropertyStatus>
        <Channels>
          <Channel ChannelCode="1"/>
          <Channel ChannelCode="2"/>
        </Channels>
        <GuestInfo MinGuestAge="2" MaxInfantAge="1" MaxChildAge="18" ChildStayFreeTypeId="1"
          ChildStayFree="true" ChildAgeTo="8"/>
        <HotelProducts>
          <HotelProduct>
            <RoomTypes>
              <RoomType RoomTypeCode="0"/>
            </RoomTypes>
            <RatePlans>
              <RatePlan RatePlanCode="605887">
                <SellDateRange End="2018-12-31" Start="2018-07-01"/>
                <StayDateRange End="2019-02-01" Start="2018-08-01"/>
              </RatePlan>
            </RatePlans>
            <ValueAddInclusions>
              <Benefit BenefitCode="1"/>
              <Benefit BenefitCode="2"/>
              <Benefit BenefitCode="3"/>
              <RoomUseExtension CheckInTime="13:00:00.000+07:00" CheckOutTime="12:00:00.000+07:00"/>
            </ValueAddInclusions>
            <PolicyInfo>
              <CancelPolicy>
                <CancelPenalty PolicyCode="155" Description = "Cancel Policy Description"/>
              </CancelPolicy>
              <BookingRules>
                <BookingRule MaxAdvancedBookingOffset="P0Y0M4D" MaxLengthOfStay="P0Y0M9D"
                  MinAdvancedBookingOffset="P0Y0M2D" MinLengthOfStay="P0Y0M0D"/>
              </BookingRules>
            </PolicyInfo>
          </HotelProduct>
        </HotelProducts>
        <RateType Name="Net Exclusive" Code="1"/>
        <PaymentMethod Name="TelexTransfer" Code="1"/>
        <ChildAgeBands>
          <ChildAgeBand AgeBandCode="1" AgeFrom="0" AgeTo="5"/>
          <ChildAgeBand AgeBandCode="2" AgeFrom="6" AgeTo="10"/>
          <ChildAgeBand AgeBandCode="3" AgeFrom="11" AgeTo="14"/>
          <ChildAgeBand AgeBandCode="4" AgeFrom="15" AgeTo="17"/>
        </ChildAgeBands>
      </TPA_Extensions>
    </HotelDescriptiveContent>
  </HotelDescriptiveContents>
</OTA_HotelDescriptiveInfoRS>
Response 400
<OTA_HotelDescriptiveInfoRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</OTA_HotelDescriptiveInfoRS>
Response 401
<OTA_HotelDescriptiveInfoRS CorrelationID="325d8000-48cf-11ea-9337-8950898f7d75">
  <Errors>
    <Error Code="497" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</OTA_HotelDescriptiveInfoRS>

4.10. Get Contract

POST /cm/hotelContracts

Description

For independent properties, this allows you to retrieve contract status.

Body parameter

HotelContractInfos

Name : body
Flags : required
Type : AG_HotelContractInfoRQ

Responses

HTTP Code Description Schema

200

The successful response with hotel contract information.

AG_HotelContractInfoRS

400

The request content was malformed

AG_HotelContractInfoRS

401

The supplier was unauthorized

AG_HotelContractInfoRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • Contracts

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/hotelContracts
Request body
<?xml version="1.0" encoding="UTF-8"?>
<AG_HotelContractInfoRQ>
  <HotelContractInfos>
    <HotelContractInfo HotelCode="1234"/>
  </HotelContractInfos>
</AG_HotelContractInfoRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<AG_HotelContractInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
  <HotelContractContents>
    <HotelContractContent ContractCode="0" HotelCode="1234" IsSigned="true" SignedAt="2020-01-08T12:37:13.930+07:00" UpdatedAt="2020-01-08T12:37:13.930+07:00">
      <IpAddress>8.8.8.8</IpAddress>
      <UserAgent>Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:10.0) Gecko/20100101 Firefox/10.0</UserAgent>
      <Contract LanguageCode="en-US">
        <Title>Accommodation Property Participation Agreement (1.931)</Title>
        <Content>### **ACCOMMODATION PROPERTY PARTICIPATION AGREEMENT**
          This Accommodation Property Participation Agreement (&amp;quot;APPA&amp;quot;),...
        </Content>
      </Contract>
    </HotelContractContent>
  </HotelContractContents>
</AG_HotelContractInfoRS>
Response 400
<?xml version="1.0" encoding="UTF-8"?>
<AG_HotelContractInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</AG_HotelContractInfoRS>
Response 401
<?xml version="1.0" encoding="UTF-8"?>
<AG_HotelContractInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="321" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</AG_HotelContractInfoRS>

4.11. Sign Contract

POST /cm/hotelContractsSign

Description

For independent properties, this allows you to electronically sign your contract. Without this being done, your property will not be visible on Agoda.com.

Body parameter

HotelContractSigns

Name : body
Flags : required
Type : AG_HotelContractSignNotifRQ

Responses

HTTP Code Description Schema

200

The successful response with hotel contract information.

AG_HotelContractSignNotifRS

400

The request content was malformed

AG_HotelContractSignNotifRS

401

The supplier was unauthorized

AG_HotelContractSignNotifRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • Contracts

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/hotelContractsSign
Request body
<?xml version="1.0" encoding="UTF-8"?>
<AG_HotelContractSignNotifRQ>
  <HotelContractSigns>
    <HotelContractSign ContractCode="0" HotelCode="string">
      <UserAgent>Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:10.0) Gecko/20100101 Firefox/10.0</UserAgent>
    </HotelContractSign>
  </HotelContractSigns>
</AG_HotelContractSignNotifRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<AG_HotelContractSignNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
</AG_HotelContractSignNotifRS>
Response 400
<?xml version="1.0" encoding="UTF-8"?>
<AG_HotelContractSignNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</AG_HotelContractSignNotifRS>
Response 401
<?xml version="1.0" encoding="UTF-8"?>
<AG_HotelContractSignNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="321" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</AG_HotelContractSignNotifRS>

4.12. Get Host Contracts

POST /cm/hostContracts

Description

For host, this allows you to retrieve contract status.

Body parameter

HostContractInfos

Name : body
Flags : required
Type : AG_HostContractInfoRQ

Responses

HTTP Code Description Schema

200

The successful response with host contract information.

AG_HostContractInfoRS

400

The request content was malformed

AG_HostContractInfoRS

401

The supplier was unauthorized

AG_HostContractInfoRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • Contracts

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/hostContracts
Request body
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractInfoRQ>
  <HostContractInfos>
    <HostContractInfo Email="host@email.com"/>
  </HostContractInfos>
</AG_HostContractInfoRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
  <HostContractContents>
    <HostContractContent ContractCode="0" Email="host@email.com" IsSigned="true" SignedAt="2020-01-08T12:37:13.930+07:00" UpdatedAt="2020-01-08T12:37:13.930+07:00">
      <IpAddress>8.8.8.8</IpAddress>
      <UserAgent>Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:10.0) Gecko/20100101 Firefox/10.0</UserAgent>
      <Contract LanguageCode="en-US">
        <Title>Accommodation Property Participation Agreement (1.931)</Title>
        <Content>### **ACCOMMODATION PROPERTY PARTICIPATION AGREEMENT**

          This Accommodation Property Participation Agreement (&amp;quot;APPA&amp;quot;),...
        </Content>
      </Contract>
    </HostContractContent>
  </HostContractContents>
</AG_HostContractInfoRS>
Response 400
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
</AG_HostContractInfoRS>
Response 401
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractInfoRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="321" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</AG_HostContractInfoRS>

4.13. Sign Host Contract

POST /cm/hostContractsSign

Description

Connectivity partners can sign contract which applies to all properties under Host Manage account. (Only for vacation rental properties)

Body parameter

HostContractSigns

Name : body
Flags : required
Type : AG_HostContractSignNotifRQ

Responses

HTTP Code Description Schema

200

The successful response

AG_HostContractSignNotifRS

400

The request content was malformed

AG_HostContractSignNotifRS

401

The supplier was unauthorized

AG_HostContractSignNotifRS

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • Host Contracts

Security

Type Name

apiKey

apiKey

Example HTTP request

Request path
/cm/hostContractsSign
Request body
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractSignNotifRQ>
  <HostContractSigns>
    <HostContractSign Email="homes@channel-manager.com">
      <UserAgent>Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:10.0) Gecko/20100101 Firefox/10.0</UserAgent>
      <Contracts>
        <Contract ContractCode="12"/>
      </Contracts>
    </HostContractSign>
  </HostContractSigns>
</AG_HostContractSignNotifRQ>

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractSignNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Success/>
</AG_HostContractSignNotifRS>
Response 400
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractSignNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="9038" ShortText="Host Contract already signed." Status="NotProcessed"/>
  </Errors>
</AG_HostContractSignNotifRS>
Response 401
<?xml version="1.0" encoding="UTF-8"?>
<AG_HostContractSignNotifRS CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e">
  <Errors>
    <Error Code="497" ShortText="Authorization error" Status="NotProcessed"/>
  </Errors>
</AG_HostContractSignNotifRS>

4.14. Get Error Codes

GET /cm/codes/error-codes

Description

Get a list of all error codes

Responses

HTTP Code Description Schema

200

Success

ErrorCodes

500

Internal server error

ErrorResponse

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • ErrorCodes

Example HTTP request

Request path
/cm/codes/error-codes

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<ErrorCodes>
  <ErrorCode Code="321" Description="Required field missing"/>
</ErrorCodes>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.15. Get Benefits

GET /cm/codes/benefits

Description

Get a list of supported benefits

Responses

HTTP Code Description Schema

200

Success

AgodaBenefits

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/benefits

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<AgodaBenefits>
  <AgodaBenefit BenefitCode="1" Name="Breakfast"/>
</AgodaBenefits>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.16. Get Cancel Policies

GET /cm/codes/cancel-policies

Description

Get a list of supported cancel policies

Responses

HTTP Code Description Schema

200

Success

CancelPolicies

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/cancel-policies

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<CancelPolicies>
  <CancelPolicy AgodaPolicyCode="1D1N_1N" Description="Any cancellation received within 1 day prior to arrival date will incur the first night charge." Name="Cancel 1 day prior to arrival date, the first night charge, No Show, the first night charge" PolicyCode="963"/>
</CancelPolicies>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.17. Get Countries

GET /cm/codes/countries

Description

Get a list of supported countries

Responses

HTTP Code Description Schema

200

Success

Countries

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/countries

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<Countries>
  <Country CountryCode="TH" Name="Thailand"/>
</Countries>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.18. Get Currencies

GET /cm/codes/currencies

Description

Get a list of supported currencies

Responses

HTTP Code Description Schema

200

Success

Currencies

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/currencies

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<Currencies>
  <Currency CurrencyCode="THB" Name="Thai Baht"/>
</Currencies>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.19. Get Hotel Services

GET /cm/codes/hotel-services

Description

Get a list of supported hotel services

Responses

HTTP Code Description Schema

200

Success

HotelServices

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/hotel-services

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<HotelServices>
  <HotelService Code="6" Name="coffee shop"/>
</HotelServices>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.20. Get Room Amenities

GET /cm/codes/room-amenities

Description

Get a list of supported room amenities

Responses

HTTP Code Description Schema

200

Success

RoomAmenities

500

Internal server error

ErrorResponse

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/room-amenities

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<RoomAmenities>
  <RoomAmenity Code="25" Name="air conditioning"/>
</RoomAmenities>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.21. Get Languages

GET /cm/codes/languages

Description

Get a list of supported languages

Responses

HTTP Code Description Schema

200

Success

AgodaLanguages

500

Internal server error

ErrorResponse

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/languages

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<AgodaLanguages>
  <AgodaLanguage LanguageCode="en-US" Name="English - United States"/>
</AgodaLanguages>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.22. Get Product Offers

GET /cm/codes/offers

Description

Get a list of supported product offers

Responses

HTTP Code Description Schema

200

Success

ProductOffers

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/offers

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<ProductOffers>
  <ProductOffer Name="Late Check-Out" OfferCode="44"/>
</ProductOffers>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.23. Get Hotel Categories

GET /cm/codes/hotel-categories

Description

Get a list of supported hotel categories

Responses

HTTP Code Description Schema

200

Success

AgodaHotelCategories

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/hotel-categories

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<AgodaHotelCategories>
  <AgodaHotelCategory CategoryCode="34" Name="Hotel"/>
</AgodaHotelCategories>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.24. Get Bed Types

GET /cm/codes/bed-types

Description

Get a list of supported bed types

Responses

HTTP Code Description Schema

200

Success

BedTypes

500

Internal server error

ErrorResponse

Consumes

  • application/xml

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/bed-types

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<BedTypes>
  <BedType Code="1" Name="Single Bed"/>
</BedTypes>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.25. Get Fees

GET /cm/codes/fees

Description

Get a list of supported fees

Responses

HTTP Code Description Schema

200

Success

Fees

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/fees

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<Fees>
  <Fee ApplyType="E" ChargeType="PRPN" Code="232" IsAmount="true" Name="City Tax Per Adult Per Night - (Property Collect)"/>
</Fees>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.26. Get Customer Segment Groups

GET /cm/codes/customer-segment-groups

Description

Get a list of supported Customer Segment Groups

Responses

HTTP Code Description Schema

200

Success

CustomerSegmentGroups

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/customer-segment-groups

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<CustomerSegmentGroups>
  <CustomerSegmentGroup CustomerSegmentType="Origin" Id="1" Name="Thailand"/>
</CustomerSegmentGroups>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.27. Get Views

GET /cm/codes/views

Description

Get a list of supported views

Responses

HTTP Code Description Schema

200

Success

Views

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/views

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<Views>
  <View Name="Ocean" ViewCode="1"/>
</Views>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="RoomAmenities">
  <Errors>
    <Error Code="321" ShortText="Required field missing" Status="NotProcessed"/>
  </Errors>
  <Warnings>
    <Warning Code="123" ShortText="Please try again in a few minutes" Status="Incomplete"/>
  </Warnings>
</ErrorResponse>

4.28. Get Image Captions

GET /cm/codes/image-captions

Description

Get a list of supported image captions

Responses

HTTP Code Description Schema

200

Success

ImageCaptions

500

Internal server error

ErrorResponse

Produces

  • application/xml

Tags

  • CodeLists

Example HTTP request

Request path
/cm/codes/image-captions

Example HTTP response

Response 200
<?xml version="1.0" encoding="UTF-8"?>
<ImageCaptions>
  <ImageCaption Code="1" IsAllowedForVacationRental="true" Name="Balcony/Terrace"/>
</ImageCaptions>
Response 500
<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponse CorrelationID="8b417d6a-f3df-4d65-870c-240378b8ad3e" Endpoint="ImageCaptions">
  <Errors>
    <Error Code="9000" ShortText="Internal Server Error" Status="NotProcessed"/>
  </Errors>
</ErrorResponse>

5. Definitions

5.1. AGErrorType

Name Description Schema

@Code
optional

This refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR).

See: Get Error Codes
Example : "9038"

string

@ShortText
optional

An abbreviated version of the error in textual format.
Example : "Hotel Contract already signed."

string

@Status
optional

Recommended values are those enumerated in the OTA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
Example : "NotProcessed"

string

5.2. AGErrorsType

Name Description Schema

Error
optional

An error that occurred during the processing of a message.
Example : [ "AGErrorType" ]

< AGErrorType > array

5.3. AGSuccessType

Type : object

5.4. AGWarningType

Name Description Schema

@Code
required

This refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR).
Example : "123"

string

@ShortText
required

An abbreviated version of the warning in textual format.
Example : "Please try again in a few minutes"

string

@Status
required

Recommended values are those enumerated in the OTA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
Example : "Incomplete"

string

5.5. AGWarningsType

Name Description Schema

Warning
required

Optionally used to indicate that the recipient of the request message identified one or more business-level warnings.
Example : [ "AGWarningType" ]

< AGWarningType > array

5.6. AG_HostContractInfoRQ

Name Description Schema

HostContractInfos
required

Request host contract information.
Example : HostContractInfos

HostContractInfos

5.7. AG_HostContractInfoRS

Name Description Schema

@CorrelationID
optional

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : AGErrorsType

AGErrorsType

HostContractContents
optional

Contract detail information. Contains contract’s content and contract signed status.
Example : HostContractContents

HostContractContents

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : AGSuccessType

AGSuccessType

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : AGWarningsType

AGWarningsType

5.8. AG_HostContractSignNotifRQ

The request object to sign contract for a host.

Name Description Schema

HostContractSigns
required

Detail information to sign contract.
Example : HostContractSigns

HostContractSigns

5.9. AG_HostContractSignNotifRS

Name Description Schema

@CorrelationID
optional

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : AGErrorsType

AGErrorsType

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : AGSuccessType

AGSuccessType

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : AGWarningsType

AGWarningsType

5.10. AG_HotelContractInfoRQ

Name Description Schema

HotelContractInfos
required

Request the contract information.
Example : HotelContractInfos

HotelContractInfos

5.11. AG_HotelContractInfoRS

Name Description Schema

@CorrelationID
optional

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : AGErrorsType

AGErrorsType

HotelContractContents
optional

Contract detail information. Contains contract’s content and contract signed status.
Example : HotelContractContents

HotelContractContents

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : AGSuccessType

AGSuccessType

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : AGWarningsType

AGWarningsType

5.12. AG_HotelContractSignNotifRQ

The request object to sign contract for a hotel.

Name Description Schema

HotelContractSigns
required

Detail information to sign contract.
Example : HotelContractSigns

HotelContractSigns

5.13. AG_HotelContractSignNotifRS

Name Description Schema

@CorrelationID
optional

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : AGErrorsType

AGErrorsType

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : AGSuccessType

AGSuccessType

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : AGWarningsType

AGWarningsType

5.14. AG_HotelStatusRQ

Name Description Schema

Criterion
required

Any criterion for filter with pagination or with list of property ids.
Example : Criterion

Criterion

5.15. AG_HotelStatusRS

Name Description Schema

CorrelationID
required

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message
Example : AGErrorsType

AGErrorsType

Properties
optional

The list of property containing property information with overall status
Example : Properties

Properties

Warnings
optional

A collection of warnings that occurred during the processing of a message.
Example : AGWarningsType

AGWarningsType

5.16. Address

Name Description Schema

@Language
required

Address language.

See: Get a list of supported languages

Amendable: No
Example : "en-US"

string

AddressLine
required

Contains free form address details. Address should contain street number and street name.

Amendable: No
Example : "213 Street Name."

string

CityName
required

City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

Amendable: No
Example : "Bangkok"

string

CountryName
required

Country Code (e.g. TH)

See: Get a list of supported countries

Amendable: No
Example : "TH"

string

PostalCode
required

Post Office Code number.

Amendable: No
Example : "10250"

string

5.17. AddressesType

Name Description Schema

Address
required

A collection of Address elements.
Example : [ "Address" ]

< Address > array

5.18. AffiliationInfoType

Name Description Schema

Awards
optional

A collection of Award elements.
Example : Awards

Awards

5.19. AgodaBenefit

Name Description Schema

@BenefitCode
required

Code of an Agoda benefit.
Example : 1

integer (int32)

@Name
required

Name of an Agoda benefit.
Example : "Breakfast"

string

5.20. AgodaBenefits

Name Description Schema

AgodaBenefit
required

List of supported benefits
Example : [ "AgodaBenefit" ]

< AgodaBenefit > array

5.21. AgodaContractType

Name Description Schema

@LanguageCode
optional

Agoda Language code.

See: Get a list of supported languages
Example : "en-US"

string

Content
optional

Detail content of the contract in markdown format.
Example : "# ACCOMMODATION PROPERTY PARTICIPATION AGREEMENT\n\nThis Accommodation Property Participation Agreement ("APPA"),…​"

string

Title
optional

Title of the contract.
Example : "Accommodation Property Participation Agreement (1.931)"

string

5.22. AgodaHotelCategories

Name Description Schema

AgodaHotelCategory
required

List of supported hotel categories
Example : [ "AgodaHotelCategory" ]

< AgodaHotelCategory > array

5.23. AgodaHotelCategory

Name Description Schema

@CategoryCode
required

Code of an Agoda hotel category.
Example : 34

integer (int32)

@Name
required

Name of an Agoda hotel category.
Example : "Hotel"

string

5.24. AgodaLanguage

Name Description Schema

@LanguageCode
required

Code of an Agoda language in RFC 3066 format.
Example : "en-US"

string

@Name
required

Name of an Agoda language.
Example : "English - United States"

string

5.25. AgodaLanguages

Name Description Schema

AgodaLanguage
required

List of supported languages
Example : [ "AgodaLanguage" ]

< AgodaLanguage > array

5.26. AmenitiesType

Name Description Schema

Amenity
required

A collection of amenities for this room type.
Example : [ "Amenity" ]

< Amenity > array

5.27. AmenitiesTypeInfo

Name Description Schema

Amenity
optional

A collection of amenities for this room type.
Example : [ "AmenityInfo" ]

< AmenityInfo > array

5.28. Amenity

Name Description Schema

@AmenityCode
optional

Amenity code that Agoda supported.

GuestRoom (Amenities) See: Get a list of supported room amenities

SubRooms (Bed Types) See: Get a list of supported bed types
Example : 25

integer (int32)

@Status
optional

Status of the amenity - applicable for Delta request type only.
Example : "Active"

enum (Active, Inactive)

@Value
required

Quantity of this amenity in this room. (Use for sub-rooms only)
Example : 1

integer (int32)

5.29. AmenityInfo

Name Description Schema

@RoomAmenityCode
optional

Amenity code that Agoda supported.

See:* Get a list of supported room amenities
Example : "25"

string

DescriptiveText
optional

Descriptive text that describes the amenity.
Example : "air conditioning"

string

5.30. Award

Name Description Schema

@Provider
required

The name of the award or ratings provider (e.g., Michelin, American Automobile Association (AAA)).
Example : "HotelStarRate"

enum (HotelStarRate)

@Rating
required

The actual award or rating received by the hotel or homes facility (e.g. 4 stars, 3 diamonds). If used in conjunction with RatingSymbol only the numeric rating would be passed here. For a vacation rental properties that doesn’t have star rating, its recommended to set to a default value of 3.0. For a luxurious vacation rental property, the property owner can define the star rating.
Example : 3.5

number (double)

5.31. Awards

Name Description Schema

Award
required

Provides detailed information regarding each award for this property.
Example : Award

Award

5.32. BedType

Name Description Schema

@Code
required

Code of an Agoda bed type.
Example : 1

integer (int32)

@Name
required

Name of an Agoda bed type.
Example : "Single Bed"

string

5.33. BedTypes

Name Description Schema

BedType
required

List of supported bed types
Example : [ "BedType" ]

< BedType > array

5.34. Benefit

Name Description Schema

@BenefitCode
required

Refer to Agoda Code List Benefit Type.

See: Get a list of supported benefits
Example : 1

integer (int64)

5.35. BookingRule

Name Description Schema

@MaxAdvancedBookingOffset
optional

Maximum days before the arrival date for which this rate plan may be booked.

  • 1 years = 365 days

  • 1 month = 30 days

  • Time duration will be ignored

  • Ignore this field when you don’t want to put any restriction.

  • Default: No restriction

ISO 8601 Duration format.
Example : "P0Y0M10D"

string

@MaxLengthOfStay
optional

Maximum number of days that a product can be booked.

  • 1 years = 365 days

  • 1 month = 30 days

  • Time duration will be ignored

  • Duration must be greater or equal to 1 day (P1D)

  • Ignore this field when you don’t want to put any restriction.

  • Default: No restriction

  • Restriction: Less than 180 days

ISO 8601 Duration format.
Example : "P0Y0M2D"

string

@MinAdvancedBookingOffset
optional

Minimum days before the arrival date for which this rate plan may be booked.

  • 1 years = 365 days

  • 1 month = 30 days

  • Time duration will be ignored

  • Ignore this field when you don’t want to put any restriction.

  • Default: No restriction

ISO 8601 Duration format.
Example : "P0Y0M12D"

string

@MinLengthOfStay
optional

Minimum number of days that a product can be booked.

  • 1 years = 365 days

  • 1 month = 30 days

  • Time duration will be ignored

  • Duration must be greater or equal to 1 day (P1D)

  • Default: P1D

ISO 8601 Duration format.
Example : "P0Y0M3D"

string

5.36. BookingRules

Name Description Schema

BookingRule
required

The BookingRule element defines restrictions to rates and stays for a given rate plan.
Example : [ "BookingRule" ]

< BookingRule > array

5.37. CancelPenaltiesType

Name Description Schema

CancelPenalty
optional

A collection of CancelPenalty.
Example : [ "CancelPenaltyType" ]

< CancelPenaltyType > array

5.38. CancelPenaltyType

Name Description Schema

@Description
optional

Description of Property Cancellation Policy.
Example : "string"

string

@End
optional

End date of cancellation policy. Date format: yyyy-MM-dd.
Example : "2019-12-31"

string

@PolicyCode
required

Agoda Cancellation Policy Code.

See: Get a list of supported cancel policies
Example : 13

integer (int32)

@Start
optional

Start date of cancellation policy. Date format: yyyy-MM-dd.
Example : "2019-01-01"

string

@Status
optional

Status of the channel - applicable for Delta request type only.
Example : "Active"

enum (Active, Inactive)

5.39. CancelPolicies

Name Description Schema

CancelPolicy
required

List of supported cancel policies
Example : [ "CancelPolicy" ]

< CancelPolicy > array

5.40. CancelPolicy

Name Description Schema

@AgodaPolicyCode
required

Code of an Agoda policy code.
Example : "1D1N_1N"

string

@Description
required

Description of an Agoda policy code.
Example : "Any cancellation received within 1 day prior to arrival date will incur the first night charge."

string

@Name
required

Name of an Agoda policy code.
Example : "Cancel 1 day prior to arrival date, the first night charge, No Show, the first night charge"

string

@PolicyCode
required

Id of an Agoda policy code.
Example : 963

integer (int32)

5.41. CategoryCodesType

Name Description Schema

GuestRoomInfo
optional

(Only for vacation rental properties)

Provides GuestRoomInfo Information.
Example : GuestRoomInfo

GuestRoomInfo

HotelCategory
required

Hotel Category Information.
Example : HotelCategory

HotelCategory

5.42. Channel

Name Description Schema

@ChannelCode
required

Agoda Channel Codes:

  • 1: Retail

  • 2: Private Sale

  • 6: Domestic

  • 7 :Mobile

  • 8: Private Opaque

  • 9: China

  • 14: Package

  • 27: Agoda VIP
    Example : "1"

enum (1, 2, 6, 7, 8, 9, 14, 27)

@Status
optional

Status of the channel - applicable for Delta request type only.
Example : "Active"

enum (Active, Inactive)

5.43. ChannelsType

Name Description Schema

Channel
required

A collection of Channel elements.
Example : [ "Channel" ]

< Channel > array

5.44. ChildAgeBand

Name Description Schema

@AgeBandCode
optional

Code used to uniquely identify the child age band.
Example : "1"

string

@AgeFrom
required

Minimum age limit of the child in years.
Example : 1

integer (int32)

@AgeTo
required

Maximum age limit of the child in years.
Example : 3

integer (int32)

@Description
optional

Textual information regarding the child age band.
Example : "string"

string

@Status
optional

Status of the child age band - applicable for Delta request type only.
Example : "Active"

enum (Active, Inactive)

5.45. ChildAgeBandsType

Name Description Schema

childAgeBand
required

Example : [ "ChildAgeBand" ]

< ChildAgeBand > array

5.46. ContactInfoRootType

Name Description Schema

@ContactProfileType
required

This defines the type of contact information (e.g. PhysicalLocation, general, etc.). For the physical address, ContactProfileType must be 'PhysicalLocation'. For personal information, ContactProfileType must be 'general'.
Example : "general"

string

Addresses
optional

A collection of Address elements.

Amendable: No
Example : AddressesType

AddressesType

Emails
optional

A collection of email elements.

Amendable: No
Example : EmailsType

EmailsType

Names
optional

Name of a contact person.

Amendable: No
Example : ContactsType

ContactsType

Phones
optional

A collection of Phone elements.

Amendable: No
Example : PhonesType

PhonesType

5.47. ContactInfosType

Name Description Schema

ContactInfo
required

A collection of ContactInfo elements that provides detailed contact information.
Example : [ "ContactInfoRootType" ]

< ContactInfoRootType > array

5.48. ContactsType

Name Description Schema

Name
required

Name details for a contact person.

Amendable: No
Example : PersonNameType

PersonNameType

5.49. Contract

Name Description Schema

@ContractCode
required

Agoda ContractCode. The code can be get via the Get Host Contract endpoint.
Example : 12

integer

5.50. ContractsType

Name Description Schema

Contract
required

Contract information.
Example : [ "Contract" ]

< Contract > array

5.51. Countries

Name Description Schema

Country
required

List of supported countries
Example : [ "Country" ]

< Country > array

5.52. Country

Name Description Schema

@CountryCode
required

Code of a country in ISO2 format.
Example : "TH"

string

@Name
required

Name of a country.
Example : "Thailand"

string

5.53. Criterion

Name Description Schema

HotelRefs
optional

List of HotelRef that will contains HotelCode
Example : HotelRefs

HotelRefs

Page
optional

Specific page number for pagination
Example : "1"

string

PageSize
optional

Specific page size for pagination
Example : "100"

string

5.54. Currencies

Name Description Schema

Currency
required

List of supported currencies
Example : [ "Currency" ]

< Currency > array

5.55. Currency

Name Description Schema

@CurrencyCode
required

Code of an Agoda currency.
Example : "THB"

string

@Name
required

Name of an Agoda currency.
Example : "Thai Baht"

string

5.56. CustomerSegmentGroup

Name Description Schema

@CustomerSegmentType
required

Type of customer segment group
Example : "Origin"

string

@Id
required

Customer segment group id of Agoda
Example : 1

integer (int32)

@Name
required

Name of customer segment group
Example : "Thailand"

string

5.57. CustomerSegmentGroups

Name Description Schema

CustomerSegmentGroup
required

List of customer segment group
Example : [ "CustomerSegmentGroup" ]

< CustomerSegmentGroup > array

5.58. Descriptions

Name Description Schema

DescriptiveText
optional

Descriptive text that describes the property.
Example : "The Best Hotel Ever"

string

5.59. DescriptionsResponse

Name Description Schema

DescriptiveText
optional

Descriptive text that describes the property.
Example : "The Best Hotel Ever"

string

MultiMediaDescriptions
required

Multimedia information about the property.
Example : MultimediaDescriptions

MultimediaDescriptions

5.60. Directions

Name Description Schema

Direction
optional

(Only for vacation rental properties)

A collection of Direction.
Example : [ "string" ]

< string > array

5.61. Email

Name Description Schema

value
required

Email address. (Require only 1 email address)

Amendable: No
Example : "admin@test-hotel.com"

string

5.62. EmailsType

Name Description Schema

Email
required

Used to pass detailed email information.
Example : [ "Email" ]

< Email > array

5.63. ErrorCode

Name Description Schema

@Code
required

Code of an Agoda error message.
Example : 321

integer (int32)

@Description
required

Description of an Agoda error message.
Example : "Required field missing"

string

5.64. ErrorCodes

Name Description Schema

ErrorCode
required

List of error codes
Example : [ "ErrorCode" ]

< ErrorCode > array

5.65. ErrorResponse

Name Description Schema

@CorrelationID
required

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

@Endpoint
required

Endpoint name
Example : "RoomAmenities"

string

Errors
required

A collection of errors that occurred during the processing of a message.
Example : ErrorsType

ErrorsType

Warnings
required

A collection of warnings that occurred during the processing of a message.
Example : WarningsType

WarningsType

5.66. ErrorType

Name Description Schema

@Code
required

This refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR).
Example : "321"

string

@ShortText
required

An abbreviated version of the error in textual format.
Example : "Required field missing"

string

@Status
required

Recommended values are those enumerated in the OTA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
Example : "NotProcessed"

string

5.67. ErrorsType

Name Description Schema

Error
required

An error that occurred during the processing of a message.
Example : [ "ErrorType" ]

< ErrorType > array

5.68. FacilityInfoType

Name Description Schema

GuestRooms
optional

A list of room types belongs to this property.
Example : GuestRooms

GuestRooms

5.69. Fee

Name Description Schema

@ApplyType
required

Apply type of an Agoda fee policy.

  • M = Mandatory (Agoda Collect) where Agoda will collect the fee when the booking is made.

  • E = External (Property Collect) where property owner will collect the fee upon arrival.
    Example : "E"

string

@ChargeType
required

Charge type of an Agoda fee policy.

  • PAPB = Per Adult Per Booking.

  • PAPN = Per Adult Per Night.

  • PB = Per Booking.

  • PCPB = Per Child Per Booking.

  • PCPN = Per Child Per Night.

  • PGPB = Per Guest Per Booking.

  • PGPN = Per Guest Per Night.

  • PN = Per Night.

  • PRPB = Per Room Per Booking.

  • PRPN = Per Room Per Night.
    Example : "PRPN"

string

@Code
required

Code of an Agoda fee policy.
Example : 232

integer (int32)

@IsAmount
required

An Agoda fee policy is amount or percent.
Example : true

boolean

@Name
required

Name of an Agoda fee policy.
Example : "City Tax Per Adult Per Night - (Property Collect)"

string

5.70. FeePolicies

Name Description Schema

FeePolicy
required

(Only for vacation rental properties)

Defines the fee policy of the property.
Example : [ "FeeType" ]

< FeeType > array

5.71. FeeType

Name Description Schema

@Amount
required

(Only for vacation rental properties)

Fee amount to be charged in the country’s local currency.
Example : 1000.0

number

@Code
required

(Only for vacation rental properties)

Fee code that Agoda supported.

See: Get a list of supported fees
Example : "34"

string

@DecimalPlaces
optional

(Only for vacation rental properties)

The number of decimal places to apply to @Amount. The Default value is 0.

  • If @Amount = 1000 and @DecimalPlaces = 1 then exact Fee amount = 100.00

  • If @Amount = 1000 and @DecimalPlaces = 2 then exact Fee amount = 10.00

  • If @Amount = 1000 and @DecimalPlaces = 3 then exact Fee amount = 1.000
    Example : 2

integer

@EffectiveDate
optional

(Only for vacation rental properties)

Fee Effective date.
Example : "2020-01-01"

string (date-time)

@ExpireDate
optional

(Only for vacation rental properties)

Fee Expiration date.
Example : "2020-12-31"

string (date-time)

5.72. Fees

Name Description Schema

Fee
required

List of supported fees
Example : [ "Fee" ]

< Fee > array

5.73. GuestInfo

Name Description Schema

@ChildAgeTo
optional

Maximum age limit of the child in years. (Overlay)

Miniumum age of the child starts from MaxInfantAge + 1.
Example : 12

integer (int32)

@ChildStayFree
optional

Whether children can stay free or not. (Overlay)
Example : true

boolean

@ChildStayFreeTypeId
optional

Child stay free type setting. (Overlay)

  • 1: All child stay free - Does not consider max occ no. in room level.

  • 2: Limit no. of child stay free base on max occ, apart from that will be cost in the property.
    Example : 1

enum (1, 2)

@MaxChildAge
optional

Maximum age of the child in years. (Overlay)

Extra bed price will be collected from this page and above.
Example : 12

integer (int32)

@MaxInfantAge
optional

Maximum age limit of the infant in years. (Overlay)
Example : 2

integer (int32)

@MinGuestAge
optional

Minimum age of the guest in years. (Overlay) 0 means all ages are allowed at the property.
Example : 18

integer (int32)

5.74. GuestRoom

Name Description Schema

@Code
optional

The Agoda.com room ID, returned on creation of the room.
Example : 123

integer (int32)

@ExtraBedChildAge
optional

A maximum child age allowed for extra beds.
Example : 12

integer

@ID
optional

The code that uniquely identifies a room type in the supplier’s system.
Example : "HIL"

string

@IsActive
optional

The boolean flag indicates if the room is currently active or not.
Example : true

boolean

@MaxExtraBeds
optional

A maximum number of extra beds allowed for this room type.
Example : 1

integer

@MaxOccupancy
optional

Maximum number of guests allowed in a room type.
Example : 2

integer

@NumberOfBedrooms
optional

Number of bedrooms for this room type.
Example : 2

integer

@RoomTypeName
optional

The room type name.
Example : "Premier Room"

string

@YcsExtraBedFlag
optional

Whether the extra bed flag has been set in Agoda YCS system.
Example : true

boolean

Amenities
optional

Collection of room amenity items available to the guest.
Example : AmenitiesTypeInfo

AmenitiesTypeInfo

DescriptiveText
optional

Descriptive text that describes the guest room.
Example : "Beach Front Rooms are 30 sqm with sea views."

string

TPA_Extensions
optional

Provide Agoda customized data of guest room schema.
Example : GuestRoomTPAExtensionsType

GuestRoomTPAExtensionsType

5.75. GuestRoomInfo

Name Description Schema

@Quantity
required

(Only for vacation rental properties)

Provides parameters of Number of Rooms.
Example : 1

integer (int32)

5.76. GuestRoomTPAExtensionsType

Name Description Schema

RoomConfiguration
optional

Attributes to describe other configuration of a room.
Example : RoomConfiguration

RoomConfiguration

SubRooms
optional

Collection of room level bed types. (Overlay)
Example : SubRooms

SubRooms

5.77. GuestRoomType

Name Description Schema

Amenities
required

Collection of room level amenities.
Example : AmenitiesType

AmenitiesType

Description
required

Description of the Room.
Example : RoomDescription

RoomDescription

Occupancy
required

Provides parameters of occupancy limits.
Example : Occupancy

Occupancy

Room
required

Attributes to describe the room from room category to location to view to bed type. (Optional for update)
Example : Room

Room

TPA_Extensions
optional

Provide Agoda customized data of guest room schema.
Example : GuestRoomTPAExtensionsType

GuestRoomTPAExtensionsType

5.78. GuestRooms

Name Description Schema

GuestRoom
optional

A list of room types belongs to this property.
Example : [ "GuestRoom" ]

< GuestRoom > array

5.79. HostContractContent

Name Description Schema

@ContractCode
optional

Agoda Contract Code. This code is required when sign contract for a host.
Example : 0

integer

@Email
optional

Host Email.
Example : "host@email.com"

string

@IsSigned
optional

A flag that indicate if the contract is signed.
Example : true

boolean

@SignedAt
optional

The time when this contract is signed.
Example : "2020-01-08T12:37:13.930+07:00"

string (date-time)

@UpdatedAt
optional

The time when this contract last updated.
Example : "2020-01-08T12:37:13.930+07:00"

string (date-time)

Contract
optional

Contract detailed information.
Example : AgodaContractType

AgodaContractType

IpAddress
optional

IP address of the client who signed the contract.
Example : "8.8.8.8"

string

UserAgent
optional

UserAgent of the actual person who sign the contract.
Example : "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:10.0) Gecko/20100101 Firefox/10.0"

string

5.80. HostContractContents

Name Description Schema

HostContractContent
optional

Contract detailed content.
Example : [ "HostContractContent" ]

< HostContractContent > array

5.81. HostContractInfo

Name Description Schema

@Email
required

Example : "host@email.com"

string

5.82. HostContractInfos

Name Description Schema

HostContractInfo
required

Example : HostContractInfo

HostContractInfo

5.83. HostContractSign

Name Description Schema

@Email
required

Host Email.
Example : "homes@channel-manager.com"

string

Contracts
required

Collection of Agoda ContractCode.
Example : ContractsType

ContractsType

UserAgent
required

UserAgent of the actual person who sign the contract. The UserAgent should be get from the host browser who access to the system to sign the contract.
Example : "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:10.0) Gecko/20100101 Firefox/10.0"

string

5.84. HostContractSigns

Name Description Schema

HostContractSign
required

Detail information to sign contract for a host: Email, ContractCode and UserAgent.
Example : HostContractSign

HostContractSign

5.85. HotelCategory

Name Description Schema

@Code
required

Agoda Hotel Category Code.

See: Get a list of supported hotel categories
Example : 34

integer (int32)

5.86. HotelContractContent

Name Description Schema

@ContractCode
optional

Agoda Contract Code. This code is required when sign contract for a property.
Example : 0

integer

@HotelCode
optional

Agoda Hotel code.
Example : "1234"

string

@IsSigned
optional

A flag that indicate if the contract is signed.
Example : true

boolean

@SignedAt
optional

The time when this contract is signed.
Example : "2020-01-08T12:37:13.930+07:00"

string (date-time)

@UpdatedAt
optional

The time when this contract last updated.
Example : "2020-01-08T12:37:13.930+07:00"

string (date-time)

Contract
optional

Contract detailed information.
Example : AgodaContractType

AgodaContractType

IpAddress
optional

IP address of the client who signed the contract.
Example : "8.8.8.8"

string

UserAgent
optional

UserAgent of the actual person who sign the contract.
Example : "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:10.0) Gecko/20100101 Firefox/10.0"

string

5.87. HotelContractContents

Name Description Schema

HotelContractContent
required

A collection of HotelContractContent elements that provides contract detailed content.
Example : [ "HotelContractContent" ]

< HotelContractContent > array

5.88. HotelContractInfo

Name Description Schema

@HotelCode
required

Example : "string"

string

5.89. HotelContractInfos

Name Description Schema

HotelContractInfo
required

Example : HotelContractInfo

HotelContractInfo

5.90. HotelContractSign

Name Description Schema

@ContractCode
required

Agoda ContractCode. The code can be get via the Get Contract endpoint.
Example : 0

integer

@HotelCode
required

Agoda HotelCode. The code is returned in the response of Manage Properties.
Example : "string"

string

UserAgent
required

UserAgent of the actual person who sign the contract. The UserAgent should be get from the property owner browser who access to the system to sign the contract.
Example : "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:10.0) Gecko/20100101 Firefox/10.0"

string

5.91. HotelContractSigns

Name Description Schema

HotelContractSign
required

Detail information to sign contract for a property: HotelCode, ContractCode and UserAgent.
Example : HotelContractSign

HotelContractSign

5.92. HotelDescriptiveContent

Name Description Schema

@BrandCode
optional

The code that uniquely identifies the brand for the Hotel chain brands. It should be from the Agoda published Brand List.
Example : "123"

string

@ChainCode
optional

The code that identifies a hotel chain or management group. If it is not provided, default code will be 0.

Note: If the property does not wish to apply chain configuration, do not include ChainCode in the request.
Example : 0

integer (int32)

@CurrencyCode
required

An ISO 4217 (3) alpha character code that specifies a monetary unit.

See: Get a list of supported currencies

Amendable: No
Example : "USD"

string

@HotelCode
optional

The Agoda.com property ID, returned on creation of the property.

(Required for update request, optional for create request)
Example : 123

integer (int32)

@HotelDescriptiveContentNotifType
required

Explains whether a hotel content is new or old.
Example : "New"

enum (New, Overlay, Delta)

@HotelName
required

A text field used to communicate the proper name of the property.

Amendable: No
Example : "Orlando Tropical Breeze"

string

@ID
required

The code that uniquely identifies a single hotel property in the supplier’s system.

(Required for create request, optional for update request)
Example : "Hotel123"

string

@LanguageCode
required

Identification of the communication language which is used for the property.

See: Get a list of supported languages
Example : "en-US"

string

AffiliationInfo
optional

Provides information regarding affiliations, loyalty programs and award ratings.
Example : AffiliationInfoType

AffiliationInfoType

ContactInfos
required

Provides contact information.
Example : ContactInfosType

ContactInfosType

HotelInfo
required

Contains descriptive information about a property.
Example : HotelInfoType

HotelInfoType

MultimediaDescriptions
required

Multimedia information about a collection of multimedia objects.
Example : MultimediaDescriptionsType

MultimediaDescriptionsType

Policies
optional

A collection of policy information as it applies to the property.
Example : Policies

Policies

TPA_Extensions
optional

Provide Agoda customized data.
Example : HotelTPAExtensions

HotelTPAExtensions

5.93. HotelDescriptiveContentResponse

Name Description Schema

@BrandCode
required

The code that identifies a brand
Example : "0"

string

@ChainCode
required

The code that identifies a hotel chain or management group.
Example : "0"

string

@CurrencyCode
required

An ISO 4217 (3) alpha character code that specifies a monetary unit.

See: Get a list of supported currencies
Example : "USD"

string

@HotelCode
required

The Agoda.com property ID, returned on creation of the property.
Example : "123"

string

@HotelName
required

The proper name of the property.
Example : "Orlando Tropical Breeze"

string

@ID
optional

The code that uniquely identifies a single hotel property in the supplier’s system.
Example : "Hotel123"

string

@LanguageCode
required

Identification of the requested language to be used for the hotel descriptive information.

See: Get a list of supported languages
Example : "en-US"

string

AffiliationInfo
required

Provides information regarding affiliations, loyalty programs and award ratings.
Example : AffiliationInfoType

AffiliationInfoType

ContactInfos
required

Provides contact information.
Example : ContactInfosType

ContactInfosType

FacilityInfo
optional

The FacilityInfo class that describes the facilities provided at the property.
Example : FacilityInfoType

FacilityInfoType

HotelInfo
required

Contains descriptive information about a property.
Example : HotelInfoTypeResponse

HotelInfoTypeResponse

Policies
optional

A collection of policy information as it applies to the property.
Example : Policies

Policies

RatePlans
optional

A collection of rate plans.
Example : RatePlansResponse

RatePlansResponse

TPA_Extensions
optional

Provide Agoda customized data.
Example : HotelDescriptiveContentTPAExtensions

HotelDescriptiveContentTPAExtensions

5.94. HotelDescriptiveContentTPAExtensions

Name Description Schema

Channels
optional

Collection of channel that able to sell a property.
Example : ChannelsType

ChannelsType

ChildAgeBands
optional

Child Age Band information of hotel.
Example : ChildAgeBandsType

ChildAgeBandsType

GuestInfo
optional

Collection of Property guest information
Example : GuestInfo

GuestInfo

HotelProducts
optional

A collection of hotel products.
Example : HotelProducts

HotelProducts

PaymentMethod
optional

Payment method information of hotel.
Example : PaymentMethod

PaymentMethod

PropertyStatus
optional

Property Status.
Example : PropertyStatus

PropertyStatus

RateType
optional

Rate type information of hotel.
Example : RateType

RateType

5.95. HotelDescriptiveContents

Name Description Schema

HotelDescriptiveContent
required

Hotel descriptive information.
Example : HotelDescriptiveContent

HotelDescriptiveContent

5.96. HotelDescriptiveContentsResponse

Name Description Schema

HotelDescriptiveContent
required

Hotel descriptive information.
Example : [ "HotelDescriptiveContentResponse" ]

< HotelDescriptiveContentResponse > array

5.97. HotelDescriptiveInfo

Name Description Schema

@HotelCode
required

The Agoda.com property ID, returned on creation of the property.
Example : 123

integer (int32)

5.98. HotelDescriptiveInfos

Name Description Schema

HotelDescriptiveInfo
required

Contains hotel descriptive information.
Example : HotelDescriptiveInfo

HotelDescriptiveInfo

5.99. HotelInfoType

Name Description Schema

CategoryCodes
required

Collection of descriptive details about a property.
Example : CategoryCodesType

CategoryCodesType

Descriptions
optional

Collection of property and/or renovation information.
Example : Descriptions

Descriptions

Position
required

Describes the geocoded location of the property.
Example : Position

Position

Services
required

Collection of property services and/or amenities available to the guest.
Example : Services

Services

TPA_Extensions
optional

(Only for vacation rental properties)

Provide Agoda customized data of hotel info schema.
Example : PropertyInfoTPAExtensions

PropertyInfoTPAExtensions

5.100. HotelInfoTypeResponse

Name Description Schema

CategoryCodes
required

Collection of descriptive details about a property.
Example : CategoryCodesType

CategoryCodesType

Descriptions
optional

Collection of property and/or renovation information.
Example : DescriptionsResponse

DescriptionsResponse

Position
required

Describes the geocoded location of the property.
Example : PositionResponse

PositionResponse

Services
required

Collection of property services and/or amenities available to the guest.
Example : ServicesResponse

ServicesResponse

TPA_Extensions
optional

(Only for vacation rental properties)

Provide Agoda customized data of hotel info schema.
Example : PropertyInfoTPAExtensions

PropertyInfoTPAExtensions

5.101. HotelProduct

Name Description Schema

PolicyInfo
optional

Policy Information for this product.
Example : HotelProductPolicyInfo

HotelProductPolicyInfo

RatePlans
required

A collection of rate plans.
Example : HotelProductRatePlans

HotelProductRatePlans

RoomTypes
required

A collection of room types.
Example : RoomTypes

RoomTypes

TPA_Extensions
optional

Provide Agoda customized data of hotel product schema
Example : HotelProductTPAExtensions

HotelProductTPAExtensions

ValueAddInclusions
optional

Items that are included with this product that add value or differentiate this product from other products at no additional charge
Example : ValueAddInclusions

ValueAddInclusions

5.102. HotelProductCancelPenaltiesType

Name Description Schema

CancelPenalty
optional

Cancel Penalty for the rateplan.
Example : HotelProductCancelPenaltyType

HotelProductCancelPenaltyType

5.103. HotelProductCancelPenaltyType

Name Description Schema

@Description
optional

Description of Hotel Product Cancellation Policy.
Example : "string"

string

@PolicyCode
required

Agoda Cancellation Policy Code.

See: Get a list of supported cancel policies
Example : 13

integer (int64)

5.104. HotelProductPolicyInfo

Name Description Schema

BookingRules
optional

A collection of booking rules.
Example : BookingRules

BookingRules

CancelPolicy
optional

The cancel policy details. A collection of CancelPenalty.
Example : HotelProductCancelPenaltiesType

HotelProductCancelPenaltiesType

5.105. HotelProductRatePlan

Name Description Schema

@RatePlanCode
required

The Agoda.com rate plan ID, returned on creation of the rate plan.
Example : 111

integer (int64)

SellDateRange
required

The date range for which this rate plan is offered for sell.
Example : SellDateRange

SellDateRange

StayDateRange
required

The date range for which this rate plan is offered for guest stays.
Example : StayDateRange

StayDateRange

5.106. HotelProductRatePlans

Name Description Schema

RatePlan
required

An individual rate plan.
Example : HotelProductRatePlan

HotelProductRatePlan

5.107. HotelProductTPAExtensions

Name Description Schema

PaymentModel
optional

Payment model to be used in a rate plan. Its only available to Direct Connect Suppliers on request. Please check with Connectivity Managers.

1: Pay to Agoda,

2: Pay at Property,

3: Both Payment Available: either Online Payment or Pay at Property and

4: Merchant Commission
Example : 1

enum (1, 2, 3, 4)

5.108. HotelProducts

Name Description Schema

@HotelCode
required

The Agoda.com property ID
Example : "9612080"

string

hotelProduct
required

Example : [ "HotelProduct" ]

< HotelProduct > array

5.109. HotelRef

Name Description Schema

HotelCode
required

The Agoda.com property ID, returned on creation of the property
Example : 9612080

integer (int32)

5.110. HotelRefs

Name Description Schema

HotelRef
optional

HotelRef refers to a hotel by HotelCode
Example : [ "HotelRef" ]

< HotelRef > array

5.111. HotelService

Name Description Schema

@Code
required

Code of an Agoda hotel service.
Example : 6

integer (int32)

@Name
required

Name of an Agoda hotel service.
Example : "coffee shop"

string

5.112. HotelServices

Name Description Schema

HotelService
required

List of supported hotel services
Example : [ "HotelService" ]

< HotelService > array

5.113. HotelSummaryMessage

Name Description Schema

@StatusType
required

The status of the property.

"Closed" status is to temporarily close the property.

"Deleted" status is to delete the property permanently.
Example : "Closed"

enum (Closed, Deleted)

5.114. HotelSummaryMessagesType

Name Description Schema

HotelSummaryMessage
required

The message that is used to provide a notification of the general status of availability of the property.
Example : [ "HotelSummaryMessage" ]

< HotelSummaryMessage > array

5.115. HotelTPAExtensions

Name Description Schema

Channels
optional

Collection of channel that able to sell a property.
Example : ChannelsType

ChannelsType

ChildAgeBands
optional

Collection of child age bands that used to set child rates.
Example : ChildAgeBandsType

ChildAgeBandsType

GuestInfo
optional

Collection of Property guest information
Example : GuestInfo

GuestInfo

OTAReferences
optional

Collection of reference to other OTA system.
Example : OTARefsType

OTARefsType

PartnerDsaContract
optional

Partner DSA contract information
Example : PartnerDsaContract

PartnerDsaContract

TaxDriverSettings
optional

Collection of tax driver id.
Example : TaxDriverSettings

TaxDriverSettings

5.116. HouseRules

Name Description Schema

HouseRule
optional

(Only for vacation rental properties)

A collection of House Rule.
Example : [ "string" ]

< string > array

5.117. Image

Name Description Schema

@CaptionCode
optional

An image caption code in Agoda
Example : "1"

string

value
required

An image url from the supplier
Example : "https://images.sample.com/room/room-image-1.jpeg"

string

5.118. ImageCaption

Name Description Schema

@Code
required

Code of an Image Caption used in Agoda.
Example : "1"

string

@IsAllowedForVacationRental
required

Flag to determines whether the Caption can be used for Vacation Rental Properties or not.
Example : true

boolean

@Name
required

Name of an Image Caption used in Agoda.
Example : "Balcony/Terrace"

string

5.119. ImageCaptions

Name Description Schema

ImageCaption
required

List of image captions
Example : [ "ImageCaption" ]

< ImageCaption > array

5.120. ImageFormat

Name Description Schema

@Main
optional

Set Main image of property
Example : false

boolean

@Sort
optional

Image Ordering
Example : 1

integer (int32)

URL
required

URL of the multimedia item for a specific format.
Example : "https://example.com/example_img.jpg"

string

5.121. ImageItem

Name Description Schema

ImageFormat
optional

A set of images for a given category which may be provided in multiple formats.
Example : [ "ImageFormat" ]

< ImageFormat > array

TPA_Extensions
optional

Provide Agoda customized data of ImageItem.
Example : ImageItemTPAExtensions

ImageItemTPAExtensions

5.122. ImageItemTPAExtensions

Name Description Schema

CaptionCode
optional

Image Caption Code for Image in Agoda
Example : "1"

string

5.123. ImageItemsType

Name Description Schema

ImageItem
optional

Collection of image items.
Example : [ "ImageItem" ]

< ImageItem > array

5.124. InventoryCrossRef

Name Description Schema

@RequestInvCode
required

Identification of the sending system Inventory Code (Supplier room id)
Example : "Room898"

string

@ResponseInvCode
required

Identification of the responding system Inventory Code. (Agoda room id)
Example : "101"

string

5.125. InventoryCrossRefs

Name Description Schema

InventoryCrossRef
required

Cross Reference between sending system and responding system Inventory Codes.
Example : [ "InventoryCrossRef" ]

< InventoryCrossRef > array

5.126. LocalRecommendations

Name Description Schema

LocalRecommendation
optional

(Only for vacation rental properties)

A collection of Local Recommendation.
Example : [ "string" ]

< string > array

5.127. MultimediaDescriptionType

Name Description Schema

ImageItems
optional

A collection of image items.
Example : ImageItemsType

ImageItemsType

5.128. MultimediaDescriptionTypeResponse

Name Description Schema

TextItems
required

A collection of text items.
Example : TextItemsType

TextItemsType

5.129. MultimediaDescriptions

Name Description Schema

MultimediaDescription
required

A multimedia item.Describes multimedia item(s).
Example : [ "MultimediaDescriptionTypeResponse" ]

< MultimediaDescriptionTypeResponse > array

5.130. MultimediaDescriptionsType

Name Description Schema

MultimediaDescription
required

Contains multimedia item(s).
Example : [ "MultimediaDescriptionType" ]

< MultimediaDescriptionType > array

5.131. NameDescription

Name Description Schema

Text
required

A name for this sellable product.
Example : "Beachfront"

string

5.132. OTAReference

Name Description Schema

@ID
required

Hotel ID stored in the OTA system.
Example : "12345"

string

@OTAName
required

Name of the OTA.
Example : "Booking.com"

enum (Booking.com)

5.133. OTARefsType

Name Description Schema

OTAReference
required

A collection of OTAReference elements.
Example : [ "OTAReference" ]

< OTAReference > array

5.134. OTA_HotelDescriptiveContentNotifRQ

Name Description Schema

HotelDescriptiveContents
required

A collection of hotel descriptive information.
Example : HotelDescriptiveContents

HotelDescriptiveContents

5.135. OTA_HotelDescriptiveContentNotifRS

Name Description Schema

@CorrelationID
required

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : ErrorsType

ErrorsType

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : SuccessType

SuccessType

UniqueID
optional

The Unique ID being created in Agoda system.
Example : UniqueID_Type

UniqueID_Type

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : WarningsType

WarningsType

5.136. OTA_HotelDescriptiveInfoRQ

Name Description Schema

HotelDescriptiveInfos
required

Contains hotel descriptive information.
Example : HotelDescriptiveInfos

HotelDescriptiveInfos

5.137. OTA_HotelDescriptiveInfoRS

Name Description Schema

@CorrelationID
required

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : ErrorsType

ErrorsType

HotelDescriptiveContents
optional

A collection of hotel descriptive information.
Example : HotelDescriptiveContentsResponse

HotelDescriptiveContentsResponse

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : SuccessType

SuccessType

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : WarningsType

WarningsType

5.138. OTA_HotelInvNotifRQ

Name Description Schema

SellableProducts
required

A collection of sellable products for a given property.
Example : SellableProducts

SellableProducts

5.139. OTA_HotelInvNotifRS

Name Description Schema

@CorrelationID
required

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : ErrorsType

ErrorsType

InventoryCrossRefs
optional

Container for Inventory Cross Reference elements.
Example : InventoryCrossRefs

InventoryCrossRefs

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : SuccessType

SuccessType

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : WarningsType

WarningsType

5.140. OTA_HotelProductNotifRQ

Name Description Schema

HotelProducts
required

A collection of hotel products.
Example : HotelProducts

HotelProducts

5.141. OTA_HotelProductNotifRS

Name Description Schema

@CorrelationID
required

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : ErrorsType

ErrorsType

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : SuccessType

SuccessType

UniqueID
optional

The Unique ID being created in Agoda system.
Example : UniqueID_Type

UniqueID_Type

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : WarningsType

WarningsType

5.142. OTA_HotelRatePlanNotifRQ

Name Description Schema

RatePlans
required

A collection of rate plans for a given property
Example : RatePlans

RatePlans

5.143. OTA_HotelRatePlanNotifRS

Name Description Schema

@CorrelationID
required

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : ErrorsType

ErrorsType

RatePlanCrossRefs
optional

Container for RatePlan Cross Reference elements.
Example : RatePlanCrossRefs

RatePlanCrossRefs

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : SuccessType

SuccessType

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : WarningsType

WarningsType

5.144. OTA_HotelSummaryNotifRQ

Name Description Schema

@HotelCode
required

The Agoda.com property ID, returned on creation of the property
Example : 9612080

integer (int32)

HotelSummaryMessages
required

A collection of HotelSummaryMessages
Example : HotelSummaryMessagesType

HotelSummaryMessagesType

5.145. OTA_HotelSummaryNotifRS

Name Description Schema

@CorrelationID
required

Allows end-to-end correlation of log messages with the corresponding Web service message throughout the processing of the Web service message.
Example : "8b417d6a-f3df-4d65-870c-240378b8ad3e"

string

Errors
optional

A collection of errors that occurred during the processing of a message.
Example : ErrorsType

ErrorsType

Success
optional

Returning an empty element of this type indicates the successful processing of a message.
Example : SuccessType

SuccessType

UniqueID
optional

The Unique ID being created in Agoda system.
Example : UniqueID_Type

UniqueID_Type

Warnings
optional

A collection of business-level warnings that occurred during the processing of a message.
Example : WarningsType

WarningsType

5.146. Occupancy

Name Description Schema

@MaxOccupancy
required

Maximum number of persons allowed in a unit of accommodation or place.
Example : 2

integer (int32)

5.147. ParagraphTypeRatePlan

Name Description Schema

@Name
required

A descriptive name of rate plan.
Example : "Standard Rate"

string

5.148. PartnerDsaContract

Name Description Schema

@AddressLine1
optional

Address line 1 for DSA Contract.
Example : "Address Line 1"

string

@AddressLine2
optional

Address line 2 for DSA Contract.
Example : "Address Line 2"

string

@BusinessType
optional

Business Type of DSA Contract.
Example : "Business"

string

@CityId
optional

CityId for DSA Contract.
Example : 1

integer (int32)

@CountryId
optional

CountryId of DSA Contract.
Example : 1

integer (int32)

@Email
optional

Email for DSA Contract.
Example : "email@em.all"

string

@Name
optional

Trading name for DSA Contract.
Example : "Trading Name"

string

@PartnerType
optional

Partner Type of DSA Contract.
Example : "PrivateHost"

string

@PhoneNumber
optional

Phone number for DSA Contract.
Example : "8164036785"

string

@PostalCode
optional

Postal Code for DSA Contract.
Example : "10500"

string

@StateId
optional

StateId for DSA Contract.
Example : 1

integer (int32)

@TradingLicense
optional

Trading License for DSA Contract.
Example : "ABS1234"

string

5.149. PaymentMethod

Name Description Schema

Name
required

Payment method name.
Example : "string"

string

code
required

Payment method code.
Example : 0

integer (int32)

5.150. PersonNameType

Name Description Schema

GivenName
required

Contact person’s given name/first name.

Amendable: No
Example : "John"

string

Surname
required

Contact person’s last name/family name.

Amendable: No
Example : "Smith"

string

5.151. Phone

Name Description Schema

@PhoneNumber
required

Telephone number assigned to a single location.

Amendable: No
Example : "+123456789"

string

5.152. PhonesType

Name Description Schema

Phone
required

A collection of Phone elements.
Example : [ "Phone" ]

< Phone > array

5.153. Policies

Name Description Schema

Policy
optional

Describes the policies of the property, such as the type of payments, or whether children or pets are accepted.
Example : [ "Policy" ]

< Policy > array

5.154. Policy

Name Description Schema

CancelPolicy
optional

Defines the cancellation policy of the hotel facility.
Example : CancelPenaltiesType

CancelPenaltiesType

FeePolicies
optional

(Only for vacation rental properties)

Fee policy information.
Example : FeePolicies

FeePolicies

PolicyInfo
optional

Basic property policy information.
Example : PolicyInfo

PolicyInfo

5.155. PolicyInfo

Name Description Schema

@CheckInTime
optional

The usual check-in time for the property. Time format: HH:mm:ss.
Example : "14:00:00"

string

@CheckOutTime
optional

The usual check-out time for the property. Time format: HH:mm:ss.
Example : "12:00:00"

string

5.156. Position

Name Description Schema

@Latitude
required

The measure of the angular distance on a meridian north or south of the equator.

Amendable: No
Minimum value : -90
Maximum value : 90
Example : 12.513994

number (double)

@Longitude
required

The measure of the angular distance on a meridian east or west of the prime meridian.

Amendable: No
Minimum value : -180
Maximum value : 180
Example : 99.965228

number (double)

5.157. PositionResponse

Name Description Schema

@Latitude
required

The measure of the angular distance on a meridian north or south of the equator.
Minimum value : -90
Maximum value : 90
Example : 12.513994

number (double)

@Longitude
required

The measure of the angular distance on a meridian east or west of the prime meridian.
Minimum value : -180
Maximum value : 180
Example : 99.965228

number (double)

5.158. ProductOffer

Name Description Schema

@Name
required

Name of an Agoda product offer.
Example : "Late Check-Out"

string

@OfferCode
required

Code of an Agoda product offer.
Example : 44

integer (int32)

5.159. ProductOffers

Name Description Schema

ProductOffer
required

List of supported product offers
Example : [ "ProductOffer" ]

< ProductOffer > array

5.160. Properties

Name Description Schema

Property
optional

Include most of the property information with all the status of property
Example : [ "Property" ]

< Property > array

5.161. Property

Name Description Schema

Code
required

The Agoda.com property ID, returned on creation of the property.
Example : "123"

string

CurrencyCode
required

An ISO 4217 (3) alpha character code that specifies a monetary unit.
Example : "USD"

string

Name
required

A text field used to communicate the proper name of the property.
Example : "Orlando Tropical Breeze"

string

PropertyStatus
required

Overall Status of the property.
Example : PropertyStatus

PropertyStatus

5.162. PropertyInfoTPAExtensions

Name Description Schema

Directions
optional

(Only for vacation rental properties)

A collection of Directions.
Example : Directions

Directions

HouseRules
optional

(Only for vacation rental properties)

A collection of House Rules.
Example : HouseRules

HouseRules

LocalRecommendations
optional

(Only for vacation rental properties)

A collection of Local Recommendations.
Example : LocalRecommendations

LocalRecommendations

RentalLicense
optional

(Only for vacation rental properties)

Rental License.
Example : "string"

string

5.163. PropertyStatus

Name Description Schema

ContractSigned
optional

Status of property’s contract signing.
Example : "Yes"

enum (Yes, No)

Created
optional

Property created data and time in yyyy-MM-dd HH:mm:ss format
Example : "2023-11-19 07:13:06"

string

FraudCheckPassed
optional

Status of property’s fraud checking.
Example : "Yes"

enum (Yes, No)

LastChange
optional

Last modified date and time of Property in yyyy-MM-dd HH:mm:ss format
Example : "2024-02-19 13:14:06"

string

PhotosIngested
optional

Status of property’s photos Ingestion.
Example : "Yes"

enum (Yes, No)

PropertyLived
optional

Status of property’s live.
Example : "Yes"

enum (Yes, No)

PropertyReady
optional

Status of property after its lived to know following things.

Servable flag is turned on RateEnabled flag is turned on YCS is enabled
Example : "Yes"

enum (Yes, No)

RatePlansAvailable
optional

Status of property to know if property have active rateplan(s).
Example : "Yes"

enum (Yes, No)

ReprocessRequired
optional

The identifier flag to know if API expect re-pushing the property contents with overlay.

Yes: Reprocessing required for property contents. No: No reprocessing required for property content
Example : "No"

enum (Yes, No)

RoomsAvailable
optional

Status of property to know if property have active room(s).
Example : "Yes"

enum (Yes, No)

StatusType
optional

The status of the property.

"Active" status means property is still active in Agoda.

"Closed" status means property was temporarily closed.

"Deleted" status means property was deleted permanently.
Example : "Closed"

enum (Active, Closed, Deleted)

5.164. RatePlan

Name Description Schema

@RatePlanCode
optional

The Agoda.com rate plan ID, returned on creation of the rate plan.

(Required for update request, optional for create request)
Example : 123

integer (int32)

@RatePlanID
optional

The code that uniquely identifies a rate plan in the supplier’s system.

(Required for create request, optional for update request)
Example : "RatePlan12"

string

@RatePlanNotifType
required

An enumerated type that indicates whether this is a new rate plan or an update of an existing rate plan. Values: New, Overlay, Delta
Example : "New"

enum (New, Overlay, Delta)

@RatePlanStatusType
optional

An enumerated type that indicates the status of the rate plan. Values: Active, Inactive, Deleted.
Example : "Inactive"

enum (Active, Inactive, Deleted)

@RatePlanType
optional

Agoda Rate Types:

  • 1: Net Exclusive

  • 2: Net Inclusive

  • 3: Sell Exclusive

  • 4: Sell Inclusive

Amendable: No
Example : "1"

enum (1, 2, 3, 4)

Description
required

RatePlan description. (Optional for update rateplan’s status request)
Example : ParagraphTypeRatePlan

ParagraphTypeRatePlan

TPA_Extensions
optional

Provide Agoda customized data of rate plan schema
Example : RatePlanTPAExtensions

RatePlanTPAExtensions

5.165. RatePlanCrossRef

Name Description Schema

@RequestRatePlanCode
required

Identification of the sending system RatePlan Code (Supplier rate plan id)
Example : "RatePlan12"

string

@ResponseRatePlanCode
required

Identification of the responding system RatePlan Code. (Agoda rate plan id)
Example : "123"

string

5.166. RatePlanCrossRefs

Name Description Schema

RatePlanCrossRef
required

Cross Reference between sending system and responding system RatePlan Codes.
Example : [ "RatePlanCrossRef" ]

< RatePlanCrossRef > array

5.167. RatePlanResponse

Name Description Schema

@IsActive
optional

The boolean flag indicates if the rate plan is currently active or not. Active means the rate plan is activated and associated with at least one room type
Example : true

boolean

@RatePlanCode
optional

The Agoda.com rate plan ID, returned on creation of the rate plan.
Example : 123

integer (int32)

@RatePlanID
optional

The code that uniquely identifies a rate plan in the supplier’s system.
Example : "RatePlan12"

string

@RatePlanType
optional

Agoda Rate Types:

  • 1: Net Exclusive

  • 2: Net Inclusive

  • 3: Sell Exclusive

  • 4: Sell Inclusive
    Example : "1"

enum (1, 2, 3, 4)

Description
optional

RatePlan description.
Example : [ "ParagraphTypeRatePlan" ]

< ParagraphTypeRatePlan > array

TPA_Extensions
optional

Provide Agoda customized data on Rate Plan.
Example : RatePlanTPAExtensions

RatePlanTPAExtensions

5.168. RatePlanTPAExtensions

Name Description Schema

Channels
optional

Collection of channels that are able to sell a rate plan.
Example : ChannelsType

ChannelsType

5.169. RatePlans

Name Description Schema

@HotelCode
required

The Agoda.com property ID, returned on creation of the property.
Example : 9612080

integer (int32)

RatePlan
required

A deal on which a room is sold. Each rate plan can have a different rate and different inclusions. Every room type must have at least one Rate Plan.
Example : [ "RatePlan" ]

< RatePlan > array

5.170. RatePlansResponse

Name Description Schema

RatePlans
required

A collection of rate plans.
Example : [ "RatePlanResponse" ]

< RatePlanResponse > array

5.171. RateType

Name Description Schema

Code
required

Rate type Code.
Example : 0

integer (int32)

Name
required

Rate type name.
Example : "string"

string

5.172. Room

Name Description Schema

@NumberOfBathroom
optional

Number of bathroom in this room. (Overlay)
Example : 1

integer (int32)

@NumberOfBedroom
optional

Number of bedroom in this room. (Overlay)
Example : 1

integer (int32)

@RoomID
optional

The code that uniquely identifies a room type in the supplier’s system.

(Required for create request, optional for update request)
Example : "Room898"

string

@RoomViewCode
optional

Identifier for the room view type. (Overlay)

See: Get a list of supported views
Example : 2

integer (int32)

@SizeMeasurement
optional

Textual description of room dimensions. Unit: square meters (m2). (Overlay)
Example : 30

integer (int32)

5.173. RoomAmenities

Name Description Schema

RoomAmenity
required

List of supported room amenities
Example : [ "RoomAmenity" ]

< RoomAmenity > array

5.174. RoomAmenity

Name Description Schema

@Code
required

Code of an Agoda room amenity.
Example : 25

integer (int32)

@Name
required

Name of an Agoda room amenity.
Example : "air conditioning"

string

5.175. RoomConfiguration

Name Description Schema

@AllowChildrenInRoom
optional

Whether children can stay in this room or not.
Example : true

boolean

@BabyCots
optional

Whether baby cots/cribs can be accommodated in this room or not.
Example : true

boolean

@ChildrenAllowedForFree
optional

Number of children allowed to stay in this room for free. Allow value from 0 to 9.
Example : 2

integer (int32)

@MaxAdultsOccupancy
optional

Maximum occupancy of adults per room.
Example : 2

integer (int32)

@MaxChildrenInRoom
optional

Deprecated: This attribute is deprecated, use AllowChildrenInRoom instead.

Maximum number of children allowed in the room.

Value must be between 0 and MaxOccupancy - 1.
Example : 1

integer (int32)

@MaxChildrenOccupancy
optional

Maximum occupancy of children per room.
Example : 2

integer (int32)

@MaxExtraBeds
optional

Maximum number of extra beds allowed. (Overlay)

Value must be between 0 and 15.
Example : 2

integer (int32)

@MaxInfantsInRoom
optional

Maximum number of infants allowed in the room. (Overlay)

Value must be between 0 and MaxOccupancy - 1.
Example : 1

integer (int32)

@MaximumRate
optional

Maximum rate at which the room can be sold at. Same currency as Property needs to be used. This does not restrict to updates via our ARI API’s. Setting this value will restrict users from manually updating rates via YCS. (Overlay)

Value should be > MinimumRate and must be between 0 and 999999999.
Example : 500.0

number (double)

@MinimumRate
optional

Minimum rate at which the room can be sold at. Same currency as Property needs to be used. This does not restrict to updates via our ARI API’s. Setting this value will restrict users from manually updating rates via YCS. (Overlay)

Value should be < MaximumRateValue and must be between 0 and 999999999.
Example : 100.0

number (double)

@NumberOfBathroom
optional

Number of bathroom in this room. (Overlay)
Example : 1

integer (int32)

@NumberOfBedroom
optional

Number of bedroom in this room. (Overlay)
Example : 1

integer (int32)

@RackRate
optional

This is the full price rate for the room type. Same currency as Property needs to be used. (Overlay)

Value must be between 0 and 999999999.
Example : 400.0

number (double)

@RoomViewCode
optional

Identifier for the room view type. (Overlay)

See: Get a list of supported views
Example : 2

integer (int32)

@SizeMeasurement
optional

Textual description of room dimensions. Unit: square meters (m2). (Overlay)
Example : 30

integer (int32)

@StandardRate
optional

This is used as a default rate when updating rates in the extranet manually. (Overlay)

Value must be between 0 and 999999999.
Example : 400.0

number (double)

5.176. RoomDescription

Name Description Schema

@Language
optional

The language of this room.

See: Get a list of supported languages
Example : "en-US"

string

Image
optional

An image url for this room.
Example : [ "Image" ]

< Image > array

Text
required

A description with language for this room.
Example : [ "Text" ]

< Text > array

5.177. RoomType

Name Description Schema

@RoomTypeCode
required

The Agoda.com room ID, returned on creation of the room.
Example : 123

integer (int64)

5.178. RoomTypes

Name Description Schema

RoomType
required

A list of room types.
Example : [ "RoomType" ]

< RoomType > array

5.179. RoomUseExtension

Name Description Schema

@CheckInTime
optional

Check-in time for this property product. Time in HH:MM:SS format.
Example : "12:00:00"

string (date-time)

@CheckOutTime
optional

Check-out time for this property product. Time in HH:MM:SS format.
Example : "17:00:00"

string (date-time)

5.180. SellDateRange

Name Description Schema

@End
required

The ending value of the time span. Date in yyyy-MM-dd format.
Example : "2019-12-31"

string

@Start
required

The starting value of the time span. Date in yyyy-MM-dd format.
Example : "2019-01-10"

string

5.181. SellableProduct

Name Description Schema

@InvCode
optional

The Agoda.com room ID, returned on creation of the room.

(Required for update request, optional for create request)
Example : 101

integer (int32)

@InvNotifType
required

An enumerated type that indicates whether this is a new inventory item or an update of an existing inventory item. Values: New, Overlay, Delta
Example : "New"

enum (New, Overlay, Delta)

@InvStatusType
optional

An enumerated type that indicates the status of the room. Values: Active, Inactive, Deleted.
Example : "Active"

enum (Active, Inactive, Deleted)

Description
optional

Description of the sellable product.
Example : NameDescription

NameDescription

GuestRoom
optional

Guest room information.
Example : GuestRoomType

GuestRoomType

5.182. SellableProducts

Name Description Schema

@HotelCode
required

The Agoda.com property ID, returned on creation of the property
Example : 9612080

integer (int32)

SellableProduct
required

The list of sellable products. Attributes of SellableProduct are the inventory codes, information on the use, application and sequencing of the inventory information.
Example : [ "SellableProduct" ]

< SellableProduct > array

5.183. Service

Name Description Schema

@Code
required

Refer to Agoda Amenity Code.

See: Get a list of supported hotel services
Example : "5"

string

@Status
optional

Status of the channel - applicable for Delta request type only.
Example : "Active"

enum (Active, Inactive)

5.184. ServiceResponse

Name Description Schema

@Code
required

Refer to Agoda Amenity Code.

See: Get a list of supported hotel services
Example : "261"

string

DescriptiveText
optional

Description of the service
Example : "mini golf course"

string

5.185. Services

Name Description Schema

Service
required

A collection of Service elements.
Example : [ "Service" ]

< Service > array

5.186. ServicesResponse

Name Description Schema

Service
required

A collection of Service elements.
Example : [ "ServiceResponse" ]

< ServiceResponse > array

5.187. StayDateRange

Name Description Schema

@End
required

The ending value of the time span. Date in yyyy-MM-dd format.
Example : "2019-12-31"

string

@Start
required

The starting value of the time span. Date in yyyy-MM-dd format.
Example : "2019-01-10"

string

5.188. SubRoom

Name Description Schema

@RoomType
required

A string value representing a room type, "BedRoom" or "LivingRoom".
Example : "BedRoom"

string

Amenities
required

Collection of room level bed type amenities.
Example : AmenitiesType

AmenitiesType

5.189. SubRooms

Name Description Schema

SubRoom
required

Bed types in each room.
Example : [ "SubRoom" ]

< SubRoom > array

5.190. SuccessType

Type : object

5.191. TaxDriverSettings

Name Description Schema

@AllInclusiveFacility
optional

All Inclusive Facility.
Example : true

boolean

@ArenaFeePassThrough
optional

Arena Fee Pass Through.
Example : true

boolean

@ArizonaOnlineLodgingMarketplace
optional

Arizona Online Lodging Marketplace.
Example : true

boolean

@AverageDailyRate
optional

Average Daily Rate.
Example : 1.234

number (float)

@BedAndBreakfastFacility
optional

Bed and Breakfast Facility.
Example : true

boolean

@BreakfastProvided
optional

Breakfast Provided.
Example : true

boolean

@CertifiedInns
optional

Certified Inns.
Example : true

boolean

@CommunityOwnedHotels
optional

Community Owned Hotels.
Example : false

boolean

@ExclusiveLongTermUse
optional

Exclusive Long Term Use.
Example : true

boolean

@ExtendedStayFacility
optional

Extended Stay Facility.
Example : true

boolean

@FacilityConstructionDate
optional

Facility Construction Date.
Example : "2022-05-31"

string (date-time)

@FacilityLimit
optional

Facility Limit.
Example : 1

integer (int32)

@FullServiceFacility
optional

Full Service Facility.
Example : true

boolean

@GamingResortFacility
optional

Gaming Resort Facility.
Example : true

boolean

@GroupMeetingFacility
optional

Group Meeting Facility.
Example : true

boolean

@HawaiiOptimumRate
optional

Hawaii Optimum Rate.
Example : true

boolean

@HistoricHotels
optional

Historic Hotels.
Example : true

boolean

@LengthOfStay
optional

Length of Stay.
Example : 3

integer (int32)

@LimitedServiceFacility
optional

Limited Service Facility.
Example : true

boolean

@LodgingRevenueThreshold
optional

Lodging Revenue Threshold.
Example : 1.234

number (float)

@LodgingRooms
optional

Lodging Rooms.
Example : 2

integer (int32)

@LongTermContractRenters
optional

Long Term Contract Renters.
Example : true

boolean

@MaineConventionalRounding
optional

Maine Conventional Rounding.
Example : true

boolean

@MeetingSpace
optional

Meeting Space.
Example : true

boolean

@NewOrleansTourismSupportAssessment
optional

New Orleans Tourism Support Assessment.
Example : true

boolean

@NewYorkCountiesRoomAndOtherCommonCharg
optional

New York Counties - Room and Other - Common Charg.
Example : true

boolean

@NewYorkCountiesRoomAndOtherCommonCharge
optional

New York Counties - Room and Other - Common Charge.
Example : true

boolean

@NightNumber
optional

Night Number.
Example : 2

integer (int32)

@NonMemberTouristBusinessImprovementDistrict
optional

Non Member Tourist Business Improvement District.
Example : true

boolean

@NumberOfPersonsInAHotelEstablishment
optional

Number of Persons in a Hotel Establishment.
Example : 2

integer (int32)

@PrepaymentInFull
optional

Prepayment in Full.
Example : true

boolean

@PrimaryResidence
optional

Primary Residence.
Example : true

boolean

@PrivateHomeOwnerOccupied
optional

Private Home - Owner Occupied.
Example : true

boolean

@PrivateHomeOwnerUnoccupied
optional

Private Home - Owner Unoccupied.
Example : true

boolean

@QualifyingRentalOrLeaseAgreement
optional

Qualifying Rental/Lease Agreement.
Example : true

boolean

@ResidentialDwellingPartialRental
optional

Residential Dwelling - Partial Rental.
Example : true

boolean

@ResortPropertyMember
optional

Resort Property Member.
Example : true

boolean

@SharedRoomFacility
optional

Shared Room Facility.
Example : true

boolean

@ShortTermRentalCommercial
optional

Short Term Rental - Commercial.
Example : true

boolean

@ShortTermRentalFacility
optional

Short Term Rental Facility.
Example : true

boolean

@ShortTermRentalProfessionallyManagedUnit
optional

Short Term Rental - Professionally Managed Unit.
Example : true

boolean

@ShortTermRentalResidential
optional

Short Term Rental - Residential.
Example : true

boolean

@ShortTermRentalTwoOrThreeFamilyDwelling
optional

Short Term Rental - Two or Three-Family Dwelling.
Example : true

boolean

@SouthCarolina1PercentExclusionIndividualsAge85AndOver
optional

South Carolina 1% Exclusion-Individuals Age 85 and over.
Example : true

boolean

@SpringfieldHotelTaxPassThrough
optional

Springfield Hotel Tax Pass Through.
Example : true

boolean

@StandardServiceFacility
optional

Standard Service Facility.
Example : true

boolean

@TourismAssessmentOptOut
optional

Tourism Assessment - Opt-out.
Example : true

boolean

@TribalEntities
optional

Tribal entities.
Example : true

boolean

5.192. Text

Name Description Schema

@Language
required

The language of this description.

See: Get a list of supported languages
Example : "en-US"

string

@Status
optional

Status of the description - applicable for Delta request type only.
Example : "Active"

enum (Active, Inactive)

value
required

A description for this room.
Example : "Beach Front Rooms are 30 sqm with sea views. Saikaew Beach Resort provides all rooms, designed to offer you easy living by the sea among natural beauty, therefore, large windows in each room allow you to admire tropical garden or the beach right from your bed."

string

5.193. TextItem

Name Description Schema

Description
required

Description of the TextItem
Example : "Agoda.com url."

string

URL
required

URL of the property. It might take some time to generate this URL after creating a property.
Example : "https://agoda.com"

string

5.194. TextItemsType

Name Description Schema

TextItem
required

Text description of a given category.
Example : [ "TextItem" ]

< TextItem > array

5.195. UniqueID_Type

Name Description Schema

@ID
required

Identification of the responding system Inventory Code. (Agoda property id)
Example : "123"

string

@Type
required

A reference to the type of object defined by the UniqueID element. Refer to OpenTravel Code List Unique ID Type (UIT).
Example : "10"

string

5.196. ValueAddInclusions

Name Description Schema

Benefit
optional

List of benefits included with the rateplan
Example : [ "Benefit" ]

< Benefit > array

RoomUseExtension
optional

Identifies the CheckIn and/or CheckOut time available for this product.
Example : RoomUseExtension

RoomUseExtension

5.197. View

Name Description Schema

@Name
required

Name of an Agoda view.
Example : "Ocean"

string

@ViewCode
required

Code of an Agoda view.
Example : "1"

string

5.198. Views

Name Description Schema

View
required

List of supported views
Example : [ "View" ]

< View > array

5.199. WarningType

Name Description Schema

@Code
required

This refers to a table of coded values exchanged between applications to identify errors or warnings. Refer to OpenTravel Code List Error Codes (ERR).
Example : "123"

string

@ShortText
required

An abbreviated version of the warning in textual format.
Example : "Please try again in a few minutes"

string

@Status
required

Recommended values are those enumerated in the OTA_ErrorRS, (NotProcessed | Incomplete | Complete | Unknown) however, the data type is designated as string data, recognizing that trading partners may identify additional status conditions not included in the enumeration.
Example : "Incomplete"

string

5.200. WarningsType

Name Description Schema

Warning
required

Optionally used to indicate that the recipient of the request message identified one or more business-level warnings.
Example : [ "WarningType" ]

< WarningType > array

6. Customized Schema of OpenTravel_2017B_XML

6.1. Requesting Schema OTA_HotelInvNotifRQ

Host : content-push.agoda.com
BasePath : /cm/xsd/{Schema}
Schemes : HTTPS
URL : https://content-push.agoda.com/cm/xsd/{Schema}
Example
{Schema} : OTA_HotelInvNotifRQ
Request : https://content-push.agoda.com/cm/xsd/OTA_HotelInvNotifRQ
Success : HTTP StatusCode 200 with content XML Schema as content.

OTA_HotelInvNotifRQ.xsd
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
    xmlns="http://www.opentravel.org/OTA/2003/05"
    targetNamespace="http://www.opentravel.org/OTA/2003/05"
    elementFormDefault="qualified" version="6.000" id="OTA2017B">
   <xs:annotation>
      <xs:documentation source="Description"
      xml:lang="en">ALL SCHEMA FILES IN THE OPENTRAVEL ALLIANCE
      SPECIFICATION ARE MADE AVAILABLE ACCORDING TO THE TERMS DEFINED
      BY THE OPENTRAVEL LICENSE AGREEMENT AT
      http://www.opentravel.org/Specifications/Default.aspx.</xs:documentation>
   </xs:annotation>
   <xs:include schemaLocation="OTA_HotelCommonTypes.xsd" />
   <xs:element name="OTA_HotelInvNotifRQ">
      <xs:annotation>
         <xs:documentation xml:lang="en">
            The OTA_HotelInvNotifRQ is the message that sends the
            notification of a new inventory item, such as a room
            type or service type created for the hotel that did
            not previously exist.
         </xs:documentation>
      </xs:annotation>
      <xs:complexType>
         <xs:sequence>
            <xs:element name="SellableProducts">
               <xs:annotation>
                  <xs:documentation xml:lang="en">
                    A collection of Sellable products for a given property.
                  </xs:documentation>
               </xs:annotation>
               <xs:complexType>
                  <xs:complexContent>
                     <xs:extension base="SellableProductsType">
                        <xs:attribute name="HotelCode"
                            type="NumericStringLength1to16"
                            use="optional">
                           <xs:annotation>
                              <xs:documentation source="Description"
                                xml:lang="en">The code that uniquely identifies
                                a single hotel property. The hotel code is decided
                                between vendors.
                            </xs:documentation>
                           </xs:annotation>
                        </xs:attribute>
                        <xs:attribute name="ID"
                            type="AsciiStringLength1to100"
                            use="optional">
                           <xs:annotation>
                              <xs:documentation source="Description"
                                xml:lang="en">
                                The code that uniquely identifies a single hotel
                                property in the supplier's system.
                              </xs:documentation>
                           </xs:annotation>
                        </xs:attribute>
                     </xs:extension>
                  </xs:complexContent>
               </xs:complexType>
            </xs:element>
         </xs:sequence>
      </xs:complexType>
   </xs:element>
</xs:schema>

6.2. Requesting Invalid Schema

Host : content-push.agoda.com
BasePath : /cm/xsd/{Schema}
Schemes : HTTPS
URL : https://content-push.agoda.com/cm/xsd/{Schema}
Example
{Schema} : Invalid_Schema
Request : https://content-push.agoda.com/cm/xsd/Invalid_Schema
Failure : HTTP StatusCode 404 without content

7. FAQ

7.1. How do the GuestInfo (age policy/child stay free) in the Property call relate to the YCS extranet settings?

See below screenshot from our YCS extranet settings and their related attribute for the API

Property Age Policy

What is the difference between ChildAgeTo and MaxChildAge?

  • ChildAgeTo → we consider guest as children up to this age.

  • MaxChildAge → we will collect extra bed price from this age and above

7.2. How should I set the Contact Info?

Please provide ContactProfileType="PhysicalLocation" which is used for physical address

Example 1:
<ContactInfo ContactProfileType="PhysicalLocation">
    <Addresses>
        <Address Language="en-US">
            <AddressLine>213 Street Name.</AddressLine>
            <CityName>Bangkok</CityName>
            <PostalCode>10250</PostalCode>
            <CountryName>TH</CountryName>
        </Address>
    </Addresses>
</ContactInfo>

Please provide ContactProfileType="general" which is used for user login, booking notification, and contact for Agoda

Example 2:
<ContactInfo ContactProfileType="general">
    <Names>
        <Name>
            <GivenName>John</GivenName>
            <Surname>Smith</Surname>
        </Name>
    </Names>
    <Phones>
        <Phone PhoneNumber="+123456789"/>
    </Phones>
    <Emails>
        <Email>admin@test-hotel.com</Email>
    </Emails>
</ContactInfo>

7.3. Will these email/phone number be shared with the guest?

No, we do not share the provided email or phone with guests.

7.4. How does the Contract work?

  1. Contract signing from the property owner is mandatory in order to proceed to fraud-check and activation of the property.

    • For individual property, please use hotelContractsSign call.

    • For vacation rentals property, please use hostContractsSign call.

  2. Property owner can sign the contract on Agoda extranet (YCS or Host Manage).

7.5. Will properties under the same email account get auto-lived after contract signed via hostContractsSign call or on Host Manage extranet?

For the following HotelCategories, properties will be auto-lived from the email account signing, regardless of room quantity:

HotelCategory ID HotelCategory Name

28

Private Villa

29

Apartment

30

Villa

102

Boat / Cruise

103

Bungalow

106

Chalet

107

Country House

108

Homestay

109

Farm Stay

110

Holiday Park / Caravan Park

114

Tent

115

Riad

120

Serviced Apartment

131

Home

7.6. Cancellation policies can be set at the property level and the product level. Which one will be used?

Please make sure you push cancellation policy to Agoda, either at the property level or hotelproduct level. Otherwise, Agoda will default to the cancellation policy to "Cancel 1 day prior to arrival date, the first-night charge, No Show, the first-night charge" (1D1N_1N).

If there are cancellation policies at both levels, or more than one policy can be applied, Agoda will apply the strictest one.

7.7. Why do I get error code 1201 "API key is not authorized for Property id: xxx" when I try to push SetARI/SetARIv2 or GetProduct?

There will be around 1 min delay time after HotelProduct creation and ARI update.

7.8. Does Agoda take commission from surcharges/fees?

Yes, surcharges/fees created via the API will be commissionable.

You can find more details here: https://agodapropertypartnerhelp.zendesk.com/hc/en-us/articles/360001445708-How-do-I-manage-additional-fees-

7.9. How Agoda calculate the booking price?

Please find the details here: https://agodapropertypartnerhelp.zendesk.com/hc/en-us/articles/360051821373-How-do-I-calculate-my-booking-rates-

7.10. Why do I get "Authorization error" when trying to create a room or rate plan?

After you create a property, we will save the data into our database tables. There will be a delay in our system for around 1 minute before you can start pushing the room or rate plan, or sign contract.

7.11. Why I got "Home should have 1 rate plan." error?

This is a validation for single unit vacation rentals (Agoda Homes) to have only 1 rate plan and 1 room type per property.

Property will be categorized as single-unit vacation rentals when: * GuestRoomInfo→Quantity = 1 * HotelCategory is matched with one of the below:

HotelCategory ID HotelCategory Name

28

Private Villa

29

Apartment

30

Villa

102

Boat / Cruise

103

Bungalow

106

Chalet

107

Country House

108

Homestay

109

Farm Stay

110

Holiday Park / Caravan Park

114

Tent

115

Riad

120

Serviced Apartment

131

Home

7.12. Why I got "Restrictions - limit 1 room" error?

Please see previous question.

7.13. How can I set RoomConfiguration in Room call?

Please see explanations of each attribute and how they relate to settings on YCS extranet

Room Configuration

7.14. How does Delta (partial update) request work?

We do have support for a partial update for 1-many fields except for image in property, room, and rate plan requests. Normally, by sending an Overlay request, you need to send all data for the particular property, room, or rate plan. Otherwise, we will delete the information if it does not present in the request.

By sending a Delta request, we have provided the ability to ignore the particular 1-many fields if there is no change related to that field. We will only process the information by using the Status attribute.

Example

For example, the property has services 1, 2, 3 currently, If you send the Overlay request with services 3, 4, 5. we will remove services 1, 2 and add services 4, 5 to the property.

Current Data Request Type Request Body Result

1, 2, 3

Overlay

 
<Services>
  <Service Code="3"/>
  <Service Code="4"/>
  <Service Code="5"/>
</Services>

3, 4, 5

If you send the Delta request. We will process only the service that presents in the request using the Status (Active, Inactive). Let says you send a request with 4 (Active), 5 (Inactive), 6 (Active). We will add services 4, 6 and remove service 5. Service 3 will remain.

Current Data Request Type Request Body Result

3, 4, 5

Delta

 
<Services>
  <Service Code="4" Status="Active"/>
  <Service Code="5" Status="Inactive"/>
  <Service Code="6" Status="Active"/>
</Services>

3, 4, 6

In case you send the Delta request without any service, all services of the property will be kept as it is.

Current Data Request Type Request Body Result

3, 4, 6

Delta

 
<Services></Services>

3, 4, 6

For the Delta request, if any element does not have the Status attribute, we will put Active as a default.

Current Data Request Type Request Body Result

3, 4, 6

Delta

 
<Services>
  <Service Code="6"/>
  <Service Code="7"/>
  <Service Code="8"/>
</Services>

3, 4, 6, 7, 8

Please note the Status attribute is applicable for the Delta request only. If you send a New or Overlay request, the Status will be ignored.

Current Data Request Type Request Body Result

3, 4, 6, 7, 8

Overlay

 
<Services>
  <Service Code="6"/>
  <Service Code="7"/>
  <Service Code="8"/>
</Services>

6, 7, 8

7.15. Other Limitations

  1. Transaction limit: 10 requests/second - PRODUCTION

  2. 1 min delay time after HotelProduct creation and ARI update - Both PRODUCTION & SANDBOX

  3. 1 min delay time after property creation and the next request for that specific property - Both PRODUCTION & SANDBOX

  4. Image / photo requirement:

    • Minimum picture dimension is 800 x 600 px

    • Maximum file size is 10 MB

    • Supported file formats are jpeg, jpg, gif, png