Jump to Content
Direct Supply
HomeAPI User GuidesAPI ReferenceChangelog
Direct Supply
API Reference
HomeAPI User GuidesAPI ReferenceChangelog

API Documentation

  • Agoda APIs

AUTHENTICATION

  • Overview
  • OAuth 2.0 Authorization
  • IP Whitelisting
  • FAQ

YCS API

  • Overview
  • Availability and Rates
    • Availability and Rates Element and Attribute
    • SetARI V2 - Basic Mode / Use same price for all occupancies
    • SetARI V2 - Use custom prices for all occupancies
    • SetARI V2 - Use custom deviation for each occupancy with amount
    • SetARI V2 - Deviation Mode Percentage
    • SetARI V2 - Response
    • GetARIV2 - Request and Response
  • Booking Retrieval
    • Element and Attributes
    • GetBookingList - Selected Properties
    • GetBookingList V2 - All Properties
    • GetBookingDetail - Booking Retrieval
    • GetBookingDetail - Japanese Properties
  • Product Management
    • Elements and Attributes
    • SetProduct
    • GetProduct
  • Booking hint
    • Booking Hint example
    • Element and Attributes
  • Code List
    • Special Requests
    • Language Code
    • List of Benefits IDs
    • Error Codes

OTA API

  • Overview
  • Availability Restrictions
    • OTA_HotelAvailNotifRQ
    • OTA_HotelAvailNotifRS
  • Generic Push Booking API
    • OTA_HotelResRQ
    • OTA_HotelResRS
    • OTA_CancelRQ
    • OTA_CancelRS
    • Special Requests
    • Error Codes
    • Unique ID Type
  • Room Availability and Rates
    • OTA_HotelRateAmountNotifRQ
    • OTA_HotelRateAmountNotifRS
  • Booking Rules
    • OTA_HotelBookingRuleNotifRQ
    • OTA_HotelBookingRuleNotifRS
  • Precheck
    • OTA_HotelAvailRQ
    • OTA_HotelAvailRS
  • Code Lists
    • AgeQualifyingCode
    • Charge Unit (Tax & Fees)
    • Type (Tax & Fees)
    • Meal Plan
    • Error Codes
  • Payment Card Solutions
    • PaymentCard

Content push api

  • Overview
  • Paths
    • Managing Properties
    • Managing Property Status
    • Get Property Status
    • Managing Rooms
    • Managing Room Status
    • Managing Rates
    • Managing Rate Status
    • Managing Product
    • Get Property Details
    • Get Contract
    • Sign Contract
    • Get Host Contracts
    • Sign Host Contracts
    • Get Error Codes
    • Get Benefits
    • Get Cancel Policies
    • Get Countries
    • Get Currencies
    • Get Hotel Services
    • Get Room Amenities
    • Get Languages
    • Get Product Offers
    • Get Hotel Categories
    • Get Hotel Types
    • Get Bed Types
    • Get Fees
    • Get Customer Segment Groups
    • Get Views
    • Get Image Captions
  • Definitions
    • AGErrorType
    • AGErrorsType
    • AGSuccessType
    • AGWarningType
    • AGWarningsType
    • AG_HotelContractInfoRQ
    • AG_HotelContractInfoRS
    • AG_HotelContractSignNotifRQ
    • AG_HotelContractSignNotifRS
    • AG_HostContractInfoRQ
    • AG_HostContractInfoRS
    • AG_HostContractSignNotifRQ
    • AG_HostContractSignNotifRS
    • AG_HotelStatusRQ
    • AG_HotelStatusRS
    • Address
    • AddressesType
    • AffiliationInfoType
    • AgodaBenefit
    • AgodaBenefits
    • AgodaContractType
    • AgodaHotelCategories
    • AgodaHotelCategory
    • AgodaLanguage
    • AgodaLanguages
    • AmenitiesType
    • AmenitiesTypeInfo
    • Amenity
    • AmenityInfo
    • Award
    • Awards
    • BedType
    • BedTypes
    • Benefit
    • BookingRule
    • BookingRules
    • CancelPenaltiesType
    • CancelPenaltyType
    • CancelPolicies
    • CancelPolicy
    • CategoryCodesType
    • Channel
    • ChannelsType
    • ChildAgeBand
    • ChildAgeBandsType
    • ContactInfoRootType
    • ContactInfosType
    • ContactsType
    • Contract
    • ContractsType
    • Countries
    • Country
    • Criterion
    • Currencies
    • Currency
    • CustomerSegmentGroup
    • CustomerSegmentGroups
    • Descriptions
    • DescriptionsResponse
    • Directions
    • Email
    • EmailsType
    • ErrorCode
    • ErrorCodes
    • ErrorResponse
    • ErrorType
    • ErrorsType
    • FacilityInfoType
    • Fee
    • FeePolicies
    • FeeType
    • Fees
    • GuestInfo
    • GuestRoom
    • GuestRoomInfo
    • GuestRoomTPAExtensionsType
    • GuestRoomType
    • GuestRooms
    • HostContractContent
    • HostContractContents
    • HostContractInfo
    • HostContractInfos
    • HostContractSign
    • HostContractSigns
    • HotelCategory
    • HotelContractContent
    • HotelContractContents
    • HotelContractInfo
    • HotelContractInfos
    • HotelContractSign
    • HotelContractSigns
    • HotelDescriptiveContent
    • HotelDescriptiveContentResponse
    • HotelDescriptiveContentTPAExtensions
    • HotelDescriptiveContents
    • HotelDescriptiveContentsResponse
    • HotelDescriptiveInfo
    • HotelDescriptiveInfos
    • HotelInfoType
    • HotelInfoTypeResponse
    • HotelProduct
    • HotelProductCancelPenaltiesType
    • HotelProductCancelPenaltyType
    • HotelProductPolicyInfo
    • HotelProductRatePlan
    • HotelProductRatePlans
    • HotelProducts
    • HotelRef
    • HotelRefs
    • HotelService
    • HotelServices
    • HotelSummaryMessage
    • HotelSummaryMessagesType
    • HotelTPAExtensions
    • HouseRules
    • Image
    • ImageCaption
    • ImageCaptions
    • ImageFormat
    • ImageItem
    • ImageItemTPAExtensions
    • ImageItemsType
    • InventoryCrossRef
    • InventoryCrossRefs
    • LocalRecommendations
    • MultimediaDescriptionType
    • MultimediaDescriptionTypeResponse
    • MultimediaDescriptions
    • MultimediaDescriptionsType
    • NameDescription
    • OTAReference
    • OTARefsType
    • OTA_HotelDescriptiveContentNotifRQ
    • OTA_HotelDescriptiveContentNotifRS
    • OTA_HotelDescriptiveInfoRQ
    • OTA_HotelDescriptiveInfoRS
    • OTA_HotelInvNotifRQ
    • OTA_HotelInvNotifRS
    • OTA_HotelProductNotifRQ
    • OTA_HotelProductNotifRS
    • OTA_HotelRatePlanNotifRQ
    • OTA_HotelRatePlanNotifRS
    • OTA_HotelSummaryNotifRQ
    • OTA_HotelSummaryNotifRS
    • Occupancy
    • ParagraphTypeRatePlan
    • PaymentMethod
    • PersonNameType
    • Phone
    • PhonesType
    • Policies
    • Policy
    • PolicyInfo
    • Position
    • PositionResponse
    • ProductOffer
    • ProductOffers
    • Properties
    • Property
    • PropertyInfoTPAExtensions
    • PropertyStatus
    • RatePlan
    • RatePlanCrossRef
    • RatePlanCrossRefs
    • RatePlanResponse
    • RatePlanTPAExtensions
    • RatePlans
    • RatePlansResponse
    • RateType
    • Room
    • RoomAmenity
    • RoomConfiguration
    • RoomDescription
    • RoomType
    • RoomTypes
    • RoomUseExtension
    • SellDateRange
    • SellableProduct
    • SellableProducts
    • Service
    • ServiceResponse
    • Services
    • ServicesResponse
    • StayDateRange
    • SubRoom
    • SubRooms
    • SuccessType
    • TaxDriverSettings
    • Text
    • TextItem
    • TextItemsType
    • UniqueID_Type
    • ValueAddInclusions
    • View
    • Views
    • WarningType
    • WarningsType
  • Customized Schema of OpenTravel_2017B_XML
    • Requesting Schema OTA_HotelInvNotifRQ
    • Requesting Invalid Schema
  • Security
  • Change log
  • Code Lists
    • Error Codes

Promotion API

  • Overview
  • Paths
    • Create/Update Promotion
    • Toggle Promotion
    • Retrieve Promotions
    • Get Error Codes
  • 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 

AgodaHotelCategories

Name Description Schema

AgodaHotelCategory
required

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

< AgodaHotelCategory > array