CustomBookingReference

Client booking reference. Is used to identify client's booking.

String

Yes

SupplierHotel

Object

Yes

SupplierId

Supplier’s ID in Ratefox. Integrated suppliers list https://documentation.hsp.gimmonix.com/docs/hsp-hotels-integrated-suppliers

Integer

Yes

SupplierHotelId

Supplier’s HotelID

String

Yes

CheckIn

Check-in date

String Unix Epoch time

Yes

CheckOut

Check-out date

String Unix Epoch time

Yes

Residency

The lead passenger residency

String(2) ISO Country Code (Ex: US, CZ, IL)

Yes

Price

object

Yes

BookingPrice

The price from client’s booking flow. Taxes, fees and commission from the request will be applied to the BookingPrice to obtain “clear” price for comparison with alternative packages’ prices. See examples below the table (*).

Double

Yes

Currency

The currency of the BookingPrice. Rates in response will be in this currency

String(3) ISO Currency Code (Ex: USD, EUR)

Yes

TotalTax

object

Amount

Amount of taxes

Double

Yes

IsIncluded

Are taxes included in the BookingPrice. If excluded, BookingPrice will be increased by Tax Amount before comparing with alternative packages’ prices. Otherwise does not affect.

Boolean

Yes

Currency

If not provided (NULL), then Price Currency is used

String(3) ISO Currency Code

TotalFee

object

Amount

Amount of fees

Double

Yes

IsIncluded

Are fees included in the BookingPrice. If included, BookingPrice will be reduced by Fee Amount before comparing with alternative packages’ prices. Otherwise does not affect.

Boolean

Yes

Currency

If not provided (NULL), then Price Currency is used

String(3) ISO Currency Code

Commission

object

Amount

Amount of client’s commission. BookingPrice will be reduced by Commission Amount before comparing with alternative packages’ prices.

Double

Yes

Currency

ISO Currency Codes. If not provided (NULL), then Price Currency is used

String(3) ISO Currency Codes

RefundableUntil

Refundability deadline

String Unix Epoch time

Yes

Rooms

Array of objects. Possible room quantity is between 1 and 4

Array

Yes

Id

Room Id inside the request. Is generated by client GUID. Should be a unique per each room in the array

GUID

Yes

RoomName

The name of the requested room (as it used by supplier from SupplierID)

String

Yes

RoomBasis

The meal-plan, ”Board” (as it used by supplier from SupplierID)

String

Yes

AdultsCount

Number of adults in the room. The value must be between 1 and 8

Integer

Yes

KidsAges

Array of kids ages. Each value must be between 0 and 17. If empty, there are no kids in the room

Array of integer

WorkMode

Defines the WorkMode for the request.
Possible values: “live”. Can be used only by the client which is set “live” in Gimmonix. The request in this mode produces the real booking;
“evaluation”. The mode for testing and evaluation. The request in this mode doesn’t produce the real booking but full description of Ratefox found alternative is steal returned. This mode can be used by both clients connected to Ratefox as "evaluation" (new clients before the certification stage is completed) and those who are set "live".

String

Yes

LeadPassenger

Array of objects. The main passenger from the booking

Yes

Id

Lead passenger’s Id inside the request. Is generated by client GUID. Should be a unique per each passenger in the request

GUID

Yes

Allocation

Id from Rooms array. Identifies the room for the LeadPassenger

GUID

Yes

Name

object

Yes

GivenName

First name. Use English characters only, otherwise the booking might fail on the supplier side. For internal use only: there is some “cleaning” process in the flow of non English characters

String(50)

Yes

NamePrefix

Mr, Mrs, Ms etc. If not provided, “Mr” is used.

String

Surname

Last name. Use English characters only, otherwise the booking might fail on the supplier side.

String(50)

Type

Must be “adult” for the LeadPassenger

String

Yes

Age

Lead passenger age

Integer

PhoneNumber

Passenger’s phone number to specify in the booking

String(50)

CustomerEmail

Passenger’s email to specify in the booking

String(254)

Address

object. Address details to specify in the booking

CountryCode

String(2) ISO Country Code (Ex: US, CZ, IL)

AddressLine

String(254)

StateProv

String(20)

PostalCode

String(20)

AdditionalPassengers

Array of objects. All passengers (adults and kids) except LeadPassenger must be described in this array.

Array

Id

Passenger’s Id inside the request. Is generated by client GUID. Should be a unique per each passenger in the request

GUID

Yes

Allocation

Id from Rooms array. Identifies the room for the Passenger

GUID

Yes

Name

object

Yes

GivenName

First name. Use English characters only, otherwise the booking might fail on the supplier side.

String(50)

NamePrefix

Mr, Mrs, Ms etc. If not provided, “Mr” is used.

String

Surname

Last name. Use English characters only, otherwise the booking might fail on the supplier side.

String(50)

Type

“adult” or “child”

String

Yes

Age

Mandatory in case the passenger’s type is ”child”. The value must be between 0 and 17 and match one of the KigsAges array’s values.

Integer

LeadPaxRoomId

Id from Rooms array. Identifies the room of the LeadPassenger

GUID

Yes

Language

Only “en” is currently supported

String

Yes

RoomsRemarks

Free text remarks to be sent to the supplier within booking. Collection of "Key" : "Value” pairs, where Key is room Id from the Rooms array. Only suppliers that support this feature will receive the remarks.

InternalAgentRef1

Agent reference of the booking

String

PointOfSale

Defines the sales environment. Possible values:

• “web” - rates that are available to be sold through desktop websites,
• ”mobileapp” - rates that are available to be sold through mobile apps/websites,
• ”cug” - Closed User Group. Discounted rates which are sold to ‘members-only’ groups,
• ”b2b” - rates which are intended to be sold by travel agents, operating under a B2B booking engine. Suppliers forbid selling B2B rates in B2C channels.

String