header

Object

Y

 /

 /

@sourceId

String

Y

maxLength: 32

id of hotel's source in DerbySoft's system

HHBIJSOPLS

@distributorId

String

Y

maxLength: 32

id of distributor in DerbySoft's system

HOTELBEDS

@version

String

Y

maxLength: 20

version of API

v4

@token

String 

Y

maxLength: 64

A unique id to identify requests and responses, normally it should be UUID.

18393849028490234

hotelId

String

Y

 /

100001

stayRange

Object

Y

 /

 /

@checkin

String

Y

check-in, format with yyyy-MM-dd

2018-01-01

@checkout

String

Y

checkout, format with yyyy-MM-dd

2018-01-04

roomCriteria

Object

Y

 /

 /

@roomCount

Integer

Y

total room count per request

2

@adultCount

Integer

Y

adult count per room

1

@childCount

Integer

N

child count per room

2

@childAges

Integer

N

Child ages for each child, array size MUST be same as child count.

[ 4, 8 ]

productCandidate

Object

N

 /

 /

@roomId

String

N

room id in supplier's system

K1D

@rateId

String

N

rate id in supplier's system

ODAD01

IATA

String 

N

IATA of distributor

 /

roomRates

Array[Object]

Y

Meal plan, fee, and cancel policy are optional fields as some distributors do not support these in API.

 /

@inventory

Integer

Y

available inventory count according to request criteria

1

@isAfterPromotion

Boolean

N

The flag indicates calculating the avail room rates with the promotion rules or not. Default is false if null.

• True means to check the availability is under the promotion rules provided by the Supplier.

• False means do not need to check the availability under any promotions, basic live-check only.

false

@promoteCode

String

N

The code for the promotion applied to this rate, it is required when isAfterPromotion=true.

discount001

@roomId

String

Y

room id in supplier's system

10000101

@rateId

String

Y

rate id in supplier's system

123456

@currency

String

Y

currency code[ISO-4217]

USD

@amountBeforeTax

Array[Number]

N

the daily amount of rate without tax&fee

[ 100, 100, 120 ]

@amountAfterTax

Array[Number]

N

the daily amount of rate with tax&fee

[ 110, 110, 130 ]

@mealPlan

String

N

meal plan code, ref to the standard meal plan code list

RO

@paymentType

Enum

N

indicates the product is prepaid to the hotel(PayNow) or pay at a hotel(PayLater)
Enum: [ PayLater, PayNow ]

PayNow

roomRates / guarantee

Object

N

Guarantee information for this room rate.

 /

@guaranteeType

String

Y

The type of guarantee method, ref to the standard guarantee type list.

CCG

roomRates / fees

Array[Object]

N

fee or tax by date range.

 /

fees / dateRange

Object

Y

 /

 /

@startDate

String

Y

start date of date range, format with yyyy-MM-dd

2018-01-01

@endDate

String

Y

end date of date range, format with yyyy-MM-dd

2018-01-04

fees/fee

Y

 /

 /

@name

String

Y

pattern: \w[\w\d]+

Service Charge

@type

Enum

Y

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

Enum: [ Inclusive, Exclusive ]

Exclusive

@amount

Number

Y

amount value of fee or tax

10

@amountType

String

Y

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

Enum: [ Fix, Percent ]

Percent

@chargeType

String

Y

Enum: [ PerRoomPerNight, PerPersonPerNight, PerRoomPerStay, PerPersonPerStay ]

PerRoomPerNight

@paymentType

Enum

N

Indicates the fee is prepaid to hotels (PayNow) or Pay at Hotel(PayLater).

Enum: [ PayLater, PayNow ]

PayNow

roomRates / cancelPolicy

Object

N

Cancellation policy defines what penalty will be charged when a guest cancels the booking at a certain advance time range. The penalty is related to no show or a time range before no show.

 /

@code

String

Y

maxLength: 128

code of cancel policy

AD100P_100P

@description

String

N

maxLength: 1024

cancel policy description

Non Refundable

extensions

Object

N

{

    "key1": "value1",

    "key2": "value2"

}

header

Object

Y

 /

 /

@sourceId

String

Y

maxLength: 32

id of hotel's source in DerbySoft's system

HHBIJSOPLS

@distributorId

String

Y

maxLength: 32

id of distributor in DerbySoft's system

HOTELBEDS

@version

String

Y

maxLength: 20

version of API

v4

@token

String 

Y

maxLength: 64

a unique id to identify request and response, normally it should be UUID

18393849028490234

reservationIds

 /

Y

 /

 /

@distributorResId

String

Y

reservation id in distributor's system

C2084DFL0

@derbyResId

String

Y

Reservation id in Derbysoft's system, this is a unique id as DerbySoft would be splitting the reservation.

D15F893D34DF

IATA

String 

N

IATA

 /

hotelId

String

Y

hotel id in supplier's system

100001

stayRange

Object

Y

 /

 /

@checkin

String

Y

check-in, format with yyyy-MM-dd

2018-01-01

@checkout

String

Y

checkout, format with yyyy-MM-dd

2018-01-04

contactPerson

Object

Y

 /

 /

@firstName

String

Y

First Name

James

@lastName

String

Y

Last Name

Bond

@email

String

N

Email

007@james.com

@phone

String

N

 /

 /

@address

String

N

 /

 /

@extensions

Object

N

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

{ "key": "value"}

roomCriteria

Object

Y

 /

 /

@roomCount

Integer

Y

total room count per request

 /

@adultCount

Integer

Y

adult count per room

 /

@childCount

Integer

N

child count per room

 /

@childAges

Integer

N

child ages for each child, array size MUST be same as child count.

 /

total

Object

Y

 /

 /

@amountBeforeTax

Number

N

 /

640

@amountAfterTax

Number

N

 /

700

payment

Object

N

 /

 /

@cardCode

String

Y

VI, MC, AX etc.

Card Code

VI

@cardNumber

String

Y

Credit card number

4111111111111111

@cardHolderName

String

Y

Cardholder name

Sherlock Holmes

@expireDate

String

Y

it should be 2 digits for month, 2 digits for year, as "MMYY".

0119

loyaltyAccount

Object

N

 /

 /

@programCode

String

Y

Loyalty program code of the supplier

BW

@accountId

String

Y

Loyalty program account id

1234567890123457

corpAccount

Object

N

 /

 /

@corpProgramCode

String

Y

Corporate Hotel Program of hotel supplier

CR

@corpId

String

Y

Corporate id in the program account

A-1232

promoteCode

String

N

Promotion code defined by hotel, the promotion code is required if making a reservation under the promotion.

 /

guests

 /

 /

 /

 /

@firstName

String

Y

First Name

James

@lastName

String

Y

Last Name

Bond

@email

String

N

Email

007@james.com

@phone

String

N

 /

 /

@address

String

N

 /

 /

@age

Integer

N

Age of guest

 /

@gender

Enum

N

Gender of guest

Male

@birthday

String

N

Birthday of guest
format with yyyy-MM-dd

1970-12-20

@type

String

N

type of guest, Adult, Child or Infant

Enum: [ Adult, Child, Infant ]

 /

@extensions

Object

N

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

{ "key": "value"}

@index

Integer

N

room index of room rate

1

comments

Array[String]

N

 /

[ "no smoking", "high floor" ]

roomRates

Array[Object]

Y

min Items: 1 max items: 1

Meal plan, fee, and cancel policy are optional fields as some distributors do not support these in API.

 /

@roomId

String

Y

room id in supplier's system

10000101

@rateId

String

Y

rate id in supplier's system

123456

@currency

String

Y

currency code[ISO-4217]

USD

@amountBeforeTax

Array[Number]

N

the daily amount of rate without tax & fee

[ 100, 100, 120 ]

@amountAfterTax

Array[Number]

N

the daily amount of rate with tax & fee

[ 110, 110, 130 ]

@mealPlan

String

N

meal plan code, ref to the standard meal plan code list

RO

@paymentType

Enum

N

indicates the product is prepaid to hotels (PayNow) or pay at hotels (PayLater)
Enum: [ PayLater, PayNow ]

PayNow

roomRates/guarantee

Object

N

Guarantee information for this room rate.

 /

@guaranteeType

String

Y

The type of guarantee method, ref to the standard guarantee type list.

CCG

roomRates/fees

Array[Object]

N

fee or tax by date range

 /

fees/dateRange

Object

Y

 /

 /

@startDate

String

Y

start date of date range, format with yyyy-MM-dd

2018-01-01

@endDate

String

Y

end date of date range, format with yyyy-MM-dd

2018-01-04

fees/fee

 /

Y

 /

 /

@name

String

Y

pattern: \w[\w\d]+

Service Charge

@type

Enum

Y

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

Enum: [ Inclusive, Exclusive ]

Exclusive

@amount

Number

Y

amount value of fee or tax

10

@amountType

String

Y

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

Enum: [ Fix, Percent ]

Percent

@chargeType

String

Y

Enum: [ PerRoomPerNight, PerPersonPerNight, PerRoomPerStay, PerPersonPerStay ]

PerRoomPerNight

@paymentType

Enum

N

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

Enum: [ PayLater, PayNow ]

PayNow

roomRates/cancelPolicy

Object

N

Cancellation policy defines what penalty will be charged when a guest cancels the booking at a certain advance time range. The penalty is related to no show or a time range before no show.

 /

@code

String

 /

maxLength: 128

code of cancel policy

AD100P_100P

@description

String

 /

maxLength: 1024

the description of the cancel policy

Non Refundable

extensions

Object

N

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

 /

threeDomainSecurity

Object

N

 /

 /

@cavv

String

N

Cardholder Authentication Verification Value Information retrieved from the 3DS provider when authentication is successful.

 /

@eci

String

N

The electronic commerce indicator.

 /

@xid

String

N

Transaction identifier for a 3DS Version 1 provider, assigned by the Directory Server to identify a single transaction.

 /

@threeDomainSecurityVersion

String

N

Include this only for 3D Secure 2.

 /

@transactionId

String

N

Transaction identifier for a 3DS Version 2 provider, assigned by the Directory Server to identify a single transaction.

 /

@merchantName

String

N

Identifier of the merchant completing the 3DS transaction.

 /

@extensions

Object

N

a common extension object for extra attributes like account, extra setting required by distributors, etc

 /

MaxLength: 32

The ID of hotels source in DerbySoft's system

MaxLength: 32

ID of distributor in DerbySoft's system

MaxLength: 20

Version of API

MaxLength: 64

A unique id to identify request and response, normally it should be UUID.

Reservation id in distributor's system

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