{"info":{"_postman_id":"24daf4d6-5c42-4c52-bb48-50eb02d3d08b","name":"ARI Push – Channel Manager APIs","description":"

Introduction

ARI Push – Channel Manager APIs are a set of APIs that allow iOLX to receive hotels' ARI (Availability, Rates, and Inventory) data. Using these APIs, iOLX can receive hotels' rates and availabilities and store them for customer searches. They support two rate models: Daily and LOS (Length of Stay).

Channel managers can use the Ping API to check if our endpoint is operational.

iOLX will use the HotelList & Hotel Products API's to retrieve hotel information from the Channel Manager.

Meanwhile, the Hotel API lets channel managers retrieve the list of active hotels and products from our system. They can use this API to filter ARI data pushes. iOLX will keep hotel and product statuses up to date.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"48381311","collectionId":"24daf4d6-5c42-4c52-bb48-50eb02d3d08b","publishedId":"2sBXcKAxMC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-03T07:48:43.000Z"},"item":[{"name":"Ping","item":[],"id":"0a04a8f7-9b9b-43fc-8e65-e95ed5f2fdc9","description":"

Channel Managers can use the ping API to check whether the endpoint provided by iOLX is working or not.

GET /ping HTTP/1.1\nURL: {{endpoint}}/ping\nAuthorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Response Example

Success Response (HTTP Status 200)

\"ok\"\n\n

Error Response (HTTP Status 401)

{\n    \"error\": \"Key not authorised\"\n}\n\n

Error Response (HTTP Status 500)

{\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"Invalid Message\"\n}\n\n

","_postman_id":"0a04a8f7-9b9b-43fc-8e65-e95ed5f2fdc9"},{"name":"Hotel List","item":[],"id":"3b667904-a20b-40df-b19c-aecfb2bcc252","description":"

iOLX will use this to query the Channel Manager for a list of active hotels for a specific Supplier.

GET /hotels/{supplierId} HTTP/1.1\nURL: {{endpoint}}/hotels/{supplierId}\nAuthorization:Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Request Parameters

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

Name	Description	Required	Type	Example
supplierId	The ID of the supplier in the Channel Manager's system	Yes	string	HILTON

Response Example

Success Response (HTTP Status 200)

[\n  {\n    \"supplierId\": \"HILTON\",\n    \"hotelId\": \"GATHI\",\n    \"hotelName\": \"This is a test hotel\",\n    \"status\": \"Actived\"\n  }\n]\n\n

Error Response (HTTP Status 401)

{\n    \"error\": \"Key not authorised\"\n}\n\n

Error Response (HTTP Status 500)

{\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"Invalid Message\"\n}\n\n

Response 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

Attribute	Type	Required	Description	Example
supplierId	string	Yes	Supplier ID in Channel Manager's system	HILTON
hotelId	string	Yes	Hotel ID in the supplier‘s system	GATHI
hotelName	string	Yes	Hotel name in supplier's system	This is a test hotel
status	enum	Yes	Enum: [ Actived, Deactived ] Status in iOLX system	Actived

","_postman_id":"3b667904-a20b-40df-b19c-aecfb2bcc252"},{"name":"Hotel Products","item":[],"id":"ac2062e3-4dc3-48e2-940a-6a7012b0f0c6","description":"

iOLX uses this API to pull hotel product lists with their status (Activated or Deactivated) for each hotel from the channel manager.

The product information required includes

Room Details
\n
- Occupancy
  \n
- Name
  \n
- Code
  \n
- Description
  \n
\n
Rate Plan details
\n
- Rateplan code
  \n
- Rateplan Name
  \n
- Rateplan description (inclusions)
  \n
- Rateplan Meal basis
  \n
- Package Rate - indicates whether rate must be packaged when sold to end consumer
  \n
- Commission - indicates the commission or discount on BAR
  \n
\n
Fees & Taxes
\n
- list of fees and taxes included in the rate
  \n
- List of fee & taxes excluded
  \n
- List of fees & taxes to be collected directly by hotel at check in
  \n
\n
Cancellation Policy
\n
- Policy Code
  \n
- Schedule (days before check-in)
  \n
- Charges Type
  \n
  - Percent
    \n
  - Amount
    \n
  - Nights
    \n
  \n
- Charges Value
  \n
\n

GET /hotel/{supplierId}/{hotelId} HTTP/1.1\nURL: {{endpoint}}/hotel/{supplierId}/{hotelId}\nAuthorization:Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Request Parameters

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

Name	Description	Required	Type	Example
supplierId	The ID of the supplier in Channel Manager's system	Yes	string	HILTON
hotelId	The ID of a hotel in the supplier's system	Yes	string	GATHI

Hotel Products Response Schema

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

Level	Field Name	Data Type	Required	Description	Example
1	hotelId	string	Y	The code that uniquely identifies a Hotel in the hotel suppliers system. Accepted characters only: 1. Digits (0-9) 2. Uppercase letters (A-Z) 3. Hyphen ('-')	GATHI
1	hotelName	string	Y	Hotel name in supplier's system	This is a test hotel
1	supplierId	string	Y	The code that uniquely identifies a supplier in Channel Manager's system	HILTON
1	status	enum	Y	Enum: [ Actived, Deactived ] Hotel Status provided by hotel suppliers [ Actived, Deactived]: Actived means the hotel is active for the distribution. Deactived means the hotel is NOT active for the distribution. ARI will not flow for deactivated hotels	Actived
1	chainCode	string	N	Unique identifier for the hotel chain or group, assigned by the chain’s central system. e.g., Hyatt, Hilton. Independent hotels don't have Chain codes	Marriott
1	brandCode	string	N	Unique identifier for the hotel brand, assigned by the hotel group’s central system. Represents specific brand (e.g., Courtyard, DoubleTree). Independent hotels don't have Chain codes	Waldorf
1	longitude	string	Y	Geographic coordinate that specifies the east–west position of the hotel on the Earth's surface.	41.40338
1	latitude	string	Y	Geographic coordinate that specifies the north–south position of the hotel on the Earth's surface.	2.17403
1	city	string	N	Name of the city or locality where the hotel is physically located.	/
1	country	string	N	Name of the country where the hotel is physically located.	/
1	state	string	N	Name of the state where the hotel is physically located.	/
1	currency	string	N	The currency code of the hotel.	USD
1	address	array	N	Street address of the hotel, provided as an ordered array of up to five address lines.	[ \"AddressLine1\", \"AddressLine2\" ]
1	phone	object	N	Primary phone number for the hotel, provided by the hotel system.	/
2	@countryAccessCode	string	C	International dialing code used to place calls to the country where the hotel is located.	/
2	@areaCityCode	string	N	Telephone area or city dialing code used within the country to reach the hotel's geographic region.	/
2	@phoneNumber	string	C	Local subscriber phone number of the hotel, excluding the country access code and area/city code.	/
1	ariType	enum	Y	Emun: [ Daily, LOS ] Defines the pricing model applied to a rate amount or value over time.	Daily
1	timezone	string	Y	Time zone in which the hotel is physically located.	America/Los_Angeles
1	rateType	enum	Y	Emun: [ AmountBeforeTax, AmountAfterTax, Both ] Specifies tax-inclusion status of the rate amount.	AmountBeforeTax
1	maxChildAge	integer	Y	Maximum age, in years, that a guest can be classified as a child. Only provided if childRateType is ByAge.	/
1	childRateType	enum	N	Enum: [ Normal, ByAge, Free, AsAdult ] Indicates which child rate type will be used in ARI OccupancyRate.	ByAge
1	products	array	Y	Collection of product elements offered by the hotel	/
1	ISO	String	Y	Country Code	GB
2	@roomId	string	Y	Unique identifier for a room type, assigned by the hotel's system (PMS or CRS).	King
2	@rateId	string	Y	Unique identifier for a rate plan, assigned by the hotel system (CRS, PMS, or channel manager).	BAR
2	@rateModel	enum	N	Enum: [ Retail, Net ] Rate model of the product	Retail

2	@stayType	enum	N	Enum: [ OverNightRoom, DayUseRoom ] Indicates if the product is for day-use or regular overnight use. Default is OverNightRoom.	OverNightRoom
2	@status	enum	Y	Enum: [ Actived, Deactived ] Indicates current operational or distribution state of an entity.	Actived
2	@roomName	string	N	Display name of the room type. Max length: 256	King Room
2	@roomDescription	string	N	Detailed textual description of the room type.	Soak in city views...
2	@rateName	string	N	Display name of the rate type. Max length: 256	Best Available Rate
2	@rateDescription	string	N	Detailed textual description of the rate type.	Begin your day with a hearty meal
2	occupancy	/	Y	Defines the maximum allowed occupancy for a room type, rate plan, or product.	/
3	@maxAdult	integer	Y	Maximum number of adult guests allowed in the room type or product.	3
3	@maxChild	integer	Y	Maximum number of child guests allowed in the room type or product.	2
3	@maxOccupancy	integer	Y	Defines the maximum allowed occupancy for a room type, rate plan, or product.	3
2	@paymentType	enum	N	Enum: [ PayLater, PayNow ] Specifies the payment model associated with the booking.	PayNow
2	guarantee	/	N	Defines the guarantee requirements for holding a reservation.	/
3	@guaranteeType	string	C	Guarantee information for this room rate. Refers to standard guarantee type list.	CCG
2	cancelPolicies	/	N	A collection of cancellation policies based on timeframes, dates, or penalty conditions.	/
3	dateRange	object	N	Specifies the date range during which the cancellation policy is applicable.	/
4	@startDate	string	C	The starting date of validity. YYYY-MM-DD	2028-01-01
4	@endDate	string	C	The ending date of validity. YYYY-MM-DD	2028-01-04
3	cancelPolicy	object	N	Defines the rules and penalties applied when a guest cancels a reservation.	/
4	@code	string	C	Unique identifier for specific cancellation policy. Max Length: 128	AD100P_100P
4	@description	string	N	Explanation of the cancellation policy terms. Max Length: 1024	Non Refundable
4	cancelPenalties	/	Y	Details about the cancellation Penalty	/
5	@noShow	boolean	Y	When true, the penalty charge is applied for No-Show.	TRUE
5	@cancellable	boolean	N	Indicates if cancellation is allowed. If false, it cannot be canceled.	TRUE
5	cancelDeadline	/	N	Specifies the time-based condition to avoid penalty.	/
6	@offsetTimeDropType	enum	N	Enum: [ BeforeArrival ]	BeforeArrival
6	@offsetTimeUnit	enum	N	Enum: [ D, H ] (Days or Hours)	/
6	@offsetTimeValue	number	N	The number of hours or days for the offset.	1
6	@deadline	string	N	The cutoff date and time for cancellation in hotel's local time.	/
5	penaltyCharge	/	Y	Defines the charge rule applied as a penalty.	/
6	@chargeBase	enum	N	Enum: [ FullStay, NightBase ]	/
6	@nights	number	N	Exists if the penalty charge is based on the night.	/
6	@amount	number	N	Exists if the penalty charge is a flat charge.	/
6	@percent	number	N	Exists if the penalty charge is a percent.	/
2	fees	/	N	Represents a list of additional charges (taxes and fees).	/
3	dateRange	/	N	Specifies the date range during which the fees are applicable.	/
4	@startDate	string	C	The starting date of validity. YYYY-MM-DD	2028-01-01
4	@endDate	string	C	The ending date of validity. YYYY-MM-DD	2028-01-04
3	fee	object	N	Represents a single fee or tax item.	/
4	@name	string	C	The name of the fee or tax	Service Charge
4	@type	enum	C	Enum: [ Inclusive, Exclusive ]	Exclusive
4	@amount	number	C	Amount value of fee or tax	10
4	@amountType	enum	C	Enum: [ Fix, Percent ]	Percent
4	@chargeType	enum	C	Enum: [ PerRoomPerNight, PerPersonPerNight, etc ]	PerRoomPerNight
4	@paymentType	enum	N	Enum: [ PayLater, PayNow ]	PayNow
4	@collectBy	enum	N	Enum: [ distributor, Property ]	Property
4	@effectivePerson	number	N	Indicates occupancy level at which fee starts.	3
4	@mealPlan	String	N	Meal Plan Code	BB
2	commissions	array[object]	N	Commission details	/
3	@startDate	string	N	Start date of commission (YYYY-MM-DD).	2028-01-01
3	@endDate	string	N	End date of commission.	2028-01-04
3	@value	number	C	Commission value	10
3	@type	enum	C	Enum: [ Percent, Amount ]	Percent
1	error	string	N	error response	Key not authorized
1	errorCode	string	C	error response	InvalidField
1	errorMessage	string	C	error response	Invalid Message

Hotel Products Response Example

Success Response (HTTP Status 200)

{\n  \"hotelId\": \"GATHI\",\n  \"hotelName\": \"This is a test hotel\",\n  \"supplierId\": \"HILTON\",\n  \"status\": \"Actived\",\n  \"chainCode\": \"Hilton\",\n  \"brandCode\": \"Hampton\",\n  \"longitude\": \"41.40338\",\n  \"latitude\": \"2.17403\",\n  \"city\": \"string\",\n  \"country\": \"string\",\n  \"state\": \"string\",\n  \"currency\": \"USD\",\n  \"ISO\": \"GB\" ,\n  \"address\": [\n    \"AddressLine1\",\n    \"AddressLine2\",\n    \"AddressLine3\",\n    \"AddressLine4\",\n    \"AddressLine5\"\n  ],\n  \"phone\": {\n    \"countryAccessCode\": \"string\",\n    \"areaCityCode\": \"string\",\n    \"phoneNumber\": \"string\"\n  },\n  \"ariType\": \"Daily\",\n  \"timezone\": \"America/Los_Angeles\",\n  \"rateType\": \"AmountBeforeTax\",\n  \"maxChildAge\": 17,\n  \"childRateType\": \"ByAge\",\n  \"products\": [\n    {\n      \"roomId\": \"10000101\",\n      \"rateId\": \"123456\",\n      \"stayType\": \"OverNightRoom\",\n      \"status\": \"Actived\",\n      \"roomName\": \"Double Room\",\n      \"roomDescription\": \"Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.\",\n      \"rateName\": \"Bar Rate\",\n      \"rateDescription\": \"Begin your day with a hearty meal.\",\n      \"occupancy\": {\n        \"maxAdult\": 3,\n        \"maxChild\": 2,\n        \"maxOccupancy\": 3\n      },\n      \"paymentType\": \"PayNow\",\n      \"guarantee\": {\n        \"guaranteeType\": \"CCG\"\n      },\n      \"cancelPolicies\": [\n        {\n          \"dateRange\": {\n            \"startDate\": \"2018-01-01\",\n            \"endDate\": \"2018-01-04\"\n          },\n          \"cancelPolicy\": {\n            \"code\": \"1D1N_1N\",\n            \"description\": \"Cancellations or changes to bookings for this room will be charged the first night of the booking in 1 day before arrival date, if no show, will be charged the first night of the booking.\",\n            \"cancelPenalties\": [\n              {\n                \"noShow\": false,\n                \"cancellable\": true,\n                \"cancelDeadline\": {\n                  \"offsetTimeDropType\": \"BeforeArrival\",\n                  \"offsetTimeUnit\": \"D\",\n                  \"offsetTimeValue\": 1\n                },\n                \"penaltyCharge\": {\n                  \"chargeBase\": \"NightBase\",\n                  \"nights\": 1\n                }\n              },\n              {\n                \"noShow\": true,\n                \"penaltyCharge\": {\n                  \"chargeBase\": \"NightBase\",\n                  \"nights\": 1\n                }\n              }\n            ]\n          }\n        }\n      ],\n      \"fees\": [\n        {\n          \"dateRange\": {\n            \"startDate\": \"2018-01-01\",\n            \"endDate\": \"2018-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"Service Charge\",\n            \"type\": \"Exclusive\",\n            \"amount\": 10,\n            \"amountType\": \"Percent\",\n            \"chargeType\": \"PerRoomPerNight\",\n            \"paymentType\": \"PayNow\",\n            \"collectBy\": \"distributor\",\n            \"effectivePerson\": 0\n            \"mealPlan\": BB\n          }\n        },\n        {\n          \"dateRange\": {\n            \"startDate\": \"2018-01-01\",\n            \"endDate\": \"2018-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"City Tax\",\n            \"type\": \"Exclusive\",\n            \"amount\": 5,\n            \"amountType\": \"Fix\",\n            \"chargeType\": \"PerPersonPerNight\",\n            \"paymentType\": \"PayLater\",\n            \"collectBy\": \"Property\",\n            \"effectivePerson\": 0\n            \"mealPlan\": BB\n          }\n        }\n      ]\n        }\n      ]\n    }\n  ]\n}\n\n

Success Response from Retail Rate Model(HTTP Status 200)

{\n  \"hotelId\": \"GATHI\",\n  \"hotelName\": \"This is a test hotel\",\n  \"supplierId\": \"HILTON\",\n  \"status\": \"Actived\",\n  \"chainCode\": \"Hilton\",\n  \"brandCode\": \"Hampton\",\n  \"longitude\": \"41.40338\",\n  \"latitude\": \"2.17403\",\n  \"city\": \"string\",\n  \"country\": \"string\",\n  \"state\": \"string\",\n  \"currency\": \"USD\",\n  \"ISO\": \"GB\",\n  \"address\": [\n    \"AddressLine1\",\n    \"AddressLine2\",\n    \"AddressLine3\",\n    \"AddressLine4\",\n    \"AddressLine5\"\n  ],\n  \"phone\": {\n    \"countryAccessCode\": \"string\",\n    \"areaCityCode\": \"string\",\n    \"phoneNumber\": \"string\"\n  },\n  \"ariType\": \"Daily\",\n  \"timezone\": \"America/Los_Angeles\",\n  \"rateType\": \"AmountBeforeTax\",\n  \"maxChildAge\": 17,\n  \"childRateType\": \"ByAge\",\n  \"products\": [\n    {\n      \"roomId\": \"10000101\",\n      \"rateId\": \"123456\",\n      \"rateModel\": \"Retail\",\n      \"stayType\": \"OverNightRoom\",\n      \"status\": \"Actived\",\n      \"roomName\": \"Double Room\",\n      \"roomDescription\": \"Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.\",\n      \"rateName\": \"Bar Rate\",\n      \"rateDescription\": \"Begin your day with a hearty meal.\",\n      \"occupancy\": {\n        \"maxAdult\": 3,\n        \"maxChild\": 2,\n        \"maxOccupancy\": 3\n      },\n      \"paymentType\": \"PayNow\",\n      \"guarantee\": {\n        \"guaranteeType\": \"CCG\"\n      },\n      \"cancelPolicies\": [\n        {\n          \"dateRange\": {\n            \"startDate\": \"2018-01-01\",\n            \"endDate\": \"2018-01-04\"\n          },\n          \"cancelPolicy\": {\n            \"code\": \"1D1N_1N\",\n            \"description\": \"Cancellations or changes to bookings for this room will be charged the first night of the booking in 1 day before arrival date, if no show, will be charged the first night of the booking.\",\n            \"cancelPenalties\": [\n                {\n                    \"noShow\": false,\n                    \"cancellable\": true,\n                    \"cancelDeadline\": {\n                        \"offsetTimeDropType\": \"BeforeArrival\",\n                        \"offsetTimeUnit\": \"D\",\n                        \"offsetTimeValue\": 1\n                    },\n                    \"penaltyCharge\": {\n                        \"chargeBase\": \"NightBase\",\n                        \"nights\": 1\n                    }\n                },\n                {\n                    \"noShow\": true,\n                    \"penaltyCharge\": {\n                        \"chargeBase\": \"NightBase\",\n                        \"nights\": 1\n                    }\n                }\n            ]\n          }\n        }\n      ],\n      \"fees\": [\n        {\n          \"dateRange\": {\n            \"startDate\": \"2018-01-01\",\n            \"endDate\": \"2018-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"Service Charge\",\n            \"type\": \"Exclusive\",\n            \"amount\": 10,\n            \"amountType\": \"Percent\",\n            \"chargeType\": \"PerRoomPerNight\",\n            \"collectBy\": \"distributor\",\n            \"effectivePerson\": 0\n            \"mealPlan\": BB\n          }\n        },\n        {\n          \"dateRange\": {\n            \"startDate\": \"2018-01-01\",\n            \"endDate\": \"2018-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"City Tax\",\n            \"type\": \"Exclusive\",\n            \"amount\": 5,\n            \"amountType\": \"Fix\",\n            \"chargeType\": \"PerPersonPerNight\",\n            \"collectBy\": \"Property\",\n            \"effectivePerson\": 0\n            \"mealPlan\": BB\n          }\n        }\n      ]\n        }\n      ],\n      \"commissions\": [\n        {\n          \"startDate\": \"2018-01-01\",\n          \"endDate\": \"2018-01-04\",\n          \"value\": 10,\n          \"type\": \"Percent\"\n        }\n      ]\n    }\n  ]\n}\n\n

Response from Net Rate Model(HTTP Status 200)

{\n  \"hotelId\": \"GATHI\",\n  \"hotelName\": \"This is a test hotel\",\n  \"supplierId\": \"HILTON\",\n  \"status\": \"Actived\",\n  \"chainCode\": \"Hilton\",\n  \"brandCode\": \"Hampton\",\n  \"longitude\": \"41.40338\",\n  \"latitude\": \"2.17403\",\n  \"city\": \"string\",\n  \"country\": \"string\",\n  \"state\": \"string\",\n  \"currency\": \"USD\",\n  \"ISO\": \"GB\",\n  \"address\": [\n    \"AddressLine1\",\n    \"AddressLine2\",\n    \"AddressLine3\",\n    \"AddressLine4\",\n    \"AddressLine5\"\n  ],\n  \"phone\": {\n    \"countryAccessCode\": \"string\",\n    \"areaCityCode\": \"string\",\n    \"phoneNumber\": \"string\"\n  },\n  \"ariType\": \"Daily\",\n  \"timezone\": \"America/Los_Angeles\",\n  \"rateType\": \"AmountBeforeTax\",\n  \"maxChildAge\": 17,\n  \"childRateType\": \"ByAge\",\n  \"products\": [\n    {\n      \"roomId\": \"10000101\",\n      \"rateId\": \"123456\",\n      \"rateModel\": \"Net\",\n      \"stayType\": \"OverNightRoom\",\n      \"status\": \"Actived\",\n      \"roomName\": \"Double Room\",\n      \"roomDescription\": \"Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.\",\n      \"rateName\": \"Bar Rate\",\n      \"rateDescription\": \"Begin your day with a hearty meal.\",\n      \"occupancy\": {\n        \"maxAdult\": 3,\n        \"maxChild\": 2,\n        \"maxOccupancy\": 3\n      },\n      \"paymentType\": \"PayNow\",\n      \"guarantee\": {\n        \"guaranteeType\": \"CCG\"\n      },\n      \"cancelPolicies\": [\n        {\n          \"dateRange\": {\n            \"startDate\": \"2018-01-01\",\n            \"endDate\": \"2018-01-04\"\n          },\n          \"cancelPolicy\": {\n            \"code\": \"1D1N_1N\",\n            \"description\": \"Cancellations or changes to bookings for this room will be charged the first night of the booking in 1 day before arrival date, if no show, will be charged the first night of the booking.\",\n            \"cancelPenalties\": [\n                {\n                    \"noShow\": false,\n                    \"cancellable\": true,\n                    \"cancelDeadline\": {\n                        \"offsetTimeDropType\": \"BeforeArrival\",\n                        \"offsetTimeUnit\": \"D\",\n                        \"offsetTimeValue\": 1\n                    },\n                    \"penaltyCharge\": {\n                        \"chargeBase\": \"NightBase\",\n                        \"nights\": 1\n                    }\n                },\n                {\n                    \"noShow\": true,\n                    \"penaltyCharge\": {\n                        \"chargeBase\": \"NightBase\",\n                        \"nights\": 1\n                    }\n                }\n            ]\n          }\n        }\n      ],\n      \"fees\": [\n        {\n          \"dateRange\": {\n            \"startDate\": \"2018-01-01\",\n            \"endDate\": \"2018-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"Service Charge\",\n            \"type\": \"Exclusive\",\n            \"amount\": 10,\n            \"amountType\": \"Percent\",\n            \"chargeType\": \"PerRoomPerNight\",\n            \"collectBy\": \"distributor\",\n            \"effectivePerson\": 0\n            \"mealPlan\": BB\n          }\n        },\n        {\n          \"dateRange\": {\n            \"startDate\": \"2018-01-01\",\n            \"endDate\": \"2018-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"City Tax\",\n            \"type\": \"Exclusive\",\n            \"amount\": 5,\n            \"amountType\": \"Fix\",\n            \"chargeType\": \"PerPersonPerNight\",\n            \"collectBy\": \"Property\",\n            \"effectivePerson\": 0\n            \"mealPlan\": BB\n          }\n        }\n      ]\n        }\n      ]\n    }\n  ]\n}\n\n

Error Response (HTTP Status 401)

{\n    \"error\": \"Key not authorized\"\n}\n\n

Error Response (HTTP Status 500)

        {\n    \"errorCode\": \"InvalidField\",\n    \"errorMessage\": \"Invalid Message\"\n}\n\n

","_postman_id":"ac2062e3-4dc3-48e2-940a-6a7012b0f0c6"},{"name":"Hotel Activation Push Distributors","item":[],"id":"6367b230-f66c-486f-8ea9-b51b826286ad","description":"

The Hotel Activation (Push) API is a step that allows iOLX to select the hotels they wish to activate for distribution.

Through this API, Channel Manager retrieves the list of active hotels for each supplier, ensuring that only the selected hotels are made available for distribution. This optional activation process gives iOLX control over which hotels are included in its distribution scope.

iOLX can use this API to:

Select the hotels they wish to activate for distribution from their suppliers.

GET /hotels/{supplierId} HTTP/1.1\nURL: {AvailabilityPeer-Endpoint}/hotels/{supplierId}\nAuthorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Hotel Activation Push Distributors Request Schema

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

Level	Field Name	Data Type	Required	Description	Example
1	supplierId	string	Y	The code that uniquely identifies a supplier in Channel Manager's system. MaxLength: 32	HILTON

Hotel Activation Push Distributors Request Example

Sample URL: https://dsgo.xxxxx.net/hotels/GOHOTEL\n\n

Hotel Activation Push Distributors Response Schema

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

Level	Field Name	Data Type	Required	Description	Example
1	supplierId	string	Y	The code that uniquely identifies a supplier in Channel Manager's system	HILTON
1	hotelId	string	Y	The code that uniquely identifies a single hotel in the hotel suppliers system	GATHI
1	status	enum	Y	Enum: [Actived, Deactived] Hotel Status provided by hotel suppliers: • Actived – hotel is active for distribution • Deactived – hotel is NOT active for distribution; ARI will not flow	Actived
1	error	string	N	Error response	Key not authorized
1	errorCode	string	C	Error response	InvalidField
1	errorMessage	string	C	Error response	Invalid Message

Hotel Activation Push Distributors Response Example

Success Response (HTTP Status 200)

[\n  {\n    \"supplierId\": \"HILTON\",\n    \"hotelId\": \"GATHI\",\n    \"status\": \"Actived\"\n  }\n]\n\n

Error Response (HTTP Status 401)

{\n    \"error\": \"Key not authorised\"\n}\n\n

Error Response (HTTP Status 500)

        {\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"Invalid Message\"\n}\n\n

","_postman_id":"6367b230-f66c-486f-8ea9-b51b826286ad"},{"name":"Hotel Products Activation Push Distributors","item":[],"id":"ef5f1db8-4c80-404e-8000-b86817a380f5","description":"

The Hotel Products Activation API is a step that allows iOLX to specify which hotel product lists they plan to sell or stop-sell, along with the status of each product (Active or Inactive) for every hotel.

iOLX can use this API to:

Indicate which hotel products they intend to sell or stop-sell by providing a list of products with their statuses (Active or Inactive) for each hotel.

GET /hotel/{supplierId}/{hotelId} HTTP/1.1\nURL: {AvailabilityPeer-Endpoint}/hotel/{supplierId}/{hotelId}\nAuthorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Hotel Product Activation Push Distributors Request Schema

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

Level	Field Name	Data Type	Required	Description	Example
1	supplierId	string	Y	The code that uniquely identifies a supplier in Channel Manager's system	HILTON
1	hotelId	string	Y	The code that uniquely identifies a single hotel in hotel suppliers system	GATHI

Hotel Product Activation Push Distributors Request Example

Sample URL: \nhttps://dsgo.xxxxx.net/hotel/GOHOTEL/GOH103\n\n

Hotel Product Activation Push Distributors Response Schema

Level	Field Name	Data Type	Required	Description	Example
1	supplierId	string	Y	The code that uniquely identifies a supplier in Channel Manager's system	HILTON
1	hotelId	string	Y	The code that uniquely identifies a single hotel in hotel suppliers system	GATHI
1	status	enum	Y	Enum: [Actived, Deactived] Hotel Status provided by hotel suppliers: • Actived – hotel is active for distribution • Deactived – hotel is NOT active for distribution; ARI will not flow for deactivated hotels	Actived
1	settings	object	N	A common extension object for extra attributes like account, extra settings required by iOLX.	`{ \"key\": \"value\" }`
1	ariType	enum	Y	Enum: [Daily, LOS] Indicates which ARI PUSH model is used for this hotel: • Daily – ARI is pushed for specific dates • LOS – ARI is pushed for specific dates and length of stay	Daily
1	rateType	enum	Y	Enum: [AmountBeforeTax, AmountAfterTax, Both] Indicates which rate will be used in ARI and Reservation flow: • AmountBeforeTax – only before-tax amount is used • AmountAfterTax – only after-tax amount is used • Both – both values can be sent and received	AmountBeforeTax
1	products	array	Y	List of products (room-rate combinations)	/
2	@roomId	string	Y	Room ID in supplier's system	King
2	@rateId	string	Y	Rate ID in supplier's system	BAR
2	@status	enum	Y	Enum: [Actived, Deactived] Product status indicated by iOLX: • Actived – product is active on the distribution system • Deactived – product is NOT active; ARI will not flow	Actived
2	@roomName	string	N	Room type name Max Length: 256	King Room
2	@rateName	string	N	Rate plan name Max Length: 256	Best Available Rate
2	occupancy	object	Y	Occupancy details	/
3	@maxAdult	integer	Y	Max adult count	3
3	@maxChild	integer	Y	Max child count	2
3	@maxOccupancy	integer	Y	Max occupancy	3
1	error	string	N	Error response	Key not authorized
1	errorCode	string	C	Error response	InvalidField
1	errorMessage	string	C	Error response	Invalid Message

Hotel Product Activation Push Distributors Response Example

Success Response (HTTP Status 200)

{\n  \"supplierId\": \"HILTON\",\n  \"hotelId\": \"GATHI\",\n  \"status\": \"Actived\",\n  \"settings\": {\n    \"additionalProp1\": \"string\",\n    \"additionalProp2\": \"string\",\n    \"additionalProp3\": \"string\"\n  },\n  \"ariType\": \"Daily\",\n  \"rateType\": \"AmountBeforeTax\",\n  \"products\": [\n    {\n      \"roomId\": \"K1\",\n      \"rateId\": \"CBAR\",\n      \"status\": \"Actived\",\n      \"roomName\": \"Double Room\",\n      \"rateName\": \"Bar Rate\",\n      \"occupancy\": {\n        \"maxAdult\": 3,\n        \"maxChild\": 2,\n        \"maxOccupancy\": 3\n      }\n    }\n  ]\n}\n\n

Error Response (HTTP Status 401)

{\n    \"error\": \"Key not authorised\"\n}\n\n

Error Response (HTTP Status 500)

        {\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"Invalid Message\"\n}\n\n

","_postman_id":"ef5f1db8-4c80-404e-8000-b86817a380f5"},{"name":"Daily Push","item":[],"id":"34cb85e7-5a85-4582-9dfb-b175415812b7","description":"

This API enables Channel Managers to send Daily ARI to iOLX for a hotel within a specified date range.

POST /ari/daily/push HTTP/1.1\nURL: {{endpoint}}/ari/daily/push\nAuthorization:Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Request Example

Occupancy Rate

{\n  \"header\": {\n    \"supplierId\": \"ABCDE\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"messageType\": \"Delta\",\n  \"hotelId\": \"ABC123\",\n  \"dateRange\": {\n    \"startDate\": \"2018-01-01\",\n    \"endDate\": \"2018-01-04\"\n  },\n  \"currency\": \"USD\",\n  \"dailyAris\": [\n    {\n      \"roomId\": \"K1\",\n      \"rateId\": \"BARB\",\n      \"mealPlans\": [\n        \"BB\",\n        \"BB\",\n        \"BB\",\n        \"BB\"\n      ],\n      \"inventories\": [\n        9,\n        0,\n        9,\n        9\n      ],\n      \"rates\": {\n        \"type\": \"OccupancyRate\",\n        \"rates\": [\n          {\n            \"adultCount\": 2,\n            \"childCount\": 1,\n            \"amountBeforeTax\": [\n              502.19,\n              502.19,\n              502.19,\n              502.19\n            ],\n            \"amountAfterTax\": [\n              623.23,\n              623.23,\n              623.23,\n              623.23\n            ]\n          }\n        ]\n      },\n      \"availStatuses\": {\n        \"close\": [\n          false,\n          false,\n          false,\n          false\n        ],\n        \"minStayArrival\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"maxStayArrival\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"minStayThrough\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"maxStayThrough\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"minAdvanceDay\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"maxAdvanceDay\": [\n          365,\n          365,\n          365,\n          365\n        ],\n        \"cta\": [\n          false,\n          false,\n          false,\n          true\n        ],\n        \"ctd\": [\n          false,\n          false,\n          false,\n          true\n        ],\n        \"fplos\": [\n          \"1111111\",\n          \"1001111\",\n          \"1000001\",\n          \"0000000\"\n        ]\n      }\n    }\n  ]\n}\n\n

Occupancy Rate from Net Rate Model

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"messageType\": \"Delta\",\n  \"hotelId\": \"GATHI\",\n  \"dateRange\": {\n    \"startDate\": \"2018-01-01\",\n    \"endDate\": \"2018-01-04\"\n  },\n  \"currency\": \"USD\",\n  \"dailyAris\": [\n    {\n      \"roomId\": \"K1\",\n      \"rateId\": \"BARB\",\n      \"mealPlans\": [\n        \"BB\",\n        \"BB\",\n        \"BB\",\n        \"BB\"\n      ],\n      \"inventories\": [\n        9,\n        0,\n        9,\n        9\n      ],\n      \"rates\": {\n        \"type\": \"OccupancyRate\",\n        \"rates\": [\n          {\n            \"adultCount\": 2,\n            \"childCount\": 1,\n            \"amountBeforeTax\": [\n              502.19,\n              502.19,\n              502.19,\n              502.19\n            ],\n            \"amountAfterTax\": [\n              623.23,\n              623.23,\n              623.23,\n              623.23\n            ]\n          }\n        ]\n      },\n      \"availStatuses\": {\n        \"close\": [\n          false,\n          false,\n          false,\n          false\n        ],\n        \"minStayArrival\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"maxStayArrival\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"minStayThrough\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"maxStayThrough\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"minAdvanceDay\": [\n          0,\n          2,\n          0,\n          0\n        ],\n        \"maxAdvanceDay\": [\n          365,\n          365,\n          365,\n          365\n        ],\n        \"cta\": [\n          false,\n          false,\n          false,\n          true\n        ],\n        \"ctd\": [\n          false,\n          false,\n          false,\n          true\n        ],\n        \"fplos\": [\n          \"1111111\",\n          \"1001111\",\n          \"1000001\",\n          \"0000000\"\n        ]\n      }\n    }\n  ]\n}\n\n

Occupancy Rate with Child Pricing based on age bands

{\n    \"header\": {\n        \"supplierId\": \"ABCDE\",\n        \"distributorId\": \"GTA\",\n        \"version\": \"v4\",\n        \"token\": \"18393849028490234\"\n    },\n    \"messageType\": \"Delta\",\n    \"hotelId\": \"ABC123\",\n    \"dateRange\": {\n        \"startDate\": \"2018-01-01\",\n        \"endDate\": \"2018-01-04\"\n    },\n    \"currency\": \"USD\",\n    \"dailyAris\": [\n        {\n            \"roomId\": \"K1\",\n            \"rateId\": \"BARB\",\n            \"mealPlans\": [\n                \"BB\",\n                \"BB\",\n                \"BB\",\n                \"BB\"\n            ],\n            \"inventories\": [\n                9,\n                0,\n                9,\n                9\n            ],\n            \"rates\": {\n                \"extraChildRates\": [\n                    {\n                        \"amountAfterTax\": [\n                            50.00,\n                            50.00,\n                            50.00,\n                            50.00\n                        ],\n                        \"amountBeforeTax\": [\n                            40.00,\n                            40.00,\n                            40.00,\n                            40.00\n                        ],\n                        \"maxAge\": 2,\n                        \"minAge\": 0\n                    },\n                    {\n                        \"amountAfterTax\": [\n                            60.00,\n                            60.00,\n                            60.00,\n                            60.00\n                        ],\n                        \"amountBeforeTax\": [\n                            50.00,\n                            50.00,\n                            50.00,\n                            50.00\n                        ],\n                        \"maxAge\": 8,\n                        \"minAge\": 3\n                    },\n                    {\n                        \"amountAfterTax\": [\n                            70.00,\n                            70.00,\n                            70.00,\n                            70.00\n                        ],\n                        \"amountBeforeTax\": [\n                            60.00,\n                            60.00,\n                            60.00,\n                            60.00\n                        ],\n                        \"maxAge\": 17,\n                        \"minAge\": 9\n                    }\n                ],\n                \"type\": \"OccupancyRate\",\n                \"rates\": [\n                    {\n                        \"adultCount\": 1,\n                        \"amountBeforeTax\": [\n                            502.19,\n                            502.19,\n                            502.19,\n                            502.19\n                        ],\n                        \"amountAfterTax\": [\n                            623.23,\n                            623.23,\n                            623.23,\n                            623.23\n                        ]\n                    },\n                    {\n                        \"adultCount\": 2,\n                        \"amountBeforeTax\": [\n                            520.19,\n                            520.19,\n                            520.19,\n                            520.19\n                        ],\n                        \"amountAfterTax\": [\n                            641.23,\n                            641.23,\n                            641.23,\n                            641.23\n                        ]\n                    }\n                ]\n            },\n            \"availStatuses\": {\n                \"close\": [\n                    false,\n                    false,\n                    false,\n                    false\n                ],\n                \"minStayArrival\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"maxStayArrival\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"minStayThrough\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"maxStayThrough\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"minAdvanceDay\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"maxAdvanceDay\": [\n                    365,\n                    365,\n                    365,\n                    365\n                ],\n                \"cta\": [\n                    false,\n                    false,\n                    false,\n                    true\n                ],\n                \"ctd\": [\n                    false,\n                    false,\n                    false,\n                    true\n                ],\n                \"fplos\": [\n                    \"1111111\",\n                    \"1001111\",\n                    \"1000001\",\n                    \"0000000\"\n                ]\n            }\n        }\n    ]\n}\n\n

All possible occupancy combinations

Notes: It supports completing possible occupancy combinations up to the maximum occupancy supported by each hotel in cases children will be free of charge by hotel suppliers. Example as follow: Max occupancy = 4, max adult = 3, max children = 2, child pricing = 0. But suppliers don't provide occupancy rate for adult plus child combinations. It supports to complele it for 3A1C, 3A0C, 2A2C, 2A1C, 2A0C, 1A1C and 1A0C.*** The feature increases the ARI, pushing traffic volume and is turned off as a default setting. If you wish to enable it, please reach out to your iOLX help for more details.\n\n

{\n    \"header\": {\n        \"supplierId\": \"ABCDE\",\n        \"distributorId\": \"GTA\",\n        \"version\": \"v4\",\n        \"token\": \"18393849028490234\"\n    },\n    \"messageType\": \"Delta\",\n    \"hotelId\": \"ABC123\",\n    \"dateRange\": {\n        \"startDate\": \"2018-01-01\",\n        \"endDate\": \"2018-01-04\"\n    },\n    \"currency\": \"USD\",\n    \"dailyAris\": [\n        {\n            \"roomId\": \"K1\",\n            \"rateId\": \"BARB\",\n            \"mealPlans\": [\n                \"BB\",\n                \"BB\",\n                \"BB\",\n                \"BB\"\n            ],\n            \"inventories\": [\n                9,\n                0,\n                9,\n                9\n            ],\n            \"rates\": {\n                \"type\": \"OccupancyRate\",\n                \"rates\": [\n                    {\n                        \"adultCount\": 1,\n                        \"childCount\": 0,\n                        \"amountBeforeTax\": [\n                            502.19,\n                            502.19,\n                            502.19,\n                            502.19\n                        ],\n                        \"amountAfterTax\": [\n                            523.23,\n                            523.23,\n                            523.23,\n                            523.23\n                        ]\n                    },\n                    {\n                        \"adultCount\": 1,\n                        \"childCount\": 1,\n                        \"amountBeforeTax\": [\n                            502.19,\n                            502.19,\n                            502.19,\n                            502.19\n                        ],\n                        \"amountAfterTax\": [\n                            523.23,\n                            523.23,\n                            523.23,\n                            523.23\n                        ]\n                    },\n                    {\n                        \"adultCount\": 2,\n                        \"childCount\": 0,\n                        \"amountBeforeTax\": [\n                            502.19,\n                            502.19,\n                            502.19,\n                            502.19\n                        ],\n                        \"amountAfterTax\": [\n                            523.23,\n                            523.23,\n                            523.23,\n                            523.23\n                        ]\n                    },\n                    {\n                        \"adultCount\": 2,\n                        \"childCount\": 1,\n                        \"amountBeforeTax\": [\n                            502.19,\n                            502.19,\n                            502.19,\n                            502.19\n                        ],\n                        \"amountAfterTax\": [\n                            523.23,\n                            523.23,\n                            523.23,\n                            523.23\n                        ]\n                    },\n                    {\n                        \"adultCount\": 2,\n                        \"childCount\": 2,\n                        \"amountBeforeTax\": [\n                            502.19,\n                            502.19,\n                            502.19,\n                            502.19\n                        ],\n                        \"amountAfterTax\": [\n                            523.23,\n                            523.23,\n                            523.23,\n                            523.23\n                        ]\n                    },\n                    {\n                        \"adultCount\": 3,\n                        \"childCount\": 0,\n                        \"amountBeforeTax\": [\n                            502.19,\n                            502.19,\n                            502.19,\n                            502.19\n                        ],\n                        \"amountAfterTax\": [\n                            523.23,\n                            523.23,\n                            523.23,\n                            523.23\n                        ]\n                    },\n                    {\n                        \"adultCount\": 3,\n                        \"childCount\": 1,\n                        \"amountBeforeTax\": [\n                            502.19,\n                            502.19,\n                            502.19,\n                            502.19\n                        ],\n                        \"amountAfterTax\": [\n                            523.23,\n                            523.23,\n                            523.23,\n                            523.23\n                        ]\n                    }\n                ]\n            },\n            \"availStatuses\": {\n                \"close\": [\n                    false,\n                    false,\n                    false,\n                    false\n                ],\n                \"minStayArrival\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"maxStayArrival\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"minStayThrough\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"maxStayThrough\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"minAdvanceDay\": [\n                    0,\n                    2,\n                    0,\n                    0\n                ],\n                \"maxAdvanceDay\": [\n                    365,\n                    365,\n                    365,\n                    365\n                ],\n                \"cta\": [\n                    false,\n                    false,\n                    false,\n                    true\n                ],\n                \"ctd\": [\n                    false,\n                    false,\n                    false,\n                    true\n                ],\n                \"fplos\": [\n                    \"1111111\",\n                    \"1001111\",\n                    \"1000001\",\n                    \"0000000\"\n                ]\n            }\n        }\n    ]\n}\n\n

Request Specification

Attribute	Type	Required	Description	Example
header	object	Yes	/	/
@supplierId	string	Yes	MaxLength: 32 The ID of hotel suppliers in Channel Manager's system.	ABCDE
@distributorId	string	Yes	MaxLength: 32 The ID of iOLX in Channel Manager's system	GTA
@version	string	Yes	MaxLength: 20 Version of API	v4
@token	string	Yes	MaxLength: 64 A unique ID to identify request and response, normally it should be UUID.	18393849028490234
messageType	enum	No	Enum: [ Delta, Overlay ] Omit the attributor means the Message Type is Overlay.	Delta
hotelId	string	Yes	ID of the hotel in the supplier's system	GATHI
dateRange	object	Yes	/	/
@startDate	string	Yes	Start date of date range, format with yyyy-MM-dd	2018-01-01
@endDate	string	Yes	End date of date range, format with yyyy-MM-dd	2018-01-04
currency	string	Yes	Currency code [ISO-4217]	USD
dailyAris	array	Yes	Daily rate and inventory within a date range	/
@roomId	string	Yes	Room ID in supplier's system	10000101
@rateId	string	Yes	Rate ID in supplier's system	123456
@mealPlans	array[string]	No	Meal plan for each date	[ \"BB\", \"BB\", \"BB\", \"BB\" ]
@inventories	array[integer]	Yes	Room inventory for each date	[ 9, 0, 9, 9 ]
dailyAris/rates	/	Yes	/	/
@type	enum	Yes	Enum: [ OccupancyRate, CommonRate ] Indicates which rate model to be used: OccupancyRate or CommonRate.	/
rates/rates	array[object]	Yes	This node will not display if it’s the Common Rate Model.	/
@adultCount	integer	No	The attribute will not display if it’s the Common Rate Model.	/
@childCount	integer	No	The attribute will not display if it’s the Common Rate Model.	/
@amountBeforeTax	array[number]	No	/	[ 502.19, 502.19, 502.19, 502.19 ]
@amountAfterTax	array[number]	Yes	/	[ 623.23, 623.23, 623.23, 623.23 ]
dailyAris/availStatuses	/	/	/	/
@close	array[boolean]	Yes	Closed or not for each date	[false, false, false, false]
@minStayArrival	array[integer]	No	Minimum length of stay based on check-in for each date, zero means no restriction.	[ 0, 2, 0, 0 ]
@maxStayArrival	array[integer]	No	Maximum length of stay based on check-in for each date, zero means no restriction.	[ 0, 2, 0, 0 ]
@minStayThrough	array[integer]	No	Minimum length of stay based on a date through for each date, zero means no restriction.	[ 0, 2, 0, 0 ]
@maxStayThrough	array[integer]	No	Maximum length of stay is based on a date for each date; zero means no restriction.	[ 0, 2, 0, 0 ]
@minAdvanceDay	array[integer]	No	Minimum days to book in advance for each date, zero means no restriction.	[ 0, 2, 0, 0 ]
@maxAdvanceDay	array[integer]	No	Maximum days to book in advance for each date, zero means no restriction.	[ 365, 365, 365, 365 ]
@cta	array[boolean]	No	Closed to arrival for each date	[ false, false, false, true ]
@ctd	array[boolean]	No	Closed to departure for each date	[ false, false, false, true ]
@fplos	array[string]	No	Full pattern length of stay to indicate if the stay is available.	[ \"1111111\", \"1001111\", \"1000001\", \"0000000\" ]

Note: Amount after Tax is mandatory as iOLX collects rates inclusive of taxes. Amount before tax is optional, and if not possible to provide either, do not pass this tag or send it with the same value as AmountAfterTax.

Response Example

Success Response (HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"ABCDE\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"hotelId\": \"ABC123\",\n  \"updateDateRange\": {\n    \"startDate\": \"2018-01-01\",\n    \"endDate\": \"2018-01-04\"\n  }\n}\n\n

Error Response (HTTP Status 403)

{\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"  Unauthorized token\"\n}\n\n

Error Response (HTTP Status 500)

{\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"Invalid Message\"\n}\n\n

Response 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\n\n\n\n\n\n\n

Attribute	Type	Required	Description	Example
Attribute	Type	Required	Description	Example
header	object	Yes	/	/
@supplierId	string	Yes	MaxLength: 32 The ID of the hotel supplier in Channel Manager's system	ABCDE
@distributorId	string	Yes	MaxLength: 32 The ID of the iOLX in Channel Manager's system	GTA
@version	string	Yes	MaxLength: 20 Version of API	v4
@token	string	Yes	MaxLength: 64 A unique ID to identify request and response, normally it should be UUID.	18393849028490234
hotelId	string	Yes	The ID of a hotel in the supplier's system	ABC123
updateDateRange	object	Yes	/	/
@startDate	string	Yes	start date of date range, format with yyyy-MM-dd	2018-01-01
@endDate	string	Yes	end date of date range, format with yyyy-MM-dd	2018-01-04

","_postman_id":"34cb85e7-5a85-4582-9dfb-b175415812b7"},{"name":"LOS Push","item":[],"id":"6b07a71f-eb31-4dbb-9ff3-adea18b9b359","description":"

This API enables Channel Managers to send LOS ARI to IOL for a hotel within a specified date range.

POST /ari/los/push HTTP/1.1\nURL: {{endpoint}}/ari/los/push\nAuthorization:Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Request Example

Occupancy Rate

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"messageType\": \"Delta\",\n  \"hotelId\": \"GATHI\",\n  \"dateRange\": {\n    \"startDate\": \"2018-01-01\",\n    \"endDate\": \"2018-01-04\"\n  },\n  \"currency\": \"USD\",\n  \"losAris\": [\n    {\n      \"roomId\": \"K1\",\n      \"rateId\": \"BARB\",\n      \"los\": 1,\n      \"mealPlans\": [\n        \"BB\",\n        \"BB\",\n        \"RO\",\n        \"BB\"\n      ],\n      \"inventories\": [\n        9,\n        0,\n        9,\n        9\n      ],\n      \"rates\": {\n        \"type\": \"OccupancyRate\",\n        \"rates\": [\n          {\n            \"adultCount\": 2,\n            \"childCount\": 1,\n            \"amountBeforeTax\": [\n              502.19,\n              502.19,\n              502.19,\n              502.19\n            ],\n            \"amountAfterTax\": [\n              623.23,\n              623.23,\n              623.23,\n              623.23\n            ]\n          }\n        ]\n      }\n    }\n  ]\n}\n\n

Occupancy Rate from Net Rate Model

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"messageType\": \"Delta\",\n  \"hotelId\": \"GATHI\",\n  \"dateRange\": {\n    \"startDate\": \"2018-01-01\",\n    \"endDate\": \"2018-01-04\"\n  },\n  \"currency\": \"USD\",\n  \"losAris\": [\n    {\n      \"roomId\": \"K1\",\n      \"rateId\": \"BARB\",\n      \"los\": 1,\n      \"mealPlans\": [\n        \"BB\",\n        \"BB\",\n        \"RO\",\n        \"BB\"\n      ],\n      \"inventories\": [\n        9,\n        0,\n        9,\n        9\n      ],\n      \"rates\": {\n        \"type\": \"OccupancyRate\",\n        \"rates\": [\n          {\n            \"adultCount\": 2,\n            \"childCount\": 1,\n            \"amountBeforeTax\": [\n              502.19,\n              502.19,\n              502.19,\n              502.19\n            ],\n            \"amountAfterTax\": [\n              623.23,\n              623.23,\n              623.23,\n              623.23\n            ],\n          }\n        ]\n      }\n    }\n  ]\n}\n\n

Occupancy Rate with Child Pricing based on age bands

{\n    \"header\": {\n        \"supplierId\": \"HILTON\",\n        \"distributorId\": \"GTA\",\n        \"version\": \"v4\",\n        \"token\": \"18393849028490234\"\n    },\n    \"messageType\": \"Delta\",\n    \"hotelId\": \"GATHI\",\n    \"dateRange\": {\n        \"startDate\": \"2018-01-01\",\n        \"endDate\": \"2018-01-04\"\n    },\n    \"currency\": \"USD\",\n    \"losAris\": [\n        {\n            \"roomId\": \"K1\",\n            \"rateId\": \"BARB\",\n            \"los\": 1,\n            \"mealPlans\": [\n                \"BB\",\n                \"BB\",\n                \"RO\",\n                \"BB\"\n            ],\n            \"inventories\": [\n                9,\n                0,\n                9,\n                9\n            ],\n            \"rates\": {\n                \"extraChildRates\": [\n                    {\n                        \"minAge\": 0,\n                        \"maxAge\": 2,\n                        \"amountAfterTax\": [\n                            50.00,\n                            50.00,\n                            50.00,\n                            50.00\n                        ],\n                        \"amountBeforeTax\": [\n                            40.00,\n                            40.00,\n                            40.00,\n                            40.00\n                        ]\n                    },\n                    {\n                        \"minAge\": 3,\n                        \"maxAge\": 8,\n                        \"amountAfterTax\": [\n                            60.00,\n                            60.00,\n                            60.00,\n                            60.00\n                        ],\n                        \"amountBeforeTax\": [\n                            50.00,\n                            50.00,\n                            50.00,\n                            50.00\n                        ]\n                    },\n                    {\n                        \"minAge\": 9,\n                        \"maxAge\": 17,\n                        \"amountAfterTax\": [\n                            70.00,\n                            70.00,\n                            70.00,\n                            70.00\n                        ],\n                        \"amountBeforeTax\": [\n                            60.00,\n                            60.00,\n                            60.00,\n                            60.00\n                        ]\n                    }\n                ],\n                \"type\": \"OccupancyRate\",\n                \"rates\": [\n                    {\n                        \"adultCount\": 2,\n                        \"amountBeforeTax\": [\n                            200.00,\n                            200.00,\n                            200.00,\n                            200.00\n                        ],\n                        \"amountAfterTax\": [\n                            220.00,\n                            220.00,\n                            220.00,\n                            220.00\n                        ]\n                    },\n                    {\n                        \"adultCount\": 1,\n                        \"amountBeforeTax\": [\n                            160.00,\n                            160.00,\n                            160.00,\n                            160.00\n                        ],\n                        \"amountAfterTax\": [\n                            192.00,\n                            192.00,\n                            192.00,\n                            192.00\n                        ]\n                    }\n                ]\n            }\n        },\n        {\n            \"roomId\": \"K1\",\n            \"rateId\": \"BARB\",\n            \"los\": 2,\n            \"mealPlans\": [\n                \"BB\",\n                \"BB\",\n                \"RO\",\n                \"BB\"\n            ],\n            \"inventories\": [\n                9,\n                0,\n                9,\n                9\n            ],\n            \"rates\": {\n                \"extraChildRates\": [\n                    {\n                        \"minAge\": 0,\n                        \"maxAge\": 2,\n                        \"amountAfterTax\": [\n                            100.00,\n                            100.00,\n                            100.00,\n                            100.00\n                        ],\n                        \"amountBeforeTax\": [\n                            80.00,\n                            80.00,\n                            80.00,\n                            80.00\n                        ]\n                    },\n                    {\n                        \"minAge\": 3,\n                        \"maxAge\": 8,\n                        \"amountAfterTax\": [\n                            120.00,\n                            120.00,\n                            120.00,\n                            120.00\n                        ],\n                        \"amountBeforeTax\": [\n                            100.00,\n                            100.00,\n                            100.00,\n                            100.00\n                        ]\n                    },\n                    {\n                        \"minAge\": 9,\n                        \"maxAge\": 17,\n                        \"amountAfterTax\": [\n                            140.00,\n                            140.00,\n                            140.00,\n                            140.00\n                        ],\n                        \"amountBeforeTax\": [\n                            120.00,\n                            120.00,\n                            120.00,\n                            120.00\n                        ]\n                    }\n                ],\n                \"type\": \"OccupancyRate\",\n                \"rates\": [\n                    {\n                        \"adultCount\": 2,\n                        \"amountBeforeTax\": [\n                            400.00,\n                            400.00,\n                            400.00,\n                            400.00\n                        ],\n                        \"amountAfterTax\": [\n                            440.00,\n                            440.00,\n                            440.00,\n                            440.00\n                        ]\n                    },\n                    {\n                        \"adultCount\": 1,\n                        \"amountBeforeTax\": [\n                            320.00,\n                            320.00,\n                            320.00,\n                            320.00\n                        ],\n                        \"amountAfterTax\": [\n                            384.00,\n                            384.00,\n                            384.00,\n                            384.00\n                        ]\n                    }\n                ]\n            }\n        }\n    ]\n}\n\n

All possible occupancy combinations

Notes: It supports completing possible occupancy combinations up to the maximum occupancy supported by each hotel in cases children will be free of charge by hotel suppliers. Example as follow: Max occupancy = 4, max adult = 3, max children = 2, child pricing = 0. But suppliers don't provide occupancy rate for adult plus child combinations. It supports to complele it for 3A1C, 3A0C, 2A2C, 2A1C, 2A0C, 1A1C and 1A0C.*** The feature increases the ARI pushing traffic volume and is turned off as a default setting. If you wish to enable it, please reach out to iOLX help for more details.\n\n

{\n    \"header\": {\n        \"supplierId\": \"HILTON\",\n        \"distributorId\": \"GTA\",\n        \"version\": \"v4\",\n        \"token\": \"18393849028490234\"\n    },\n    \"messageType\": \"Delta\",\n    \"hotelId\": \"GATHI\",\n    \"dateRange\": {\n        \"startDate\": \"2018-01-01\",\n        \"endDate\": \"2018-01-07\"\n    },\n    \"currency\": \"USD\",\n    \"losAris\": [\n        {\n            \"roomId\": \"NCAA\",\n            \"rateId\": \"LHGKX\",\n            \"los\": 1,\n            \"mealPlans\": [\n                \"BB\",\n                \"BB\",\n                \"BB\",\n                \"BB\",\n                \"BB\",\n                \"BB\",\n                \"BB\"\n            ],\n            \"inventories\": [\n                0,\n                0,\n                0,\n                0,\n                1,\n                1,\n                1\n            ],\n            \"rates\": {\n                \"rates\": [\n                    {\n                        \"adultCount\": 1,\n                        \"childCount\": 0,\n                        \"amountBeforeTax\": [\n                            183.01,\n                            141,\n                            166,\n                            176,\n                            176,\n                            158,\n                            182\n                        ]\n                    },\n                    {\n                        \"adultCount\": 1,\n                        \"childCount\": 1,\n                        \"amountBeforeTax\": [\n                            183.01,\n                            141,\n                            166,\n                            176,\n                            176,\n                            158,\n                            182\n                        ]\n                    },\n                    {\n                        \"adultCount\": 2,\n                        \"childCount\": 0,\n                        \"amountBeforeTax\": [\n                            183.01,\n                            141,\n                            166,\n                            176,\n                            176,\n                            158,\n                            182\n                        ]\n                    },\n                    {\n                        \"adultCount\": 2,\n                        \"childCount\": 1,\n                        \"amountBeforeTax\": [\n                            183.01,\n                            141,\n                            166,\n                            176,\n                            176,\n                            158,\n                            182\n                        ]\n                    },\n                    {\n                        \"adultCount\": 2,\n                        \"childCount\": 2,\n                        \"amountBeforeTax\": [\n                            183.01,\n                            141,\n                            166,\n                            176,\n                            176,\n                            158,\n                            182\n                        ]\n                    },\n                    {\n                        \"adultCount\": 3,\n                        \"childCount\": 0,\n                        \"amountBeforeTax\": [\n                            191.85,\n                            149.87,\n                            175.07,\n                            184.84,\n                            184.84,\n                            166.83,\n                            190.84\n                        ]\n                    },\n                    {\n                        \"adultCount\": 3,\n                        \"childCount\": 1,\n                        \"amountBeforeTax\": [\n                            191.85,\n                            149.87,\n                            175.07,\n                            184.84,\n                            184.84,\n                            166.83,\n                            190.84\n                        ]\n                    }\n                ],\n                \"type\": \"OccupancyRate\"\n            }\n        }\n    ]\n}\n\n

Request Specification

Attribute	Type	Required	Description	Example
header	object	Yes	/	/
@supplierId	string	Yes	max length: 32 The ID of hotel suppliers in Channel Manager's system	HILTON
@distributorId	string	Yes	max length: 32 ID of iOLX in Channel Manager's system	GTA
@version	string	Yes	max length: 20 Version of API	v4
@token	string	Yes	max length: 64 A unique ID to identify requests and response, normally it should be UUID.	18393849028490234
messageType	enum	No	Enum: [ Delta, Overlay ] Omit the attributor means the Message Type is Overlay.	Delta
hotelId	string	Yes	The ID of a hotel in the supplier's system	GATHI
dateRange	object	Yes	/	/
@startDate	string	Yes	Start date of date range, format with yyyy-MM-dd	2018-01-01
@endDate	string	Yes	End date of date range, format with yyyy-MM-dd	2018-01-04
currency	string	Yes	Currency code[ISO-4217]	USD
losAris	array	Yes	Length of stay rate and inventory within a date range. If no available rates, it means the hotel was closed. If the available rates are only for certain room types, it means other room types are closed.	/
@roomId	string	Yes	Room ID in supplier's system	10000101
@rateId	string	Yes	Rate ID in supplier's system	123456
@los	integer	Yes	Length of stay	1
@mealPlans	array[string]	No	Meal plan for each date	[ \"BB\", \"BB\", \"BB\", \"BB\" ]
@inventories	array[integer]	Yes	Room inventory for each date	[ 9, 0, 9, 9 ]
losAris/rates	/	Yes	/	/
@type	enum	Yes	Enum: [ OccupancyRate, CommonRate ] Indicates which rate model to be used: OccupancyRate or CommonRate.	/
rates/rates	array[object]	Yes	This node will not display if it’s the Common Rate Model.	/
@adultCount	integer	No	This node will not display if it’s the Common Rate Model.	/
@childCount	integer	No	The node will not display if it’s the Common Rate Model.	/
@amountBeforeTax	array[number]	No	/	[ 502.19, 502.19, 502.19, 502.19 ]
@amountAfterTax	array[number]	Yes	/	[ 623.23, 623.23, 623.23, 623.23 ]
rates/extraChildRates	object	No	Extra child rate is only used with occupancy rate, max child age must be provided for available hotel product.	/
@minAge	integer	Yes	Minimum child age is greater than or equal to zero.	0
@maxAge	integer	Yes	Maximum child age is less than or equal to maxChildAge.	2
@amountBeforeTax	array[number]	No	/	[ 40, 40 ]
@amountAfterTax	array[number]	No	/	[ 40, 40 ]


extensions	object	No	A common extension object for extra attributes like account, extra setting required by a distributor, etc.	/

Response Example

Success Response (HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"hotelId\": \"GATHI\",\n  \"updateDateRange\": {\n    \"startDate\": \"2018-01-01\",\n    \"endDate\": \"2018-01-04\"\n  }\n}\n\n

Error Response (HTTP Status 403)

{\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"  Unauthorized token\"\n}\n\n

Error Response (HTTP Status 500)

{\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"Invalid Message\"\n}\n\n

Response 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\n\n\n\n\n\n\n

Attribute	Type	Required	Description	Example
Attribute	Type	Required	Description	Example
header	object	Yes	/	/
@supplierId	string	Yes	MaxLength: 32 The ID of the hotel supplier in Channel Manager's system	HILTON
@distributorId	string	Yes	MaxLength: 32 The ID of iOLX in Channel Manager's system	GTA
@version	string	Yes	MaxLength: 20 Version of API	v4
@token	string	Yes	MaxLength: 64 A unique ID to identify request and response, normally it should be UUID.	18393849028490234
hotelId	string	Yes	ID of a hotel in supplier's system	GATHI
updateDateRange	object	Yes	/	/
@startDate	string	Yes	Start date of date range, format with yyyy-MM-dd	2018-01-01
@endDate	string	Yes	End date of date range, format with yyyy-MM-dd	2018-01-04

","_postman_id":"6b07a71f-eb31-4dbb-9ff3-adea18b9b359"},{"name":"Live Check","item":[],"id":"152a2672-93c3-4ff6-a12f-e13ba53df571","description":"

Live Check API

The Live Check API allows iOLX to query real-time availability from hotel suppliers or the Channel Manager cache, ensuring they receive up-to-date information on all available rooms and rates. This functionality is essential for ensuring that the data presented to customers reflects the current status of hotel inventory. If a hotel supplier does not support the live check function, the check will be done in the Channel Manager cache to provide availability data. Additionally, the Live Check API supports a maximum stay of up to 61 days, depending on the supplier’s capabilities. This flexibility enables iOLX to check long-term availability and offer extended stay options to its customers, provided the supplier supports this duration.

The implementation of this API is a mandatory step in the booking flow, ensuring accurate and timely availability information before proceeding with further reservation actions.

POST /availability HTTP/1.1\nURL: {BookingUSB-Endpoint}/availability\nAuthorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Live Check Request Schema

Level	Field Name	Data Type	Required	Description	Example
1	header	object	Y	/	/
2	@supplierId	string	Y	The ID of the hotel supplier in Channel Manager's system. MaxLength: 32	HILTON
2	@distributorId	string	Y	The ID of iOLX in Channel Manager's system. MaxLength: 32	GTA
2	@version	string	Y	Version of API. MaxLength: 20	v4
2	@token	string	Y	A unique identifier for each request and response, typically a UUID. Note that this is an echo token, not an access token. MaxLength: 64	18393849028490234
1	hotelId	string	Y	Hotel IDs contain digits (0-9), uppercase letters (A-Z), hyphen '-'	100001, GATHI, 00016, PEP-B3T2, B8W7
1	stayRange	object	Y	/	/
2	@checkin	string	Y	Check in date expressed YYYY-MM-DD	2028-01-01
2	@checkout	string	Y	Check out date expressed YYYY-MM-DD	2028-01-04
1	roomCriteria	object	Y	/	/

2	@adultCount	integer	Y	Adult count per room	1
2	@childCount	integer	N	Child count per room	2
2	@childAges	array	N	Child ages for each child, array size MUST match child count	[4, 8]
1	productCandidate	object	N	/	/
2	@roomId	string	N	Room ID in supplier's system	K1D
2	@rateId	string	N	Rate ID in supplier's system	ODAD01
1	iata	string	N	IATA of iOLX	/

Live Check Request Example

Live Check Request Example

{\n    \"header\": {\n      \"supplierId\": \"HILTON\",\n      \"distributorId\": \"GTA\",\n      \"version\": \"v4\",\n      \"token\": \"18393849028490234\"\n    },\n    \"hotelId\": \"GATHI\",\n    \"stayRange\": {\n      \"checkin\": \"2028-01-01\",\n      \"checkout\": \"2028-01-04\"\n    },\n    \"roomCriteria\": {\n      \"adultCount\": 1,\n      \"childCount\": 2,\n      \"childAges\": [\n        4,\n        8\n      ]\n    },\n    \"productCandidate\": {\n      \"roomId\": \"K1D\",\n      \"rateId\": \"ODAD01\"\n    },\n    \"iata\": \"string\"\n  }\n\n

Live Check Response Schema

Level	Field Name	Data Type	Required	Description	Example
1	header	object	Y	/	/
2	@supplierId	string	Y	The ID of the hotel supplier in Channel Manager's system. MaxLength: 32	HILTON
2	@distributorId	string	Y	The ID of iOLX in Channel Manager's system. MaxLength: 32	GTA
2	@version	string	Y	Version of API. MaxLength: 20	v4
2	@token	string	Y	A unique identifier for each request/response. Echo token, not access token. MaxLength: 64	18393849028490234
1	hotelId	string	Y	Hotel IDs contain digits (0-9), uppercase letters (A-Z), hyphen '-'	100001, GATHI, 00016, PEP-B3T2, B8W7
1	stayRange	object	Y	/	/
2	@checkin	string	Y	Check in date expressed YYYY-MM-DD	2028-01-01
2	@checkout	string	Y	Check out date expressed YYYY-MM-DD	2028-01-04
1	roomCriteria	object	Y	/	/
2	@roomCount	integer	Y	Total room count per request	2
2	@adultCount	integer	Y	Adult count per room	1
2	@childCount	integer	N	Child count per room	2
2	@childAges	array	N	Child ages for each child, array size MUST match child count	[4,8]
1	productCandidate	object	N	/	/
2	@roomId	string	N	Room ID in supplier system	K1D
2	@rateId	string	N	Rate ID in supplier system	ODAD01
1	iata	string	N	IATA of distributor	/
1	roomRates	object	Y	Meal plan, fee, cancellation optional	/
2	@inventory	integer	Y	Available inventory count according to request criteria	1
2	@isAfterPromotion	boolean	N	TRUE = check availability with promotion, FALSE = basic live-check	false
2	@promoteCode	string	N	Promotion code applied (required if isAfterPromotion=true)	discount001
2	@roomId	string	Y	Room ID in supplier system	10000101
2	@roomName	string	N	Max length 256	King Room
2	@roomDescription	string	N	/	Soak in city views...
2	@rateId	string	Y	Rate ID in supplier system	BAR
2	@rateName	string	N	Max length 256	Best Available Rate
2	@rateDescription	string	N	/	Begin your day with a hearty meal
2	commission	object	N	Indicates if rate is commissionable	/
3	@value	number	C	Commission value	10
3	@type	enum	C	Enum: [Percent, Amount]	Percent
2	@currency	string	Y	Currency code [ISO-4217]	USD
2	@amountBeforeTax	array[number]	N	Daily rate excluding taxes	[100,100,120]
2	@amountAfterTax	array[number]	N	Daily rate including taxes	[110,110,130]
3	@amountBeforeTax	number	N	/	600
3	@amountAfterTax	number	Y	/	700
2	@mealPlan	string	N	Meal plan code	RO
2	@paymentType	enum	N	Enum: [PayLater, PayNow]	PayNow
2	guarantee	object	N	Guarantee info for this rate	/
3	@guaranteeType	string	C	Guarantee method type	CCG
2	fees	array[object]	N	Fee or tax by date range	/
3	dateRange	object	Y	/	/
4	@startDate	string	Y	Start date YYYY-MM-DD	2028-01-01
4	@endDate	string	Y	End date YYYY-MM-DD	2028-01-04
3	fee	object	Y	/	/
4	@name	string	Y	Pattern: starts with word character	Service Charge
4	@type	enum	Y	Enum: [Inclusive, Exclusive]	Exclusive
4	@amount	number	Y	Amount of fee	10
4	@amountType	string	Y	Enum: [Fix, Percent]	Percent
4	@chargeType	string	Y	Enum: [PerRoomPerNight, PerPersonPerNight, ...]	PerRoomPerNight
4	@paymentType	enum	N	Enum: [PayLater, PayNow]	PayNow
4	@collectBy	enum	N	Enum: [Distributor, Property]	Distributor
4	@effectivePerson	number	N	Fee charged starting from which occupancy	3
2	cancelPolicy	object	N	Cancellation policy	/
3	@code	string	C	Cancel policy code, max 128	AD100P_100P
3	@description	string	N	Cancel policy description, max 1024	Non Refundable
3	cancelPenalties	array[object]	C	Details about cancel penalty	/
4	@noShow	boolean	C	True if penalty applies for No-Show	/
4	@cancellable	boolean	N	True if cancellation allowed	/
4	cancelDeadline	/	N	/	/
5	@offsetTimeDropType	enum	N	Enum: [BeforeArrival]	/
5	@offsetTimeUnit	enum	N	Enum: [D,H]	/
5	@offsetTimeValue	number	N	Number of offset units	/
5	@deadline	string	N	Local deadline time	/
4	penaltyCharge	/	/	/	/
5	@chargeBase	enum	N	Enum: [FullStay,NightBase]	/
5	@nights	number	N	Nights if based on NightBase	/
5	@amount	number	N	Flat penalty charge	/
5	@percent	number	N	Percent penalty	/
1	extensions	object	N	Optional additional attributes	/
1	error	string	N	Error response	Key not authorized
1	errorCode	string	C	Error code	InvalidField
1	supplierErrorCode	string	C	Supplier error code	InvalidField
1	errorMessage	string	C	Error message	Invalid Message

Live Check Response Example

Success Response (HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"hotelId\": \"GATHI\",\n  \"stayRange\": {\n    \"checkin\": \"2028-01-01\",\n    \"checkout\": \"2028-01-04\"\n  },\n  \"roomCriteria\": {\n    \"roomCount\": 2,\n    \"adultCount\": 1,\n    \"childCount\": 2,\n    \"childAges\": [\n      4,\n      8\n    ]\n  },\n  \"productCandidate\": {\n    \"roomId\": \"K1D\",\n    \"rateId\": \"ODAD01\"\n  },\n  \"iata\": \"string\",\n  \"roomRates\": [\n    {\n      \"inventory\": 2,\n      \"isAfterPromotion\": true,\n      \"promoteCode\": \"discount001\",\n      \"roomId\": \"K1D\",\n      \"roomName\": \"Double Room\",\n      \"roomDescription\": \"Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.\",\n      \"rateId\": \"ODAD01\",\n      \"rateName\": \"Standard Rate\",\n      \"rateDescription\": \"Standard Rate Includes Breakfast\",\n      \"commission\": {\n        \"value\": 10,\n        \"type\": \"Percent\"\n      },\n      \"currency\": \"USD\",\n      \"amountBeforeTax\": [\n        100,\n        100,\n        120\n      ],\n      \"amountAfterTax\": [\n        110,\n        110,\n        130\n      ],\n      \"mealPlan\": \"RO\",\n      \"paymentType\": \"PayNow\",\n      \"guarantee\": {\n        \"guaranteeType\": \"CCG\"\n      },\n      \"fees\": [\n        {\n          \"dateRange\": {\n            \"startDate\": \"2028-01-01\",\n            \"endDate\": \"2028-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"Service Charge\",\n            \"type\": \"Exclusive\",\n            \"amount\": 10,\n            \"amountType\": \"Percent\",\n            \"chargeType\": \"PerRoomPerNight\",\n            \"paymentType\": \"PayNow\",\n            \"collectBy\": \"Distributor\",\n            \"effectivePerson\": 0\n          }\n        },\n        {\n          \"dateRange\": {\n            \"startDate\": \"2028-01-01\",\n            \"endDate\": \"2028-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"City Tax\",\n            \"type\": \"Exclusive\",\n            \"amount\": 5,\n            \"amountType\": \"Fix\",\n            \"chargeType\": \"PerPersonPerNight\",\n            \"paymentType\": \"PayLater\",\n            \"collectBy\": \"Property\",\n            \"effectivePerson\": 0\n          }\n        }\n      ],\n      \"cancelPolicy\": {\n        \"code\": \"AD100P_100P\",\n        \"description\": \"Non Refundable\",\n        \"cancelPenalties\": [\n          {\n            \"noShow\": true,\n            \"cancellable\": true,\n            \"cancelDeadline\": {\n              \"offsetTimeDropType\": \"BeforeArrival\",\n              \"offsetTimeUnit\": \"D\",\n              \"offsetTimeValue\": 0,\n              \"deadline\": \"string\"\n            },\n            \"penaltyCharge\": {\n              \"chargeBase\": \"FullStay\",\n              \"nights\": 0,\n              \"amount\": 0,\n              \"percent\": 0\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n\n

Successful Response from Retail Rate Model(HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"hotelId\": \"GATHI\",\n  \"stayRange\": {\n    \"checkin\": \"2028-01-01\",\n    \"checkout\": \"2028-01-04\"\n  },\n  \"roomCriteria\": {\n    \"roomCount\": 2,\n    \"adultCount\": 1,\n    \"childCount\": 2,\n    \"childAges\": [\n      4,\n      8\n    ]\n  },\n  \"productCandidate\": {\n    \"roomId\": \"K1D\",\n    \"rateId\": \"ODAD01\"\n  },\n  \"iata\": \"string\",\n  \"roomRates\": [\n    {\n      \"inventory\": 2,\n      \"isAfterPromotion\": true,\n      \"promoteCode\": \"discount001\",\n      \"roomId\": \"K1D\",\n      \"roomName\": \"Double Room\",\n      \"roomDescription\": \"Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.\",\n      \"rateId\": \"ODAD01\",\n      \"rateName\": \"Standard Rate\",\n      \"rateDescription\": \"Standard Rate Includes Breakfast\",\n      \"commission\": {\n        \"value\": 10,\n        \"type\": \"Percent\"\n      },\n      \"currency\": \"USD\",\n      \"amountBeforeTax\": [\n        100,\n        100,\n        120\n      ],\n      \"amountAfterTax\": [\n        110,\n        110,\n        130\n      ],\n      \"mealPlan\": \"RO\",\n      \"paymentType\": \"PayNow\",\n      \"guarantee\": {\n        \"guaranteeType\": \"CCG\"\n      },\n      \"fees\": [\n        {\n          \"dateRange\": {\n            \"startDate\": \"2028-01-01\",\n            \"endDate\": \"2028-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"Service Charge\",\n            \"type\": \"Exclusive\",\n            \"amount\": 10,\n            \"amountType\": \"Percent\",\n            \"chargeType\": \"PerRoomPerNight\",\n            \"collectBy\": \"Distributor\",\n            \"effectivePerson\": 0\n          }\n        },\n        {\n          \"dateRange\": {\n            \"startDate\": \"2028-01-01\",\n            \"endDate\": \"2028-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"City Tax\",\n            \"type\": \"Exclusive\",\n            \"amount\": 5,\n            \"amountType\": \"Fix\",\n            \"chargeType\": \"PerPersonPerNight\",\n            \"collectBy\": \"Property\",\n            \"effectivePerson\": 0\n          }\n        }\n      ],\n      \"cancelPolicy\": {\n        \"code\": \"AD100P_100P\",\n        \"description\": \"Non Refundable\",\n        \"cancelPenalties\": [\n          {\n            \"noShow\": true,\n            \"cancellable\": true,\n            \"cancelDeadline\": {\n              \"offsetTimeDropType\": \"BeforeArrival\",\n              \"offsetTimeUnit\": \"D\",\n              \"offsetTimeValue\": 0,\n              \"deadline\": \"string\"\n            },\n            \"penaltyCharge\": {\n              \"chargeBase\": \"FullStay\",\n              \"nights\": 0,\n              \"amount\": 0,\n              \"percent\": 0\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n\n

Successful Response from Net Rate Model(HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"hotelId\": \"GATHI\",\n  \"stayRange\": {\n    \"checkin\": \"2028-01-01\",\n    \"checkout\": \"2028-01-04\"\n  },\n  \"roomCriteria\": {\n    \"roomCount\": 2,\n    \"adultCount\": 1,\n    \"childCount\": 2,\n    \"childAges\": [\n      4,\n      8\n    ]\n  },\n  \"productCandidate\": {\n    \"roomId\": \"K1D\",\n    \"rateId\": \"ODAD01\"\n  },\n  \"iata\": \"string\",\n  \"roomRates\": [\n    {\n      \"inventory\": 2,\n      \"isAfterPromotion\": true,\n      \"promoteCode\": \"discount001\",\n      \"roomId\": \"K1D\",\n      \"roomName\": \"Double Room\",\n      \"roomDescription\": \"Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.\",\n      \"rateId\": \"ODAD01\",\n      \"rateName\": \"Standard Rate\",\n      \"rateDescription\": \"Standard Rate Includes Breakfast\",\n      \"currency\": \"USD\",\n      \"amountBeforeTax\": [\n        100,\n        100,\n        120\n      ],\n      \"amountAfterTax\": [\n        110,\n        110,\n        130\n      ],\n      \"mealPlan\": \"RO\",\n      \"paymentType\": \"PayNow\",\n      \"guarantee\": {\n        \"guaranteeType\": \"CCG\"\n      },\n      \"fees\": [\n        {\n          \"dateRange\": {\n            \"startDate\": \"2028-01-01\",\n            \"endDate\": \"2028-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"Service Charge\",\n            \"type\": \"Exclusive\",\n            \"amount\": 10,\n            \"amountType\": \"Percent\",\n            \"chargeType\": \"PerRoomPerNight\",\n            \"collectBy\": \"Distributor\",\n            \"effectivePerson\": 0\n          }\n        },\n        {\n          \"dateRange\": {\n            \"startDate\": \"2028-01-01\",\n            \"endDate\": \"2028-01-04\"\n          },\n          \"fee\": {\n            \"name\": \"City Tax\",\n            \"type\": \"Exclusive\",\n            \"amount\": 5,\n            \"amountType\": \"Fix\",\n            \"chargeType\": \"PerPersonPerNight\",\n            \"collectBy\": \"Property\",\n            \"effectivePerson\": 0\n          }\n        }\n      ],\n      \"cancelPolicy\": {\n        \"code\": \"AD100P_100P\",\n        \"description\": \"Non Refundable\",\n        \"cancelPenalties\": [\n          {\n            \"noShow\": true,\n            \"cancellable\": true,\n            \"cancelDeadline\": {\n              \"offsetTimeDropType\": \"BeforeArrival\",\n              \"offsetTimeUnit\": \"D\",\n              \"offsetTimeValue\": 0,\n              \"deadline\": \"string\"\n            },\n            \"penaltyCharge\": {\n              \"chargeBase\": \"FullStay\",\n              \"nights\": 0,\n              \"amount\": 0,\n              \"percent\": 0\n            }\n          }\n        ]\n      }\n    }\n  ]\n}\n\n

Error Response(HTTP Status 403)

{\n  \"error\": \"Key not authorized\"\n}\n\n

Error Response (HTTP Status 500)

        {\n  \"errorCode\": \"string\",\n  \"supplierErrorCode\": \"string\",\n  \"errorMessage\": \"string\"\n}\n\n

","_postman_id":"152a2672-93c3-4ff6-a12f-e13ba53df571"},{"name":"Pre Book","item":[],"id":"7fea1f5f-9f4e-41fa-860f-dd230bda127a","description":"

PreBook API

The Prebook API allows iOLX to perform a final check on the availability and rates of a selected product before proceeding with a booking. This step ensures that the room and rate are still available and accurate at the time of booking, reducing the risk of discrepancies or overbooking. If the hotel supplier supports it, the Prebook API can handle reservations with a maximum stay length of up to 61 days. By executing this final check, iOLX can confidently proceed with the booking process, knowing that the selected room and rate remain available. This API is essential for ensuring a smooth and reliable booking experience for both iOLX and customers.

POST /reservation/prebook HTTP/1.1\nURL: {BookingUSB-Endpoint}/reservation/prebook\nAuthorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nContent-Type: application/json;charset=utf-8\n\n

PreBook Request Schema

Level	Field Name	Data Type	Required	Description	Example
1	header	object	Y	/	/
2	@supplierId	string	Y	The ID of hotel supplier in Channel Manager's system. Max Length: 32	HILTON
2	@distributorId	string	Y	The ID of iOLX in Channel Manager's system. Max Length: 32	GTA
2	@version	string	Y	Version of API. Max Length: 20	v4
2	@token	string	Y	A unique identifier for each request and response, typically a UUID. Note that this is an echo token, not an access token. Max Length: 64	18393849028490234
1	reservationIds	object	Y	/	/
2	@distributorResId	string	Y	iOLX's reservation ID. Mandatory field.	C2084DFL0
1	iata	string	N	IATA	/
1	hotelId	string	Y	Hotel IDs provided by hotel suppliers. Allowed: digits, uppercase letters, hyphen	100001 / GATHI / 00016 / PEP-B3T2 / B8W7
1	stayRange	object	Y	/	/
2	@checkin	string	Y	Check-in date expressed YYYY-MM-DD	2028-01-01
2	@checkout	string	Y	Check out date expressed YYYY-MM-DD	2028-01-04
1	contactPerson	object	Y	/	/
2	@firstName	string	Y	Contact person first name	James
2	@lastName	string	Y	Contact person last name	Bond
2	@email	string	N	Contact person email	007@james.com
2	@phone	string	N	Contact person phone number including country code	34123456789
2	@address	string	N	Contact person home address	King's Road in Chelsea
1	roomCriteria	object	Y	/	/

2	@adultCount	integer	Y	Adult count per room	/
2	@childCount	integer	N	Child count per room	/
2	@childAges	array	N	Child ages array	/
1	total	object	Y	Object used to share total amount of reservation	/
2	@amountBeforeTax	number	C	ABT, mandatory if AAT is not provided	640
2	@amountAfterTax	number	Y	AAT, mandatory if ABT is not provided	700
1	payment	object	N	Used to share payment information	/
2	@cardType	string	N	CC / VCC / CBILL	CC
2	@cardCode	string	Y	Card Code	VI
2	@cardNumber	string	C	Credit card number	4111111111111111
2	@cardHolderName	string	C	Cardholder name	Sherlock Holmes
2	@expireDate	string	C	MMYY	0119
2	@securityCode	string	N	Card verification value	123
2	@vccEffectiveDate	string	C	VCC effective date YYYY-MM-DD	2025-06-30
2	@vccInvalidDate	string	N	VCC expiry date YYYY-MM-DD	2025-07-30
2	@vccAmountOnCard	number	N	Amount on virtual card	1000.00
2	@vccCurrency	string	N	Currency code ISO-4217	USD
1	promoteCode	string	N	Promotion code	/
1	guests	array[object]	Y	/	/
2	@firstName	string	Y	Guest first name	James
2	@lastName	string	Y	Guest last name	Bond
2	@email	string	N	Guest email	007@james.com
2	@phone	string	N	Guest phone number	34123456789
2	@address	string	N	Guest address	King's Road
2	@age	integer	N	Age of guest	/
2	@gender	enum	N	Enum: [Male, Female]	Male
2	@birthday	string	N	Birthday	1970-12-20
2	@type	string	N	Enum: [Adult, Child, Infant]	Adult
1	comments	array[string]	N	Any preference or comment	[\"no smoking\",\"high floor\"]
1	roomRates	array[object]	Y	Min Items: 1 Max Items: 1	/
2	@roomId	string	Y	Room ID	10000101
2	@rateId	string	Y	Rate ID	123456
2	@currency	string	Y	Currency code ISO-4217	USD
2	@amountBeforeTax	array[number]	N	Daily rate before tax	[100,100,120]
2	@amountAfterTax	array[number]	C	Daily rate after tax	[110,110,130]
2	@mealPlan	string	N	Meal plan code	RO
2	@paymentType	enum	N	Enum: [PayLater, PayNow]	PayNow

PreBook Request Example

{\n    \"header\": {\n      \"supplierId\": \"HILTON\",\n      \"distributorId\": \"GTA\",\n      \"version\": \"v4\",\n      \"token\": \"18393849028490234\"\n    },\n    \"reservationIds\": {\n      \"distributorResId\": \"C2084DFL0\"\n    },\n    \"iata\": \"string\",\n    \"hotelId\": \"GATHI\",\n    \"stayRange\": {\n      \"checkin\": \"2028-01-01\",\n      \"checkout\": \"2028-01-04\"\n    },\n    \"contactPerson\": {\n      \"firstName\": \"Thomas\",\n      \"lastName\": \"Hintz\",\n      \"email\": \"Thomas.Hintz@yahoo.com\",\n      \"phone\": \"260-975-4091\",\n      \"address\": \"3946 Freddy Locks\"\n    },\n    \"roomCriteria\": {\n      \"adultCount\": 2,\n      \"childCount\": 1,\n      \"childAges\": [\n        5\n      ]\n    },\n    \"total\": {\n      \"amountBeforeTax\": 640,\n      \"amountAfterTax\": 700\n    },\n    \"payment\": {\n      \"cardType\": \"CC\",\n      \"cardCode\": \"VI\",\n      \"cardNumber\": \"4111111111111111\",\n      \"cardHolderName\": \"Sherlock Holmes\",\n      \"expireDate\": \"0119\",\n      \"securityCode\": \"123\",\n      \"vccEffectiveDate\": \"2028-01-01\",\n      \"vccInvalidDate\": \"2028-01-02\",\n      \"vccAmountOnCard\": 502.19,\n      \"vccCurrency\": \"USD\"\n    },\n    \"promoteCode\": \"string\",\n    \"guests\": [\n      {\n        \"firstName\": \"Thomas\",\n        \"lastName\": \"Hintz\",\n        \"email\": \"Thomas.Hintz@yahoo.com\",\n        \"phone\": \"260-975-4091\",\n        \"address\": \"3946 Freddy Locks\",\n        \"age\": 32,\n        \"gender\": \"Male\",\n        \"birthday\": \"1990-01-01\",\n        \"type\": \"Adult\",\n      },\n      {\n        \"firstName\": \"Hillary\",\n        \"lastName\": \"Ullrich\",\n        \"email\": \"Xavier.Lind49@yahoo.com\",\n        \"phone\": \"260-975-4091\",\n        \"address\": \"3946 Freddy Locks\",\n        \"age\": 28,\n        \"gender\": \"Female\",\n        \"birthday\": \"1994-01-01\",\n        \"type\": \"Adult\",\n      },\n      {\n        \"firstName\": \"Alex\",\n        \"lastName\": \"Hintz\",\n        \"age\": 5,\n        \"type\": \"Child\",\n      }\n    ],\n    \"comments\": [\n      \"no smoking\",\n      \"high floor\"\n    ],\n    \"roomRates\": [\n      {\n        \"roomId\": \"K1D\",\n        \"rateId\": \"ODAD01\",\n        \"currency\": \"USD\",\n        \"amountBeforeTax\": [\n          100,\n          100,\n          120\n        ],\n        \"amountAfterTax\": [\n          110,\n          110,\n          130\n        ],\n        \"mealPlan\": \"RO\",\n        \"paymentType\": \"PayNow\"\n    }\n  }\n\n

PreBook Response Schema

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

Level	Field Name	Data Type	Required	Description	Example
1	header	object	Y	/	/
2	@supplierId	string	Y	The ID of the hotel supplier in Channel Manager's system. MaxLength: 32	HILTON
2	@distributorId	string	Y	The ID of iOLX in Channel Manager's system. MaxLength: 32	GTA
2	@version	string	Y	Version of API. MaxLength: 20	v4
2	@token	string	Y	A unique identifier for each request and response, typically a UUID. Note that this is an echo token, not an access token. MaxLength: 64	18393849028490234
1	bookingToken	string	Y	Booking token is used for booking	/
1	error	string	N	error response	Key not authorized
1	errorCode	string	C	error response	InvalidField
1	supplierErrorCode	string	C	error response	InvalidField
1	errorMessage	string	C	error response	Invalid Message

PreBook Response Example

Success Response (HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"bookingToken\": \"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c\",\n  }\n}\n\n

Error Response (HTTP Status 403)

{\n  \"error\": \"Key not authorised\"\n}\n\n

Error Response (HTTP Status 500)

{\n  \"errorCode\": \"string\",\n  \"supplierErrorCode\": \"string\",\n  \"errorMessage\": \"string\"\n}\n\n

","_postman_id":"7fea1f5f-9f4e-41fa-860f-dd230bda127a"},{"name":"Book","item":[],"id":"4f2b1fff-8e3e-49bf-9c32-bf8e82916df6","description":"

Book API

The Book API is used by iOLX to reserve rooms in real time. Once a request is sent to the hotel supplier’s system, it processes the reservation and returns immediate confirmation of the booking. This API ensures that the reservation is secured, with iOLX receiving a real-time response, which helps in completing the booking process quickly and accurately. The Book API is a critical step in finalising reservations, offering a seamless experience for both iOLX and customers by providing instant confirmation from the hotel system.

POST /reservation/book HTTP/1.1\nURL: {BookingUSB-Endpoint}/reservation/book\nAuthorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nContent-Type: application/json;charset=utf-8\n\n

Book Request Schema

Level	Field Name	Data Type	Required	Description	Example
1	header	object	Y	/	/
2	@supplierId	string	Y	The ID of the hotel supplier in Channel Manager's system. Max Length: 32	HILTON
2	@distributorId	string	Y	The ID of iOLX in Channel Manager's system. Max Length: 32	GTA
2	@version	string	Y	Max Length: 20. Version of API	v4
2	@token	string	Y	A unique identifier for each request and response, typically a UUID. Note that this is an echo token, not an access token. Max Length: 64	18393849028490234
1	reservationIds	object	Y	/	/
2	@distributorResId	string	Y	iOLX's reservation ID.	C2084DFL0
1	iata	string	N	IATA	/
1	hotelId	string	Y	Hotel IDs provided by hotel suppliers. Allowed characters: digits (0-9), uppercase letters (A-Z), hyphen (-)	100001
1	stayRange	object	Y	/	/
2	@checkin	string	Y	Check-in date expressed YYYY-MM-DD	2028-01-01
2	@checkout	string	Y	Check-out date expressed YYYY-MM-DD	2028-01-04
1	contactPerson	object	Y	/	/
2	@firstName	string	Y	Contact person's first name	James
2	@lastName	string	Y	Contact person's last name	Bond
2	@email	string	N	Email	007@james.com
2	@phone	string	N	Contact person's phone number including country code	34123456789
2	@address	string	N	Contact person's home address	King's Road in Chelsea
1	roomCriteria	object	Y	/	/

2	@adultCount	integer	Y	Adult count per room	/
2	@childCount	integer	N	Child count per room	/
2	@childAges	array	N	For child ages for each child, array size MUST match child count	/
1	total	object	Y	Object used to share total amount (ABT or AAT or both)	/
2	@amountBeforeTax	number	C	ABT, mandatory if AAT is not provided	640
2	@amountAfterTax	number	Y	AAT, mandatory if ABT is not provided	700
1	payment	object	N	Used to share payment information with properties	/
2	@cardType	string	N	CC, VCC, CBILL	CC
2	@cardCode	string	Y	VI, MC, AX, etc.	VI
2	@cardNumber	string	C	Credit card number	4111111111111111
2	@cardHolderName	string	C	Cardholder name	Sherlock Holmes
2	@expireDate	string	C	Expiry date MMYY	0119
2	@securityCode	string	N	Card verification value	123
2	@vccEffectiveDate	string	N	VCC effective date YYYY-MM-DD	2025-06-30
2	@vccInvalidDate	string	N	VCC expiry date YYYY-MM-DD	2025-07-30
2	@vccAmountOnCard	number	N	Amount on virtual card	1000.00
2	@vccCurrency	string	N	Currency code [ISO-4217]	USD
1	promoteCode	string	N	Promotion code defined by the hotel	/
1	guests	array[object]	Y	/	/
2	@firstName	string	Y	Guest first name	James
2	@lastName	string	Y	Guest last name	Bond
2	@email	string	N	Guest email	007@james.com
2	@phone	string	N	Guest phone number	34123456789
2	@address	string	N	Guest home address	King's Road
2	@age	integer	N	Age of guest	/
2	@gender	enum	N	Enum: [Male, Female]	Male
2	@birthday	string	N	Birthday yyyy-MM-dd	1970-12-20
2	@type	string	N	Enum: [Adult, Child, Infant]	/
1	comments	array[string]	N	Any preference or comment	[\"no smoking\",\"high floor\"]
1	roomRates	array[object]	Y	Min Items: 1 Max Items: 1	/
2	@roomId	string	Y	Room ID in supplier's system	10000101
2	@rateId	string	Y	Rate ID in supplier's system	123456
2	@currency	string	Y	Currency code [ISO-4217]	USD
2	@amountBeforeTax	array[number]	N	Daily rate without tax	[100,100,120]
2	@amountAfterTax	array[number]	C	Daily rate with tax	[110,110,130]
2	@mealPlan	string	N	Meal plan code	RO

Book Request Example

Book Request Example

{\n    \"header\": {\n      \"supplierId\": \"HILTON\",\n      \"distributorId\": \"GTA\",\n      \"version\": \"v4\",\n      \"token\": \"18393849028490234\"\n    },\n    \"reservationIds\": {\n      \"distributorResId\": \"C2084DFL0\"\n    },\n    \"iata\": \"string\",\n    \"hotelId\": \"GATHI\",\n    \"stayRange\": {\n      \"checkin\": \"2028-01-01\",\n      \"checkout\": \"2028-01-04\"\n    },\n    \"contactPerson\": {\n      \"firstName\": \"Thomas\",\n      \"lastName\": \"Hintz\",\n      \"email\": \"Thomas.Hintz@yahoo.com\",\n      \"phone\": \"260-975-4091\",\n      \"address\": \"3946 Freddy Locks\"\n    },\n    \"roomCriteria\": {\n      \"adultCount\": 2,\n      \"childCount\": 1,\n      \"childAges\": [\n        5\n      ]\n    },\n    \"total\": {\n      \"amountBeforeTax\": 640,\n      \"amountAfterTax\": 700\n    },\n    \"payment\": {\n      \"cardType\": \"CC\",\n      \"cardCode\": \"VI\",\n      \"cardNumber\": \"4111111111111111\",\n      \"cardHolderName\": \"Sherlock Holmes\",\n      \"expireDate\": \"0119\",\n      \"securityCode\": \"123\",\n      \"vccEffectiveDate\": \"2028-01-01\",\n      \"vccInvalidDate\": \"2028-01-02\",\n      \"vccAmountOnCard\": 502.19,\n      \"vccCurrency\": \"USD\"\n    },\n    \"promoteCode\": \"string\",\n    \"guests\": [\n      {\n        \"firstName\": \"Thomas\",\n        \"lastName\": \"Hintz\",\n        \"email\": \"Thomas.Hintz@yahoo.com\",\n        \"phone\": \"260-975-4091\",\n        \"address\": \"3946 Freddy Locks\",\n        \"age\": 32,\n        \"gender\": \"Male\",\n        \"birthday\": \"1990-01-01\",\n        \"type\": \"Adult\"\n        }\n      },\n      {\n        \"firstName\": \"Hillary\",\n        \"lastName\": \"Ullrich\",\n        \"email\": \"Xavier.Lind49@yahoo.com\",\n        \"phone\": \"260-975-4091\",\n        \"address\": \"3946 Freddy Locks\",\n        \"age\": 28,\n        \"gender\": \"Female\",\n        \"birthday\": \"1994-01-01\",\n        \"type\": \"Adult\"\n      },\n      {\n        \"firstName\": \"Alex\",\n        \"lastName\": \"Hintz\",\n        \"age\": 5,\n        \"type\": \"Child\"\n      }\n    ],\n    \"comments\": [\n      \"no smoking\",\n      \"high floor\"\n    ],\n    \"roomRates\": [\n      {\n        \"roomId\": \"K1D\",\n        \"rateId\": \"ODAD01\",\n        \"currency\": \"USD\",\n        \"amountBeforeTax\": [\n          100,\n          100,\n          120\n        ],\n        \"amountAfterTax\": [\n          110,\n          110,\n          130\n        ],\n        \"mealPlan\": \"RO\",\n        \"paymentType\": \"PayNow\"\n  }\n\n

Book Response Schema

Level	Field Name	Data Type	Required	Description	Example
1	header	object	Y	/	/
2	@supplierId	string	Y	The ID of the hotel supplier in Channel Manager's system. Max Length: 32	HILTON
2	@distributorId	string	Y	The ID of iOLX in Channel Manager's system. Max Length: 32	GTA
2	@version	string	Y	Max Length: 20. Version of API	v4
2	@token	string	Y	A unique identifier for each request and response, typically a UUID. Note that this is an echo token, not an access token. Max Length: 64	18393849028490234
1	reservationIds	object	Y	/	/
2	@distributorResId	string	Y	iOLX's reservation ID.	C2084DFL0
2	@ChannelManagerResId	string	N	Reservation ID in Channel Manager system, this is a unique ID as Channel Manager should be splitting the reservation.	D15F893D34DF
2	@supplierResId	string	N	Reservation ID in supplier's system	89389494
2	@value	number	Y	/	10
2	@type	enum	Y	Commission type. Enum: [Percent, Amount]	Percent
2	@amountBeforeTax	number	N	/	600
2	@amountAfterTax	number	Y	/	700
1	error	string	N	error response	Key not authorized
1	errorCode	string	C	error response	InvalidField
1	supplierErrorCode	string	C	error response	InvalidField
1	errorMessage	string	C	error response	Invalid Message

Book Response Example

Success Response (HTTP Status 200)

{\n  \"header\": {\n  \"supplierId\": \"HILTON\",\n  \"distributorId\": \"GTA\",\n  \"version\": \"v4\",\n  \"token\": \"18393849028490234\"\n  },\n  \"reservationIds\": {\n  \"distributorResId\": \"C2084DFL0\",\n  \"ChannelManagerResId\": \"D15F893D34DF\",\n  \"supplierResId\": \"89389494\"\n  }\n  }\n\n

Successful Response from Retail Rate Model(HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"reservationIds\": {\n    \"distributorResId\": \"C2084DFL0\",\n    \"ChannelManagerResId\": \"D15F893D34DF\",\n    \"supplierResId\": \"89389494\"\n  }\n}\n\n

Successful Response from Net Rate Model(HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"reservationIds\": {\n    \"distributorResId\": \"C2084DFL0\",\n    \"ChannelManagerResId\": \"D15F893D34DF\",\n    \"supplierResId\": \"89389494\"\n  }\n  }\n}\n\n

Error Response (HTTP Status 403)

{\n  \"error\": \"Key not authorized\"\n}\n\n

Error Response (HTTP Status 500)

        {\n  \"errorCode\": \"string\",\n  \"supplierErrorCode\": \"string\",\n  \"errorMessage\": \"string\"\n}\n\n

","_postman_id":"4f2b1fff-8e3e-49bf-9c32-bf8e82916df6"},{"name":"Cancellation","item":[],"id":"f54d4a74-b35d-4221-99a2-697e8ff80bc1","description":"

Cancellation API

The Cancel API enables iOLX to send cancellation requests to the Channel Manager, which then communicates with the hotel supplier’s system to cancel the booking in real time. Cancellations are performed using the supplier reservation identifier. Once the cancellation request is sent, iOLX receives immediate confirmation from the supplier’s system, ensuring the cancellation is processed and accurately reflected.

POST /reservation/cancel HTTP/1.1\nURL: {BookingUSB-Endpoint}/reservation/cancel\nAuthorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nContent-Type: application/json;charset=utf-8<strong class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; class=&#x27;preserveHtml&#x27; >\nCancellation Request Example</b>\n\n

Cancellation Request Schema

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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Level	Field Name	Required	Data Type	Description	Example
1	header	Y	object	Request header information
2	supplierId	Y	string	The ID of the hotel supplier in Channel Manager's system. Max Length: 32	HILTON
2	distributorId	Y	string	The ID of iOLX in Channel Manager's system. Max Length: 32	GTA
2	version	Y	string	Version of API. Max Length: 20	v4
2	token	Y	string	A unique identifier used for requests and responses (echo token, not an access token). Max Length: 64	18393849028490234
1	reservationIds	Y	object	Reservation identifiers
2	distributorResId	Y	string	iOLX’s reservation ID.	C2084DFL0
2	ChannelManagerResId	N	string	Reservation ID in ChannelManager’s system. Unique ID generated when a reservation is split	D15F893D34DF
2	supplierResId	N	string	Reservation ID in the supplier’s system	89389494

Cancellation Request Sample

{\n        \"header\": {\n            \"supplierId\": \"HILTON\",\n            \"distributorId\": \"GTA\",\n            \"version\": \"v4\",\n            \"token\": \"18393849028490234\"\n        },\n        \"reservationIds\": {\n            \"distributorResId\": \"C2084DFL0\",\n            \"ChannelManagerResId\": \"D15F893D34DF\",\n            \"supplierResId\": \"89389494\"\n        }\n      }\n\n

Cancellation Response Schema

Response

Level	Field Name	Required	Data Type	Description	Example
1	header	Y	object	Response header information
2	supplierId	Y	string	The ID of the hotel supplier in Channel Manager's system. Max Length: 32	HILTON
2	distributorId	Y	string	The ID of iOLX in Channel Manager's system. Max Length: 32	GTA
2	version	Y	string	Version of API. Max Length: 20	v4
2	token	Y	string	A unique identifier used for requests and responses (echo token, not an access token). Max Length: 64	18393849028490234
1	reservationIds	Y	object	Reservation identifiers
2	distributorResId	Y	string	iOLX's reservation ID.	C2084DFL0
2	ChannelManagerResId	Y	string	Reservation ID in Channel Manager’s system. Unique ID generated when a reservation is split	D15F893D34DF
2	supplierResId	Y	string	Reservation ID in the supplier’s system	89389494
2	cancellationId	Y	string	Cancellation confirmation number in the supplier’s system	C89389494
1	error	N	string	Error message	Key not authorized
1	errorCode	C	string	Platform error code	InvalidField
1	supplierErrorCode	C	string	Supplier-specific error code	InvalidField
1	errorMessage	C	string	Detailed error description	Invalid Message

Cancellation Response Example

Success Response (HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorid\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"reservationIds\": {\n    \"distributorResId\": \"C2084DFL0\",\n    \"ChannelManagerResId\": \"D15F893D34DF\",\n    \"supplierResId\": \"89389494\"\n  },\n  \"cancellationId\": \"C89389494\"\n}\n\n

Error Response (HTTP Status 403)

{\n  \"error\": \"Key not authorized\"\n} \n\n

Error Response (HTTP Status 500)

        {\n  \"errorCode\": \"string\",\n  \"supplierErrorCode\": \"string\",\n  \"errorMessage\": \"string\"\n}\n\n

","_postman_id":"f54d4a74-b35d-4221-99a2-697e8ff80bc1"},{"name":"Query Reservation List","item":[],"id":"da7f393f-05f1-4857-a485-f308fb0fa2cc","description":"

Query Reservation List API

The Query Reservation List API allows iOLX to retrieve a list of reservations from both Channel Manager's system and the hotel supplier's system. The query is based on a specified date range of the reservation’s last modified date, ensuring that only relevant and updated reservation information is fetched. This API is essential for managing and tracking reservations over time, providing iOLX with up-to-date insights into their bookings. To ensure proper functionality, both Channel Manager and the hotel supplier must implement this API. By doing so, iOLX can query reservations across both systems, offering a comprehensive view of reservation statuses and updates, which is crucial for effective booking management.

POST /reservations HTTP/1.1\nURL: {BookingUSB-Endpoint}/reservations\nAuthorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Reservation List Request Schema

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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Level	Field Name	Required	Data Type	Description	Example
1	header	Y	object	Request header information
2	supplierId	Y	string	The ID of the hotel supplier in Channel Manager's system. Max Length: 32	HILTON
2	distributorId	Y	string	The ID of iOLX in Channel Manager's system. Max Length: 32	GTA
2	version	Y	string	Version of API. Max Length: 20	v4
2	token	Y	string	Unique identifier for request/response (echo token, not access token). Max Length: 64	18393849028490234
1	dateRange	Y	object	Date range for last modified reservations
2	startDate	Y	string	Start date of date range (YYYY-MM-DD)	2028-01-01
2	endDate	Y	string	End date of date range (YYYY-MM-DD)	2028-01-04
1	hotelId	N	string	Supplier hotel ID in Channel Manager's system	GATHI

Reservation List Request Example

Reservation List Request Example

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"dateRange\": {\n    \"startDate\": \"2028-01-01\",\n    \"endDate\": \"2028-01-04\"\n  },\n  \"hotelId\": \"GATHI\"\n}\n\n

Reservation List Response Schema

Response

Level	Field Name	Required	Data Type	Description	Example
1	header	Y	object	Response header information
2	supplierId	Y	string	The ID of the hotel supplier in Channel Manager's system. Max Length: 32	HILTON
2	distributorId	Y	string	The ID of iOLX in Channel Manager's system. Max Length: 32	GTA
2	version	Y	string	Version of API. Max Length: 20	v4
2	token	Y	string	Unique identifier for request/response (echo token, not access token). Max Length: 64	18393849028490234
1	reservations	N	array[object]	List of reservations
2	reservationIds	N	object	Reservation identifiers
3	iOLXResId	Y	string	iOLX’s reservation ID.	C2084DFL0
3	ChannelManagerResId	Y	string	Reservation ID in Channel Manager’s system. Unique ID generated when reservations are split	D15F893D34DF
3	supplierResId	Y	string	Reservation ID in the supplier’s system	89389494
2	iata	N	string	IATA code of iOLX
2	hotelId	Y	string	Supplier hotel ID. Allowed characters: digits (0–9), uppercase letters (A–Z), hyphen (-)	GATHI
2	stayRange	Y	object	Stay date range
3	checkin	Y	string	Check-in date (YYYY-MM-DD)	2028-01-01
3	checkout	Y	string	Check-out date (YYYY-MM-DD)	2028-01-04
2	roomCriteria	Y	object	Room criteria
3	roomCount	Y	integer	Total room count	2
3	adultCount	Y	integer	Adult count per room	1
3	childCount	N	integer	Child count per room	2
3	childAges	N	array	Child ages. Array size must match childCount	[4, 8]

2	total	Y	object	Total price information
3	amountBeforeTax	C	number	Amount before tax (mandatory if amountAfterTax is not provided)	640
3	amountAfterTax	Y	number	Amount after tax (mandatory if amountBeforeTax is not provided)	700
2	commission	N	object	Commission details. Visible only for Exchange + Retail rate model
3	value	Y	number	Commission value	10
3	type	Y	enum	Commission type. Enum: [Percent, Amount]	Percent

3	amountBeforeTax	N	number	Suggested amount before tax	600
3	amountAfterTax	Y	number	Suggested amount after tax	700
2	status	Y	enum	Reservation status. Enum: [Confirmed, Modified, Cancelled]	Confirmed
2	cancellationId	N	string	Cancellation confirmation number in supplier’s system	C89389494
2	result	Y	enum	Reservation processing result. Enum: [Successful, Failed, Processing]	Successful
2	failCause	C	object	Failure details. Visible only if result = Failed
3	errorCode	C	string	Platform error code (refer to Error Code Appendix)	InvalidField
3	supplierErrorCode	C	string	Supplier-specific error code	InvalidField
3	errorMessage	C	string	Error message	Invalid Message

Reservation List Response Example

Success Response (HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"reservations\": [\n    {\n      \"reservationIds\": {\n        \"distributorResId\": \"C2084DFL0\",\n        \"ChannelManagerResId\": \"D15F893D34DF\",\n        \"supplierResId\": \"89389494\"\n      },\n      \"iata\": \"string\",\n      \"hotelId\": \"GATHI\",\n      \"stayRange\": {\n        \"checkin\": \"2028-01-01\",\n        \"checkout\": \"2028-01-04\"\n      },\n      \"roomCriteria\": {\n        \"roomCount\": 2,\n        \"adultCount\": 1,\n        \"childCount\": 2,\n        \"childAges\": [\n          4,\n          8\n        ]\n      },\n      \"total\": {\n        \"amountBeforeTax\": 640,\n        \"amountAfterTax\": 700\n      },\n      \"status\": \"Confirmed\",\n      \"cancellationId\": \"C89389494\",\n      \"result\": \"Successful\",\n      \"failCause\": {\n        \"errorCode\": \"string\",\n        \"supplierErrorCode\": \"string\",\n        \"errorMessage\": \"string\"\n      }\n    }\n  ]\n}\n\n

Successful Response from Retail Rate Model(HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"reservations\": [\n    {\n      \"reservationIds\": {\n        \"distributorResId\": \"C2084DFL0\",\n        \"ChannelManagerResId\": \"D15F893D34DF\",\n        \"supplierResId\": \"89389494\"\n      },\n      \"iata\": \"string\",\n      \"hotelId\": \"GATHI\",\n      \"stayRange\": {\n        \"checkin\": \"2028-01-01\",\n        \"checkout\": \"2028-01-04\"\n      },\n      \"contactPerson\": {\n        \"firstName\": \"James\",\n        \"lastName\": \"Bond\",\n        \"email\": \"007@james.com\",\n        \"phone\": \"string\",\n        \"address\": \"string\"\n      },\n      \"roomCriteria\": {\n        \"roomCount\": 2,\n        \"adultCount\": 1,\n        \"childCount\": 2,\n        \"childAges\": [\n          4,\n          8\n        ]\n      },\n      \"total\": {\n        \"amountBeforeTax\": 640,\n        \"amountAfterTax\": 700\n      },\n      \"commission\": {\n        \"value\": 10,\n        \"type\": \"Percent\"\n      },\n      \"status\": \"Confirmed\",\n      \"cancellationId\": \"C89389494\",\n      \"result\": \"Successful\"\n    }\n  ]\n}\n\n

Successful Response from Net Rate Model(HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"reservations\": [\n    {\n      \"reservationIds\": {\n        \"distributorResId\": \"C2084DFL0\",\n        \"ChannelManagerResId\": \"D15F893D34DF\",\n        \"supplierResId\": \"89389494\"\n      },\n      \"iata\": \"string\",\n      \"hotelId\": \"GATHI\",\n      \"stayRange\": {\n        \"checkin\": \"2028-01-01\",\n        \"checkout\": \"2028-01-04\"\n      },\n      \"contactPerson\": {\n        \"firstName\": \"James\",\n        \"lastName\": \"Bond\",\n        \"email\": \"007@james.com\",\n        \"phone\": \"string\",\n        \"address\": \"string\"\n      },\n      \"roomCriteria\": {\n        \"roomCount\": 2,\n        \"adultCount\": 1,\n        \"childCount\": 2,\n        \"childAges\": [\n          4,\n          8\n        ]\n      },\n      \"total\": {\n        \"amountBeforeTax\": 640,\n        \"amountAfterTax\": 700\n      },\n      \"status\": \"Confirmed\",\n      \"cancellationId\": \"C89389494\",\n      \"result\": \"Successful\"\n    }\n  ]\n}\n\n

Error Response (HTTP Status 403)

{\n  \"error\": \"Key not authorized\"\n}\n\n

Error Response (HTTP Status 500)

        {\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"Invalid Message\"\n}\n\n

","_postman_id":"da7f393f-05f1-4857-a485-f308fb0fa2cc"},{"name":"Query Reservation Details","item":[],"id":"8df5c39d-0d5e-4b30-b935-73036200a541","description":"

The Query Reservation Detail API allows iOLX to retrieve detailed information about existing bookings, including the current status of the reservation. The possible statuses include confirmed, modified, or cancelled, helping iOLX track the progress and changes to the booking. This API provides a comprehensive view of individual reservations, allowing iOLX to access key details such as guest information, room types, booking dates, and other important data. This API is essential for efficient reservation management, giving iOLX the ability to stay informed about the status and details of each booking, enabling it to take appropriate actions when necessary.

POST /reservation/detail HTTP/1.1\nURL: {BookingUSB-Endpoint}/reservation/detail\nAuthorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc\nAccept-Encoding: gzip\nContent-Encoding: gzip\nContent-Type: application/json;charset=utf-8\n\n

Reservation Details Request Schema

Request (POST)

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

Level	Field Name	Required	Data Type	Description	Example
1	header	Y	object	Request header information
2	supplierId	Y	string	The ID of the hotel supplier in the Channel Manager’s system. Max Length: 32	HILTON
2	distributorId	Y	string	The ID of iOLX in the Channel Manager’s system. Max Length: 32	GTA
2	version	Y	string	Version of API. Max Length: 20	v4
2	token	Y	string	Unique identifier for request/response (echo token, not access token). Max Length: 64	18393849028490234
1	reservationIds	Y	object	Reservation identifiers
2	distributorResId	Y	string	iOLX’s reservation ID	C2084DFL0
2	channelManagerResId	N	string	Reservation ID in Channel Manager’s system. Unique ID generated if reservations are split	D15F893D34DF
2	supplierResId	N	string	Reservation ID in supplier’s system	89389494

Reservation Details Request Example

Reservation Details Request Example

{\n    \"header\": {\n      \"supplierId\": \"HILTON\",\n      \"distributorId\": \"GTA\",\n      \"version\": \"v4\",\n      \"token\": \"18393849028490234\"\n    },\n    \"reservationIds\": {\n      \"distributorResId\": \"C2084DFL0\",\n      \"ChannelManagerResId\": \"D15F893D34DF\",\n      \"supplierResId\": \"89389494\"\n    }\n  }\n\n

Reservation Details Response Schema

Response

Level	Field Name	Required	Data Type	Description	Example
1	header	Y	object	Response header information
2	supplierId	Y	string	Hotel supplier ID in the Channel Manager system. Max Length: 32	HILTON
2	distributorId	Y	string	iOLX ID in the Channel Manager system. Max Length: 32	GTA
2	version	Y	string	API version. Max Length: 20	v4
2	token	Y	string	Echo token for request/response. Max Length: 64	18393849028490234
1	reservations	N	array[object]	Reservation details
2	reservationIds	N	object	Reservation identifiers
3	distributorResId	Y	string	iOLX reservation ID	C2084DFL0
3	ChannelManagerResId	Y	string	Channel manager reservation ID	D15F893D34DF
3	supplierResId	Y	string	Supplier reservation ID	89389494
2	iata	N	string	iOLX IATA code
2	hotelId	Y	string	Supplier hotel ID (A–Z, 0–9, `-`)	GATHI
2	stayRange	Y	object	Stay date range
3	checkin	Y	string	Check-in date (YYYY-MM-DD)	2028-01-01
3	checkout	Y	string	Check-out date (YYYY-MM-DD)	2028-01-04
2	roomCriteria	Y	object	Room criteria
3	roomCount	Y	integer	Total rooms	2
3	adultCount	Y	integer	Adults per room	1
3	childCount	N	integer	Children per room	2
3	childAges	N	array	Child ages	[4, 8]
2	total	Y	object	Total price
3	amountBeforeTax	N	number	Amount before tax	640
3	amountAfterTax	Y	number	Amount after tax	700
2	commission	N	object	Visible for Exchange + Retail rate model
3	value	N	number	Commission value	10
3	type	N	enum	Enum: [Percent, Amount]	Percent


2	promoteCode	N	string	Promotion code
2	comments	N	array[string]	Guest preferences/comments	[\"no smoking\", \"high floor\"]
2	roomRates	Y	array[object]	Room rate details (min 1, max 1)
3	roomId	Y	string	Supplier room ID	10000101
3	rateId	Y	string	Supplier rate ID	123456
3	currency	Y	string	ISO-4217 currency	USD
3	amountBeforeTax	N	array[number]	Daily rate before tax	[100,100,120]
3	amountAfterTax	N	array[number]	Daily rate after tax	[110,110,130]
3	mealPlan	N	string	Meal plan code	RO
3	paymentType	N	enum	Enum: [PayLater, PayNow]	PayNow
3	guarantee	N	object	Guarantee details
4	guaranteeType	C	string	Guarantee type	CCG
3	fees	N	array[object]	Fees and taxes
2	cancelPolicy	N	object	Cancellation policy
2	bookingChannel	N	string	Sub-distributor ID
2	status	Y	enum	Enum: [Confirmed, Modified, Cancelled]	Confirmed
2	cancellationId	N	string	Supplier cancellation ID	C89389494
2	result	Y	enum	Enum: [Successful, Failed, Processing]	Successful
2	failCause	N	object	Failure details (if failed)
3	errorCode	Y	string	Platform error code
3	supplierErrorCode	N	string	Supplier error code
3	errorMessage	Y	string	Error message

Success Response (HTTP Status 200)

{\n  \"header\": {\n    \"supplierId\": \"HILTON\",\n    \"distributorId\": \"GTA\",\n    \"version\": \"v4\",\n    \"token\": \"18393849028490234\"\n  },\n  \"reservations\": [\n    {\n      \"reservationIds\": {\n        \"iOLXResId\": \"C2084DFL0\",\n        \"ChannelManagerResId\": \"D15F893D34DF\",\n        \"supplierResId\": \"89389494\"\n      },\n      \"iata\": \"string\",\n      \"hotelId\": \"GATHI\",\n      \"stayRange\": {\n        \"checkin\": \"2028-01-01\",\n        \"checkout\": \"2028-01-04\"\n      },\n      \"roomCriteria\": {\n        \"roomCount\": 2,\n        \"adultCount\": 1,\n        \"childCount\": 2,\n        \"childAges\": [\n          4,\n          8\n        ]\n      },\n      \"total\": {\n        \"amountBeforeTax\": 640,\n        \"amountAfterTax\": 700\n      },\n      \"commission\": {\n        \"value\": 10,\n        \"type\": \"Percent\"\n      },\n      \"promoteCode\": \"string\",\n      \"comments\": [\n        \"no smoking\",\n        \"high floor\"\n      ],\n      \"roomRates\": [\n        {\n          \"roomId\": \"K1D\",\n          \"rateId\": \"ODAD01\",\n          \"currency\": \"USD\",\n          \"amountBeforeTax\": [\n            100,\n            100,\n            120\n          ],\n          \"amountAfterTax\": [\n            110,\n            110,\n            130\n          ],\n          \"mealPlan\": \"RO\",\n          \"paymentType\": \"PayNow\",\n          \"guarantee\": {\n            \"guaranteeType\": \"CCG\"\n          },\n          \"fees\": [\n            {\n              \"dateRange\": {\n                \"startDate\": \"2028-01-01\",\n                \"endDate\": \"2028-01-04\"\n              },\n              \"fee\": {\n                \"name\": \"Service Charge\",\n                \"type\": \"Exclusive\",\n                \"amount\": 10,\n                \"amountType\": \"Percent\",\n                \"chargeType\": \"PerRoomPerNight\",\n                \"paymentType\": \"PayNow\",\n                \"collectBy\": \"Distributor\",\n                \"effectivePerson\": 0\n              }\n            },\n            {\n              \"dateRange\": {\n                \"startDate\": \"2028-01-01\",\n                \"endDate\": \"2028-01-04\"\n              },\n              \"fee\": {\n                \"name\": \"City Tax\",\n                \"type\": \"Exclusive\",\n                \"amount\": 5,\n                \"amountType\": \"Fix\",\n                \"chargeType\": \"PerPersonPerNight\",\n                \"paymentType\": \"PayLater\",\n                \"collectBy\": \"Property\",\n                \"effectivePerson\": 0\n              }\n            }\n          ],\n          \"cancelPolicy\": {\n            \"code\": \"AD100P_100P\",\n            \"description\": \"Non Refundable\",\n            \"cancelPenalties\": [\n              {\n                \"noShow\": true,\n                \"cancellable\": true,\n                \"cancelDeadline\": {\n                  \"offsetTimeDropType\": \"BeforeArrival\",\n                  \"offsetTimeUnit\": \"D\",\n                  \"offsetTimeValue\": 0,\n                  \"deadline\": \"string\"\n                },\n                \"penaltyCharge\": {\n                  \"chargeBase\": \"FullStay\",\n                  \"nights\": 0,\n                  \"amount\": 0,\n                  \"percent\": 0\n                }\n              }\n            ]\n          }\n        }\n      ],\n      \"bookingChannel\": \"string\",\n      \"status\": \"Confirmed\",\n      \"cancellationId\": \"C89389494\",\n      \"result\": \"Successful\",\n      \"failCause\": {\n        \"errorCode\": \"string\",\n        \"supplierErrorCode\": \"string\",\n        \"errorMessage\": \"string\"\n      }\n    }\n  ]\n}\n\n

Error Response (HTTP Status 403)

{\n  \"error\": \"Key not authorized\"\n}\n\n

Error Response (HTTP Status 500)

        {\n  \"errorCode\": \"InvalidField\",\n  \"errorMessage\": \"Invalid Message\"\n}\n\n

","_postman_id":"8df5c39d-0d5e-4b30-b935-73036200a541"}]}