Rate Management API

Contents

1. Overview

Rate Management API is part of the Content API, however it's possible to use this part only for creating and managing Rate Plans.

This API supports textual content only in English language. The content text in English language will be translated to multiple languages on our side. The contents for other languages other than English will be ignored. The endpoints between Hotels and Vacation Rental properties are shared.

1.1. Version Information

Version : 6.4.8

1.2. URL scheme

Host : content-push-sandbox.agoda.com

BasePath : /

Schemes : HTTPS, HTTP

2. Security

2.1. apiKey

Type : apiKey

Name : Authorization

In : HEADER

3. Managing Rates

3.1. Description

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

3.2. Body Parameter

List of RatePlans in OTA2017B format which need to be created

Name : body

Flags : required

Type : OTA_HotelRatePlanNotifRQ

3.3. Responses

3.4. Consumes

application/xml

3.5. Produces

application/xml

3.6. Tags

RatePlans

3.7. Security

3.8. Example HTTP request

<?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="123" RatePlanID="RatePlan12" RatePlanNotifType="New" RatePlanType="1">

<Description Name="Standard Rate"/>

<TPA_Extensions>

<Channels>

<Channel ChannelCode="1"/>

</Channels>

</TPA_Extensions>

</RatePlan>

</RatePlans>

</OTA_HotelRatePlanNotifRQ>

3.9. 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>