header

object

Yes

 /

 /

@sourceId

string

Yes

maxLength: 32

id of hotel's source in DerbySoft's system

HHBIJSOPLS

@distributorId

string

Yes

maxLength: 32

id of distributor in DerbySoft'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

reservations

 /

Yes

 /

 /

@distributorResId

string

Yes

Reservation id in distributor's system

C2084DFL0

@derbyResId

string

Yes

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

D15F893D34DF

@supplierResId

string

No

reservation id in supplier's system

89389494

iata

string 

No

IATA

 /

hotelId

string

Yes

hotel id in supplier's system

100001

stayRange

object

Yes

 /

 /

@checkin

string

Yes

check-in, format with yyyy-MM-dd

2018-01-01

@checkout

string

Yes

checkout, format with yyyy-MM-dd

2018-01-04

contactperson

object

Yes

 /

 /

@firstName

string

Yes

First Name

James

@lastName

string

Yes

Last Name

Bond

@email

string

No

Email

[email protected]

@phone

string

No

 /

 /

@address

string

No

 /

 /

@extensions

object

No

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

{ "key": "value"}

roomCriteria

object

Yes

 /

 /

@roomCount

integer

Yes

total room count per request

 /

@adultCount

integer

Yes

adult count per room

 /

@childCount

integer

No

child count per room

 /

@childAges

integer

No

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

 /

total

object

Yes

 /

 /

@amountBeforeTax

number

No

 /

640

@amountAfterTax

number

No

 /

700

payment

object

No

 /

 /

@cardCode

string

Yes

VI, MC, AX, etc.

Card Code

VI

@cardNumber

string

Yes

Credit card number

4111111111111111

@cardHolderName

string

Yes

Cardholder name

Sherlock Holmes

@expireDate

string

Yes

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

0119

Card verification value

loyalty account

object

No

 /

 /

@programCode

string

Yes

Loyalty program code of the supplier

BW

@accountId

string

Yes

Loyalty program account id

1234567890123457

corpAccount

object

No

 /

 /

@corpProgramCode

string

Yes

Corporate Hotel Program of hotel supplier

CR

@corpId

string

Yes

Corporate id in the program account

A-1232

promoteCode

string

No

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

 /

guests

 /

 /

 /

 /

@firstName

string

Yes

First Name

James

@lastName

string

Yes

Last Name

Bond

@email

string

No

Email

[email protected]

@phone

string

No

 /

 /

@address

string

No

 /

 /

@age

integer

No

age of guest

 /

Birthday of guest

format with yyyy-MM-dd

@type

string

No

type of guest, Adult, Child or Infant

Enum: [ Adult, Child, Infant ]

 /

@extensions

object

No

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

{ "key": "value"}

@index

integer

No

room index of room rate

1

comments

array[string]

No

 /

[ "no smoking", "high floor" ]

roomRates

array[object]

Yes

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

Yes

room id in supplier's system

10000101

@rateId

string

Yes

rate id in supplier's system

123456

@currency

string

Yes

currency code[ISO-4217]

USD

@amountBeforeTax

array[number]

No

the daily amount of rate without tax & fee

[ 100, 100, 120 ]

@amountAfterTax

array[number]

No

the daily amount of rate with tax & fee

[ 110, 110, 130 ]

@mealPlan

string

No

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

RO

@paymentType

enum

No

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

PayNow

roomRates / guarantee

object

No

Guarantee information for this room rate.

 /

@guaranteeType

string

Yes

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

CCG

roomRates / fees

array[object]

No

fee or tax by date range.

 /

fees / 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

fees/fee

 /

Yes

 /

 /

@name

string

Yes

pattern: \w[\w\d]+

Service Charge

@type

enum

Yes

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

Enum: [ Inclusive, Exclusive ]

Exclusive

@amount

number

Yes

amount value of fee or tax

10

@amountType

string

Yes

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

Enum: [ Fix, Percent ]

Percent

@chargeType

string

Yes

Enum: [ PerRoomPerNight, PerPersonPerNight, PerRoomPerStay, PerPersonPerStay ]

PerRoomPerNight

@paymentType

enum

No

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

Enum: [ PayLater, PayNow ]

PayNow

roomRates / cancelPolicy

object

No

Cancellation policy defines what penalty will be charged when a guest cancels the booking in 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

No

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

 /

threeDomainSecurity

object

No

 /

 /

@cavv

string

No

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

 /

@eci

string

No

The electronic commerce indicator.

 /

@xid

string

No

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

@threeDomainSecurityVersion

string

No

Include this only for 3D Secure 2.

 /

@transactionId

string

No

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

 /

@merchantName

string

No

Identifier of the merchant completing the 3DS transaction.

 /

@extensions

object

No

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

 /

reservationIds

object

Yes

 /

100001

@distributorResId

string

Yes

reservation id in distributor's system

C2084DFL0

@derbyResId

string

Yes

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

D15F893D34DF

@supplierResId

string

Yes

reservation id in supplier's system

89389494

iata

string

No

 /

 /

hotelId

string

Yes

hotel id in supplier’s system

100001

stayRange

object

Yes

 /

 /

@checkin

string

Yes

checkin, format with yyyy-MM-dd

2018-01-01

@checkout

string

Yes

checkout, format with yyyy-MM-dd

2018-01-04

contactPerson

object

Yes

 /

 /

@firstName

string

Yes

First Name

James

@lastName

string

Yes

Last Name

Bond

@email

string

No

Email

[email protected]

@phone

string

No

 /

 /

@address

string

No

 /

 /

@age

integer

No

age of guest

 /

@type

string

No

type of guest, Adult, Child or Infant

Enum: [ Adult, Child, Infant ]

 /

@extensions

ojbect

No

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

{ "key": "value"}

@index

integer

No

room index of room rate

1

roomCriteria

object

Yes

 /

 /

@roomCount

integer

Yes

total room count per request

 /

@adultCount

integer

Yes

adult count per room

 /

@childCount

integer

No

child count per room

 /

@childAges

integer

No

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

 /

total

object

Yes

 /

 /

@amountBeforeTax

number

No

 /

640

@amountAfterTax

number

No

 /

700

distributorId

string

No

maxLength: 32

id of distributor in DerbySoft's system

GTA

status

enum

Yes

Enum: [ Confirmed, Modified, Cancelled ]

status of reservation

Confirmed - New reservation 

Modified -  Modification Reservation

Cancelled - Cancellation Reservation

Please combine the status and result fields to determine the reservation whether successful, combination examples are as follows:

Confirmed + Successful = Booking is successful

Confirmed + Failed = Booking is failed

Modified + Successful = Modification is successful

Modified + Failed = Modification is failed

Cancelled + Successful = Cancellation is successful

Cancelled + Failed = Cancellation is failed

 /

result

enum

Yes

Enum: [ Successful, Failed, Processing ]

status of the reservation to send to supplier

 /

cancellationId

string

No

cancel confirmation number in supplier's system

C89389494

errorMessage

string

No

error message

 /

sourceId

id of source in DerbySoft's system

Yes

string

PEGASUS

distributorId

id of distributor in DerbySoft's system

Yes

string

BOOKINGCOM

distributorResId

res id in distributor system

Yes

string

D15F893D34DF