hotelId

string

Yes

Hotel ID in supplier's system

GATHI

hotelName

string

No

Hotel name in supplier's system

This is a test hotel

supplierId

string

Yes

Supplier ID in DerbySoft's system

 HILTON

status

enum

Yes

Enum: [ Actived, Deactived ]

Status in supplier's system

Actived

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.

Waldorf

longitude

string

No

The information for hotel location.

41.40338

latitude

string

No

The information for hotel location.

2.17403

city

string

No

 /

 /

country

string

No

 /

 /

state

string

No

 /

 /

address

array

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

No

An additional field is used for transmitting extra settings, accounts, etc that are required by Distributors

{

    "key": "value"

}

extensions

It is used to provide the rate cluster information for Marriott properties. This additional field will consist of a cluster code and its corresponding rate plan IDs. It is optional but available to all distributors connecting to Marriott who wish to receive rate cluster indicators.

{

    "key1": "value1",

    "key2": "value2"

 }

ariType

enum

Yes

Emun:[ Daily, LOS ]

Indicates which ARI model be used for ARI API

Daily

timezone

string

Yes

Timezone of property

America/Los_Angeles

rateType

enum

Yes

Emun:[ AmountBeforeTax, AmountAfterTax, Both ]

Indicates which rate will be used in ARI and Reservation.

• AmountBeforeTax: only AmountBeforeTax is pushed out to distributors, and only AmountBeforeTax is sent back to the supplier.
• AmountAfterTax: only AmountAfterTax is pushed out to distributors, and only AmountAfterTax is sent back to the supplier.
• Both: AmountBeforeTax & AmountAfterTax will be pushed to Distributors.

AmountBeforeTax

maxChildAge

integer

No

maxChildAge will be provided If childRateType is ByAge.

 /

childRateType

enum

No

Enum: [ Normal, ByAge, Free, AsAdult ]

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

• Normal: This is the default option, hotels provide rates for a combination of adults and children.
• ByAge: Hotels provide extra child pricing based on age bands, maxChildAge field will be provided as well as extraChildRates nodes will be provided in ARI.
• Free: Hotels indicate children as free of charge to stay, maxChildAge may be provided.
• AsAdult: Hotels indicate children will be charged the same rate as adults for their stay.

ByAge

products

array

Yes

 /

 /

@roomId

string

Yes

Room ID in supplier's system

King

@rateId

string

Yes

Rate ID in supplier's system

BAR

@stayType

enum

No

Enum: [ OverNightRoom, DayUseRoom ]

This tag indicates if the product is specifically for day-use or regular overnight use. The default is OverNightRoom.

OverNightRoom

@status

enum

Yes

Enum: [ Actived, Deactived ]

Actived

@roomName

string

No

Room type name

Max length: 256

King Room

@roomDescription

string

No

 /

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

@rateName

string

No

Rate plan name

Max length: 256

Best Available Rate

@rateDescription

string

No

 /

Begin your day with a hearty meal

products/occupancy

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

 /

No

 /

 /

@guaranteeType

string

Yes

Guarantee information for this room rate.
The type of guarantee method, refers to the standard guarantee type list.

CCG

products/cancelPolicies

 /

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

Code of cancel policy

Max Length: 128

AD100P_100P

@description

string

No

The description of the cancellation policy

Max Length: 1024

Non Refundable

cancelPolicy/cancelPenalties

 /

Yes

Detail about the cancellation Penalty

 /

@noShow

boolean

Yes

If true, it means the penalty charge is applied for No-Show, and the cancellable and cancelDeadline nodes won't appear.

 /

@cancellable

boolean

No

Indicates if cancellation is allowed or not. If false, it cannot be canceled. If true, the cancelDeadline node will appear.

 /

cancelPenalties / cancelDeadline

 /

 /

 /

 /

@offsetTimeDropType

enum

No

Enum: [ BeforeArrival ]

An enumerated type indicates when the deadline drop time goes into effect.

 /

@offsetTimeUnit

enum

No

Enum: [ D, H ]

 /

@offsetTimeValue

number

No

The number of offset times with the time unit.

 /

@deadline

string

No

Local deadline times allowed for cancellation, like 4 PM, 6 PM

 /

cancelPenalties/ penaltyCharge

 /

Yes

 /

 /

@chargeBase

enum

No

Enum: [ FullStay, NightBase ]

if FullStay, it will be a percentage or amount, if NightBased, the nights are required.

 /

@nights

number

No

Exists if the penalty charge is based on the night, like the first night

 /

@amount

number

No

Exists if the penalty charge is a flat charge, like USD 30.00

 /

@percent

number

No

Exists if the penalty charge is percent, like 15.5 means 15.5%

 /

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 the fee or tax

Service Charge

@type

enum

Yes

Enum: [ Inclusive, Exclusive ]

Indicates fees 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: [ PayLater, PayNow ]
Indicates if the fee is prepaid to hotels(PayNow) or paid at the hotel(PayLater).

PayNow

 @effectivePerson

 number

 No

It indicates the fee will be charged starting from which occupancy, such as the "Extra Person Charge" fee. The EffectivePerson is 3, meaning an extra fee will be applied from the third person onward.

3