Jump to Content

Home API User Guides API Reference Changelog

API Reference

Home API User Guides API Reference Changelog

API Documentation

Agoda APIs

AUTHENTICATION

Overview
OAuth 2.0 Authorization
IP Whitelisting
FAQ

YCS API

Overview
Availability and Rates
Booking Retrieval
Product Management
Booking hint
- Booking Hint example
- Element and Attributes
Code List

OTA API

Overview
Availability Restrictions
- OTA_HotelAvailNotifRQ
- OTA_HotelAvailNotifRS
Generic Push Booking API
Room Availability and Rates
- OTA_HotelRateAmountNotifRQ
- OTA_HotelRateAmountNotifRS
Booking Rules
- OTA_HotelBookingRuleNotifRQ
- OTA_HotelBookingRuleNotifRS
Precheck
- OTA_HotelAvailRQ
- OTA_HotelAvailRS
Code Lists
Payment Card Solutions
- PaymentCard

Content push api

Overview
Paths
Definitions
Customized Schema of OpenTravel_2017B_XML
- Requesting Schema OTA_HotelInvNotifRQ
- Requesting Invalid Schema
Security
Change log
Code Lists
- Error Codes

Promotion API

Overview
Paths
Definitions
Security
Change Log

pUllspec v1.34

hotelSearch
- Gets the availability of a hotel based on given search criteriapost
precheck
- Checks the **availability and price** before submitting the booking to supplier/partner.post
makebook
- Makes the bookingpost
cancel
- Cancels the booking given an Agoda booking reference IDpost
bookingDetail
- Gets details of an individual bookingpost
bookingIds
- Fetch booking IDs created within a given time periodpost
OpenAPI spec file
PDF documentation

Powered by

ImageItemTPAExtensions

Name Description Schema

CaptionCode
optional

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

string