{"info":{"_postman_id":"38c40127-a148-4b56-8a2c-f0bf11a04e52","name":"Agoda.com API Specs","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"11110788","collectionId":"38c40127-a148-4b56-8a2c-f0bf11a04e52","publishedId":"SzmcZyT3","public":true,"customColor":{"top-bar":"042338","right-sidebar":"303030","highlight":"044A76"},"publishDate":"2020-05-07T13:21:26.000Z"},"item":[{"name":"YCS5 API Specs","item":[{"name":"Multi Occupancy","item":[{"name":"SetARI V2","id":"06d184e9-a3e3-4566-be36-b9f1b6f67751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n 1\n 2\n 3\n 4\n 5\n 6\n 7\n \n 9\n \n false\n false\n true\n \n \n \n \n \n \n 2019-06-30\n \n \n \n \n \n \n \n \n \n 200.0\n \n \n \n \n \n \n \n false\n \n 1\n 30\n \n \n 2\n \n \n \n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

XML Elements and Attributes

\n

SetAriRQ

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Request
Timestamp		Numeric1Y1483526410357
(GMT: Wed, 04 Jan 2017 10:40:10.357)		A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided must correspond with the time in the originating system and in EPOCH. System requires EPOCH timestamps in milliseconds.
TypeNumeric Length 11Y1This number identifies a particular
request:
1 SetAri
2 GetAri
3 GetBookingList
4 GetBookingDetail
5 GetProduct
8 SetProduct
9 GetBookingListV2
Criteria
Property Id		String Length 1-81Y123Every request must contain a valid property ID that partner has access to. Every property has a unique ID in Agoda and every Channel Manager partner has to have the access to this specific property via an authorized API key.
Inventory
Update room_id		Numeric Length 1-8unboundedY72027This is the Agoda room ID related to the property inventory element. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
date_range from toDate YYYY-MM-DDunboundedY2016-04-02Date Range information for request. From = inclusive start date for the inventory request To = inclusive end date for the inventory request
dowNumeric Length 1-71 to 7N1Denotes the day of the week which needs to be updated via the SetAri request:
1 = Monday
2 = Tuesday
3 = Wednesday
4 = Thursday
5 = Friday
6 = Saturday
7 = Sunday
Note: DOW can only be used in conjunction with date_range
allotmentNumeric length 1-31Y2Controls if room type is open for sale or closed to sale. Close will stop room type regular inventory being sold even if inventory is available. Guaranteed inventory is still available for sale if close is applied.
Restrictions
closed		boolean1YTRUE or 1Controls if room type is open for sale or closed to sale. Close will stop room type regular inventory being sold even if inventory is available. Guaranteed inventory is still available for sale if close is applied.
ctdboolean1NFALSE or 0Set to make room type open for departure for this date or closed for departure on this date. Customer can still stay through this date if they depart on future date. Not mandatory and if element not sent, Close to Departure status in extranet remains same as current.
ctabooleanNFALSE or 0Set to make room type open for arrival for this date or closed for arrival on this date. Customer can still stay through this date if they arrive on past date. Not mandatory and if element not sent, Close to Arrival status in extranet remains same as current.
Rate
Update room_id		Numeric Length 1-8unboundedY72027This is the Agoda room ID related to the property inventory element. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
Rateplan_idNumeric Length 1-6unboundedY1 to 6This is the Agoda Rateplan ID related to a particular offer active on a room. Agoda active Rate Type IDs can be returned with Getproduct request. If no Rateplan ID is specified in the request, all active Rateplans will be returned in the response.
Date_values valueDate YYYY-MM-DD1 to 31YMaximum 31 date values can be set in the request. Alternatively, the date_range from/to can be used at this point of the request.
prices
currency		Alpha 31YTHBThe Currency must match with the property currency.
Normal Default
Numeric Length 1-91N250.0The rate is applied to all occupancies
Normal Occupancy PersonNumericunboundedN300.0Number of occupancies the price will applied to.
Normal Occupancy PriceNumeric Length 1-9unboundedN350.0The price for the specified occupancy.
deviation base_priceNumeric Length 1-91N400.0This price is use as the base for the deviation (amount or percentage) of each occupancy.
deviation occupancy percentageNumeric Lenght 1-9unboundedN10The deviation in percentage for the specified occupancy.
deviation occupancy ammountNumeric Lenght 1-9unboundedN10.0/td>\n The deviation in ammount for the specified occupancy.
Extra bedNumeric nnn.nn1N100.0/td>\n This rate is used as the extra bed rate and is available to all hotel occupancy models. ‘0’ extra bed rate indicates extra bed is not available for sale for the specified room, rateplan and date (closed for sale). Extra bed rate can only be set if num_extrabed is set to ‘1’ or more.
child_rates
child_rate price		Numeric nnn.nnunboundedN200.0This is the rate amount for the child pricing for the specific age band. ‘0’ child price rate indicates the child will not be charged for the specified room, rateplan and date.
child_rate age_band_codeNumericunboundedN2This is the code used to uniquely identify the child age band.
Restrictions
closed		boolean1NTRUE or 1Controls if room type is open for sale or closed to sale. Close will stop room type regular inventory being sold even if inventory is available. Guaranteed inventory is still available for sale if close is applied. Not mandatory and if element not sent, close out status in extranet remains same as current.
ctdboolean1NFALSE or 0Set to make rate type open for departure for this date or closed for departure on this date. Customer can still stay through this date if they depart on future date. Not mandatory and if element not sent, Close to Departure status in extranet remains same as current.
ctaboolean1NFALSE or 0Set to make rate type open for arrival for this date or closed for arrival on this date. Customer can still stay through this date if they arrive on past date. Not mandatory and if element not sent, Close to Arrival status in extranet remains same as current.
LOS
min		Numeric length 1-21N1 to 99Minimum length of stay that is required to search and book this room type. MinLOS cannot be greater than maxLOS. To remove minLOS restriction, default value = ‘1’.
maxNumeric length 1-21N0 to 99Minimum length of stay that is required to search and book this room type. MaxLOS cannot be less than minLOS. To remove maxLOS restriction, default value = ‘0’.
STAYTHROUGH
min		Numeric1N0 to 30Minimum length of stay that is required to search and book this room type for stay through. Not mandatory and if element not sent, Min stay through remains same as current.
To remove min stay through restriction, set min = ‘0’.
\n\n

SetAriRS

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Result
TUID		String length 131Y89f66310-6718-11e5-b298-0758c951ac41A Track Unique Identifier (TUID) is an identifier which is guaranteed to be unique and it has a specific tracking purpose.
TimestampNumeric1Y1483526410357
(GMT: Wed, 04 Jan 2017 10:40:10.357)		A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided will correspond with the time in the originating system and in EPOCH.
System requires EPOCH timestamps in milliseconds.
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"7c8fd51e-1f7d-4b9c-85c3-74818219779b","name":"SetARI V2 - xsd or pre-validation failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n 1\n 2\n 3\n 4\n 5\n 6\n 7\n \n 9\n \n false\n false\n true\n \n \n \n \n \n \n 2019-06-30\n \n \n \n \n \n \n \n \n \n 200.0\n \n \n \n \n \n \n \n false\n \n 1\n 30\n \n \n 2\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:49:31 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n"},{"id":"decf071b-112e-4972-98f5-29bdb4895cb3","name":"SetARI V2 - xsd and pre-validation passed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n 1\n 2\n 3\n 4\n 5\n 6\n 7\n \n 9\n \n false\n false\n true\n \n \n \n \n \n \n 2019-06-30\n \n \n \n \n \n \n \n \n \n 200.0\n \n \n \n \n \n \n \n false\n \n 1\n 30\n \n \n 2\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:49:31 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"06d184e9-a3e3-4566-be36-b9f1b6f67751"},{"name":"SetARI V2 - Basic Mode / Use same price for all occupancies","id":"229aa538-7575-474d-ab75-790cdb575b55","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

Price Table - Max Occupancy = 5

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Occupancy
1
2
3
4
5
Price
2000.0 THB2000.0 THB2000.0 THB2000.0 THB2000.0 THB
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"3a5e39ac-ed8f-41d2-89a9-221ed6db0430","name":"SetARI V2 - xsd and pre-validation passed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:45:04 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":""},{"id":"7c09e4f4-93ae-4594-bf66-13700baf8964","name":"SetARI V2 - xsd or pre-validation failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:45:04 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n"}],"_postman_id":"229aa538-7575-474d-ab75-790cdb575b55"},{"name":"SetARI V2 - Use custom prices for all occupancies","id":"7296d7af-b393-49aa-8d7b-7200c59bb521","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

Price Table - Max Occupancy = 5

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Occupancy
1
2
3
4
5
Price
1000.0 THB1200.0 THB1400.0 THB1600.0 THB1800.0 THB
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"0c57bdc1-f748-4d41-898b-e12fd3942a03","name":"SetARI V2 - xsd and pre-validation passed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:50:02 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":""},{"id":"b77c3069-32d6-4da0-bed9-c1329b52a55b","name":"SetARI V2 - xsd or pre-validation failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:50:02 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n"}],"_postman_id":"7296d7af-b393-49aa-8d7b-7200c59bb521"},{"name":"SetARI V2 - Use custom deviation for each occupancy with amount","id":"fb6d4fbc-02a1-47d4-8f92-8444de3bfc88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

Price Table - Max Occupancy = 4

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Occupancy
1
2
3
4
Price
1000.0 THB1100.0 THB1200.0 THB1300.0 THB
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"26682302-1cb0-4397-9658-e733dc7fcfc0","name":"SetARI V2 - xsd and pre-validation passed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:50:02 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":""},{"id":"59c7b285-719a-4942-b223-d576e8bc8ee1","name":"SetARI V2 - xsd or pre-validation failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:50:02 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n"}],"_postman_id":"fb6d4fbc-02a1-47d4-8f92-8444de3bfc88"},{"name":"SetARI V2 - Deviation Mode Percentage","id":"1a0dafd3-df8b-426c-b750-07dc56239fcf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

Price Table - Max Occupancy = 4

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Occupancy
1
2
3
4
Price
1100.0 THB1200.0 THB1200.0 THB1200.0 THB
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"9b5d9d28-38b5-4e49-8848-fe349428454b","name":"SetARI V2 - xsd and pre-validation passed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:50:08 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":""},{"id":"fb90a711-1ac4-4ece-9c95-af27b24c227f","name":"SetARI V2 - xsd or pre-validation failed","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n 100.0\n \n \n \n \n \n \n \n false\n false\n false\n \n 1\n 30\n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"akka-http/10.1.10"},{"key":"Date","value":"Wed, 16 Sep 2020 01:50:08 GMT"},{"key":"Content-Type","value":"text/xml; charset=UTF-8"},{"key":"Content-Length","value":"223"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n"}],"_postman_id":"1a0dafd3-df8b-426c-b750-07dc56239fcf"},{"name":"GetARIV2","id":"8f0b9be5-fb76-40a7-9d9b-74810c197a60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

This function allows retrieval of Availability and Rate Inventory (ARI) for existing rooms and rates.

\n

XML Elements and Attributes

\n

GetAriV2 RQ

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Request
Timestamp		Numeric1Y1483526410357
(GMT: Wed, 04 Jan 2017 10:40:10.357)		A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided must correspond with the time in the originating system and in EPOCH. System requires EPOCH timestamps in milliseconds.
TypeNumeric Length 11Y2This number identifies a particular request:
1 SetAri
2 GetAri
3 GetBookingList
4 GetBookingDetail
5 GetProduct
8 SetProduct
9 GetBookingListV2
Criteria
from to		Datetime YYYY-MM-DD HH:MM:SS1Y2015-09-01T00:00:00+07:00The inclusive start (from) and end (to) date and time for the query. Time of reference is always UTC time zone +/- to identify other timezones. The date range cannot be longer than 31 days.
Property
Id		String Length 1-81 to 5Y123Every request must contain a valid property ID that partner has access to. Every property has a unique ID in Agoda and every Channel Manager partner must have the access to this specific property via an authorized API key. Maximum 5 property IDs can be queried in this GetARI request.
Room_idNumeric Length 1-81N85236This is the Agoda room ID related to the property inventory element. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
Rateplan_idNumeric Length 1-61N24468This is the Agoda Rateplan ID related to a particular offer active on a room. Agoda active Rate Type IDs can be returned with Getproduct request. If no Rateplan ID is specified in the request, all active Rateplans will be returned in the response.
TypeAlpha1NInventoryThe type in the criteria>>request can be one of the following:
rate
inventory
both
\n\n

GetAriV2 RS

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Result
Timestamp		Numeric1Y1454628391 (2016-02-04T23:26:31Z)
A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided will correspond with the time in the originating system and in EPOCH. System requires EPOCH timestamps in milliseconds.
Properties
item_count		Numeric1Y2Count indicates how many dates are returned across all properties queried.
Property IdString Length 1-81Y123Every request must contain a valid property ID that partner has access to
dateDate YYYY-MM-DDunboundedY2016-12-31
Rates
rateplan_id		Numeric Length 1-6unboundedY1 to 6This is the Agoda Rateplan ID related to a particular offer active on a room. Agoda active Rate Type IDs can be returned with Getproduct request. If no Rateplan ID is specified in the request, all active Rateplans will be returned in the response.
CurrencyAlpha 31YTHB
Room
Room_id		Numeric Length 1-8unboundedY72027This is the Agoda room ID related to the property inventory element. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
extra_bedNumeric nnn.nn1Y100.0This rate is used as the extra bed rate and is available to all hotel occupancy models. ‘0’ is returned if ‘0’ is set via SetAri call or if price for extra bed rate does not exist. ‘0’ extra bed rate indicates extra bed is not available for sale for the specified room, rateplan and date.
closedboolean1YFALSEControls if room type is open for sale or closed to sale. Close will stop room type being sold even if inventory is available but will still allow Guaranteed Allotments to be sold
ctaboolean1YTRUEControls if room type is open for arrival for this date or closed for arrival on this date. Customer can still stay through this date if they arrive on past date
ctdboolean1YFALSEControls if room type is open for departure for this date or closed for departure on this date. Customer can still stay through this date if they depart on future date
min_losNumeric length 1-21Y1Minimum length of stay that is required to search and book this room type
max_losNumeric length 1-21Y5Maximum length of stay that is required to search and book this room type
min_staythroughNumeric length 1-21Y2Minimum length of stay that is required for stay through.
prices
occupancy person		NumericunboundedY2Number of occupancies the price will applied to.
occupancy priceNumeric Length 1-9unboundedY350.0The price for the specified occupancy.
child_rates
child_rate price		Numeric nnn.nnunboundedN200.0This is the rate amount for the child pricing for the specific age band. ‘0’ child price rate indicates the child will not be charged for the specified room, rateplan and date.
child_rate age_fromNumericunboundedN1Minimum child age for the specific age band.
child_rate age_toNumericunboundedN6Maximum child age for the specific age band.
child_rate age_band_codeNumericunboundedN2The code used to uniquely identify the child age band.
Inventories
room room_id		Numeric Length 1-8unboundedY72027This is the Agoda room ID related to the property inventory element. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
allotmentNumeric length 1-31Y2Total amount of regular allotment rooms in this room type available in YCS5 for sale to customers
guaranteed_allotmentNumeric length 1-31Y5Total amount of guaranteed allotment rooms in this room type available in YCS5 for sale to customers.
allotment_used_regularNumeric length 1-31Y2Total amount of regular allotment rooms in this room type sold in YCS to Agoda
allotment_used_guaranteedNumeric length 1-31Y1Total amount of guaranteed allotment rooms in this room type sold to Agoda customers.
closedboolean1YFALSEControls if room type is open for sale or closed to sale. Close will stop room type being sold even if inventory is available but will still allow Guaranteed Allotments to be sold
ctaboolean1YTRUEControls if room type is open for arrival for this date or closed for arrival on this date. Customer can still stay through this date if they arrive on past date
ctdboolean1YFALSEControls if room type is open for departure for this date or closed for departure on this date. Customer can still stay through this date if they depart on future date
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"f327fdde-cfa8-4da7-a560-35333a86883a","name":"GetARIV2 ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADD YOU APIKEY HERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADD YOU APIKEY HERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Wed, 22 Apr 2020 06:27:31 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"340"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"}],"_postman_id":"8f0b9be5-fb76-40a7-9d9b-74810c197a60"}],"id":"79dce7a2-d398-44cb-aa0a-a965707ad6dc","description":"

Introduction

\n

Agoda recommends channel manager partners to use occupancy-based pricing as this pricing model offers the most flexible solution for pricing. No migration is needed to convert a property currently on the per-day pricing model to occupancy-based pricing. Please make sure the pricing model you specify when sending rate updates is the right one pre-configured for your property on Agoda extranet. You can obtain pricing model information through a GetProduct request for product details, including the “occupancy_model\" attribute. Should a property be using a pricing model you have not developed please contact your account manager or Agoda connectivity team.

\n

Functionality

\n

If a channel manager partners wants to change the number of occupancy levels in the room, the property first must contact its Market Manager to change the configuration of the room type (thereby updating the property’s settings on Agoda extranet, and then partner can send Agoda the new rates for those occupancy levels. Occupancy-based pricing also requires the rate to be set to the total amount charged for that occupancy level. For example, if a property already has occupancy level 4 newly configured for it on Agoda extranet and wants to set the rate for occupancy level 4 of a room type to $150.00, then it should include the following input in the request message:

\n \n\n

Two modes are available for occupancy-based pricing updates:

\n
    \n
  • Basic: Allow customer rates for all occupancies with default or custom prices
    • \n
  • Deviation: Allow custom deviation for each occupancy with amount or percentage
    • \n
\n

Note: The channel manager API currently does not support removal of occupancies

\n

Limitation on request size

\n
    \n
  • SetAriV2: 1,000,000 bytes (1 MB – powers of ten)
    • \n
\n

API Interface

\n

This function allows the connectivity partners to update or retrieve Availability Rates Inventory (ARI) and restrictions for a specific hotel on a specific date range. Some attributes in this call are defined by settings in YCS5 Room Setup and/or Rate Plan Setup page.

\n

Note: All updates are strict in nature, which means old data will be completely overwritten by new price. In this version we do not allow partial updates

\n
Important Information
You can specify up to 730 days (2 years) of rates and availability from the date you send the updates","event":[{"listen":"prerequest","script":{"id":"6a9ebee1-9f53-4778-b086-844cc22abe83","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fc9e7dec-fc91-463b-a8e5-adadd5f8385d","type":"text/javascript","exec":[""]}}],"_postman_id":"79dce7a2-d398-44cb-aa0a-a965707ad6dc"},{"name":"Bookings","item":[{"name":"GetBookingList - Selected Properties","id":"bfc32f73-fdc0-4dd3-957e-76add3c46f68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

This function allows the Connectivity Partners to retrieve the bookings for a specific property or up to 5 properties at once.

\n

XML Elements and Attributes

\n

GetBookingListRQ

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Request
Timestamp		Numeric1Y1483526410357
(GMT: Wed, 04 Jan 2017 10:40:10.357)		A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided must correspond with the time in the originating system and in EPOCH. System requires EPOCH timestamps in milliseconds.
TypeNumeric Length 11Y3This number identifies a particular
request:
1 SetAri
2 GetAri
3 GetBookingList
4 GetBookingDetail
5 GetProduct
8 SetProduct
9 GetBookingListV2
Criteria
from to		Datetime YYYY-MM-DD HH:MM:SS1Y2015-09-01T00:00:00+07:00The inclusive start (from) and end (to) date and time for the booking query. The inclusive start (from) and end (to) date and time for the booking query. Time of reference is always UTC time zone +/- to identify other timezones. From date time cannot be older than 740 days. Date range allows up to 90 days per request.
statusAlpha1NAmendBookingDenotes the type of bookings to query. Options are:
ConfirmBooking
AmendBooking
CancelBooking
Property
Id		String Length1 to 5Y123Every request must contain a valid property ID that partner has access to. Every property has a unique ID in Agoda and every Channel Manager partner has to have the access to this specific property via an authorized API key. Maximum 5 property IDs can be queried in this GetBookingList request.
\n\n

GetBookingListRS

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Result Timestamp
Numeric1Y1454628391 (2016-02-04T23:26:31Z)A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided will correspond with the time in the originating system and in EPOCH. System requires EPOCH timestamps in milliseconds.
Properties
count		Numeric 1-51Y1Count indicates number of properties. In this request a maximum of 5 properties can be requested to retrieve the bookings.
Property
Id		String Length 1-81Y123Every request must contain a valid property ID that partner has access to
Booking
booking_id		Numeric Length 1-151Y4335173Agoda Booking ID for this booking. This must be used when sending GetBookingDetails request
booking_dateDatetime YYYY-MM-DD HH:MM:SS1Y2015-09-15T12:39:00+07:00Date that booking was created on Agoda YCS5. Time of reference is always UTC time zone +/- to identify other timezones.
last_actionDatetime YYYY-MM-DD HH:MM:SS1Y2015-09-15T12:47:33+07:00The last date that the booking was actioned: created/amended/cancelled. If booking is amended multiple times only the last amended date is listed here. Time of reference is always UTC time zone +/- to identify other timezones.
arrivalDate YYYY-MM-DD1Y10-4-2015The inclusive start date for the booking (check in date)
departureDate YYYY-MM-DD1Y10-5-2015The inclusive end date for the booking (check out date)
statusAlpha1YConfirmBookingDenotes the status type of bookings. Statuses are:
ConfirmBooking
AmendBooking
CancelBooking
acknowledge0 - 11Y0It defines if a booking is already acknowledged or not:
0= not acknowledge
1= acknowledged
\n\n

GetBookingList Request Time Interval and Criteria Example

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Request Time
From Date
To date
2018-07-17 18:00:00 (GMT+7)2018-07-17 at 17:55:00 (GMT+7)2018-07-17 at 18:00:00 (GMT+7)
2018-07-17 18:05:00 (GMT+7)2018-07-17 at 18:00:00 (GMT+7)2018-07-17 at 18:05:00 (GMT+7)
2018-07-17 18:10:00 (GMT+7)2018-07-17 at 18:05:00 (GMT+7)2018-07-17 at 18:10:00 (GMT+7)
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"6cfc9b58-a805-4ba8-9c22-d7e3227372cf","name":"GetBookingList - Selected Properties / AmendBooking","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n"},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 23 Apr 2020 07:52:05 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"240"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n \n \n \n \n"},{"id":"92a2b7a2-7089-4726-a496-9455ac0a746b","name":"GetBookingList - Selected Properties / ConfirmBooking","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n"},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 23 Apr 2020 07:43:33 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"239"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n \n \n \n \n"},{"id":"e59d9b30-0f85-438d-84d7-d29cf7caedf0","name":"GetBookingList - Selected Properties / Empty Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n"},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 23 Apr 2020 07:38:07 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"132"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n \n \n \n \n"},{"id":"efbf5ae9-6ef1-4a5b-9d59-9e070f43caf5","name":"GetBookingList - Selected Properties / CancelBooking","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n"},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 23 Apr 2020 07:55:02 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"240"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n \n \n \n \n"}],"_postman_id":"bfc32f73-fdc0-4dd3-957e-76add3c46f68"},{"name":"GetBookingList V2 - All Properties","id":"bb85afaf-5f48-4c2d-9390-34776a525975","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"text/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

This function allows the connectivity partners to get booking list without hotel specified. GetBookingListV2 will return all bookings that updated in specified period of all hotels belong to channel manager.

\n

XML Elements and Attributes

\n

GetBookingListV2RQ

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Request
Timestamp		Numeric1Y1483526410357
(GMT: Wed, 04 Jan 2017 10:40:10.357)		A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds.
TypeNumeric Length 11Y9This number identifies a particular request: 1 SetAri
2 GetAri
3 GetBookingList
4 GetBookingDetail
5 GetProduct
8 SetProduct
9 GetBookingListV2
Criteria
from to		Datetime YYYY-MM-DD HH:MM:SS1Y2015-09-01T00:00:00+07:00The inclusive start (from) and end (to) date and time for the booking query based on last action. The inclusive start (from) and end (to) date and time for the booking query. Time of reference is always UTC time zone +/- to identify other timezones. From date time cannot be older than 740 days. Date range allows up to 60 mins per request.
statusAlpha1NAmendBookingDenotes the type of bookings to query. Options are: ConfirmBooking AmendBooking CancelBooking
If no status specified, all booking status will be returned.
Result
Timestamp		Numeric11483526410357
(2017-01-04 10:40:10.357)		2015-09-15T12:39:00+07:00A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds.
Properties
count		Numeric 1-51Y1Count indicates number of properties.
Property
Id		String Length 1-81Y123Every request must contain a valid property ID that partner has access to and correspond with booking ID
Booking
booking_id		Date YYYY-MM-DD1Y10-5-2015The inclusive end date for the booking (check out date)
booking_dateAlpha1YConfirmBookingDenotes the status type of bookings. Statuses are:
ConfirmBooking
AmendBooking
CancelBooking
last_action0 - 11Y0It defines if a booking is already acknowledged or not:
0= not acknowledge
1= acknowledged
arrivalDate YYYY-MM-DD12016-10-05The inclusive start date for the booking (check in date)
departureDate YYYY-MM-DD12016-10-05The inclusive end date for the booking (check out date)
statusAlpha1ConfirmBookingDenotes the status type of bookings. Statuses are:
ConfirmBooking
AmendBooking
CancelBooking
acknowledge0 - 110It defines if a booking is already acknowledged or not:
0= not acknowledge
1= acknowledged
\n\n

GetBookingListV2RS

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Result
Timestamp		Numeric1Y1483526410357
(2017-01-04 10:40:10.357)		A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds.
Properties
count		Numeric 1-51Y1Count indicates number of properties.
Property
Id		String Length 1-81Y123Every request must contain a valid property ID that partner has access to and correspond with booking ID
Booking
booking_id		Numeric Length 1-151Y4335173Agoda Booking ID for this booking. This must be used when sending GetBookingDetails request
booking_dateDatetime YYYY-MM-DD HH:MM:SS1Y2015-09-15T12:39:00+07:00Date that booking was created on Agoda YCS5. Time of reference is always UTC time zone +/- to identify other timezones.
last_actionDatetime YYYY-MM-DD HH:MM:SS1Y2015-09-15T12:47:33+07:00The last date that the booking was actioned: created/amended/cancelled. If booking is amended multiple times only the last amended date is listed here. Time of reference is always UTC time zone +/- to identify other timezones.
arrivalDate YYYY-MM-DD1Y10-4-2015The inclusive start date for the booking (check in date)
departureDate YYYY-MM-DD1Y10-5-2015The inclusive end date for the booking (check out date)
statusAlpha1YConfirmBookingDenotes the status type of bookings. Statuses are:
ConfirmBooking
AmendBooking
CancelBooking
acknowledge0 - 11Y0It defines if a booking is already acknowledged or not:
0= not acknowledge
1= acknowledged
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"60201773-001b-419e-881c-d92b99be0ea0","name":"GetBookingListV2 - Response (xsd and pre-validation pass)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 23 Apr 2020 07:39:56 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"93"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"},{"id":"62c48eac-a992-4954-90c4-aed9164d64b5","name":"GetBookingList V2 - Response (no booking return)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\n \r\n\n"},{"id":"a01aa4cb-65cb-4413-bab4-91dfb03bae55","name":"GetBookingList V2 - Response (xsd or pre-validation fail)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\n \n \n \n"}],"_postman_id":"bb85afaf-5f48-4c2d-9390-34776a525975"},{"name":"GetBookingDetail - Booking Retrieval","id":"6a20aa1a-5857-4fb0-8c2c-0c78ca83c4c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n\n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

This function allows the Connectivity Partners to collect the booking details for a specific property up to 50 bookings at once.\nThe data retention period for booking details is 90 days.

\n

XML Elements and Attributes

\n

GetBookingDetailsRQ

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Request
Timestamp		Numeric1Y1483526410357
(GMT: Wed, 04 Jan 2017 10:40:10.357)		A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds.
TypeNumeric Length 11Y4This number identifies a particular request: 1 SetAri
2 GetAri
3 GetBookingList
4 GetBookingDetail
5 GetProduct
8 SetProduct
9 GetBookingListV2
Criteria
Language		Alpha Lentgh 21YENLanguage in which the response will be returned. If the language is not correct, the response will return a warning and the response in English. Refer to language list for languages available for use.
Property
Id		String Length 1-81N123Every request must contain a valid property ID that partner has access to. Every property has a unique ID in Agoda and every Channel Manager partner has to have the access to this specific property via an authorized API key.
booking_idNumeric Length 1-1511 to 50Y4335173Agoda Booking ID for this booking. This ID is required when sending GetBookingDetails request and maximum number of booking id that can be set in this request is 50.
\n\n

GetBookingDetailsRS

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Result
Timestamp		Numeric1Y1483526410357
(GMT: Wed, 04 Jan 2017 10:40:10.357)		A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time the XML was generated in the originating system in EPOCH. System requires EPOCH timestamps in milliseconds.
Bookings
count		Numeric 1-501Y1Count indicates number of bookings returned for the requested property.
iataidNumeric1Y96637800Lists Agoda IATA number.
Booking
Property Id		String Length 1-8unboundedN123Agoda property ID. If booking ID is not returned, invalid Booking ID was not found against property ID in Request.
property_nameAlpha1YSunshine Garden ResortAgoda Booking ID for this booking. This must be used when sending GetBookingDetails request
booking_idNumeric Length 1-151Y4335173
booking_dateDatetime YYYY-MM-DD HH:MM:SS1Y2015-09-15T12:39:00+07:00Date that booking was created on Agoda YCS. Time of reference is always UTC time zone +/- to identify other timezones.
last_actionDatetime YYYY-MM-DD HH:MM:SS1Y2015-09-15T12:47:33+07:00The last date that the booking was changed/amended. If booking is amended multiple times only the last amended date is listed here. Time of reference is always UTC time zone +/- to identify other timezones.
arrivalDate YYYY-MM-DD1Y2015-04-24The inclusive start date for the booking (check in date)
departureDate YYYY-MM-DD1Y2015-04-25The inclusive end date for the booking (check out date)
statusAlpha1YConfirmBookingDenotes the status type of bookings. Statuses are:
ConfirmBooking
AmendBooking
CancelBooking
acknowledge0 - 11Y0It defines if a booking is already acknowledged or not:
0= not acknowledged
1= acknowledged
room_idNumeric Length 1-81Y72027This is the Agoda room ID related to the property inventory element in the YCS API version 5. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
room_typeAlpha1YDeluxe
channel_idNumeric Length 11Y1Channels in YCS5 are replacing the Rateplan in YCS5. Channels are aimed to expand or limit customer type and usually will have price discount or sale limitations:
1 Retail
2 Agoda Private Sale
6 Domestic
7 Mobile
8 Agoda Opaque
9 China
channel_nameAlpha1YRetail
rateplan_idNumeric Length 1-61Y1 to 6This is the Agoda Rateplan ID related to a particular offer active on a room. Agoda active Rate Type IDs can be returned with Getproduct request. If no Rateplan ID is specified in the request, all active Rateplans will be returned in the response.
rateplan_nameAlpha1NBreakfast
promotion_idNumeric Length 11N1184215Defines the ID related to a Promotion activate on a specific rateplan.
promotion_nameAlpha1NEarly Booking Saver Rate includes 15% discount!
room_countNumeric Length 11Y1Number of rooms booked in the same booking ID.
adultsNumeric Length 11Y2Number of Adults booked in booking. If multiple rooms are booked this number will be total adults for all bookings
childrenNumeric Length 11Y1Number of Children booked in booking. If multiple rooms are booked this number will be total adults for all bookings
extrabedsNumeric Length 11Y1Lists the number of extra beds that are booked in the booking. Any extra bed costs will be listed in the price type = \"Extrabed\".
cxl_codeString1Y1D1N_1N
= cancell within 1 day 1 night charge, no show 1 night charge
365D100P_100P
= non refundable		All cancellation policies contain 3 policy elements. Polices are set in order and policy 3 is always no-show policy and will list days as 0. The Policies value relates to a value or percentage
customer
first_name		String1YMaryThe first name of the guest for the booking
last_nameString1YWongThe last name of the guest for the booking
nationalityString1YThailandThe nationality of the guest making the booking
emailString1Nfxi@test.comThe email address of Agoda messaging service used to facilitate communication between guest and property up to 50 characters
phoneString1N0811234567The phone number of guest if ‘customer info’ is activated for the property
benefits
benefit benefit_id		Numeric Length 11 to 9N5Denotes of upto 5 benefits linked to the Rate Plan booked. Refer to benefits list for the full list of benefits available.
benefit_nameAlpha1 to 9NLunchDenotes of upto 5 benefits linked to the Rate Plan booked. Refer to benefits list for the full list of benefits available.
requests
request request_name		AlphaunboundedNNonSmokeDenotes of special requests the customer can ask when create a booking:
NonSmoke
LateCheckIn
EarlyCheckIn
HighFloor
LargeBed
TwinBeds
AirportTransfer:{0}
AdditionalNotes:{0}
FlightNo:{0}
ArrivalFlightNo:{0}
DepartFlightNo:{0}
payment
card_type		Alpha1NMastercardCredit card type for booking – will always show as Mastercard for all bookings as this is the Agoda card type for UPC card.
card_numberNumeric Length 161N503444796022XXXXNumber of the Agoda UPC (Unique Plastic Card) used by the property to debit the amount of the booking.
card_nameAlpha1NAgoda Company Pte Ltd.Name on credit card. For all bookings will show ‘Agoda Pte Ltd.’
card_expDate MM/YYYY1N10/2017Credit card expiry date
card_cvvNumeric1N170Credit card CCV number
prices
currency		Alpha 31Y763.27Denotes type of rates is returned in the GetBookingDetails response.
Net inc = net exc + taxes + fees
net_inclusive_amtNumeric nnn.nn1Y763.27Denotes type of rates is returned in the GetBookingDetails response. Net inc = net exc + taxes + fees
net_exclusive_amtNumeric nnn.nn1N693.88Net exc = net price without taxes and commission
sell_inclusive_amtNumeric nnn.nn1N919.60Sell inc = net exc + taxes + fees + commissions
sell_exclusive_amtNumeric nnn.nn1N836.00Sell exc = net exc + commissions
tax_amtNumeric nnn.nn1N69.39
fees_amtNumeric nnn.nn1N0.00
refsell_amtNumeric nnn.nn1N919.60Refsell = net exc + taxes + fees + commissions + mandatory surcharge
type1NCancellationDenotes the type of attribute the charge is referred to. Types are:
Room
Surcharge
Extrabed
Cancellation
paymentmodelNumeric0 to 1N1Payment model will be returned for channel manager participated Property Collect. Payment model can be 1 or 2
1 = Merchance booking (Agoda Collect)
2 = Agency booking (Property Collect)
\n\n

Difference between Agoda Collect and Property Collect payment model

\n
‘Paymentmodel’ = 1 (\"pay to Agoda\" bookings)
\n\n

This is the current payment model where guests pay Agoda. For this model, connectivity partner receives virtual credit card details.

\n
\n\n
‘Paymentmodel’ = 2 (\"property collect\" bookings)
\n\n

This is the new payment model where guests pay directly to the property. For this model, channel manager receives no credit card details.

\n
\n\n

**No credit card details are transmitted via API when a property is enabling ‘Property Collect’ payment model.

\n

GetBookingDetails Tax breakdown

\n

You will find below scenario for returning the tax breakdown in the GetBookingDetails response.

\n

Net Inclusive + Ref Sell Inclusive: configuration for all markets only except for some specific markets

\n
We recommend you to develop the API for hosting the 7 attributes returning in the Getbookingdetails response.
\n\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
1. Net Exclusive
2. Tax on Net
3. Fees on Net
4. Net Inclusive
5. Sell Exclusive
6. Sell Inclusive
6. Ref Sell Inclusive
Example which kinds of hotels has this setting
0001001
Merchant hotels:
majority of properties worldwide.
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"3f7d7177-5bf0-4a89-8ae0-46950a3cfafd","name":"GetBookingDetails Response Example","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n\n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 23 Apr 2020 07:47:10 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"621"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n \n \n \n \n \n \n \n 2\n \n \n\n\n \n \n \n \n \n \n \n \n \n \n 2\n \n \n"},{"id":"bc223f78-3a43-4cf2-821d-3640a2f32c11","name":"GetBookingDetail - Booking Retrieval / AmendBooking","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/xml","type":"text"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n\n","options":{"raw":{"language":"xml"}}},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Thu, 23 Apr 2020 07:52:55 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"625"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n \n \n \n \n \n \n \n \n \n"}],"_postman_id":"6a20aa1a-5857-4fb0-8c2c-0c78ca83c4c2"}],"id":"fa24a0cd-0294-4df0-a4c4-542f35a42b8e","_postman_id":"fa24a0cd-0294-4df0-a4c4-542f35a42b8e","description":""},{"name":"Product Management","item":[{"name":"SetProduct","id":"0f093ed6-4fd3-4840-9d1e-a9152fb6ad7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

SetProduct call allow partners to update room setting (such as Maximum number of person per room, minimum rate threshold of the room) and rateplan restriction (such as minimum and maximum night of stay, minimum and maximum days purchase in advance).

\n
Room Level
- any value set at Room Level affects Price parameters for SetARI call.\n* SetProduct min_rate = ‘100’, SetARI ‘prices’ default, single, double &/or full Rate must be > 100\n* SetProduct num_persons = ‘3’, SetARI ‘prices’ default or single, double & full Rate is Mandatory\n* SetProduct num_persons = ‘2’, SetARI ‘prices’ default or single & double Rate is Mandatory\n\n
Rate Plan Level
- all items in this section will apply the restriction to existing cached ARI at Rate Plan level for all dates. However, min_los & max_los can also be set via SetARI at date level and will override cached restrictions for the specified room, Rate Plan and date only.\n\n
Scenario
\n
Update # 1.
SetProduct min_los = ‘2’ this will apply minLOS ‘2’ restrictions to all dates for room, rates & dates associated with the specified rate plan.\n
Update # 2.
SetARI min = ‘3’ for a specific room ID, Rate Plan ID & date. This will change minLOS to ‘3’ only for the specific room, Rateplan & date only until it is override by a subsequent minLOS update via SetARI or SetProduct.\n\n

XML Elements and Attributes

\n

SetProductRQ

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Request
Timestamp		Numeric1Y1454628391 (2017-02-04T23:26:31Z)A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided must correspond with the time in the originating system and in EPOCH.
System requires EPOCH timestamps in milliseconds.
TypeNumeric Length 11Y8This number identifies a particular
request:
1 SetAri
2 GetAri
3 GetBookingList
4 GetBookingDetail
5 GetProduct
8 SetProduct
9 GetBookingListV2
Criteria
Property Id		String Length 1-81Y123Every request must contain a valid agoda property ID. Every property has a unique ID in Agoda and partner must first be authorised by agoda to have access to the property ID.
currencyAlpha 31NTHBCurrency is optional attribute but it will be mandadatory if partner would like to set minimum rate in the request.
Room
Update room_id		Numeric Length 1-8unboundedY72027This is the Agoda room ID related to the property inventory element. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
num_personsNumeric Length 1-2unboundedN1-30Maximum number of persons that can be accommodated in the room using existing bedding.
min_rateNumeric Length 1-9unboundedN200.0Minimum price for this room. Any value set for specified Room_id will restrict rate value set in SetAri call
Rateplan
Update
rateplan_id		Numeric Length 1-6unboundedY1 to 6This is the Agoda Rateplan ID related to a particular offer active on a room. Agoda active Rate Type IDs can be returned with Getproduct request. If no Rateplan ID is specified in the request, all active Rateplans will be returned in the response.
min_losNumeric length 1-2unboundedN1 to 99Minimum length of stay that is required to search and book this room type. MinLOS cannot be greater than maxLOS. To remove minLOS restriction, default value = ‘1’.
max_losNumeric length 1-2unboundedN0 to 99Minimum length of stay that is required to search and book this room type. MaxLOS cannot be less than minLOS. To remove maxLOS restriction, default value = ‘0’.
min_adv_daysNumeric Length 1-2unboundedN0 to 90Minimum Days in advance that rate must be booked to be eligible for a specific rateplan. To remove MinAdv restriction, default value = ‘0’.
max_adv_daysNumeric Length 1-2unboundedN-1 to 90Maximum Days in advance that rate must be booked to be eligible for a specific rateplan.
To remove MinAdv restriction, default value = ‘-1’. Note: ‘0’ restricts the sale of rate plan to be same day as check in date.
\n\n

SetProductRS

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Result
Timestamp		Numeric1Y1454628391 (2017-02-04T23:26:31Z)A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided will correspond with the time in the originating system and in EPOCH.
System requires EPOCH timestamps in milliseconds.
success1NThis tag is returned when set product success without error.
Property
id		String Length 1-81Y123Every request must contain a valid property ID that partner has access to. Every property has a unique ID in Agoda and every Channel Manager partner has to have the access to this specific property via an authorized API key.
Error
code		Numeric Length 4unboundedNRefer to Error ListAgoda’s error code. Refer to Error List
Error
description		StringunboundedNRefer to Error ListAgoda’s error message. Refer to Error List
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"035c60c3-50ed-4118-8ca2-4dafa2751f4f","name":"SetProduct ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n"},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Wed, 22 Apr 2020 06:24:48 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"73"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n"}],"_postman_id":"0f093ed6-4fd3-4840-9d1e-a9152fb6ad7c"},{"name":"GetProduct","id":"80711f92-e237-4925-b56a-acffbde87e0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n\n \n\n \n \n"},"url":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","description":"

This function allows the Connectivity Partners to retrieve the dynamic content for a specific property.

\n

XML Elements and Attributes

\n

GetProductRQ

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Request TimestampNumeric1Y1483526410357 (GMT: Wed, 04 Jan 2017 10:40:10.357)A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided must correspond with the time in the originating system and in EPOCH. System requires EPOCH timestamps in milliseconds.
TypeNumeric Length 11Y5This number identifies a particular
request:
1 SetAri
2 GetAri
3 GetBookingList
4 GetBookingDetail
5 GetProduct
8 SetProduct
9 GetBookingListV2
Criteria LanguageAlpha Lentgh 21YENLanguage in which the response will be returned. Language should be a valid language supported by Agoda. Refer to language list for languages available for use.
Property IdString Length 1-81Y123Every request must contain a valid property ID that partner has access to
Room_idNumeric Length 1-81N85236This is the Agoda room ID related to the property inventory element. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
Rateplan_idNumeric Length 1-61N24468This is the Agoda Rateplan ID related to a particular offer active on a room. Agoda active Rate Type IDs can be returned with Getproduct request. If no Rateplan ID is specified in the request, all active Rateplans will be returned in the response.
\n\n

GetProductRS

\n\n
\n\n\n\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Element / Attribute
Data Type
Occurs
Required
Examples
Description
Result
Timestamp		Numeric1Y1454628391 (2016-02-04T23:26:31Z)A timestamp is a sequence of characters or encoded information identifying when a certain event occurred. Time provided will correspond with the time in the originating system and in EPOCH. System requires EPOCH timestamps in milliseconds.
Property Id
String Length 1-81Y123Every request must contain a valid property ID that partner has access to
Property NameAlphaYSunshine Garden Resort
Property IdString Length 1-81Y123Every request must contain a valid property ID that partner has access to
CurrencyAlpha 31YTHB
LanguageAlpha Lentgh 21YENLanguage in which the response will be returned. Refer to language list for languages available for use.
Live_statusNumeric 0-11Y1 = active 0 = inactive
Occupancy_modelAlpha1YFull RateIn the 'Full Occupancy’ model there is single, double and full occupancy pricing – plus extra bed pricing based on room settings.
Rooms
Room_id		Numeric Length 1-8unboundedY72027This is the Agoda room ID related to the property inventory element. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
Room_nameAlphaunboundedYDeluxe
num_roomsNumeric Length 1-31Y52Total number of rooms for this room type set in Agoda extranet
num_personsNumeric Length 1-21YMaximum number of persons that can be accommodated in the room using existing room bedding.
num_childrenNumeric Length 11YMaximum number of children that can be accommodated in this room. This number is part of the total max occupancy number
total_personsNumeric Length 1-21YMaximum number of persons that can be accommodated in the room using existing room bedding and extra bed. Includes both adults and children.
num_extrabedNumeric Length 11YMaximum number of extra beds that accommodated in room. Each bed allows for 1 extra person.
num_baby_cotsNumeric Length 11YMaximum number of baby cots that accommodated in room.
min_rateNumeric Length 1-91YMinimum price for this room.
max_rateNumeric Length 1-91YMaximum price for this room.
rack_rateNumeric Length 1-91YRack rate for this room.
Rateplans
rateplan_id		Numeric Length 1-6unboundedY1 to 6This is the Agoda Rateplan ID related to a particular offer active on a room. Agoda active Rate Type IDs can be returned with Getproduct request. If no Rateplan ID is specified in the request, all active Rateplans will be returned in the response.
rateplan_nameAlphaunboundedYBreakfast
master_rateNumeric Length 0-6unboundedY0 to 6If the Master rate=0 this is the master rate on which other rates can be based for discount. If the Master Rate is not =0, this is a child rate and it cannot be updated via Channel Manager. The Child Rate must derive the rate from the Master, the rate can be increased/decreased by amount/percentage from the Master Rate.
sell_startDate YYYY-MM-DDTHH:MM:SSunboundedYThe inclusive start date to sell this rate.
sell_endDate YYYY-MM-DDTHH:MM:SSunboundedYThe inclusive end date to sell this rate.
stay_startDate YYYY-MM-DDunboundedNThe inclusive start date to stay for this rate.
stay_endDate YYYY-MM-DDunboundedNThe inclusive end date to stay for this rate.
tax_includedNumeric Length 1unboundedY\"0\"= exc \"1\"= incTax settings information: the tax can be excluded (0) or included (1).
rate_typeAlphaunboundedYNet SellIf the rate type is Sell, it includes all commissions. If the rate type is Net, it excludes all commissions.
min_adv_daysNumeric Length 1-21NMinimum Days in advance that rate must be booked to be eligible for a specific rateplan. This attribute is returned in the response if min_adv_days is set at Rate Plan level.
max_adv_daysNumeric Length 1-21NMaximum Days in advance that rate must be booked to be eligible for a specific rateplan. This attribute is returned in the response if max_adv_days is set at Rate Plan level.
min_losNumeric length 1-21NMinimum length of stay that is required to search and book this room type. This attribute is returned in the response if min_los is set at Rate Plan level.
max_losNumeric length 1-21N5Maximum length of stay that is required to search and book this room type. This attribute is returned in the response if max_los is set at Rate Plan level.
cxl_codeString1YEach Agoda cancellation policy has a unique ID. This ID relates to this Agoda cancel policy. All cancellation policies contain 3 policy elements. Polices are set in order and policy 3 is always no-show policy and will list days as 0. The Policies value relates to a value or percentage
offertype_idNumeric Length 1-6YIt defines the type of offer active for a specific Rateplan.
offertype_nameAlphaYBreakfast
benefit_idNumeric Length 11 to 9Y5Denotes of all benefits to customer for a Rate Plan. Refer to benefits list for the full list of benefits available.
benefit_nameAlpha1 to 9YLunchRefer to benefits list for the full list of benefits available.
products
product room_id		Numeric Length 1-8unboundedY72027This is the Agoda room ID related to the property inventory element. Agoda active Room IDs can be returned with Getproduct request. If no room is specified in the request, all active Rooms will be returned in the response.
rateplan_idNumeric Length 1-6unboundedY1 to 6This is the Agoda Rateplan ID related to a particular offer active on a room. Agoda active Rateplan type IDs can be returned with Getproduct request. If no Rateplan ID is specified in the request, all active Rateplans will be returned in the response.
channels
channel channel_id		Numeric Length 11Y1Channel represents product distribution channel. Channel in YCS5 is replacing the Rateplan in YCS4. Channles are aimed to expand or limit customer type and usually will have price discount or sale limitations:
1 Retail
2 Agoda Private Sale
6 Domestic
7 Mobile
8 Agoda Opaque
9 China
channel_nameAlpha1YRetail
","urlObject":{"protocol":"https","path":["api"],"host":["supply","agoda","com"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}],"variable":[]}},"response":[{"id":"22ef6d36-1b58-4654-a6c1-7d3b5305f0f0","name":"GetProduct ","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\n\n \n \n \n \n\n \n\n \n \n"},"url":{"raw":"https://supply.agoda.com/api?apiKey=ADDYOURAPIKEYHERE","protocol":"https","host":["supply","agoda","com"],"path":["api"],"query":[{"key":"apiKey","value":"ADDYOURAPIKEYHERE"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Server","value":"nginx/1.16.1"},{"key":"Date","value":"Wed, 22 Apr 2020 06:28:41 GMT"},{"key":"Content-Type","value":"application/xml; charset=UTF-8"},{"key":"Content-Length","value":"544"},{"key":"Connection","value":"keep-alive"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n"}],"_postman_id":"80711f92-e237-4925-b56a-acffbde87e0a"}],"id":"68392eaf-fa50-4d6e-83cf-0e5319be5d77","_postman_id":"68392eaf-fa50-4d6e-83cf-0e5319be5d77","description":""}],"id":"95fc5fba-588d-4fbd-b662-fba08094c020","description":"

Introduction

\n\n

The Agoda YCS APIs allow Connectivity Partners to send and retrieve data such as Rates, Availabiltiy, and Reservations for connected properties listed on Agoda. Properties can easily manage prices, allotments, restrictions, and reservations using Connectivity Partner systems which is a “one-stop service” for connected properties to effortlessly control hotel rates and inventory across multiple OTAs/Websites all at once.

\n

Available API Requests

\n\n

As an Agoda Connectivity Partner, you should support all available API functions:

\n\n
\n\n\n\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
API RequestsDescriptionRemarks
SetAriTo update Availability Rates Inventory (ARI) and restrictions for a specific hotel on a specific date rangeMandatory
GetAriTo retrieve Availability and Rate Inventory (ARI) for existing rooms and ratesMandatory
SetAriV2To update Availability Rates Inventory (ARI) and restrictions for a specific hotel on a specific date range - Multi Occupancy
GetAriV2To retrieve Availability and Rate Inventory (ARI) for existing rooms and rates - Multi Occupancy
GetBookingListTo retrieve the bookings for a specific property or up to 5 properties at onceMandatory (not if support GetBookingListV2)
GetBookingDetailTo collect the booking details for a specific property up to 50 bookings at onceMandatory
GetBookingListV2to get booking list without hotel specified. GetBookingListV2 will return all bookings that updated in specified period of all hotels belong to channel manager.Mandatory
SetProductTo update room setting and rateplan restrictionMandatory
GetProductTo retrieve the dynamic content for a specific propertyMandatory
\n\n

EndPoints

\n\n

agoda supports two types of endpoints:

\n

• Single endpoint for all the request you will send via API or\n• To use a different unique endpoint for each request.

\n

NOTE:

please note that if you wish to use the single endpoint for your request, the Type attribute will be mandatory in all the requests you will send to Agoda.","event":[{"listen":"prerequest","script":{"id":"174acf49-b210-4c31-99d8-1c6a9e1bc914","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"1a679e1a-0278-4cdd-ae53-4e660f0b6285","type":"text/javascript","exec":[""]}}],"_postman_id":"95fc5fba-588d-4fbd-b662-fba08094c020"},{"name":"OTA API Specs","item":[{"name":"Availability Restrictions","item":[{"name":"OTA_HotelAvailNotifRQ","id":"8d746734-e762-421a-8182-577292ad88d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n"},"url":"http://supplyota.agoda.com/b2b/ota/2013A/hotels","description":"

OTA_HotelAvailNotifRQ

You can update availability restrictions for a single hotel per one request message. However, you can update multiple restrictions within one message. We recommend to update one hotel and one room per request.

Basic Structure

The basic structure of the message is as per below:

\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\" Target=\"Production\" PrimaryLangID=\"en\">\n   <AvailStatusMessages HotelCode=\"HOTEL\">\n      <AvailStatusMessage LocatorID=\"1\">\n         <StatusApplicationControl Start=\"2010-01-01\" End=\"2010-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\" />\n         <!-- Content omitted -->\n      </AvailStatusMessage>\n      <AvailStatusMessage LocatorID=\"2\">\n         <StatusApplicationControl Start=\"2010-01-02\" End=\"2010-01-02\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\" />\n         <!-- Content omitted -->\n      </AvailStatusMessage>\n      <AvailStatusMessage LocatorID=\"3\">\n         <StatusApplicationControl Start=\"2010-01-03\" End=\"2010-01-03\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\" />\n         <!-- Content omitted -->\n      </AvailStatusMessage>\n   </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>
\n

The OTA_HotelAvailNotifRQ message contains:

  1. One AvailStatusMessages element which define the hotel to update (@HotelCode attribute).
  2. Multiple AvailStatusMessages/AvailStatusMessage elements which define the transaction id (@LocatorID) used to communicate back to the sender.
  3. Each AvailStatusMessage element will contain a single StatusApplicationControl element. This element is used to specify the room type, rate plan code and date range for which the update applies. The dates affected by the update are controlled by the mandatory @Start and @End attributes.

How to set restrictions

The restriction details will be identified in either StatusApplicationControl/RestrictionStatus or StatusApplicationControl/LengthsOfStays element. One of these element must appear once in each StatusApplicationControl element.

Close/Open Restrictions Setting

Close for sale, closed to arrival and closed to departure update can be set by using the StatusApplicationControl/RestrictionStatus element. Please see the example of the settings below.

Restriction Type
How it will be sent
Room is closed for sale
<RestrictionStatus Status=\"Close\" />
Room is open for sale
<RestrictionStatus Status=\"Open\" />
Room is set as closed to arrival
<RestrictionStatus Status=\"Close\" Restriction=\"Arrival\" />
Room is set as open to arrival
<RestrictionStatus Status=\"Open\" Restriction=\"Arrival\" />
Room is set as closed to departure
<RestrictionStatus Status=\"Close\" Restriction=\"Departure\" />
Room is set as open to departure
<RestrictionStatus Status=\"Open\" Restriction=\"Departure\" />

Length of Stay Setting

Minimum and maximum length of stay updates can be set by using the StatusApplicationControl/LengthsOfStay element. This element contains a single LengthOfStay element with the attributes @MinMaxMessageType and @Time. @Time is the length of stay in days. Please see the example of the setting below.

Restriction Type
How it will be sent
Room has minimum length of stay 2 nights
<LengthsOfStay>\n   <LengthOfStay MinMaxMessageType=\"SetMinLOS\" Time=\"2\"/>\n</LengthsOfStay>
Room does not have minimum length of stay
<LengthsOfStay>\n   <LengthOfStay MinMaxMessageType=\"RemoveMinLOS\"/>\n</LengthsOfStay>
Room has maximum length of stay 5 nights
<LengthsOfStay>\n   <LengthOfStay MinMaxMessageType=\"SetMaxLOS\" Time=\"5\"/>\n</LengthsOfStay>
Room does not have maximum length of stay
<LengthsOfStay>\n   <LengthOfStay MinMaxMessageType=\"RemoveMaxLOS\"/>\n</LengthsOfStay>

OTA_HotelAvailNotifRQ Specification

Element

Number

Type

Description

OTA_HotelAvailNotifRQ

1


Root node

@TimeStamp

1

DateTime

Time of the transaction

@Version

1

Decimal

Current version is 1.0

@EchoToken1StringGlobally unique identifier for the request. We suggest to use epoch time that the request was sent to Agoda. This should be reflected as an EchoToken in the response.
@Target1StringTarget which can be either Production or Sandbox
@PrimaryLangID1StringLanguage ID, now only support English (en)

OTA_HotelAvailNotifRQ / AvailStatusMessages

1


Contains the availability messages

@HotelCode

1

String

The code for the property whose availability is being updated

AvailStatusMessages / AvailStatusMessage

1..n


Contains the availability messages. There can be multiple of these nodes per request

@LocatorID1LongIdentifies the transaction id, normally use to communicate back to the sender

AvailStatusMessage / StatusApplicationControl

1


Contains date and room identification information

@Start

1

Date

The start date for which the availability update is being set. This date is inclusive.

@End

1

Date

The end date for which the availability update is being set. This date is inclusive.

@RatePlanCode

1

String

Identifies the rate plan. The RatePlanCode is used in conjunction with the InvTypeCode to identify the room and rate plan to update.

@InvTypeCode

1

String

Identifies the room. The InvTypeCode is used in conjunction with the RatePlanCode to identify the room and rate plan to update.

StatusApplicationControl /
LengthsOfStay / LengthOfStay

0..1


Optional, used for minimum and maximum length of stay

@MinMaxMessageType

1

String

Mandatory if LengthsOfStay present. Can be one of the following

SetMinLOS: Sets the minimum length of stay

SetMaxLOS: Sets the maximum length of stay

RemoveMinLOS: Removes the minimum length of stay

RemoveMaxLOS: Removes the maximum length of stay

@Time

1

Integer

Mandatory if LengthsOfStay is present and MinMaxMessageType is of type \"Set\". Sets the minimum number of nights required for a stay or maximum number of nights qualified for a booking.

AvailStatusMessage / RestrictionStatus

0..1


Optional, used to close the room for sale, for arrival, or for departure.

@Status1String

Mandatory if RestrictionStatus is present.
Can be one of two values
Open: Should open a room for sale
Close: Should close or 'stop sell' a room for sale

@Restriction0..1String

Can be one of two values.
Arrival: The restriction is on arrival
Departure: The restriction is on departure

If there is no restriction type, the update should be assumed to be a full close or open for a room date.

Example of the OTA_HotelAvailNotifRQ messages

Set MinLOS to Two Days


\n
<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\" Target=\"Production\" PrimaryLangID=\"en\">\n  <AvailStatusMessages HotelCode=\"HOTEL\">\n    <AvailStatusMessage LocatorID=\"1\">\n      <StatusApplicationControl Start=\"2010-01-01\" End=\"2010-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\"/>\n      <LengthsOfStay>\n        <LengthOfStay MinMaxMessageType=\"SetMinLOS\" Time=\"2\"/>\n      </LengthsOfStay>\n    </AvailStatusMessage>\n  </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>
\n

Remove MinLOS Restriction


\n
<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\" Target=\"Production\" PrimaryLangID=\"en\">\n  <AvailStatusMessages HotelCode=\"HOTEL\">\n    <AvailStatusMessage LocatorID=\"1\">\n      <StatusApplicationControl Start=\"2010-01-01\" End=\"2010-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\"/>\n      <LengthsOfStay>\n        <LengthOfStay MinMaxMessageType=\"RemoveMinLOS\"/>\n      </LengthsOfStay>\n    </AvailStatusMessage>\n  </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>
\n

Set MaxLOS to Five Days


\n
<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\" Target=\"Production\" PrimaryLangID=\"en\">\n  <AvailStatusMessages HotelCode=\"HOTEL\">\n    <AvailStatusMessage LocatorID=\"1\">\n      <StatusApplicationControl Start=\"2010-01-01\" End=\"2010-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\"/>\n      <LengthsOfStay>\n        <LengthOfStay MinMaxMessageType=\"SetMaxLOS\" Time=\"5\"/>\n      </LengthsOfStay>\n    </AvailStatusMessage>\n  </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>
\n


Remove MaxLOS Restriction


\n
<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\" Target=\"Production\" PrimaryLangID=\"en\">\n  <AvailStatusMessages HotelCode=\"HOTEL\">\n    <AvailStatusMessage LocatorID=\"1\">\n      <StatusApplicationControl Start=\"2010-01-01\" End=\"2010-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\"/>\n      <LengthsOfStay>\n        <LengthOfStay MinMaxMessageType=\"RemoveMaxLOS\"/>\n      </LengthsOfStay>\n    </AvailStatusMessage>\n  </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>
\n

Update All Values

Below is a sample request for a message that updates availability, closed to sale, MinLOS, closed to arrival and closed to departure.


\n
<OTA_HotelAvailNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\" Target=\"Production\" PrimaryLangID=\"en\">\n  <AvailStatusMessages HotelCode=\"HOTEL\">\n    <AvailStatusMessage LocatorID=\"2\">\n      <StatusApplicationControl Start=\"2012-01-01\" End=\"2012-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\"/>\n      <LengthsOfStay>\n        <LengthOfStay MinMaxMessageType=\"SetMinLOS\" Time=\"2\"/>\n      </LengthsOfStay>\n    </AvailStatusMessage>\n    <AvailStatusMessage LocatorID=\"3\">\n      <StatusApplicationControl Start=\"2012-01-01\" End=\"2012-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\"/>\n      <RestrictionStatus Status=\"Close\" Restriction=\"Arrival\"/>\n    </AvailStatusMessage>\n    <AvailStatusMessage LocatorID=\"4\">\n      <StatusApplicationControl Start=\"2012-01-01\" End=\"2012-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"GLD\"/>\n      <RestrictionStatus Status=\"Close\" Restriction=\"Depature\"/>\n    </AvailStatusMessage>\n  </AvailStatusMessages>\n</OTA_HotelAvailNotifRQ>
\n
","urlObject":{"protocol":"http","path":["b2b","ota","2013A","hotels"],"host":["supplyota","agoda","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"8d746734-e762-421a-8182-577292ad88d7"},{"name":"OTA_HotelAvailNotifRS","id":"e4c4c278-0ddb-4574-94bc-542a1c790c4f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\r\n \r\n"},"url":"http://supplyota.agoda.com/b2b/ota/2013A/hotels","description":"

OTA_HotelAvailNotifRS

The OTA_HotelAvailNotifRS is the response Agoda will return for every OTA_HotelAvailNotifRQ. There are 2 types of response which are Success and Failure. The error codes and their descriptions are available in API Validation section.

Example of the message

Success Response


\n
<OTA_HotelAvailNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2017-05-31T11:45:47+07:00\" Target=\"Production\" Version=\"1.000\" EchoToken=\"abc123\">\n   <Success/>\n</OTA_HotelAvailNotifRS>
\n


Failure Response (2013A)


\n
<OTA_HotelAvailNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2017-05-31T12:37:04+07:00\" Target=\"Production\" Version=\"1.0\" EchoToken=\"abc123\">\n  <Errors>\n    <Error Type=\"3\" Code=\"9006\">EndDate can't be in past</Error>\n  </Errors>\n</OTA_HotelAvailNotifRS>
\n

Failure Response (2015B)


\n
<OTA_HotelAvailNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\">\n  <Errors>\n    <Error Type=\"3\" Code=\"9006\" RecordID=\"123\" Status=\"\" ShortText=\"EndDate can't be in past\"/>\n  </Errors>\n</OTA_HotelAvailNotifRS>
\n


OTA_HotelAvailNotifRS Specification

Element

Number

Type

Description

OTA_HotelAvailNotifRS

1


Root node

@EchoToken

1StringReturn the EchoToken from the request message.
@Version1DecimalCurrent version is 1.0
@TimeStamp1DateTime

Time of the transaction.

@Target1StringTarget which can be either production or sandbox
OTA_HotelAvailNotifRS / Success0..1
only present if it was a successful response. The Errors node will not be present if the Success node is present.
OTA_HotelAvailNotifRS / Errors0..1
Contains a list of errors in the event of a failed request.
Errors / Error1..n
Mandatory if Errors present.
@Type1String

Mandatory if Error present. Identifies the type of error.

@Code0..1String

Mandatory if Error is present. Identifies the specific error in the given type.

@RecordID1StringReference record ID
@Status1StringReference status
@ShortText1StringShort description of the error
","urlObject":{"protocol":"http","path":["b2b","ota","2013A","hotels"],"host":["supplyota","agoda","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e4c4c278-0ddb-4574-94bc-542a1c790c4f"}],"id":"9cc351f9-9588-486a-97c8-1272fa45578e","description":"

Availability Restrictions

You can update the availability restrictions by using the OTA_HotelAvailNotifRQ request. Agoda will response to your request via OTA_HotelAvailNotifRS response message. The OTA_HotelAvailNotifRQ allows you to update below restrictions. You can also open those restrictions as well.

  1. Closed for sale - stop selling the specified room, even if there are still available rooms.
  2. Closed to arrival - cannot book a room for arrive on this date
  3. Closed to departure - cannot book a room for check out on this date
  4. Length of stay - define the minimum or maximum number of nights where guests have to stay
","event":[{"listen":"prerequest","script":{"id":"d444f16f-547d-410f-a0be-6e3e727174d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fedf1b58-fe0e-4e18-9904-6f34a5070e9d","type":"text/javascript","exec":[""]}}],"_postman_id":"9cc351f9-9588-486a-97c8-1272fa45578e"},{"name":"Booking Rules","item":[{"name":"OTA_HotelBookingRuleNotifRQ","id":"84fa48c0-b852-4c6c-9efd-538572fa021b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\r\n"},"url":"http://supplyota.agoda.com/b2b/ota/2013A/hotels","description":"

OTA_HotelBookingRuleNotifRQ

You can update availability restrictions for a single hotel per one request message. However, you can update multiple booking rules within one message. We recommend to update one hotel and one room per request.

Basic Structure

The basic structure of the message is as per below:

Booking Rule Notification - Relative
\n
<OTA_HotelBookingRuleNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production\" Version=\"1.006\" PrimaryLangID=\"en\" TimeStamp=\"2016-09-09T13:20:01.000+07:00\">\n        <RuleMessages BrandCode=\"MER\" ChainCode=\"MER\" HotelCode=\"YIPPY\">\n        <RuleMessage UniqueID=\"123456789\">\n            <StatusApplicationControl Start=\"2016-10-01\" End=\"2016-10-05\" InvTypeCode=\"YR001\" RatePlanCode=\"AAA\" />\n            <BookingRules>\n                <BookingRule AbsoluteCutoff=\"2016-10-01\">\n                </BookingRule>\n            </BookingRules>\n        </RuleMessage>\n        <RuleMessage UniqueID=\"123456789\">\n            <StatusApplicationControl Start=\"2016-10-02\" End=\"2016-10-04\" InvTypeCode=\"YR001\" RatePlanCode=\"BBB\" />\n            <BookingRules>\n                <BookingRule MinAdvancedBookingOffset=\"P11D\">\n                </BookingRule>\n            </BookingRules>\n        </RuleMessage>\n    </RuleMessages>\n</OTA_HotelBookingRuleNotifRQ>
\n

The OTA_HotelAvailNotifRQ message contains:

  1. One RuleMessages element which define the hotel to update (@HotelCode attribute).
  2. Multiple RuleMessages/RuleMessage elements which define the transaction id (@UniqueID) used to communicate back to the sender.
  3. Each RuleMessage element will contain a single StatusApplicationControl element. This element is used to specify the room type, rate plan code and date range for which the update applies. The dates affected by the update are controlled by the mandatory @Start and @End attributes.

How to set booking rules

The rules will be identified in BookingRules element which must appear once in each StatusApplicationControl element. The BookingRules element contains a collection of booking rules which apply to the specific room type and rate code indicated by StatusApplicationControl. Each BookingRules element has one or more BookingRule elements.

Each BookingRule can represent an absolute or relative date for the booking restriction. Please see the example of the settings below.


Booking Restriction
How it will be sent
Fixed deadline for when a booking must be made
<BookingRule AbsoluteCutoff=\"2016-10-01\" />

The first date that the booking can be made

<BookingRule AbsoluteDropTime = \"2016-10-01\" />
Minimum number of days before arrival for which this rate plan can be booked.
<BookingRule MinAdvancedBookingOffset = \"P11D\" />
Maximum number of days before arrival for which this rate plan can be booked.
<BookingRule MaxAdvancedBookingOffset = \"P3D\" />

OTA_HotelBookingRuleNotifRQ Specification

Element

Number

Type

Description

OTA_HotelBookingRuleNotifRQ

1


Root node

@TimeStamp

1

DateTime

Time of the transaction

@Version

1

Decimal

Current version is 1.0

@Target1StringTarget which can be either Production or Sandbox
@PrimaryLangID1StringLanguage ID, now only support English (en)
@EchoToken1StringGlobally unique identifier for the request. We suggest to use epoch time that the request was sent to Agoda. This should be reflected as an EchoToken in the response.

OTA_HotelBookingRuleNotifRQ / RuleMessages

1


Contains the booking rule messages

@HotelCode

1

String

The code for the property whose availability is being updated

@BrandCode1StringCode for the brand
@ChainCode1StringCode for the hotel chain

RuleMessages / RuleMessage

1..n


Contains the booking rule messages. There can be multiple of these nodes per request

@UniqueID

0..1

IntegerUse as message identifier, normally use to communicate back to the sender

RuleMessage / StatusApplicationControl

1


Contains date and room identification information

@Start

1

Date

The start date for which the availability update is being set. This date is inclusive.

@End

1

Date

The end date for which the availability update is being set. This date is inclusive.

@RatePlanCode

1

String

Identifies the rate. The RatePlanCode is used in conjunction with the InvTypeCode to identify the room to update.

@InvTypeCode

1

String

Identifies the room. The InvTypeCode is used in conjunction with the RatePlanCode to identify the room to update.

StatusApplicationControl /
BookingRules / BookingRule

0..1


Set booking rules. At least one of @AbsoluteCutoff or @AbsoluteDropTime or @MinAdvancedBookingOffset or @MaxAdvancedBookingOffset must be specified.

@AbsoluteCutoff

0..1

String

Fixed deadline for when a booking can be made

@AbsoluteDropTime

0..1

String

The first date that the booking can be made

@MinAdvancedBookingOffset0..1String

Minimum number of days before arrival for which this rate plan can be booked.

@MaxAdvancedBookingOffset0..1String

Maximum number of days before arrival for which this rate plan can be booked.

Example of the OTA_HotelBookingRuleNotifRQ messages

Relative Booking Rules Example

For stays between 2016-08-01 and 2016-12-31, users must book a minimum of 3 days in advance and a maximum of 365 days in advance to get this room/rate plan. i.e. if today is 2016-09-08 and I want to book a room for 2016-10-02, I will get this room/rate plan. However if I want to book a room for 2016-09-10 or 2017-01-05, this room/rate plan will not be available.

Relative Booking Example
\n
<OTA_HotelBookingRuleNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production\" Version=\"1.006\" PrimaryLangID=\"en\" TimeStamp=\"2016-08-10T11:57:01.000+02:00\">\n        <RuleMessages BrandCode=\"MER\" ChainCode=\"MER\" HotelCode=\"YIPPY\">\n        <RuleMessage UniqueID=\"123456789\">\n            <StatusApplicationControl Start=\"2016-08-01\" End=\"2016-12-31\" InvTypeCode=\"YR001\" RatePlanCode=\"AAA\" />\n            <BookingRules>\n                <BookingRule MinAdvancedBookingOffset=\"P3D\" MaxAdvancedBookingOffset=\"P365D\">\n                </BookingRule>\n            </BookingRules>\n        </RuleMessage>\n    </RuleMessages>\n</OTA_HotelBookingRuleNotifRQ>
\n


Absolute Booking Rules Example

For stays between 2016-11-01 and 2017-03-31, users must book between 2016-09-01 and 2016-10-05 in order to get this room/rate plan.

Absolute Booking Example
\n
<OTA_HotelBookingRuleNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production\" Version=\"1.006\" PrimaryLangID=\"en\" TimeStamp=\"2016-08-10T11:57:01.000+02:00\">\n        <RuleMessages BrandCode=\"MER\" ChainCode=\"MER\" HotelCode=\"YIPPY\">\n            <RuleMessage UniqueID=\"123456789\">\n            <StatusApplicationControl Start=\"2016-11-01\" End=\"2017-03-31\" InvTypeCode=\"YR001\" RatePlanCode=\"AAA\" />\n            <BookingRules>\n                <BookingRule AbsoluteDropTime=\"2016-09-01\" AbsoluteCutoff=\"2016-10-05\" >\n                </BookingRule>\n            </BookingRules>\n        </RuleMessage>\n    </RuleMessages>\n</OTA_HotelBookingRuleNotifRQ>
\n
","urlObject":{"protocol":"http","path":["b2b","ota","2013A","hotels"],"host":["supplyota","agoda","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"84fa48c0-b852-4c6c-9efd-538572fa021b"},{"name":"OTA_HotelBookingRuleNotifRS","id":"93494c09-1e84-477a-aa87-0dc3ec367445","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml","type":"text"}],"body":{"mode":"raw","raw":"\n \n"},"url":"http://supplyota.agoda.com/b2b/ota/2013A/hotels","description":"

OTA_HotelBookingRuleNotifRS

The OTA_HotelBookingRuleNotifRS is the response Agoda will return for every OTA_HotelBookingRuleNotifRQ. There are 2 types of response which are Success and Failure. The error codes and their descriptions are available in API Validation section.

Example of the message

Success Response


\n
<OTA_HotelBookingRuleNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\">\n  <Success/>\n</OTA_HotelBookingRuleNotifRS>
\n

Failure Response (2013A)


\n
<OTA_HotelBookingRuleNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\">\n  <Errors>\n    <Error Type=\"3\" Code=\"9004\">StartDate is greater than EndDate</Error>\n  </Errors>\n</OTA_HotelBookingRuleNotifRS>
\n


Failure Response (2015B)


\n
<OTA_HotelBookingRuleNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\">\n  <Errors>\n    <Error Type=\"3\" Code=\"9004\" RecordID=\"\" Status=\"\" ShortText=\"StartDate is greater than EndDate\"/>\n  </Errors>\n</OTA_HotelBookingRuleNotifRS>
\n

OTA_HotelBookingRuleNotifRS Specification

Element

Number

Type

Description

OTA_HotelBookingRuleNotifRS

1


Root node

@EchoToken

1StringReturn the EchoToken from the request message.
@Version1DecimalCurrent version is 1.0
@TimeStamp1DateTime

Time of the transaction.

@Target1StringTarget which can be either Production or Sandbox
OTA_HotelBookingRuleNotifRS / Success0..1
Is only present if it was a successful response. The Errors node will not be present if the Success node is present.
OTA_HotelBookingRuleNotifRS / Errors0..1
Contains a list of errors in the event of a failed request
Errors / Error1..n
Mandatory if Errors present
@Type1String

Mandatory if Error present. Identifies the type of error

@Code0..1String

Mandatory if Error is present. Identifies the specific error in the given type

@RecordID1StringReference record ID
@Status1StringReference status
@ShortText1StringShort description of the error
","urlObject":{"protocol":"http","path":["b2b","ota","2013A","hotels"],"host":["supplyota","agoda","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"93494c09-1e84-477a-aa87-0dc3ec367445"}],"id":"ea3625f0-e53f-4852-b271-403e96047bd5","description":"

Booking Rules

You can update the booking rules using the OTA_HotelBookingRuleNotifRQ request. Agoda will response to your request via OTA_HotelBookingRuleNotifRS response message. The OTA_HotelAvailNotifRQ allows you to update below booking rules.

  1. Relative Booking Time: defines a number of days between booking date and arrival. i.e. must be booked 2 weeks in advance.
  2. Absolute Booking Time: defines a specific begin and/or end date for a booking. i.e. must book before November 30th, 2017.
","event":[{"listen":"prerequest","script":{"id":"3c951873-7d3d-40a1-af3c-414e1e3f5c9f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"63c4640d-2712-4a8f-abae-7fd2fe3eec61","type":"text/javascript","exec":[""]}}],"_postman_id":"ea3625f0-e53f-4852-b271-403e96047bd5"},{"name":"Generic Push Booking API","item":[{"name":"OTA_HotelResRQ","id":"d0aac680-286e-4c96-b385-d7ff12ebfd1a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n false\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n XXXX\n XXXX\n \n CN\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"d0aac680-286e-4c96-b385-d7ff12ebfd1a"},{"name":"OTA_HotelResRS","id":"5a27a1c1-3254-491a-a56f-038adef8548f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[{"id":"58d03550-674f-42c6-b34e-68189a00389f","name":"OTA_HotelResRS - Success Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n false\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n XXXX\n XXXX\n \n CN\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\n\n\t\n\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\t\n\t\t\t\t\n\t\t\t\t\n\t\t\t\t\t\n\t\t\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\n"},{"id":"4925a849-990f-498f-969b-e3d7d091c0f5","name":"OTA_HotelResRS - Fail Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n false\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n XXXX\n XXXX\n \n CN\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":""},"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\n\t\n\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\n"}],"_postman_id":"5a27a1c1-3254-491a-a56f-038adef8548f"},{"name":"OTA_CancelRQ","id":"0b0b8e56-b2e9-49d3-80fb-a2be8ff6b6b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":"","description":"

3.2. Cancellation


Agoda send cancellation request with booking id to be cancelled to suppliers for cancel booking. Booking cancellation will be completed once Agoda received success response with cancellation number from suppliers.


3.2.1. OTA_CancelRQ


This section will explain about description for element, attribute and example of request for cancel booking request.


3.2.1.1. XML Elements and Attributes

\n\n\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
OTA_CancelRQ
Element or @AttributeData TypeNo. of occurMandatoryExampleDescription
OTA_CancelRQdatetime1Y2016-09-01T13 :25 :42+07:00Indicates the creation date and time of the message using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss(+/-)hh:mm with time values using the 24 hour clock (e.g. 20 November 2016, 1:59:38 pm BKK becomes 2016-11-20T13:59:38+07:00).
@Timestamp
@Versiondecimal, n.n1Y0.1For all OTA versioned messages, the version of the message is indicated by a decimal value.
@xmlnsstring1Yhttp://www.opentravel.org/OTA/2003/05Namespace for the OTA payload message.
POSnumeric length 81Y96637800Unique identifier of the requestor.
SourceAgoda’s IATA ID is 96637800
RequestorID
@ ID
@ ID_Contextalpha length 41YIATAUsed to identify the source of the identifier
@ TypeOTA_CodeType1Y18Reference to the type of requestor. 18 = Other
@ URLString length 1 to 501YAgoda.comUsed to identify the source url
UniqueID1Y
@IDstring1Y12345Requester will send both Agoda’s booking id or Supplier booking id which use for make booking.
length
1 to 20
@Typenumeric1Y4Reference to the type of requestor.
4 = Agoda’s booking ID
5 = Supplier’s booking  ID
@ID_Contextstring length 1 to 501Yagoda.comSource of the booking id
\n


3.2.1.2. OTA_CancelRQ Example

\n
<OTA_CancelRQ Version=\"0.2\" TimeStamp=\"2018-02-07T13:38:57+07:00\" xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n    <POS>\n        <Source>\n            <RequestorID ID=\"96637800\" ID_Context=\"IATA\" Type=\"18\" URL=\"Agoda.com\"/>\n        </Source>\n    </POS>\n    <UniqueID ID=\"210466950\" Type=\"4\" ID_Context=\"Agoda\"/>\n    <UniqueID ID=\"3414274153\" Type=\"5\" ID_Context=\"DHIL\"/>\n</OTA_CancelRQ>\n\n

\n




","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"0b0b8e56-b2e9-49d3-80fb-a2be8ff6b6b5"},{"name":"OTA_CancelRS","id":"1feb3adf-8268-40da-90a6-5efeb0006278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":"","description":"

3.2.2. OTA_CancelRS


This section will explain about description for element, attribute and example of request for make cancel response.


3.2.2.1. XML Elements and Attributes


\n\n\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
OTA_CancelRS
Element or @AttributeData TypeNo. of occurMandatoryExampleDescription
OTA_CancelRSdatetime1Y2016-09-01T13 :25 :42+07:00Indicates the creation date and time of the message using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss(+/-)hh:mm with time values using the 24 hour clock (e.g. 20 November 2016, 1:59:38 pm BKK becomes 2016-11-20T13:59:38+07:00).
@ timestamp
@ versiondecimal, n.n1Y0.1For all OTA versioned messages, the version of the message is indicated by a decimal value.
@ xmlnsstring1Yhttp://www.opentravel.org/OTA/2003/05Namespace for the OTA payload message.
POSnumeric length 81Y123456Unique identifier of Supplier.
Source
RequestorID
@ ID
@ ID_Contextalpha length 41YIATAUsed to identify the source of the identifier
@ TypeOTA_CodeType1Y18Reference to the type of requestor. 18 = Other
@ URLstring length1YChannelManager.comUsed to identify the source url
1 to 50
Success[0..1]NSuccess element will appear in the response when the cancellation confirmed and it does not appear if the cancellation fail.
UniqueID[0..4]N
@IDstring1YID meaning is depend on @Type
length@Type = 10:@ID = hotel code
1 to 20@Type = 14:@ID = reservation number
@Type = 15:@ID = cancellation number
@Typenumeric1Y10: hotel code
14: reservation number
15: cancellation number
@ID_Contextstring length 1 to 501Y
TPA_Extensions[0..1]NError element is an element for any fault occur and will be appear when cancellation fail.
Error
@ Codestring1Y4001Generic Agoda Error Code.
lengthRefer to Appendix D
1 to 50
@ Descriptionstring1YReservation “1234” Not FoundGeneric Agoda Error Message.
lengthRefer to Appendix D
1 to 250
\n

3.2.2.2. OTA_CancelRS Example


  1. Success Response
\n
<OTA_CancelRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" Version=\"0.0\" TimeStamp=\"2015-04-23T18:17:54.546+02:00\">\n\n
<POS>
\n
<Source>
\n
<RequestorID ID=\"13244\" ID_Context=\"IATA\" Type=\"18\" URL=\"ChannelManager.com\"/> </Source>
\n
</POS>
\n
<Success/>
\n
<UniqueID ID=\"0903\" Type=\"10\" ID_Context=\"AGODA\"/>
\n
<UniqueID ID=\"62025941\" Type=\"14\" ID_Context=\"AGODA\"/>
\n
<UniqueID ID=\"0903PE1500\" Type=\"14\" ID_Context=\"ChannelManager\"/>
\n
<UniqueID ID =\"0903PE1500\" Type=\"15\" ID_Context=\"ChannelManager\"/>
\n
</OTA_CancelRS>
\n

\n






  1. Fail Response
\n
<OTA_CancelRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" Version=\"0.0\" TimeStamp=\"2015-04-23T18:17:54.546+02:00\">\n\n
<POS>
\n
<Source>
\n
<RequestorID ID=\"13244\" ID_Context=\"IATA\" Type=\"18\" URL=\"ChannelManager.com\"/> </Source>
\n
</POS>
\n
<UniqueID ID=\"0903\" Type=\"10\" ID_Context=\"AGODA\"/>
\n
<UniqueID ID=\"62025941\" Type=\"14\" ID_Context=\"AGODA\"/>
\n
<UniqueID ID=\"0903PE1500\" Type=\"14\" ID_Context=\"ChannelManager\"/>
\n
<TPA_Extensions>
\n
<Error Code=\"4001\" Description=\"Reservation “0903PE1500” Not Found \"/> </TPA_Extensions>
\n
</OTA_CancelRS>
\n

\n











\n

Appendix B: Special Request

\n\n\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
Special Request
NonSmoke
EarlyCheckIn
LateCheckIn
HighFloor
LargeBed
TwinBeds
AirportTransferAirport <Flight Number>
AdditionalNotes <Customer ‘s Note>
\n

Appendix D: Error Code Specification

\n\n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
   Error Code      Error Message   
   1001      Room Type “XXX” Not Found   
   1002      Rate Plan “XXX” Not Found   
   1003      Hotel “XXX” Not Found   
   1004      No Allotment   
   1005      Exceed Adult Count   
   1006      Rate mismatch, supplier rate = \"XXX\"   but agoda rate = \"YYY\"   
   1007      Currency mismatch, property currency   is “XXX” not \"YYY\"   
   1008      Incorrect Checkin Date “XXX”   
   1009      Over Reservation Time   
   3001      Missing field “XXX”   
   3002      Invalid value “XXX” of field “YYY”   
   4001      Reservation “XXX” Not Found   
   4002      Cancellation Is Not Allowed   
   4003      Over Cancellation Time   
   9001      Internal system error   
   9002      External system unknown error   
\n

Appendix E: Unique ID Type

\n\n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
   UIT      UIT Description   
   1      Customer   
   2      CRO (Customer Reservations   Office)   
   3      Corporation representative   
   4      Company   
   5      Travel agency   
   6      Airline   
   7      Wholesaler   
   8      Car rental   
   9      Group   
   10      Hotel   
   11      Tour operator   
   12      Cruise line   
   13      Internet broker   
   14      Reservation   
   15      Cancellation   
   16      Reference   
   17      Meeting planning agency   
   18      Other   
   19      Insurance agency   
   20      Insurance agent   
   21      Profile   
   22      ERSP (Electronic   reservation service provider)   
   23      Provisional reservation   
   24      Travel Agent PNR   
   25      Associated reservation   
   26      Associated itinerary   reservation   
   27      Associated shared   reservation   
   28      Alliance   
   29      Booking agent   
   30      Ticket   
   31      Divided reservation   
   32      Merchant   
   33      Acquirer   
   34      Master reference   
   35      Purged master reference   
   36      Parent reference   
   37      Child reference   
   38      Linked reference   
   39      Contract   
   40      Confirmation number   
   41      Fare quote   
   42      Reissue/refund quote   
   43      Ground transportation supplier   
   44      EMD   
","urlObject":{"query":[],"variable":[]}},"response":[{"id":"674a3f06-7269-46f6-8c7c-d72db697b463","name":"OTA_CancelRS - Success Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":""},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\n\t\n\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\n"},{"id":"8f37ea41-f34c-4c15-b51c-1fac95540f7e","name":"OTA_CancelRS - Fail Response","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":""},"_postman_previewlanguage":"xml","header":null,"cookie":[],"responseTime":null,"body":"\n\t\n\t\t\n\t\t\t\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\n\n"}],"_postman_id":"1feb3adf-8268-40da-90a6-5efeb0006278"}],"id":"26e027f4-bcb4-463d-9eb2-42bf6a54e2db","description":"\n\n\n\n\n

\n\n\n\n\n
\n\n

 

\n\n

 

\n\n

 

\n\n

1.  INTRODUCTION

\n\n

 

\n\n

Agoda Push Booking is designed\naccording to standard OTA so this will be the generic API supports booking,\ncancellation and modification.

\n\n

 

\n\n

This connectivity is aimed to\nreduce the over booking rate by ensuring reservation will be push to suppliers\nand Agoda will get confirmation back. The booking will be confirmed to customer\nonce getting supplier’s confirmation number.

\n\n

 

\n\n

2.  Functionality

\n\n

 

\n\n

There\nare 3 main features

\n\n

1.     Booking

\n\n

a.     OTA_HotelResRQ

\n\n

b.     OTA_HotelResRS

\n\n

 

\n\n

2.     Cancellation

\n\n

a.     OTA_CancelRQ

\n\n

b.     OTA_CancelRS

\n\n

3.     Modification (coming\nsoon)

\n\n

a.     OTA_HotelResModifyRQ

\n\n

b.     OTA_HotelResModifyRS

\n\n

 

\n\n

 

\n\n

2.1. Process Diagram

\n\n

 

\n\n

Overview\nof the process diagram is to conclude the flow which Agoda connects to\nsuppliers with generic push booking framework.

\n\n

\n\n

Figure 1: Process Diagram\nfor Generic Push Booking

\n\n

 

\n\n\n\n

3.  API\nInterface

\n\n

 

\n\n

This\nsection will explain you about description for element and attribute field\nwhich used between Agoda and suppliers. We also give suppliers a sample request\nwhich you can reference it. XML schema refer to the request and response is\ncontained in Appendix C.

\n\n

 

\n\n

3.1.     Booking

\n\n

 

\n\n

Agoda\nsend booking request with booking information to suppliers for make booking.\nBooking will be completed once Agoda received supplier confirmation number.

\n\n

 

\n\n

Note: If there is connection problems\nwhich Agoda cannot get the response of OTA_HotelResRS. We will have retry process. Suppliers should handle duplicate\nbooking by checking Agoda reservation ID and not create new booking for the\nsame Agoda reservation ID.

\n\n

3.1.1.    OTA_HotelResRQ

\n\n

 

\n\n

This section will explain about description for\nelement, attribute and example of request for make booking request.

\n\n

 

\n\n

3.1.1.1.    XML\nElements and Attributes

\n\n\n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
OTA_HotelResRQ
Element or @AttributeData TypeNo. of occurMandatoryExampleDescription
OTA_HotelResRQDatetime1Y2016-09-01T13 :25 :42+07:00Indicates the creation date and time of the message using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss(+/-)hh:mm with time values using the 24 hour clock (e.g. 20 November 2016, 1:59:38 pm BKK becomes 2016-11-20T13:59:38+07:00).
@Timestamp
@VersionDouble1Y0.1For all OTA versioned messages, the version of the message is indicated by a double value (format n.n).
@xmlnsString1Yhttp://www.opentravel.org/OTA/2003/05Namespace for the OTA payload message.
@xmlns :xsiString1Yhttp://www.w3.org/2001/XMLSchema-instanceNamespace for XML schema-instance.
POSNumeric length 81Y96637800Unique identifier of the requestor.
SourceAgoda’s IATA ID is 96637800
RequestorID
@ID
@ID_ContextString length 41YIATAUsed to identify the source of the identifier
@TypeOTA_CodeType1Y18Reference to the type of requestor. 18 = Other
Refer to Appendix E for more details
@URLString length 1 to 501YAgoda.comUsed to identify the source URL
HotelReservationsDatetime1Y2016-09-01T00:00:00+07:00Indicates the booking date and time using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss(+/-)hh:mm with time values using the 24 hour clock (e.g. 20 November 2016, 1:59:38 pm BKK becomes 2016-11-20T13:59:38+07:00).
HotelReservation
@CreateDateTime
RoomRatesnumeric1Y2Details on the room rates associated with the reservation.
RoomRateUsed to identify the number of room to be booked.
@NumberOfUnits
@RoomTypeCodestring length1Y3138110Used to identify the unique room type code to be booked.
1 to 20
@RatePlanCodestring length1Y25468Used to identify the unique rate plan code to be booked.
1 to 20
@ChannelIDnumeric[0..1]N1Used to identify the channel id to be booked. This field will be provided for YCS5 hotel only.
**Supplier should have the channel id mapping for channel id and channel name if it required in supplier side.
Refer to Appendix F for more details
FeaturesString length 1 to 250[0..n]NExtraBedTo identify feature of that room for example, ExtraBed etc.
Feature
Description
@Name
Ratesnumeric[1..n]Y1The number of days between effective date and expiry date with that particular rate
Rate
@UnitMultiplier
@RateTimeUnitString length 1 to 201YDayDefault for Agoda Request it will be “Day”
@EffectiveDatedate1Y4/2/2016Effective date for that particular date the format will be “YYYY-MM-DD”
@ExpireDateDate1Y4/3/2016Expire date for that particular date the format will be “YYYY-MM-DD”
Ratesnumeric[1..n]Y2Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard “minor unit”. Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=”2” to represent $85
Rate
Base
@DecimalPlaces
@CurrencyCodeAlpha1YUSDThe code specifying a monetary unit. Use ISO 4217, three alpha code.
length 3
@AmountAfterTaxdouble[0..1]N26836Daily room price include tax multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26836 and DecimalPlaces = 2 so the value will be $268.36
Price can be Net or Sell price depend on property setting.
@ AmountBeforeTaxdouble[0..1]N26033Daily room price exclude tax multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
Price can be Net or Sell price depend on property setting.
@ Taxdouble[0..1]N200Daily Tax multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
@ Feedouble[0..1]N100Daily Fee multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
@ RefSelldouble[0..1]N27000Daily Reference sell (Sell Inclusive) multiplied by number of rooms.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
GuestCounts[1..n]YDetail of number of guests.
GuestCount
@AgeQualifyingCodeNumeric1Y10A code representing a business rule that determines the charges for a guest based upon age range (e.g. Adult, Child, Senior, Child With Adult, Child Without Adult). Refer to OpenTravel Code List Age Qualifying Code (AQC)
@CountNumeric1N1The number of that particular specific guest type.
Totalnumeric[1..n]Y2Indicates the number of decimal places for a particular currency. This is equivalent to the ISO 4217 standard “minor unit”. Typically used when the amount provided includes the minor unit of currency without a decimal point (e.g., USD 8500 needs DecimalPlaces=”2” to represent $85
@ DecimalPlaces
@CurrencyCodeAlpha1YUSDThe code specifying a monetary unit. Use ISO 4217, three alpha code.
length 3
@AmountAfterTaxdouble[0..1]N26836Total room price include tax multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26836 and DecimalPlaces = 2 so the value will be $268.36
Price can be Net or Sell price depend on property setting.
@ AmountBeforeTaxdouble[0..1]N26033Total room price exclude tax multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
Price can be Net or Sell price depend on property setting.
@ Taxdouble[0..1]N200Total Tax multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
@ Feedouble[0..1]N100Total Fee multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
@ RefSelldouble[0..1]N27000Total Reference sell (Sell Inclusive) multiplied by number of rooms and nights.
To calculate this number, it may need to refer to Decimal place value which define for the floating point for this number for example
Price = 26033 and DecimalPlaces = 2 so the value will be $260.33
ResGuests1YDetail of guests associated with a reservation.
ResGuest[1..n]YDetail of each guest associated with reservation. Agoda can send only lead guest information or all guests to be stayed at the hotel.
@ResGuestRPHNumeric1Y1The index of guest.
@PrimaryIndicatorBoolean1YTrue/FalseTo identify the guest is primary contact.
Profiles1YIdentify guest profile
ProfileInfo
Profile
Customer
PersonName
GivenName1YGiven name, first name or names
Surname1YFamily name, last name
Telephone[0..1]Y1234567890Customer phone number. This can be alphanumeric.
Email[0..1]Ntest@agoda.comEmail address of the customer.
CitizenCountryName[0..1]NTHCitizen Country name (e.g. TH, CN, JP, US)
Refer to Appendix A : Guest Country
ResGlobalInfo1YResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods
TimeSpan1YThe Time Span which covers the period of stay.
@Startdatetime1Y8/22/2016Check-in date with format YYYY-MM-DD
@Enddatetime1Y8/25/2016Check-out date with format YYYY-MM-DD
SpecialRequests[0..1]NIdentify customer’s additional requests.
SpecialRequest
Textstring length1YNonSmoke, HighFloor, AdditionalNotes:Swimming Pool View  Connecting rooms or adjoining rooms please.,The string of special request list separate each request by ‘,’.
1 to 250
Refer to Appendix B: Agoda Special Request
Guarantee[0..1]NDetail of payment information
GuaranteesAccepted
GuaranteeAccepted
PaymentCard1YDetail of credit card
CardHolderNameAlpha1YAgoda Company Pte Ltd.Name on credit card. For all bookings will show ‘Agoda Pte Ltd.’
CardNumbernumeric1Y503444796022xxxxNumber of the Agoda UPC (Unique Plastic Card) used by the property to debit the amount of the booking.
length 16
@ExpiredDate1Y17-MarCredit card expiry date in format MM/YY
@SecureIndnumeric1Y170Credit card CVV number
length
3
HotelReservationIDs1YDetail of hotel reservation contains various unique (ReservationID) and non-unique (ConfirmationID, CancellationID) identifiers that the trading partners associate with a given reservation
HotelReservationID
@ResID_Valuestring1Y76104819Agoda’s booking ID
length
1 to 20
@ResID_TypeNumeric1Y4Reference to the type of requestor. 4 = Agoda booking ID
@ResID_Sourcestring1YAgodaSource of booking, It’s always Agoda.
length
1 to 20
BasicPropertyInfo1YProperty Information for the Room Stay
@ HotelCodestring1Y6000089Used to identify the unique hotel id to be booked.
length
1 to 20
TPA_Extensionsstring length[0..1]NAn element for additional data if needed.
1 to 250
\n\n

 

\n

3.1.2.2 OTA_HotelResRQ Example

a. Success Response

\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelResRQ TimeStamp=\"2013-08-28T13:40:00+01:00\" Version=\"0.0\" xmlns=\"http://www.opentravel.org/OTA/2003/05\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n    <POS>\n        <Source>\n            <RequestorID ID=\"96637800\" ID_Context=\"IATA\" Type=\"18\" URL=\"AGODA.com\"/>\n        </Source>\n    </POS>\n    <HotelReservations>\n        <HotelReservation CreateDateTime=\"2013-08-28T13:40:00+01:00\">\n            <RoomStays>\n                <RoomStay>\n                    <RoomRates>\n                        <RoomRate NumberOfUnits=\"2\" RoomTypeCode=\"3138110\" RatePlanCode=\"25468\" ChannelID=\"1\">\n                            <Features>\n                                <Feature>\n                                    <Description Name=\"ExtraBed\">True</Description>\n                                </Feature>\n                            </Features>\n                            <Rates>\n                                <Rate UnitMultiplier=\"1\" RateTimeUnit=\"Day\" EffectiveDate=\"2013-09-28\" ExpireDate=\"2013-09-29\">\n                                    <Base DecimalPlaces=\"2\" CurrencyCode=\"SGD\" AmountAfterTax=\"26836\" AmountBeforeTax=\"26033\" Tax=\"200\" Fee=\"100\" RefSell=\"27000\"/>\n                                </Rate>\n                                <Rate UnitMultiplier=\"1\" RateTimeUnit=\"Day\" EffectiveDate=\"2013-09-29\" ExpireDate=\"2013-09-30\">\n                                    <Base DecimalPlaces=\"2\" CurrencyCode=\"SGD\" AmountAfterTax=\"26836\" AmountBeforeTax=\"26033\" Tax=\"200\" Fee=\"100\" RefSell=\"27000\"/>\n                                </Rate>\n                            </Rates>\n                        </RoomRate>\n                    </RoomRates>\n                    <GuestCounts>\n                        <GuestCount AgeQualifyingCode=\"10\" Count=\"2\"/>\n                        <GuestCount AgeQualifyingCode=\"8\" Count=\"1\"/>\n                    </GuestCounts>\n                    <Total DecimalPlaces=\"2\" CurrencyCode=\"SGD\" AmountAfterTax=\"53672\" AmountBeforeTax=\"52066\" Tax=\"400\" Fee=\"200\" RefSell=\"54000\"/> \n                </RoomStay>\n            </RoomStays>\n            <ResGuests>\n                <ResGuest ResGuestRPH=\"1\" PrimaryIndicator=\"True\">\n                    <Profiles>\n                        <ProfileInfo>\n                            <Profile>\n                                <Customer>\n                                    <PersonName>\n                                        <GivenName>John</GivenName>\n                                        <Surname>Doe</Surname>\n                                    </PersonName>\n<Telephone>1234567890</Telephone>\n<Email>test@agoda.com</Email>\n                                    <CitizenCountryName>TH</CitizenCountryName>\n                                </Customer>\n                            </Profile>\n                        </ProfileInfo>\n                    </Profiles>\n                </ResGuest>\n            </ResGuests>\n            <ResGlobalInfo>\n                <TimeSpan Start=\"2013-09-28\" End=\"2013-09-30\"/>\n                <SpecialRequests>\n                    <SpecialRequest>\n                        <Text>NonSmoke, HighFloor</Text>\n                    </SpecialRequest>\n                </SpecialRequests>\n                <Guarantee>\n                    <GuaranteesAccepted>\n                        <GuaranteeAccepted>\n                            <PaymentCard>\n                                <CardHolderName>Agoda Company Pte Ltd.</CardHolderName>\n                                <CardNumber ExpireDate=\"03/2017\" SecureInd=\"170\">503444796022xxxx</CardNumber>\n                            </PaymentCard>\n                        </GuaranteeAccepted>\n                    </GuaranteesAccepted>\n                </Guarantee>\n                <HotelReservationIDs>\n                    <HotelReservationID ResID_Value=\"1234\" ResID_Type=\"4\" ResID_Source=\"Agoda\"/>\n                </HotelReservationIDs>\n                <BasicPropertyInfo HotelCode=\"6000089\"/>\n            </ResGlobalInfo>\n            <TPA_Extensions>Generic Data Tag</TPA_Extensions>\n        </HotelReservation>\n    </HotelReservations>\n</OTA_HotelResRQ>\n\n
3.1.2.    OTA_HotelResRS

This section will explain about description for element, attribute and example of response for make booking request.

3.1.2.1.   XML Elements and Attributes

\n\n\n\n  \n    \n  \n\n\n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n  \n    \n    \n    \n    \n    \n    \n  \n\n
OTA_HotelResRS
Element or @AttributeData TypeNo. of occurMandatoryExampleDescription
OTA_HotelResRSdatetime1Y2016-09-01T13 :25 :42+07:00Indicates the creation date and time of the message using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss(+/-)hh:mm with time values using the 24 hour clock (e.g. 20 November 2016, 1:59:38 pm BKK becomes 2016-11-20T13:59:38+07:00).
@Timestamp
@ Versiondecimal, n.n1Y0.1For all OTA versioned messages, the version of the message is indicated by a decimal value.
@ xmlnsstring1Yhttp://www.opentravel.org/OTA/2003/05Namespace for the OTA payload message.
@ xmlns :xsistring1Yhttp://www.w3.org/2001/XMLSchema-instanceNamespace for XML schema-instance.
POSnumeric length 81Y123456Unique identifier of Supplier.
Source
RequestorID
@ ID
@ ID_Contextalpha length 41YIATAUsed to identify the source of the identifier
@ TypeOTA_CodeType1Y18Reference to the type of requestor. 18 = Other
@ URLString length 1 to 501YChannelManager.comUsed to identify the source url
Success[0..1]NSuccess element will appear in the response when the reservation confirmed and does not appear if the reservation fail.
HotelReservationsdatetime1Y2016-09-01T13 :25 :42+07:00Indicates the booking date and time using the following format specified by ISO 8601; YYYY-MM-DDThh:mm:ss(+/-)hh:mm with time values using the 24 hour clock (e.g. 20 November 2016, 1:59:38 pm BKK becomes 2016-11-20T13:59:38+07:00).
HotelReservation
@CreateDateTime
ResGlobalInfo[0..1]NResGlobalInfo is a container for various information that affects the Reservation as a whole. These include global comments, counts, reservation IDs, loyalty programs, and payment methods
HotelReservationIDs1YDetail of hotel reservation contains various unique (ReservationID) and non- unique (ConfirmationID, CancellationID) identifiers that the trading partners associate with a given reservation
HotelReservationID
@ResID_Valuestring1Y76104819Supplier’s booking ID
length
1 to 20
@ResID_TypeNumeric1Y5Reference to the type of requestor. 5 = Supplier booking ID
@ResID_Sourcestring1Y<supplier name>Source of booking, it is supplier name.
length
1 to 20
TPA_Extensions[0..1]NError element is an element for any fault occur and will be appear when reservation fail.
Error
@ Codestring1Y1001Generic Agoda Error Code.
lengthRefer to Appendix D
1 to 50
@ Descriptionstring1YRoom Type “1234” Not FoundGeneric Agoda Error Message.
lengthRefer to Appendix D
1 to 250
\n\n
3.1.2.2.    OTA_HotelResRS Example
1.Success Response
\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelResRS TimeStamp=\"2013-08-28T13:40:00+01:00\" Version=\"0.0\" xmlns=\"http://www.opentravel.org/OTA/2003/05\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n    <POS>\n        <Source>\n            <RequestorID ID=\"13244\" ID_Context=\"IATA\" Type=\"18\" URL=\"ChannelManager.com\"/>\n        </Source>\n    </POS>\n    <Success /> <!-- Appear when it successful -->\n    <HotelReservations>\n        <HotelReservation CreateDateTime=\"2013-08-28T13:40:00\">\n            <ResGlobalInfo>\n                <!-- Booking ID from Destination Side -->\n                <HotelReservationIDs>\n                    <HotelReservationID ResID_Value=\"1234\" ResID_Type=\"5\" ResID_Source=\"ChannelManager\"/>\n                </HotelReservationIDs>\n            </ResGlobalInfo>\n            <TPA_Extensions></TPA_Extensions>\n        </HotelReservation>\n    </HotelReservations>\n</OTA_HotelResRS>
\n
2.  Fail response

\n
<OTA_HotelResRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2018-02-07T02:04:17+00:00\" Version=\"0.2\">\n    <POS>\n        <Source>\n            <RequestorID ID=\"96637800\" ID_Context=\"IATA\" Type=\"18\" URL=\"DerbySoft.com\"/>\n        </Source>\n    </POS>\n    <HotelReservations>\n        <HotelReservation CreateDateTime=\"2018-02-06T17:00:00+00:00\">\n            <TPA_Extensions>\n                <Error Code=\"1006\" Description=\"Inconsistent rate of [LONLI] [D1|OGLWP1] at [2018-02-17|2018-02-19] for 2A, expect GBP [167.38] but actual GBP [141.43]\"/>\n            </TPA_Extensions>\n        </HotelReservation>\n    </HotelReservations>\n</OTA_HotelResRS>
\n


\n\n

\n
\n\n
\n\n\n","event":[{"listen":"prerequest","script":{"id":"1710b128-4d72-4218-95b8-13466f273fbc","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"a5816583-3f51-4dc0-a89b-ca5f7136409d","type":"text/javascript","exec":[""]}}],"_postman_id":"26e027f4-bcb4-463d-9eb2-42bf6a54e2db"},{"name":"Room Availability and Rates","item":[{"name":"OTA_HotelRateAmountNotifRQ","id":"ea48803f-bc64-494c-8266-0109459a586f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml"}],"body":{"mode":"raw","raw":"\r\n\t\r\n\t\t\r\n\t\t\t\r\n\t\t\t\r\n\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\t\r\n\t\t\t\t\t\r\n\t\t\t\t\r\n\t\t\t\r\n\t\t\r\n\t\r\n"},"url":"http://supplyota.agoda.com/b2b/ota/2013A/hotels","description":"

OTA_HotelRateAmountNotifRQ

You can update rates for a single hotel per one request message. However, you can update multiple rates within one message. We recommend to update one hotel and one room per request.

Basic Structure

The basic structure of the message is as per below:


\n
<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2005-08-01T09:30:47+08:00\" Version=\"1.0\" EchoToken=\"abc123\" Target=\"Production\" PrimaryLangID=\"en\" NotifType=\"Overlay|Delta\">\n  <RateAmountMessages HotelCode=\"HOTEL\">\n    <RateAmountMessage LocatorID=\"177974458\">\n      <StatusApplicationControl Start=\"2010-01-01\" End=\"2010-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"1\" LengthOfStay=\"1\" QuoteID=\"LSEtckE0elhGaGJrbVFoTDQ1SXJNK0VzQ05iTm5tQnZvTXpXQmt3emloT1U2WnNqUTN6RnVMbVZ0Ykp3bkFWNDQ2RE14d2I3a3Fob1ZFTHVmcWVjOE53cVRLcnBxR2krbVNuZ3ZKejgyOW10QUE9\"/>\n      <!-- Content omitted -->\n    </RateAmountMessage>\n    <RateAmountMessage LocatorID=\"177974459\">\n      <StatusApplicationControl Start=\"2010-01-02\" End=\"2010-01-02\" InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"1\" LengthOfStay=\"1\" QuoteID=\"LSEtckE0elhGaGJrbVFoTDQ1SXJNK0VzQ05iTm5tQnZvTXpXQmt3emloT1U2WnNqUTN6RnVMbVZ0Ykp3bkFWNDQ2RE14d2I3a3Fob1ZFTHVmcWVjOE53cVRLcnBxR2krbVNuZ3ZKejgyOW10QUE9\"/>\n      <!-- Content omitted -->\n    </RateAmountMessage>\n    <RateAmountMessage LocatorID=\"177974460\">\n      <StatusApplicationControl Start=\"2010-01-04\" End=\"2010-01-04\" InvTypeCode=\"A1K\" RatePlanCode=\"BAR\"RateChannelCode=\"1\" LengthOfStay=\"1\" QuoteID=\"LSEtckE0elhGaGJrbVFoTDQ1SXJNK0VzQ05iTm5tQnZvTXpXQmt3emloT1U2WnNqUTN6RnVMbVZ0Ykp3bkFWNDQ2RE14d2I3a3Fob1ZFTHVmcWVjOE53cVRLcnBxR2krbVNuZ3ZKejgyOW10QUE9\"/>\n      <!-- Content omitted -->\n    </RateAmountMessage>\n  </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>
\n

The OTA_HotelRateAmountNotifRQ message contains:

  1. One RateAmountMessages element which define the hotel to update (@HotelCode attribute).
  2. Multiple RateAmountMessages/RateAmountMessage elements which define the transaction id (@LocatorID) used to communicate back to the sender.
  3. Each RateAmountMessage element will contain a single StatusApplicationControl element. This element is used to specify the room type, rate plan code, rate channel (optional) and date range for which the update applies.
    1. The dates affected by the update are controlled by the mandatory @Start and @End attributes.
    2. LengthOfStay attribute changes the update type to be a Full Pattern Length of Stay update. If the update is for stay dates, then no need to set this attribute.
    3. The QuoteID is optional field to specify additional data. For example, use it to specify the api key value.

In the root node, the NotifType determines whether this is an update of changed rate amounts or a full replacement of rate amounts for specified products. The NotifType can be:

  • Overlay - replace existing rates
  • Delta - keep existing rates and update new (This is the default value, if the NotifType attribute is not specified.) We recommend to use this NotifType for delta update the rates. For rate with tax, rate with meal plan, rate with fee, rate with additional guest, please use Overlay update.

Example of Delta

How to set rates

Room availability and rates will be identified in Rates/Rate element. The Rates element will appear once in each StatusApplicationControl element.

Rate Type

When to use

AmountBeforeTaxIf all hotels in a supplier use specific rate type, we’ll set up rate type at supplier level
AmountAfterTax
AmountIncludingMarkup
AmountPlainIf hotels can have different rate types, this will be set up in our YCS system, and we expect you to send AmountPlain

Rates Setting

Rate can be updated using the BaseByGuestAmts/BaseByGuestAmt element. The rate value is specified by on of these three elements: @AmountAfterTax (for net inclusive rate type) or @AmountBeforeTax (for net exclusive rate type) or @AmountIncludingMarkup (for sell inclusive rate type). The value of @AmountAfterTax or @AmountBeforeTax or @AmountIncludingMarkup will be a positive decimal value.

Note:

  1. Net Exclusive rate type is not supported.
  2. Only one of these attributes should be present - either AmountAfterTax or AmountBeforeTax or AmountIncludingMarkup, but not more than one.
Rate TypeHow it will be sent
Net Exclusive
<Rates>
<Rate NumberOfUnits=\"5\">
<BaseByGuestAmts>
<BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountBeforeTax=\"1000\" DecimalPlaces=\"0\">
</BaseByGuestAmt>
<BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountBeforeTax=\"2000\" DecimalPlaces=\"0>
</BaseByGuestAmt>
</BaseByGuestAmts>
</Rate>
</Rates>
Net Inclusive
<Rates>
<Rate NumberOfUnits=\"5\">
<BaseByGuestAmts>
<BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountAfterTax=\"1000\" DecimalPlaces=\"0\">
</BaseByGuestAmt>
<BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountAfterTax=\"2000\" DecimalPlaces=\"0\">
</BaseByGuestAmt>
</BaseByGuestAmts>
</Rate>
</Rates>
Sell Inclusive
<Rates>
<Rate NumberOfUnits=\"5\">
<BaseByGuestAmts>
<BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountIncludingMarkup=\"1200\" DecimalPlaces=\"0\">
</BaseByGuestAmt>
<BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountIncludingMarkup=\"2000\" DecimalPlaces=\"0\">
</BaseByGuestAmt>
</BaseByGuestAmts>
</Rate>
</Rates>


Rate Channel Setting

Rate channels can be updated using the StatusApplicationControl/@RateChannelCode attribute. It can contain multiple channels in the single HotelRateAmountNotif request. For example, the same room, rate category can sell with different prices for different channels (retail, private sell, etc.) as the example of the settings below.


Rate Channel Setting
\n
<OTA_HotelRateAmountNotifRQ \n    xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2005-08-01T09:30:47+08:00\" Version=\"1.0\" EchoToken=\"abc123\" Target=\"Production\" PrimaryLangID=\"en\" NotifType=\"Overlay\">\n    <RateAmountMessages HotelCode=\"HOTEL\">\n        <RateAmountMessage LocatorID=\"177974458\">\n            <StatusApplicationControl Start=\"2010-01-01\" End=\"2010-01-01\" InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"1\" LengthOfStay=\"1\" />\n            <Rates>\n                <Rate NumberOfUnits=\"5\">\n                    <BaseByGuestAmts>\n                        <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountBeforeTax=\"1000\" DecimalPlaces=\"0\"></BaseByGuestAmt>\n                        <BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountBeforeTax=\"2000\" DecimalPlaces=\"0\"></BaseByGuestAmt>\n                    </BaseByGuestAmts>\n                </Rate>\n            </Rates>\n        </RateAmountMessage>\n        <RateAmountMessage LocatorID=\"177974459\">\n            <StatusApplicationControl Start=\"2010-01-02\" End=\"2010-01-02\" InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"2\" LengthOfStay=\"1\" />\n            <Rates>\n                <Rate NumberOfUnits=\"5\">\n                    <BaseByGuestAmts>\n                        <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountBeforeTax=\"700\" DecimalPlaces=\"0\"></BaseByGuestAmt>\n                        <BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountBeforeTax=\"800\" DecimalPlaces=\"0\"></BaseByGuestAmt>\n                    </BaseByGuestAmts>\n                </Rate>\n            </Rates>\n        </RateAmountMessage>\n        <RateAmountMessage LocatorID=\"177974460\">\n            <StatusApplicationControl Start=\"2010-01-04\" End=\"2010-01-04\" InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"8\" LengthOfStay=\"1\" />\n            <Rates>\n                <Rate NumberOfUnits=\"5\">\n                    <BaseByGuestAmts>\n                        <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountBeforeTax=\"400\" DecimalPlaces=\"0\"></BaseByGuestAmt>\n                        <BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountBeforeTax=\"500\" DecimalPlaces=\"0\"></BaseByGuestAmt>\n                    </BaseByGuestAmts>\n                </Rate>\n            </Rates>\n        </RateAmountMessage>\n    </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>
\n


Room Availability Setting

Room availability can be updated using the Rate element. Number of room available will be define in @NumberOfUnits attribute. Please see the example of the setting below.

Room Availability Setting
\n
<Rates>\n  <Rates>\n   <Rate NumberOfUnits=\"5\">\n      <BaseByGuestAmts>\n         <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountBeforeTax=\"1000\" DecimalPlaces=\"0\">\n         </BaseByGuestAmt>\n         <BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountBeforeTax=\"2000\" DecimalPlaces=\"0>\n         </BaseByGuestAmt>\n      </BaseByGuestAmts>\n   </Rate>\n</Rates>
\n

Fees Setting

Fees (additional charge) can be updated using the Fees element. You can update multiple fees per one request by using multiple Fees/Fee elements. The @ChargeUnit and @Code details are in Code List section. Please see the example of the settings below.


\n
<Rates>\n   <Rate>\n       <BaseByGuestAmts>\n           <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountBeforeTax=\"1000\" DecimalPlaces=\"0\">\n               <Taxes>\n                   <Tax ChargeUnit=\"PB\" Code=\"1\" Type=\"Exclusive\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Percent=\"10\" DecimalPlaces=\"0\" />\n               </Taxes>\n           </BaseByGuestAmt>\n           <BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountBeforeTax=\"2000\" DecimalPlaces=\"0\">\n               <Taxes>\n                  <Tax ChargeUnit=\"PB\" Type=\"Inclusive\" Code=\"2\" DecimalPlaces=\"1\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Amount=\"153\" />\n               </Taxes>\n           </BaseByGuestAmt>\n       </BaseByGuestAmts>\n       <!-- Fee Amount that is applied to the rate. Fees are used for non tax amounts like service charges. Used for non-tax fees and charges (e.g. service charges) -->\n       <Fees>\n          <Fee Amount=\"1200\" ChargeUnit=\"PB\" Code=\"10\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Amount=\"10\" TaxableIndicator=\"false\" Type=\"Inclusive\" />\n          <Fee Amount=\"1000\" ChargeUnit=\"PB\" Code=\"6\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Amount=\"10\" TaxableIndicator=\"false\" Type=\"Exclusive\" />\n       </Fees>\n    </Rate>\n</Rates>
\n

Meal Plan Setting

Meal Plan can be updated using the Rate/MealsIncluded element. The meal plan code will be define in @MealPlanCodes attribute. The available meal plan code are as per below.


MealPlanCode
Description
1All inclusive (Breakfast, Lunch, Dinner and Beverages)
3Bed & Breakfast
10Full board (Breakfast, Lunch and Dinner)
12Half board (Breakfast and Dinner)
14Room Only (Or no meal plan)


Please see the example of the setting below.

Meal Plan setting
\n
<Rates>\n    <Rate>\n        <BaseByGuestAmts>\n           <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountIncludingMarkup=\"1200\" DecimalPlaces=\"0\">\n              <Taxes>\n                 <Tax ChargeUnit=\"PB\" Code=\"1\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Percent=\"10\" Type=\"Exclusive\"/>\n              </Taxes>\n           </BaseByGuestAmt>\n           <BaseByGuestAmt NumberOfGuests=\"2&quoquot; CurrencyCode=\"THB\" AmountIncludingMarkup=\"2000\" DecimalPlaces=\"0\">\n              <Taxes>\n                 <Tax ChargeUnit=\"PB\" Code=\"2\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Amount=\"153\" Type=\"Inclusive\" DecimalPlaces=\"1\"/>\n              </Taxes>\n           </BaseByGuestAmt>\n       </BaseByGuestAmts>\n       <MealsIncluded MealPlanCodes=\"3\" />\n     </Rate>\n</Rates>
\n

Remove Rates

You can remove rate and room availability by using the empty Rates element. Please see the example of the setting below. Make sure that the NotifType in the root node is set to Overlay.

\n
<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2005-08-01T09:30:47+08:00\" Version=\"1.0\" EchoToken=\"abc123\" Target=\"Production\" PrimaryLangID=\"en\" NotifType=\"Remove\">\n  <RateAmountMessages HotelCode=\"HOTEL\">\n    <RateAmountMessage LocatorID=\"177974459\">\n      <StatusApplicationControl InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"1\" Start=\"2010-01-01\" End=\"2010-01-01\" QuoteID=\"abcd\"/>\n      <Rates></Rates>\n    </RateAmountMessage>\n  </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>
\n

Example of the OTA_HotelAvailNotifRQ rate update messages

Set Rates: AmountBeforeTax (Net Exclusive) Example

\n
<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2005-08-01T09:30:47+08:00\" Version=\"1.0\" EchoToken=\"abc123\" NotifType=\"Overlay\">\n  <RateAmountMessages HotelCode=\"HOTEL\">\n    <RateAmountMessage LocatorID=\"177974459\">\n      <StatusApplicationControl InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"1\" Start=\"2010-01-01\" End=\"2010-01-01\"/>\n      <Rates>\n        <Rate NumberOfUnits=\"5\">\n          <BaseByGuestAmts>\n            <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountBeforeTax=\"1000\" DecimalPlaces=\"0\">\n                <Taxes>\n                    <Tax ChargeUnit=\"PB\" Code=\"1\" Type=\"2\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Percent=\"10\" DecimalPlaces=\"0\"/>\n                </Taxes>\n            </BaseByGuestAmt>\n\n
        &lt;BaseByGuestAmt NumberOfGuests=&quot;2&quot; CurrencyCode=&quot;THB&quot; AmountBeforeTax=&quot;2000&quot; DecimalPlaces=&quot;0&gt;\n            &lt;Taxes&gt;\n                &lt;Tax ChargeUnit=&quot;PN&quot; Type=&quot;Inclusive&quot; Code=&quot;2&quot; DecimalPlaces=&quot;0&quot; EffectiveDate=&quot;2010-01-01&quot; ExpireDate=&quot;2010-01-01&quot; Amount=&quot;153&quot;  DecimalPlaces=&quot;1&quot;/&gt;\n            &lt;/Taxes&gt;\n        &lt;/BaseByGuestAmt&gt;\n      &lt;/BaseByGuestAmts&gt;\n    &lt;/Rate&gt;\n  &lt;/Rates&gt;\n&lt;/RateAmountMessage&gt;\n
  </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>

\n

Set Rates: AmountAfterTax (Net Inclusive) Example

\n
<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2005-08-01T09:30:47+08:00\" Version=\"1.0\" EchoToken=\"abc123\" NotifType=\"Overlay\">\n  <RateAmountMessages HotelCode=\"HOTEL\">\n    <RateAmountMessage LocatorID=\"177974459\">\n      <StatusApplicationControl InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"1\" Start=\"2010-01-01\" End=\"2010-01-01\"/>\n      <Rates>\n        <Rate>\n          <BaseByGuestAmts>\n      <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountAfterTax=\"1000\" DecimalPlaces=\"0\">\n          <Taxes>\n              <Tax ChargeUnit=\"PB\" Code=\"1\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Percent=\"10\" Type=\"Exclusive\"/>\n          </Taxes>\n      </BaseByGuestAmt>\n      <BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountAfterTax=\"2000\" DecimalPlaces=\"0\">\n          <Taxes>\n              <Tax ChargeUnit=\"PAPB\" Code=\"2\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Amount=\"153\" Type=\"Inclusive\" DecimalPlaces=\"1\"/>\n          </Taxes>\n      </BaseByGuestAmt>\n          </BaseByGuestAmts>\n        </Rate>\n      </Rates>\n    </RateAmountMessage>\n  </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>
\n

Set Rates: AmountIncludingMarkup (Sell Inclusive) Example

\n
<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2005-08-01T09:30:47+08:00\" Version=\"1.0\" EchoToken=\"abc123\" NotifType=\"Overlay\">\n  <RateAmountMessages HotelCode=\"HOTEL\">\n    <RateAmountMessage LocatorID=\"177974459\">\n      <StatusApplicationControl InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"1\" Start=\"2010-01-01\" End=\"2010-01-01\"/>\n      <Rates>\n        <Rate>\n          <BaseByGuestAmts>\n      <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountIncludingMarkup=\"1200\" DecimalPlaces=\"0\">\n          <Taxes>\n              <Tax ChargeUnit=\"PB\" Code=\"1\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Percent=\"10\" Type=\"Exclusive\"/>\n          </Taxes>\n      </BaseByGuestAmt>\n      <BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountIncludingMarkup=\"2000\" DecimalPlaces=\"0\">\n          <Taxes>\n              <Tax ChargeUnit=\"PB\" Code=\"2\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Amount=\"153\" Type=\"Inclusive\" DecimalPlaces=\"1\"/>\n          </Taxes>\n      </BaseByGuestAmt>\n          </BaseByGuestAmts>\n        </Rate>\n      </Rates>\n    </RateAmountMessage>\n  </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>
\n

Delta Update Example


Set Fees (Additional Charges) Example

\n
<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2005-08-01T09:30:47+08:00\" Version=\"1.0\" EchoToken=\"abc123\" NotifType=\"Overlay\">\n   <RateAmountMessages HotelCode=\"HOTEL\">\n      <RateAmountMessage LocatorID=\"177974459\">\n         <StatusApplicationControl InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"1\" Start=\"2010-01-01\" End=\"2010-01-01\" />\n         <Rates>\n            <Rate>\n               <BaseByGuestAmts>\n                  <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountBeforeTax=\"1000\" DecimalPlaces=\"0\">\n                     <Taxes>\n                        <Tax ChargeUnit=\"PB\" Code=\"1\" Type=\"Exclusive\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Percent=\"10\" DecimalPlaces=\"0\" />\n                     </Taxes>\n                  </BaseByGuestAmt>\n                  <BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountBeforeTax=\"2000\" DecimalPlaces=\"0\">\n                     <Taxes>\n                        <Tax ChargeUnit=\"PB\" Type=\"Inclusive\" Code=\"2\" DecimalPlaces=\"1\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Amount=\"153\" />\n                     </Taxes>\n                  </BaseByGuestAmt>\n               </BaseByGuestAmts>\n               <!-- Fee Amount that is applied to the rate. Fees are used for non tax amounts like service charges. Used for non-tax fees and charges (e.g. service charges) -->\n               <Fees>\n                  <Fee Amount=\"1200\" ChargeUnit=\"PB\" Code=\"10\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Percent=\"10\" TaxableIndicator=\"false\" Type=\"Inclusive\" />\n               </Fees>\n            </Rate>\n         </Rates>\n      </RateAmountMessage>\n   </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>
\n

Set Meal Plan Example

\n
<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" TimeStamp=\"2005-08-01T09:30:47+08:00\" Version=\"1.0\" EchoToken=\"abc123\" NotifType=\"Overlay\">\n  <RateAmountMessages HotelCode=\"HOTEL\">\n    <RateAmountMessage LocatorID=\"177974459\">\n      <StatusApplicationControl InvTypeCode=\"A1K\" RatePlanCode=\"BAR\" RateChannelCode=\"1\" Start=\"2010-01-01\" End=\"2010-01-01\"/>\n      <Rates>\n        <Rate>\n          <BaseByGuestAmts>\n      <BaseByGuestAmt NumberOfGuests=\"1\" CurrencyCode=\"THB\" AmountIncludingMarkup=\"1200\" DecimalPlaces=\"0\">\n          <Taxes>\n              <Tax ChargeUnit=\"PB\" Code=\"1\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Percent=\"10\" Type=\"Exclusive\"/>\n          </Taxes>\n      </BaseByGuestAmt>\n      <BaseByGuestAmt NumberOfGuests=\"2\" CurrencyCode=\"THB\" AmountIncludingMarkup=\"2000\" DecimalPlaces=\"0\">\n          <Taxes>\n              <Tax ChargeUnit=\"PB\" Code=\"2\" DecimalPlaces=\"0\" EffectiveDate=\"2010-01-01\" ExpireDate=\"2010-01-01\" Amount=\"153\" Type=\"Inclusive\" DecimalPlaces=\"1\"/>\n          </Taxes>\n      </BaseByGuestAmt>\n          </BaseByGuestAmts>\n        <MealsIncluded MealPlanCodes=\"3\" />\n        </Rate>\n      </Rates>\n    </RateAmountMessage>\n  </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>
\n



How to set cancellation policies

The cancel policy may be set or updated by using the CancelPolicies element. Within each CancelPolicies element is one or more CancelPenalty elements.


Cancel Policy


\n
<OTA_HotelRateAmountNotifRQ xmlns=\"http://www.opentravel.org/OTA/2003/05\" EchoToken=\"1459354682247\" Target=\"Test\" Version=\"1.006\" PrimaryLangID=\"en\" TimeStamp=\"2016-08-10T11:57:01.000+02:00\">\n    <RateAmountMessages HotelCode=\"YIPPY\">\n        <RateAmountMessage LocatorID=\"1\">\n            <StatusApplicationControl Start=\"2016-08-01\" End=\"2016-08-01\" InvTypeCode=\"YR001\" RatePlanCode=\"AAA\"/>\n            <Rates>\n                <Rate>\n                    <CancelPolicies>                 \n                        <CancelPenalty>\n                            <Deadline AbsoluteDeadline=\"00:00:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"999\" />\n                            <PenaltyDescription>\n                                <Text>No cancelation charge applies until 10 days, 18:30 (Local time) before arrival. Between 10 days and 5 days, hotel will charge 50.00 pct of the stay. Thereafter, hotel will charge the first night.</Text>\n                            </PenaltyDescription>\n                        </CancelPenalty>\n                        <CancelPenalty NonRefundable=\"false\">\n                            <Deadline AbsoluteDeadline=\"18:30:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"10\" />\n                        </CancelPenalty>\n                        <CancelPenalty NonRefundable=\"false\">\n                            <Deadline AbsoluteDeadline=\"00:00:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"5\" />\n                            <AmountPercent Percent=\"50.00\" />\n                        </CancelPenalty>\n                        <CancelPenalty NonRefundable=\"false\">\n                            <Deadline AbsoluteDeadline=\"23:59:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"0\" />\n                            <AmountPercent NmbrOfNights=\"1\" />\n                        </CancelPenalty>     \n                    </CancelPolicies>\n                </Rate>\n            </Rates>\n        </RateAmountMessage>\n    </RateAmountMessages>\n</OTA_HotelRateAmountNotifRQ>
\n



Element
Number
Description
DeadLine1deadline to apply cancellation penalty
AmountPercent0..1penalty as amount in currency, percent of booking price, or number of nights
PenaltyDescription0..1cancellation penalty description


CancelPenalty - DeadLine:

Attribute
Type
Restriction
Description
AbsoluteDeadLinetimeHH:mm:ssLatest time to apply this penalty
OffsetDropTimeenumBeforeArrivalOnly support BeforeArrival
OffsetTimeUnitenumDayOnly support Day
OffsetUnitMultiplierint>= 0Number of unit in this case is the number of days before checkin date

CancelPenalty - AmountPercent:

Attribute
Type
Required
Restriction
Description
NmbrOfNightsintNo>= 0Penalty as number of nights
PercentdoubleNo>=0.0Penalty as percent of booking price
AmountdoubleNo>=0.0Penalty as amount in currency
DecimalPlacesintNo>= 0Number of decimal places for Amount and Percent

Example:

Non-Refundable

For any CancelPenalty with NonRefundable = True, we can omit AmountPercent value. It will be treated as 100 percent penalty.


\n
<CancelPenalty>\n    <Deadline AbsoluteDeadline=\"00:00:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"999\" />\n    <PenaltyDescription>\n        <Text>The amount due is not refundable even if the booking is cancelled or modified.</Text>\n    </PenaltyDescription>\n</CancelPenalty>\n<CancelPenalty NonRefundable=\"True\">\n    <Deadline AbsoluteDeadline=\"18:00:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"0\" />\n</CancelPenalty>
\n


or


\n
<CancelPenalty NonRefundable=\"True\">\n    <Deadline AbsoluteDeadline=\"18:00:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"0\" />\n</CancelPenalty>
\n


More Example



\n
<CancelPenalty>\n    <Deadline AbsoluteDeadline=\"00:00:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"999\" />\n</CancelPenalty>\n<CancelPenalty NonRefundable=\"false\">\n    <Deadline AbsoluteDeadline=\"18:30:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"10\" />\n    <PenaltyDescription>\n        <Text>No cancelation charge applies until 10 days, 18:30 (Local time) before arrival. Between 10 days and 5 days (20:30), hotel will charge 50.00 pct of the stay. Thereafter, hotel will charge the first night.</Text>\n    </PenaltyDescription>\n</CancelPenalty>\n<CancelPenalty NonRefundable=\"false\">\n    <Deadline AbsoluteDeadline=\"20:30:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"5\" />\n    <AmountPercent Percent=\"50.00\" />\n    <PenaltyDescription>\n        <Text>No cancelation charge applies until 10 days, 18:30 (Local time) before arrival. Between 10 days and 5 days (20:30), hotel will charge 50.00 pct of the stay. Thereafter, hotel will charge the first night</Text>\n    </PenaltyDescription>\n</CancelPenalty>\n<CancelPenalty NonRefundable=\"false\">\n    <Deadline AbsoluteDeadline=\"23:59:00\" OffsetDropTime=\"BeforeArrival\" OffsetTimeUnit=\"Day\" OffsetUnitMultiplier=\"0\" />\n    <AmountPercent NmbrOfNights=\"1\" />\n    <PenaltyDescription>\n        <Text>No cancelation charge applies until 10 days, 18:30 (Local time) before arrival. Between 10 days and 5 days (20:30), hotel will charge 50.00 pct of the stay. Thereafter, hotel will charge the first night.</Text>\n    </PenaltyDescription>\n</CancelPenalty>
\n

Cancellation penalty is defined in the <AmountPercent> tag. It can be define as pecent or number of night.

Picture below is helping to understand cancellation policy OffsetUnitMultiplier.

However, Agoda doesn't support time based cancellation. So, any AbsoluteDeadline that is less than 23:55:00, OTA will add up 1 day. So, the result for this example is 11D50P_6D1N which can be read as \"If user cancel 11 Day before check-in date, user will be charged 50%. If user cancel 6 days before check-in date, user will be charged 1 night.\"


OTA_HotelRateAmountNotifRQ Specification

Element
Number
Type
Description
OTA_HotelRateAmountNotifRQ1
Root node
@TimeStamp1DateTimeTime of the transaction
@Version1DecimalCurrent version is 1.0
@EchoToken1StringGlobally unique identifier for the request, this should be reflected as an EchoToken in the response
@Target1StringTarget which can be either Production or Sandbox
@PrimaryLangID1StringLanguage ID, now only support English (en)
@NotifType1String

This indicates whether this is an update of changed rate amounts, instructions to remove rate amounts or a full replacement of rate amounts for specified products. If not specified - Delta is assumed

Possible values:

  1. Delta: Update of changed rate amounts (Default)
  2. Overlay: Full replacement of rate amounts for specified products
OTA_HotelRateAmountNotifRQ /
RateAmountMessages		1
Contains rates for a given hotel
@HotelCode1StringHotel code of the property whose rate is being updated
RateAmountMessages / RateAmountMessage1..n
Contains details of a rate update for a time span
RateAmountMessage / StatusApplicationControl1
Contains date and room identification information
@InvTypeCode1String

Identifies the room

@RatePlanCode0..1StringIdentifies the rate plan
@RateChannelCode0..1NumberIdentifies the channel to which this rate is allowed. Default is Retail (Code: 1), please refer to code list for other codes
@Start1DateThe start date for which the rate is being set. This date is inclusive.
@End1DateThe end date for which the rate is being set. This date is inclusive.
@LengthOfStay0..1NumberOptional attribute to mark the request of type Full Pattern. If not present, the date range is considered as stay dates.
@QuoteID0..1StringOptional attribute that identifies a specific quote, or value. Max length = 350 characters.
RateAmountMessage / Rates1

Rates / Rate1

@NumberOfUnits0..1IntegerNumber of rooms available
Rate / BaseByGuestAmts1
Base charge for a given number of guests.
BaseByGuestAmts / BaseByGuestAmt1..n
Contains information about the rates.
@AmountBeforeTax1DecimalRate Amount before tax. Positive decimal value. (Net Exclusive)
@AmountAfterTax1DecimalRate Amount after tax. Positive decimal value. (Net Inclusive)
@AmountIncludingMarkup1DecimalRate Amount Including markup. Positive value. (Sell Inclusive)
@NumberOfGuests0..1IntegerNumber of guests in room (occupancy)
@CurrencyCode0..1StringThe currency of the rate
BaseByGuestAmt / Taxes1
Group of taxes applicable for the occupancy
Taxes / Tax1..n
List of tax applicable
@Amount0..1NumberAmount to for the tax type (currency is inherited from BaseByGuestAmount)
@DecimalPlaces0..1NumberNumber of decimal places in the Amount or Percent (default = 0)
@Percent0..1NumberPercentage of the tax to be applied. Either Amount of Percent need to be present. If both, then always Amount is preferred.
@Code1NumberDefines the tax type for example CityTax etc. Refer to Code List.
@Type1StringDefines the Pay now or Pay at hotel type for the tax. For example Inclusive, Exclusive. Refer to Code List
@ChargeUnit1String (Code)Defines the charge unit for example Per Person Per Night, Per Person Per Stay etc. Refer to Code List
@EffectiveDate1DateInclusive start date when this tax starts to be applicable
@ExpireDate1DateInclusive end date when this tax can be applicable.
Rate / CancelPolicies1
Cancel Policies for this rate
CancelPolicies / CancelPenalty1..n
Contains information about the cancel policies
CancelPenalty / Deadline1
Each deadline represents the time at which a particular policy goes into effect
@AbsoluteDeadline1TimeThe time at which the policy goes into effect

@OffsetDropTime

1StringThe point from which the cancel policy is measured (before arrival, for example)

@OffsetTimeUnit

1StringUnit of time (\"day\", for example) by which the cancel policy offset is measured
@OffsetUnitMultiplier 1Integer The number of time units before the drop time that the cancel policy is in effect
CancelPenalty /

PenaltyDescription / Text

1StringText description of the cancel penalty
Rate / Fees0..1

Fees / Fee1..n
Fees information on the rate
@Amount0..1NumberAmount to for the fees type (currency is inherited from BaseByGuestAmount)
@DecimalPlaces0..1NumberNumber of decimal places in the Amount or Percent (default = 0)
@Percent0..1Number

[Not support] Percentage of the fees to be applied. Either Amount of Percent need to be present. If both, then always Amount is preferred.

@Code1NumberDefines the fee type for example New Year Party Charge etc. Refer to Code List.
@Type1NumberDefines the Pay now or Pay at hotel type for the fees. Refer to Code List
@ChargeUnit1String (Code)Defines the charge unit for example Per Person Per Night, Per Person Per Stay etc. Refer to Code List
@EffectiveDate1DateInclusive start date when this fees starts to be applicable
@ExpireDate1DateInclusive end date when this fees can be applicable.
Rate / AdditionalGuestAmounts0..1

AdditionalGuestAmounts / AdditionalGuestAmount1..n
List of additional guest amount per age qualifying code. There can be only one block per one age qualifying code.
@AgeQualifyingCode1NumberDefines the age qualifying code on which this additional amount is applicable for example Adult, Child, or Infant. Please refer to Code List for all possible values.
@Amount1NumberAmount to be charged for the each additional guest for in that particular age code. Please note that the amount type i.e. net / sell, inclusive / exclusive is inherited from the base by guest amount
@DecimalPlaces0..1NumberNumber of decimal places in the Amount or Percent (default = 0)
@MaxAdditionalGuests1NumberMaximum number of additional guests allowed to be added for the ${AgeQualifyingCode}
AdditionalGuestAmount / Taxes0..1
Refer to Taxes element above.
Rate / MealsIncluded0..1

MealPlanCodes1IntegerDefines the meal plan for the rate. 3 - Breakfast. Refer to Code List. If the value is not set, it means Room only.

Limitations

  • Fees, Tax, Additional guests is always overlay - we don't allow merging.
  • Standalone fees, meal plan, and additional guest update (without base by guest prices) is not allowed.
  • Tax & Fees date range should always be inclusive of the date range in Status Application Control.
  • Tax & Fees date range should not overlap for same code and type
  • With rate type AmountAfterTax and AmountIncludingMarkup, Tax value must be chargeUnit='PB' with Percent only.
","urlObject":{"protocol":"http","path":["b2b","ota","2013A","hotels"],"host":["supplyota","agoda","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"ea48803f-bc64-494c-8266-0109459a586f"},{"name":"OTA_HotelRateAmountNotifRS","id":"2cbd9a23-367a-48cb-a659-020f03288e0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/xml","type":"text"}],"body":{"mode":"raw","raw":"\r\n \r\n"},"url":"http://supplyota.agoda.com/b2b/ota/2013A/hotels","description":"

OTA_HotelRateAmountNotifRS

The OTA_HotelRateAmountNotifRS is the response Agoda will return for every OTA_HotelRateAmountNotifRQ . There are 2 types of response which are Success and Failure. The error codes and their descriptions are available in API Validation section.

Example of the message

Success Response


1
2
3
<OTA_HotelRateAmountNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\">
<Success/>
</OTA_HotelRateAmountNotifRS>

Failure Response (2013A)


1
2
3
4
5
<OTA_HotelRateAmountNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\">
<Errors>
<Error Type=\"3\" Code=\"9004\">StartDate is greater than EndDate</Error>
</Errors>
</OTA_HotelRateAmountNotifRS>


Failure Response (2015B)


1
2
3
4
5
<OTA_HotelRateAmountNotifRS xmlns=\"http://www.opentravel.org/OTA/2003/05\" Target=\"Production\" Version=\"1.0\" TimeStamp=\"2005-08-01T09:30:47+08:00\" EchoToken=\"abc123\">
<Errors>
<Error Type=\"3\" Code=\"9004\" RecordID=\"\" Status=\"\" ShortText=\"StartDate is greater than EndDate\"/>
</Errors>
</OTA_HotelRateAmountNotifRS>

OTA_HotelRateAmountNotifRS Specification

Element
Number
Type
Description
OTA_HotelRateAmountNotifRS1
Root element

@EchoToken

1StringReturn the EchoToken from the request message.
@Version1DecimalCurrent version is 1.0
@TimeStamp1DateTime

Time of the transaction.

@Target1StringTarget which can be either production or sandbox
OTA_HotelRateAmountNotifRS / Success0..1
Should only be present if the request processed successfully. The Errors node should not be present if the Success node is present
OTA_HotelRateAmountNotifRS / Errors0..1
Contains a list of errors if the request failed to process.
Errors / Error1..n
Should be at least one node if there is an Errors Node.
@Type1String

Mandatory if Error present. Identifies the type of error

@Code0..1String

Mandatory if Error is present. Identifies the specific error in the given type

@RecordID1StringReference record ID
@Status1StringReference status
@ShortText1StringShort description of the error



","urlObject":{"protocol":"http","path":["b2b","ota","2013A","hotels"],"host":["supplyota","agoda","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2cbd9a23-367a-48cb-a659-020f03288e0e"}],"id":"e6f13f82-301a-411f-bca3-3247df4bc567","description":"

Room Availability and Rates

You can update the room availability and rates by using the OTA_HotelRateAmountNotifRQ request. Agoda will response to your request via OTA_HotelRateAmountNotifRS response message. The OTA_HotelRateAmountNotifRQ allows you to update:

  1. Room/rate Plan availability
  2. Room/rate Plan rates
  3. Room/rate inclusions
  4. Room/rate Tax & Fees
  5. Room/rate Cancellation policies

","event":[{"listen":"prerequest","script":{"id":"af6aa9c9-2dda-4fba-99e5-59491fbc7e83","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"43685418-4ac0-4bb6-a8e8-bb8c4f113636","type":"text/javascript","exec":[""]}}],"_postman_id":"e6f13f82-301a-411f-bca3-3247df4bc567"},{"name":"Code List","item":[{"name":"AgeQualifyingCode","item":[],"id":"58b57776-d231-403a-968d-38f932f41481","description":"

AgeQualifyingCode

<AdditionalGuestAmount AgeQualifyingCode=\"10\" ... >

Code
Description
10Adult
8Child
6Infant
","_postman_id":"58b57776-d231-403a-968d-38f932f41481"},{"name":"Charge Unit (Tax & Fees)","item":[],"id":"5d91ea9b-ba01-414b-816f-fedda4ff6486","description":"

Charge Unit (Tax & Fees)

<Tax ChargeUnit=\"PB\" ...>


Code
Description
PAPBPer Adult Per Booking
PAPNPer Adult Per Night
PBPer Booking
PGPBPer Guest Per Booking
PGPNPer Guest Per Night
PNPer Night
PRPBPer Room Per Booking
PRPNPer Room Per Night


","_postman_id":"5d91ea9b-ba01-414b-816f-fedda4ff6486"},{"name":"Type (Tax & Fees)","item":[],"id":"794e2311-3787-499d-882c-52b0533cd308","description":"

Type (Tax & Fees)

<Tax Type=\"Inclusive\" ...>

<Fee Type=\"Exclusive\" ...>

Code
Type
InclusivePayNow
ExclusivePayAtHotel


","_postman_id":"794e2311-3787-499d-882c-52b0533cd308"},{"name":"Meal Plan","item":[],"id":"2501866b-5182-481d-8105-3616a139c0d3","description":"

Meal Plan

Code
Type
1All inclusive
3Breakfast
10Full board
12Half board


","_postman_id":"2501866b-5182-481d-8105-3616a139c0d3"},{"name":"Tax & Fee Code ()","item":[],"id":"c02d95d5-54cc-45db-96c7-a56c84b37af5","description":"

Tax & Fee Code (<Incomplete>)

Code
Description
6City Tax



","event":[{"listen":"prerequest","script":{"id":"7ba50e74-83ad-4c22-90ac-0f09650e6c91","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"14b2ccbf-0b0c-4ef7-8769-b69c5d77e7db","type":"text/javascript","exec":[""]}}],"_postman_id":"c02d95d5-54cc-45db-96c7-a56c84b37af5"},{"name":"RateChannelCode (RateChannelCode (<Incomplete)


Code
Description
1Retail



","_postman_id":"20c13bfd-41a9-4aed-9559-2f9e7e81198c"},{"name":"API Validation","item":[],"id":"a71e28d0-05e5-4228-a501-7b4d27bb6f48","description":"

API Validation

Please see below the error code and its description.

HTTP Status CodeError CodeError Description
4009001Message Timestamp is older than 10 minutes
4009004StartDate is greater than EndDate
4009005StartDate can't be in past
4009006EndDate can't be in past
4009009Amount must be > 0.0
4009010Amount is not specified
4009011NumberOfGuests must be >= 0
4009012InvTypeCode can't be empty
4009013RatePlanCode can't be empty
4009015RestrictionStatus can't be empty
4009016RestrictionStatus should be Open or Close
4009019OffsetTimeUnit can't be empty
4009020OffsetDropTime can't be empty
4009021OffsetUnitMultiplier must be greater than -1
4009022AbsoluteDropTime must be less than or equal AbsoluteCutoff
4009028AmountIncludingMarkup/AmountAfterTax should be PB and Percent
4009029BaseByGuestAmt not allow have multiple currencies
4009030AgeQualifyingCode invalid value
4009031AgeQualifyingCode duplicate value
4009033Fee DateRange not inclusive in Checkin to LastCheckin+LOS
4009035Tax DateRange not inclusive in Checkin to LastCheckin+LOS
4009036Fee DateRange cannot overlap in the same group
4009037Tax DateRange cannot overlap in the same group
4009039Fee not allow if BaseByGuestAmt is empty
4009040LengthOfStay required between 1 and #number allow
4009041RateLoadType are not allow
4009042NumberOfUnit is required more than zero
4009044Tax Code is not allowed
4009045Fee Code is not allowed
4009098Lead Days over than setting allow
4009099LOS not allow more than 2 years
4039901Access is denied. User is unauthorized
4059903Method not allowed
5009999Internal Server Error
","_postman_id":"a71e28d0-05e5-4228-a501-7b4d27bb6f48"}],"id":"90e0af03-425e-4d03-9297-4fa1171732a8","_postman_id":"90e0af03-425e-4d03-9297-4fa1171732a8","description":""},{"name":"Precheck","item":[{"name":"OTA_HotelAvailRQ","id":"e35acf83-aeb6-4684-a9b8-5e66893b813e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"e35acf83-aeb6-4684-a9b8-5e66893b813e"},{"name":"OTA_HotelAvailRS","id":"71da12ee-d58c-40f9-8182-a2fdd1c94bf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","options":{"raw":{"language":"xml"}}},"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"71da12ee-d58c-40f9-8182-a2fdd1c94bf2"}],"id":"d44a6d77-ec7e-47d7-83ca-630eb2119f22","description":"

You can search single or multiple properties for detailed availability and pricing information of room products by using the OTA_HotelAvailRQ request. Agoda will respond to your request via OTA_HotelAvailRS response message.\nOTA_HotelAvailRQ
The following search type is supported by the HotelAvail Request message.
Searching availability for single property - return the availability for a single property by a unique hotel id for a specified date range.


Basic Structure
The basic structure of the message is as per below:

\n
<OTA_HotelAvailRQ PrimaryLangID=\"en\" xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n    <AvailRequestSegments>\n        <AvailRequestSegment>\n            <StayDateRange Start=\"2017-11-25\" End=\"2017-11-29\"/>\n            <RatePlanCandidates>\n                <RatePlanCandidate RatePlanCode=\"RAC\"/>\n            </RatePlanCandidates>\n            <RoomStayCandidates>\n                <RoomStayCandidate RoomTypeCode=\"A1K\" Quantity=\"1\">\n                    <GuestCounts>\n                        <GuestCount AgeQualifyingCode=\"10\" Count=\"2\"/>\n                    </GuestCounts>\n                </RoomStayCandidate>\n            </RoomStayCandidates>\n            <HotelSearchCriteria>\n                <Criterion>\n                    <HotelRef HotelCode=\"61027\"/>\n                </Criterion>\n            </HotelSearchCriteria>\n        </AvailRequestSegment>\n    </AvailRequestSegments>\n</OTA_HotelAvailRQ>
\n


OTA_HotelAvailRQ Specification


Element

Number

Type

Description





OTA_HotelAvailRQ

1


Root node








Primary language preference for the message.

@PrimaryLangID

0..1

String

Identified by ISO 639 codes.





OTA_HotelAvailRQ/




AvailRequestSegments








AvailRequestSegments/




AvailRequestSegment








AvailRequestSegment/




StayDateRange








@Start

1

Date

The starting value of the time span





@End

1

Date

The ending value of the time span





AvailRequestSegment/




RatePlanCandidates








RatePlanCandidates/




RatePlanCandidate








@RatePlanCode

1

String

Identifies the rate plan code





AvailRequestSegment/




RoomStayCandidates








RoomStayCandidates/




RoomStayCandidate











Indicates the number of rooms to book. If this

@Quantity

1

Integer

attribute is not sent or is not valid, validation error




is returned.





@RoomTypeCode

1

String

Identifies the room type code.





RoomStayCandidate/




GuestCounts








GuestCounts/




GuestCount








@AgeQualifyingCode

1

Integer

This value is always “10”





@Count

1

Integer

The number of guests in one AgeQualifyingCode

AvailRequestSegment/




HotelSearchCriteria








HotelSearchCriteria/




Criteria








Criteria/




Criterion








Criterion/




HotelRef








@HotelCode

1StringThe code that uniquely identifies a single hotel property













OTA_HotelAvailRS


The OTA_HotelAvailRS is the response Agoda will return for every OTA_HotelAvailRQ. There are 2 types of response which are Success and Failure. The error codes and their descriptions are available in API Validation section.


Example of the message


Success Response

\n
<OTA_HotelAvailRS PrimaryLangID=\"en\" TimeStamp=\"2017-10-02T19:56:15+00:00\" xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n    <Success/>\n    <RoomStays>\n        <RoomStay>\n            <RoomTypes>\n                <RoomType RoomTypeCode=\"A1K\" NumberOfUnits=\"99\">\n                    <RoomDescription Name=\"Deluxe King Room\">\n                        <Text>Deluxe King Room default long desc</Text>\n                        <Image/>\n                    </RoomDescription>\n                </RoomType>\n            </RoomTypes>\n            <RatePlans>\n                <RatePlan RatePlanCode=\"RAC\" RatePlanName=\"Standard Rate\">\n                    <RatePlanDescription Name=\"Standard Rate\">\n                        <Text>Standard Rate default Long Desc</Text>\n                    </RatePlanDescription>\n                    <Commission>\n                        <Percent>8</Percent>\n                    </Commission>\n                </RatePlan>\n            </RatePlans>\n            <RoomRates>\n                <RoomRate RoomTypeCode=\"A1K\" RatePlanCode=\"RAC\">\n                    <Rates>\n                        <Rate>\n                            <Base AmountBeforeTax=\"108.18\" AmountAfterTax=\"124.95\" CurrencyCode=\"USD\"/>\n                            <Fees>\n                                <Fee Amount=\"80.00\" CurrencyCode=\"USD\"/>\n                            </Fees>\n                            <Total AmountBeforeTax=\"540.90\" AmountAfterTax=\"704.75\" CurrencyCode=\"USD\">\n                                <Taxes Amount=\"163.85\">\n                                    <Tax Amount=\"10.82\" Code=\"3\" EffectiveDate=\"2017-11-25\" ExpireDate=\"2017-11-29\" ChargeFrequency=\"1\">\n                                        <TaxDescription Name=\"Name\">\n                                            <Text>City Tax</Text>\n                                        </TaxDescription>\n                                        <TaxDescription Name=\"Description\">\n                                            <Text>10pct City Tax per night Inclusive</Text>\n                                        </TaxDescription>\n                                    </Tax>\n                                    <Tax Amount=\"5.95\" Code=\"10\" EffectiveDate=\"2017-11-25\" ExpireDate=\"2017-11-29\" ChargeFrequency=\"1\">\n                                        <TaxDescription Name=\"Name\">\n                                            <Text>Occupancy Tax</Text>\n                                        </TaxDescription>\n                                        <TaxDescription Name=\"Description\">\n                                            <Text>5 pct Occupancy Tax per night EXCLUDED</Text>\n                                        </TaxDescription>\n                                    </Tax>\n                                    <Tax Amount=\"80.00\" Code=\"12\" EffectiveDate=\"2017-11-25\" ExpireDate=\"2017-11-29\" ChargeFrequency=\"12\">\n                                        <TaxDescription Name=\"Name\">\n                                            <Text>Resort Fee</Text>\n                                        </TaxDescription>\n                                        <TaxDescription Name=\"Description\">\n                                            <Text>80 USD Resort Fee per stay EXCLUSIVE</Text>\n                                        </TaxDescription>\n                                    </Tax>\n                                </Taxes>\n                            </Total>\n                        </Rate>\n                    </Rates>\n                </RoomRate>\n            </RoomRates>\n            <BasicPropertyInfo HotelCode=\"61027\" HotelName=\"Jymnson Hotel 001\"/>\n        </RoomStay>\n    </RoomStays>\n    <Criteria>\n        <Criterion>\n            <HotelRef HotelCode=\"61027\" HotelName=\"Jymnson Hotel 001\"/>\n        </Criterion>\n    </Criteria>\n</OTA_HotelAvailRS>
\n


Failure Response

\n
<OTA_HotelAvailRS PrimaryLangID=\"en\" TimeStamp=\"2017-09-05T12:24:50+00:00\" xmlns=\"http://www.opentravel.org/OTA/2003/05\">\n<Errors>\n<Error Type=\"1\" ShortText=\"Error checking availability.\" Code=\"197\" />\n</Errors>\n</OTA_HotelAvailRS>\n
\n


OTA_HotelAvailRS Specification


Element

Number



Type


Description










OTA_HotelAvailRS

1





Root node
















Primary language preference for the message.


@PrimaryLangID

0..1



String


The human language is identified by ISO 639








codes.










@TimeStamp

1



DateTime


Time of the transaction










OTA_HotelAvailRS /






Only present if it was a successful response. The


0..1





Errors node will not be present if the Success


Success











node is present.

















OTA_HotelAvailRS /








RoomStays
















RoomStays /








RoomStay
















RoomStay /








RoomTypes
















RoomTypes /








RoomType
















@RoomTypeCode

1



String


Identifies the room type










@NumberOfUnits

1



Integer


Available units of this room type which matches





the availability request

















RoomType /








RoomDescription
















@Name

1



String


Language specific room type name










RoomDescription /

1



String


Language specific short description for this


Text




room type









Element

Number



Type


Description










RoomDescription /

1



String


Image URL for the room type


Image




















RoomStay /








RatePlans
















RatePlans /








RatePlan
















@RatePlanCode

1



String


Identifies the rate plan










@RatePlanName

1



String


Name of the rate plan










RatePlan /








RatePlanDescription
















@Name

1



String


Language specific rate plan name










RatePlanDescription /

1



String


Language specific short description for this rate


Text




plan
















RatePlan /








Commission






















Commission percentage associated with the rate


Commission /

0..1



Integer


plan, if a rate is commissionable. If there is


Percent




commission and its percent is more than 0, the














rate is sell rates










RoomStay /








RoomRates
















RoomRates /








RoomRate
















@RoomTypeCode

1



String


Identifies the room type










@RatePlanCode

1



String


Identifies the rate plan










RoomRate /








Rates
















Rates /








Rate
















Rate /








Base
















@AmountBeforeTax

1



Decimal


This is the total amount for the reservation not





including taxes


















Element


Number



Type


Description











@AmountAfterTax

1



Decimal


The average price of the room after adding in





nightly taxes and fees



















@CurrencyCode

1



String


The currency associated with the average price.





Use ISO 4217, three alpha code



















Rate /









Fees


















Fees /









Fee


















@Amount

1



Decimal


The fee amount. This fee contains the total





nightly fees, as well as any per stay fees



















@CurrencyCode

1



String


The currency associated with the fee amount.





Use ISO 4217, three alpha code



















Rate /









Total

















@AmountBeforeTax

1



Decimal


The total price per stay











@AmountAfterTax

1



Decimal


The total price of the stay after adding in taxes





and fees



















@CurrencyCode

1



String


The currency associated with the total price. Use





ISO 4217, three alpha code



















Total /









Taxes


















@Amount

1



Decimal


The total amount of all taxes and fees for the





availability result



















Taxes /


1..n






Tax































The amount of tax or fee applied per night of


@Amount

1



Decimal


stay (for Per Night charges) or per stay (for Per









Stay charges)











@Code

1



String


The OpenTravel FTT (fee tax type) code for the





tax or fee. See the Tax Code table appendix



















@EffectiveDate

1



Date


The date the charge was applied for Per Night





charges or the arrival date for Per Stay charges


























The date the charge was applied for Per Night


@ExpireDate

1



Date


charges or the last night of the stay for Per Stay









charges












Element

Number



Type


Description
















OpenTravel CHG (charge type) code of “1”


@ChargeFrequency

1



String


(Daily) for Per Night charges or “12” (Per Stay)








for Per Stay charges.










Tax /








TaxDescription
















@Name

1



String


Tax or fee name. This value is “Name”










TaxDescription /

1



String


Language-specific name for the tax or fee


Text




















Tax /








TaxDescription
















@Name

1



String


Tax or fee description. This value is





“Description”

















TaxDescription /

1



String


Language-specific description for the tax or fee


Text




















RoomStay /








BasicPropertyInfo
















@HotelCode

1



String


The code that uniquely identifies a single hotel





property

















@HotelName

1



String


Indicates the hotel name










OTA_HotelAvailRS /








Criteria
















Criteria /








Criterion
















Criterion /








HotelRef
















@HotelCode

1



String


The code that uniquely identifies a single hotel





property

















@HotelName

1



String


Indicates the hotel name










OTA_HotelAvailRS /

0..1





Contains a list of errors in the event of a failed


Errors





request.















Errors / Error

1..n




Mandatory if Errors present.










@Type

1



String


Mandatory if Error present. Identifies the type





of error.


















Element

Number



Type


Description










@Code

1



String


Mandatory if Error is present. Identifies the





specific error in the given type.

















@ShortText

1



String


Short description of the error










Appendix. Tax codes


Code

Description

1

Bed Tax

2

City Hotel Fee

3

City Tax

4

County Tax

5

Energy Tax

6

Federal Tax

7

Food & Beverage Tax

8

Lodging Tax

9

Maintenance Fee

10

Occupancy Tax

11

Package Fee

12

Resort Fee

13

Sales Tax

14

Service Charge

15

State Tax

16

Surcharge

17

Total Tax

18

Tourism Tax

19

VAT/GST Tax

27

Miscellaneous Fee

27

Miscellaneous Tax

28

Room Tax


\n\n \n \n \n
    </div>\n
","event":[{"listen":"prerequest","script":{"id":"dbd18522-dc5f-488f-a219-b598cdbd0bcb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"84489597-e65a-43d5-88a9-281c13727299","type":"text/javascript","exec":[""]}}],"_postman_id":"d44a6d77-ec7e-47d7-83ca-630eb2119f22"}],"id":"bddb5058-b5b0-4474-afdd-072454a15cd7","description":"

Overview

Agoda OTA API is an interface that let you manage your rates and availability for Agoda. This document will help you understand how to send the requests to OTA API and how to read the response messages.

OTA API Versions

Currently Agoda supports two versions of the OTA sepccifications which are:

  1. 2013A
  2. 2015B

Functions

Please see below the available requests and their descriptions.

RequestResponseDescription
OTA_HotelAvailNotifRQOTA_HotelAvailNotifRSUpdate the availability restrictions for one room type in a single hotel. The restrictions include closed for sale, closed to arrival, closed to departure, length of stay.
OTA_HotelBookingRuleNotifRQOTA_HotelBookingRuleNotifRSUpdate the booking rules for one room type in a single hotel. The booking rule include min advance purchase, max advance purchase, or absolute cut off date.
OTA_HotelRateAmountNotifRQOTA_HotelRateAmountNotifRSUpdate the availability and rates for one room type in a single hotel. The rates include availability, rates, taxes, fees, meal plan, and cancellation policies.

Background

In order for you to understand the terms and descriptions of elements we used in OTA API, please find the details of the important elements here.

Rate Plan

To be added

RatePlanCode

Room

To be added

InvgtypeCode

Channel

To be added

End Points and Authentication

End Points

In order to connect to Agoda OTA API, please use the end points as specified below. Please noted that we offer different end points for each version.

Function2013A URI2015B URI
OTA_HotelAvailNotifRQhttp://supplyota.agoda.com/b2b/ota/2013A/hotelshttp://supplyota.agoda.com/b2b/ota/2015B/hotels
OTA_HotelBookingRuleNotifRQhttp://supplyota.agoda.com/b2b/ota/2013A/hotelshttp://supplyota.agoda.com/b2b/ota/2015B/hotels
OTA_HotelRateAmountNotifRQhttp://supplyota.agoda.com/b2b/ota/2013A/hotelshttp://supplyota.agoda.com/b2b/ota/2015B/hotels

Authentication

The Agoda OTA API requires HTTP Basic Authentication which is the encryption (base64) of the \"username:password\". The authentication must be available in the header of the request.

\"authentication\"


Normally the rest API application will provide the encryption for you. Just enter the username and password you receive from Agoda.

\"authentication2\"


","event":[{"listen":"prerequest","script":{"id":"dd43fe11-a287-470b-ae65-72714fea117c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2fc286e7-d71e-4102-95b2-791afcea16f2","type":"text/javascript","exec":[""]}}],"_postman_id":"bddb5058-b5b0-4474-afdd-072454a15cd7"},{"name":"Lists & Codes","item":[{"name":"Special Request List","item":[],"id":"b8f971f5-902e-4f60-bd7a-5b354ad36aa4","description":"\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Special requests FESpecial requests XML push booking
Non-smoking roomNonSmoke
Smoking roomSmokingRoom
Room on high floorHighFloor
Quiet roomQuietRoom
Adjoining roomAdjoiningRoom
Large bedLargeBed
Twin bedsTwinBeds
Baby cotBabyCot
Early Check-InEarlyCheckIn
Late Check-InArrivalFlightNo
Airport transferAirportTransfer:{value}
Arrival timeArrivalTime:{value}
Additional NotesAdditionalNotes:{value}
Arrival Flight NoArrivalFlightNo:{value}
Depart Flight NoDepartFlightNo:{value}
","event":[{"listen":"prerequest","script":{"id":"b7822daa-a985-42b8-8277-789623f262cb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"08f7fbaa-55bc-487e-a28d-d0db334e34b6","type":"text/javascript","exec":[""]}}],"_postman_id":"b8f971f5-902e-4f60-bd7a-5b354ad36aa4"},{"name":"Language List","item":[],"id":"3b03ebc3-b56a-4705-9a6a-1b90a388defd","description":"\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
language_code
language_name
ARArabic
BGBulgarian
CACatalan
CNS.Chinese / Mainland
CSCzech
DADanish
DEGerman
ELGreek
ENEnglish
ESSpanish
ETEstonian
FIFinnish
FRFrench
HEHebrew
HIHindi
HRCroatian
HUHungarian
IDIndonesian
ITItalian
JAJapanese
KOKorean
LTLithuanian
LVLatvian
MSMalay
NLDutch
NONorwegian
PLPolish
PTPortugese
RORomanian
RURussian
SLSlovenian
SVSwedish
THThai
TRTurkish
UKUkrainian
VIVietnamese
ZHT. Chinese
","event":[{"listen":"prerequest","script":{"id":"b1194eee-5d27-4909-9305-6618fada7a89","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6efa1811-55b4-4943-934f-57b4a2d254eb","type":"text/javascript","exec":[""]}}],"_postman_id":"3b03ebc3-b56a-4705-9a6a-1b90a388defd"},{"name":"Benefits List","item":[],"id":"74d601fe-87e9-4d42-90d0-063c3c689c11","description":"\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Benefit id
Benefit name
1Breakfast
2Lunch
3Dinner
4Beverages
6Parking
8Airport transfer [one way]
9Airport transfer [both ways]
10Welcome drink
11Bottle of wine
12Free room upgrade
13Afternoon tea
14Late check-out
15Early check-in
16Restaurant credit
17Spa credit
18Club lounge access
19Bottle of sparkling wine
20Breakfast for 1
21Iftar
22Suhor
25Airport pick-up
26Breakfast for 2
27Buffet dinner
28Car rental
29Casino credit
30Complimentary phone card
31Cruise dinner
32Daily yoga class
33Diving excursion
34Express check-in
35Free extra bed
36Free gift
37Free mini bar
38Free shuttle service
39Fruit basket
40Japanese dinner
41Kaiseki dinner
42Limited bus pass
43Limited golf package
44Limited laundry service
45Limited train pass
46Local admission tickets
47Safari tour
48Selected beverages [alcoholic]
49Selected beverages [non-alcoholic]
50Selected watersports
51Sightseeing tour
52Special meal arrangements
53Theme park tickets
54Western dinner
55All Inclusive
56Airport drop-off
572 Complimentary Buffet credits
58Beverage credit
59Bike Rental
60Complimentary show tickets
61Dining discount
62Ferry Transfer [both ways]
63Ferry Transfer [one way]
64Food & Beverage credit
65Food & Drink discount
66Food discount
67Free meal upgrade (Dinner & Lunch)
68Late Check-In
69Late check-out prior to 6 pm
70Limited housekeeping
71Motorcycle Rental
72Resort Credit
73Ski pass
74Spa discount
75Unlimited alcohol beverages at lounge
76Water Park Tickets
77Free Premium Wifi
78Complimentary breakfast for 3 guests
79Portable wifi unit during stay
80Free local mobile SIM card
81Mooncake
822 free drinks at coffee shop
83Duty-free shopping gift voucher
84Complimentary snacks
85Free sauna access
86In- room dinner
87Wagyu beef dinner
88Japanese robe free rental
89Local breakfast
90Crab dinner
91Public Transportation Credit
92Water Activities
93Meeting Room
94Parking Credit
95Free WiFi
96Room Phone Credit
97Foot Massage
98Full Body Massage
99Free entry to Infinity Pool
100Free entry to Sands Sky Park
101Free entry to Banyan Tree Fitness Club
102Sunset Cruise
103Dolphin Cruise
104Local Island Excursion
105Sunset Fishing Excursion
106Snorkeling Excursion
107One Half Day Excursion per Person per Stay
108One Night Fishing per Person per Stay
1092 Adventure Cove Waterpark Tickets
1102 S.E.A. Aquarium Tickets
1112 The Maritime Museum and Typhoon Theater Tickets
1122 Universal Studios Singapore Tickets
113Basic Kaiseki Dinner
114Casual Kaiseki Dinner
115Free Fitness Center Access
116Free Pool Access
117Ladies Amenities
118Premium Kaiseki Dinner
119Private Hot Spring Bath
120Quo Card
121Vegetarian Breakfast
122Vegetarian Dinner
","_postman_id":"74d601fe-87e9-4d42-90d0-063c3c689c11"},{"name":"Error List","item":[],"id":"4e9e2f7d-782b-43ad-ad0f-2a1d6723fb3a","description":"\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
Request Type
Error   Type
Error   List
Error   Message
Generic   ErrorsDatedates   Range Error1101,   \"From date: xxxs cannot be later than To date: xxxs\"
Generic ErrorsDatefrom Date Error1102, \"From date: xxxs cannot be earlier   than yesterday and cannot be later than xxxs days\"
Generic   ErrorsDateto   Date Error1103,   \"To date: xxxs cannot be earlier than yesterday and cannot be later than   xxxs days\"
Generic ErrorsDatedate Value Error1104, \"Date values cannot be earlier than   yesterday and cannot be later than xxxs days\"
Generic   ErrorsApiKeyinvalidApiKeyError1201,   \"API key is not authorised for Property id: xxxs\"
Generic ErrorsProperty IdinvalidPropertyId1301, \"Invalid Property id: xxxs\"
Generic   ErrorsLanguagenotSupportedByAgoda1401,   \"Requested language: xxxs is not supported by Agoda\"
Generic ErrorsLanguagenotSupportedByHotel1402, \"Requested language: xxxs is not   supported by the property xxxs\"
Generic   ErrorsrequestinvalidRequest1501,   \"The request is invalid: %s\"
Generic ErrorsrequestinvalidInput1502, \"The requested xml contains invalid   input: %s\"
Generic   Errorsrequestunauthorized1503,   \"Authentication failed: %s\"
Generic ErrorsrequestrateLimit1504, \"Rate limit has been exceeed:   %s\"
Generic   Errorsrequestduplicate1506,   \"Property number has exceed the limit of %s\"
Generic ErrorsrequestbookingExceedLimit1507, \"Booking number has exceed the limit   of %s per property\"
SetArirequestrequestsize1508, \"The request payload is too large: max size allowed 1000000 but got xxxxxx bytes\"
Generic   ErrorsrequestinvalidSchema1511,   could be vary depending on xsd formats, \"[Line: <line_number>   Column: <column_number>] <description_of_error>\"
Generic ErrorsrateModelErrorinvalidRateModel1601, \"The requested property (%s) has   incorrect rate model\"
SetAriPre   ValidationratesDefaultError2101,   \"Default rate is required but does not exist\"
SetAriPre ValidationratesOccupancyErrorSingleDouble2102, \"Single rate cannot be greater than   Double rate\"
SetAriPre   ValidationratesOccupancyErrorDoubleFull2103,   \"Double rate cannot be greater than Full rate\"
SetAriPre ValidationinvalidCurrencyError2105, \"Invalid input for currency:   xxxs\"
SetAriPre   ValidationmaxLOSError2106,   \"Max LOS: xxxs cannot be less than xxxs or greater than xxxs\"
SetAriPre ValidationminLOSError2107, \"Min LOS: xxxs cannot be less than   xxxs or greater than xxxs\"
SetAriPre   ValidationminLosGtError2108,   \"Min LOS: xxxs cannot be greater than Max LOS: xxxs\"
SetAriPre ValidationmaxLosLtError2109, \"Max LOS: xxxs cannot be less than   Min LOS: %s\"
SetAriPre   ValidationsetAriDateValueError2110,   \"Date Value cannot be more than xxxs days\"
SetAriPre ValidationdowOutOfInvervalError2111, \"DOW xxxs not falling between date   range xxxs (xxxs)\"
SetAriPre   ValidationoccupancyModeError2112,   \"At least one occupancy rate must be set in OVERWRITE or OVERLAY   mode.\"
SetAriPre ValidationfromDateError2213, \"From date: %s cannot be earlier   than yesterday\"
SetAriPre   ValidationtoDateError2214,   \"To date: %s cannot be earlier than yesterday\"
SetAriPre ValidationdateValueError2215, \"Date values cannot be earlier than   yesterday\"
SetAriPost ValidationmaxRoomsError2202, \"Allotment: xxxs cannot be greater   than xxxs\"
SetAriPost   ValidationhotelCurrencyError2203,   \"Requested currency: xxxs does not match with Property currency:   xxxs\"
SetAriPost ValidationmaxOccError2204, \"Price provided not sufficient for   Max occupancy xxxs, rate missing: xxxs\"
SetAriPost   ValidationinvalidRoomError2205,   \"Room: xxxs does not exist for Property id: xxxs\"
SetAriPost ValidationredundancyRateError2206, \"Cannot set xxxs because max   occupancy is xxxs\"
SetAriPost   ValidationextraBedIsNotSet2207,   \"Extrabed is xxxs, please set Extra Bed rate\"
SetAriPost ValidationcannotSetExtraBed2208, \"Max extrabed has not been set, You   cannot set the extrabed rate\"
SetAriPost   ValidationinvalidRatePlan2209,   \"Rate plan: xxxs does not exist for Property id: xxxs\"
SetAriPost ValidationisChildRatePlan2210, \"Rate plan: xxxs is child rate plan   which is not allow to set rate\"
GetAriPre ValidationgetAriDateRangeError3101, \"Date Range for GetAri cannot be   longer than 31 days, xxxs days
GetAriPre   Validation requested\"
GetAriPre ValidationinvalidRoomError3102, \"Room: xxxs does not exist for   Property id: xxxs\"
GetAriPre   ValidationinvalidRatePlan3103,   \"Rate plan: xxxs does not exist for Property id: xxxs\"
GetBookingListPre ValidationisChildRatePlan3104, \"Rate plan: xxxs is child rate plan   which is not allow to get rate\"
GetBookingListPre   ValidationfromDateError4101,   \"From date: xxxs cannot be older than 90 days\"
GetBookingListPre ValidationdateRangeError4102, \"Date Range for GetBookingList   cannot be longer than 90 days, xxxs days requested\"
GetBookingListPre   ValidationtimeZoneError4103,   \"Timezone defined in 'From' and 'To' must be the same\"
GetBookingListV2Pre ValidationoffSetError4104, \"Timezone offset is invalid\"
GetBookingListV3Pre   ValidationfromDateError11101,   \"From date: %s cannot be later than %s days\"
GetBookingListV4Pre ValidationtimeZoneError11103, \"Timezone defined in 'From' and   'To' must be the same\"
GetBookingListV5Pre   ValidationoffSetError11104,   \"Timezone offszet is invalid\"
GetProductPre ValidationtimeRangeError11105, \"Time Range for GetBookinglistV2   cannot be longer than %s minutes, around %s minutes requested\"
GetProductPre   ValidationlanguageNotFoundError7101,   \"Language: xxxs is invalid\"
setProductErrorsPre ValidationinvalidRoomError10101, \"Room: %s does not exist for   Property id: %s\"
setProductErrorsPre   ValidationinvalidRatePlan10102,   \"Rate plan: %s does not exist for Property id: %s\"
setProductErrorsPre ValidationinvalidHotelCurrency10103, \"Requested currency: %s does not   match with Property currency: %s\"
setProductErrorsPre   ValidationnumPersonError10104,   \"num_persons: %s must be between 1 and 30\"
setProductErrorsPre ValidationminRateError10105, \"Min rate: %s must be between 1 and   999999999\"
setProductErrorsPre   ValidationminRateWithoutCurrencyError10106,   \"Currency must be specified when setting min_rate\"
setProductErrorsPre ValidationminLosError10107, \"Min LOS: %s must be between 1 and   99\"
setProductErrorsPre   ValidationmaxLosError10108,   \"Max LOS: %s must be between 0 and 99\"
setProductErrorsPre ValidationminLosGtError10109, \"Min LOS: %s cannot be greater than   Max LOS: %s\"
setProductErrorsPre   ValidationmaxLosLtError10110,   \"Max LOS: %s cannot be less than Min LOS: %s\"
setProductErrorsPre ValidationminAdvError10111, \"min_adv_days: %s must be between 0   and 90\"
setProductErrorsPre   ValidationmaxAdvError10112,   \"max_adv_days: %s must be between -1 and 90\"
setProductErrorsPre ValidationminAdvGtError10113, \"min_adv_days: %s cannot be greater   than max_adv_days: %s\"
setProductErrorsPre   ValidationmaxAdvLtError10114,   \"max_adv_days: %s cannot be less than min_adv_days: %s\"
setProductErrorsPre ValidationminRateGtError10115, \"Min rate: %s cannot be greater   than Max rate: %s\"
apiErrorsInternal   ErrorinternalException99101,   \"There was an internal server error: %s\"
xsdErrorsXsd ValidationxsdSchemaError1511, \"[Line:<LINE_NUMBER>   Column:<COLUMN_NUMBER>] <DESCRIPTION_OF_ERROR>]\"
","event":[{"listen":"prerequest","script":{"id":"de1e734d-f891-48f3-885d-bee9a82cb4de","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"dff78438-2055-4708-88a9-9f47d1f00531","type":"text/javascript","exec":[""]}}],"_postman_id":"4e9e2f7d-782b-43ad-ad0f-2a1d6723fb3a"}],"id":"6543e080-d2de-4101-8ef8-a9d9f2d9bd48","_postman_id":"6543e080-d2de-4101-8ef8-a9d9f2d9bd48","description":""}],"event":[{"listen":"prerequest","script":{"id":"d3d18ea6-c567-4a1f-a4d0-07e199448230","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"af2bb2b0-8d03-4648-b54b-8d3b2d7aaafb","type":"text/javascript","exec":[""]}}]}