header

object

Yes

 /

 /

@supplierId

string

Yes

MaxLength: 32

The ID of the hotel supplier in DerbySoft's system

HILTON

@distributorId

string

Yes

MaxLength: 32

The ID of the 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

hotelId

string

Yes

 Hotel ID in supplier's system

GATHI

stayRange

object

Yes

 /

 /

@checkin

string

Yes

Check-in, format with yyyy-MM-dd

2018-01-01

@checkout

string

Yes

Check out, format with yyyy-MM-dd

2018-01-04

roomCriteria

object

Yes

 /

 /

@roomCount

integer

Yes

Total room count per request

2

@adultCount

integer

Yes

Adult count per room

1

@childCount

integer

No

Child count per room

2

@childAges

array

No

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

[ 4, 8 ]

productCandidate

object

No

 /

 /

@roomId

string

No

Room ID in supplier system

K1D

@rateId

string

No

Rate ID in supplier system

ODAD01

iata

string

No

IATA of distributor

 /

roomRates

Yes

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

 /

@inventory

integer

Yes

Available inventory count according to request criteria

1

@isAfterPromotion

boolean

No

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

TRUE means to check the availability that is under the promotion rules provided by the supplier.

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

false

@promoteCode

string

No

the code for the promotion applied to this rate, It's required when isAfterPromotion = true.

discount001

@roomId

string

Yes

Room ID in supplier system

10000101

@rateId

string

Yes

Rate ID in supplier system

123456

Enum: [Exchange, Standard]

Indicates the connection type of product. 

Notes: If the field is omitted, it means the Connection Type is Standard.

Commission type

Enum: [percentage, amount]

@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 ]

rooomRates/suggestedTotalPrice

@mealPlan

string

No

For meal plan code, refer to the standard meal plan code list.

RO

@paymentType

enum

No

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

PayNow

roomRates/guarantee

object

No

Guarantee information for this room rate.

 /

@guaranteeType

string

Yes

The type of guarantee method, refer 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 the hotel (PayNow) or pay at the hotel (PayLater)

Enum: [ PayLater, PayNow ]

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

roomRates/cancelPolicy

object

No

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

 Yes

Max Length: 128

Code of cancel policy

AD100P_100P

@description

string

 No

Max Length: 1024

the description of the cancel policy

Non Refundable

cancelPolicy/cancelPenalties

Yes

Detail about the cancel Penalty

 /

@noShow

boolean

Yes

If true, it means the penaltyCharge applied for No-Show, and the cancellable, cancelDeadline will NOT exist.

 /

@cancellable

boolean

No

Indicates cancel is allowed or not. If false, it cannot be canceled. If true, the cancelDeadline will exist.

 /

cancelPenalties / cancelDeadline

 No

 /

 /

@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 time allowed for cancellation, like 4 PM, or 6 PM.

 /

cancelPenalties / penaltyCharge

 /

 /

 /

 /

@chargeBase

enum

No

Enum: [ FullStay, NightBase ]

if FullStay, it will be a percentage or amount, if NightBase, 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%.

 /

extensions

object

No

Optional: Additional agreed-upon attributes between suppliers and distributors (DerbySoft will provide the specified format). Please don't transmit sensitive information through this field. For more information refer to:

Sensitive Information

 /

header

object

Yes

 /

 /

@supplierId

string

Yes

Max Length: 32

The ID of hotel supplier in DerbySoft's system.

HILTON

@distributorId

string

Yes

Max Length: 32

The ID of the distributor in DerbySoft's system

GTA

@version

string

Yes

Max Length: 20

Version of API

v4

@token

string

Yes

Max Length: 64

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

18393849028490234

reservationIds

 /

Yes

 /

 /

@distributorResId

string

Yes

Distributor's reservation ID. Distributors should keep the ID unique on their system to avoid any potential issues caused by duplicate reservation IDs.

PS: If distributors don't generate reservation IDs during the stage, you can fill in a blank value in the request for the field like distributorResId="", but the null value doesn't be accepted since it's a mandatory field.

C2084DFL0

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

Check out, 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

 /

 /

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

array

No

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

 /

total

object

Yes

 /

 /

@amountBeforeTax

number

No

 abbr. ABT

It's required if AAT is not provided

640

@amountAfterTax

number

No

 abbr. AAT

It's required if ABT is not provided

700

payment

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, and 2 digits for the year, as "MMYY".

0119

Card verification value

loyaltyAccount

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

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

 /

guests

array[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 ]

 /

@index

integer

No

Indicate which guests will be allocated to which room.

For one room reservation, the room index is 1 for all guests.

For multi-room reservations, the index starts from 1 and the max room index is equal to the number of booked rooms.

index = 1, Indicate the guest will allocate to the first room.

index = 2, Indicate the guest will allocate to the second room.

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 the 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

abbr. ABT

The daily amount of rate without tax and fee

It's required if AAT is not provided

[ 100, 100, 120 ]

@amountAfterTax

array[number]

No

abbr. AT

The daily amount of rate with tax and fee

It's required if ABT is not provided

[ 110, 110, 130 ]

@mealPlan

string

No

Meal plan code, refer to the standard meal plan code list.

RO

@paymentType

enum

No

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

PayNow

roomRates/guarantee

object

No

Guarantee information for this room rate.

 /

@guaranteeType

string

Yes

The type of guarantee method, refer 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 the hotel (PayNow) or pay at the hotel (PayLater)

Enum: [ PayLater, PayNow ]

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.

 /

roomRates/cancelPolicy

object

No

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

 Yes

MaxLength: 128

code of cancel policy

AD100P_100P

@description

string

 No

MaxLength: 1024

the description of the cancel policy

Non Refundable

cancelPolicy/cancelPenalties

Yes

Detail about the cancel Penalty

/ 

@noShow

boolean

Yes

If true, it means the penaltyCharge applied for No-Show, and the cancellable, cancelDeadline will NOT exist.

 /

@cancellable

boolean

No

Indicates cancel is allowed or not. If false, it cannot be canceled. If true, the cancelDeadline will exist.

 /

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 allowed for cancellation, like
4 PM, 6 PM.

 /

cancelPenalties/penaltyCharge

 /

 /

 /

 /

@chargeBase

enum

No

Enum: [ FullStay, NightBase ]

if FullStay, it will be a percentage or amount, if NightBase, 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%

 /

extensions

object

No

Optional: Additional agreed-upon attributes between suppliers and distributors (DerbySoft will provide the specified format). Please don't transmit sensitive information through this field. For more information refer to:

Sensitive Information

 /