hotelId

string

Yes

1. Digits (0-9) 

2. Uppercase letters (A-Z) 

3. Hyphen ('-')

100001
NYABO
00016
PEP-B3T2
B8W7

hotelName

string

No

Hotel name

This is a test hotel

distributorId

string

Yes

Distributor ID in DerbySoft's system

GTA

status

enum

Yes

Enum: [ Actived, Deactived ]

Status in supplier's system

Actived

- ISO 639-1 (2-Letter) Codes: For example, "en" (English), "zh" (Chinese), or "fr" (Franch).

- Combined Codes: A 2-letter ISO 639 language code followed by a hyphen and a 2-letter ISO 3166 country code (e.g., "en-US", "zh-CN", or "fr-FR").

"hotelI18n": {

  "en-US": {

    "hotelName": "Best Western Plus Yacht Harbor Inn",

    "address": [

      "150 Marina Plz"

    ],

    "country": "US",

    "state": "FL",

    "city": "Dunedin"

  }

}

[ "AddressLine1", "AddressLine2", "AddressLine3", "AddressLine4", "AddressLine5" ]

chainCode

string

No

The chain code may identify a hotel chain or management group, e.g. Hyatt, Hilton. The hotel chain code is decided between suppliers and is optional if the hotel is an independent property that can be identified by the hotelId field alone.

Marriott

brandCode

string

No

The brand code may identify the brand within a chain, e.g. Courtyard, Hampton Inn. This field is optional if the hotel is an independent property that can be identified by the hotelId field alone.

Courtyard

longitude

string

No

The information for hotel location.

41.40338

latitude

string

No

The information for hotel location.

2.17403

city

string

No

The information for hotel location.

country

string

No

The information for hotel location.

state

string

No

The information for hotel location.

The currency code of the hotel.

address

array[string]

No

Support up to five enumeration values

[ "AddressLine1", "AddressLine2", "AddressLine3", "AddressLine4", "AddressLine5" ]

phone

object

No

/

/

@countryAccessCode

string

Yes

/

/

@areaCityCode

string

No

/ 

/ 

@phoneNumber

string

Yes

/ 

/

settings

object

Yes

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

"settings": {
"key1": "value1",
"key2": "value2"
}

ariType

enum

Yes

Emun:[ Daily, LOS ]

Indicates which ARI model to be used for ARI API.

Daily

timezone

string

Yes

Timezone of property

America/Los_Angeles

rateType

enum

Yes

Enum: [ AmountBeforeTax, AmountAfterTax, Both ]

• AmountBeforeTax: only AmountBeforeTax be pushed out to distributors, and only AmountBeforeTax be sent back to the supplier.
• AmountAfterTax: only AmountAfterTax be pushed out to distributors, and only AmountAfterTax be sent back to the supplier.
• Both: both of AmountBeforeTax & AmountAfterTax are to be pushed out to distributors, and both AmountBeforeTax & AmountAfterTax be sent back to suppliers.

Both

maxChildAge

integer

No

If childRateType is set as ByAge, max child age must be provided and greater than zero.

17

childRateType

enum

No

Enum: [ Normal, ByAge, Free, AsAdult ]

Indicates which child rate type will be used in ARI OccupancyRate.

• Normal: by default, occupancy rate is combined by adult rate and child rate without age settings.
• ByAge: the child will be charged by age, maxChildAge must be provided, and extraChildRates should be provided in ARI.
• Free: the child is free, maxChildAge may be provided.
• AsAdult: the child will be charged as an adult.

ByAge

products

array[object]

Yes

 /

 /

- ISO 639-1 (2-Letter) Codes: For example, "en" (English), "zh" (Chinese), or "fr" (Franch).

- Combined Codes: A 2-letter ISO 639 language code followed by a hyphen and a 2-letter ISO 3166 country code (e.g., "en-US", "zh-CN", or "fr-FR").

"roomTypeI18n": {

  "en": {

    "name": "Deluxe Room",

    "description": "Spacious room with city view"

  },

  "zh-CN": {

    "name": "豪华房",

    "description": "宽敞的房间，可欣赏城市景观"

  }

}

- ISO 639-1 (2-Letter) Codes: For example, "en" (English), "zh" (Chinese), or "fr" (Franch).

- Combined Codes: A 2-letter ISO 639 language code followed by a hyphen and a 2-letter ISO 3166 country code (e.g., "en-US", "zh-CN", or "fr-FR").

"ratePlanI18n": {

  "en": {

    "name": "Standard Rate",

    "description": "Best available rate with breakfast included"

  },

  "zh-CN": {

    "name": "标准房价",

    "description": "最优可用房价，含早餐"

  }

}

@roomId

string

Yes

Room ID in supplier's system

10000101

@roomDescription

string

No

 /

Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.

@rateId

string

Yes

Rate ID in supplier's system

123456

@rateDescription

string

No

 /

Begin your day with a hearty meal.

@stayType

enum

No

Enum: [ OverNightRoom, DayUseRoom ]

 Indicates if the product is specifically for day-use or regular overnight use. The default value is OverNightRoom.

OverNightRoom

@status

enum

Yes

Enum: [ Actived, Deactived ]

Actived

@roomName

string

No

Room type name

Double Room

@rateName

string

No

Rate plan name

Best Available Rate

products/occupancy

object

Yes

 /

 /

@maxAdult

integer

Yes

Max adult count

3

@maxChild

integer

Yes

Max child count

2

@maxOccupancy

integer

Yes

Max occupancy

3

@paymentType

enum

No

Enum: [ PayLater, PayNow ]

Indicates the product is prepaid to the hotel(PayNow) or pay at the hotel(PayLater)

PayNow

products/guarantee

object

No

 /

 /

@guaranteeType

string

Yes

Guarantee information for this room rate.
Appendix: Guarantee Type

CCG

products/cancelPolicies

array[object]

No

 /

 /

cancelPolicies/dateRange

object

No

 /

 /

@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

cancelPolicies/cancelPolicy

object

No

 /

 /

@code

string

Yes

Cancel policy

maxLength: 128

AD100P_100P

@description

string

No

The description of the cancellation policy

maxLength: 1024

Non Refundable

{

  "fr-FR": { "description": "Non Refundable" },

  "zh-CN": { "description": "不可退款" }

}

products/fees

 /

No

 /

 /

fees/dateRange

 /

No

 /

 /

@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

fees/fee

object

No

 /

 /

@name

string

Yes

The name of fee or tax

Service Charge

@type

enum

Yes

Enum: [ Inclusive, Exclusive ]

The fee or tax is included in the amount before tax or not.

Exclusive

@amount

number

Yes

Amount value of fee or tax

10

@amountType

enum

Yes

Enum: [ Fix, Percent ]

Indicates how to charge the tax, 10% per room per night in this example.

Percent

@chargeType

enum

Yes

Enum: [ PerRoomPerNight, PerPersonPerNight, PerRoomPerStay, PerPersonPerStay ]

PerRoomPerNight

@paymentType

enum

No

Enum: [Distributor, Property]

Indicates that the fee (e.g., City Tax, Tourist Tax) should be collected by the hotel(Property) at check-in or by distributors when guests make a reservation(Distributor).

Note:

The 'paymentType' field will be replaced by 'collectBy' and removed from the API in the future.

PayNow

Enum: [Distributor, Property]

Indicates that the fee (e.g., City Tax, Tourist Tax) should be collected by the hotel(Property) at check-in or by distributors when guests make a reservation(Distributor).

Localized fee names keyed by BCP 47 locale tags (e.g. fr-FR, zh-CN); keys are not fixed.

{

  "fr-FR": { "name": "Frais de resort" },

  "zh-CN": { "name": "度假村费" }

}