header

object

Y

 /

 /

@supplierId

string

Y

The ID of the hotel's source is in DerbySoft's system.

Max Length: 32

HILTON

@distributorId

string

Y

The ID of the distributor in DerbySoft's system

MaxLength: 32

GTA

@version

string

Y

Max Length: 20

Version of API

v4

@token

string

Y

A unique identifier is used for requests and responses, typically a UUID. MaxLength: 64

 Note that this is an echo token, not an access token.

18393849028490234

reservationIds

object

Y

 /

 /

@distributorResId

string

Y

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

C2084DFL0

@derbyResId

string

Y

Reservation ID in DerbySoft's system, it's a unique ID as DerbySoft would be splitting the reservation 

D15F893D34DF

@supplierResId

string

Y

Reservation ID in supplier's system

89389494

iata

string

N

IATA

 /

hotelId

string

Y

Hotel IDs provided by hotel suppliers, only the following characters are allowed.

1. Digits (0-9) 

2. Uppercase letters (A-Z) 

3. Hyphen ('-')

100001

GATHI

00016

PEP-B3T2

B8W7

stayRange

object

Y

 /

 /

@checkin

string

Y

Check in date expressed YYYY-MM-DD

2028-01-01

@checkout

string

Y

Check out date expressed YYYY-MM-DD

2028-01-04

contactPerson

object

Y

 /

 /

@firstName

string

Y

Contact person first name

James/

@lastName

string

Y

Contact person last name

Bond

@email

string

N

Contact person email

007@james.com

@phone

string

N

Contact person phone number including country code

34123456789

@address

string

N

Contact person home address

King's Road in Chelsea, specifically in Wellington Square

@extensions

object

N

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

{ "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

array

N

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

 /

total

object

Y

Object used to share the total amount of the reservation, either ABT or AAT, or both

 /

@amountBeforeTax

number

C

ABT, mandatory if AAT is not provided.

The total room rate for the entire reservation, not including taxes and fees.

640

@amountAfterTax

number

C

AAT, mandatory if ABT is not provided.

The total room rate for the entire reservation, including taxes and fees.

700

payment

object

N

It is used to share payment information with properties.

If the credit card information is not going to be passed to the property, this information will be ignored.

 /

If the payment card type is not specified, it will be treated as the default value "CC" which stands for Credit Card. The type value can be one of the options listed below.
CC: Credit Card
VCC: Virtual Credit Card
CBILL: Central Bill

@cardCode

string

Y

VI, MC, AX, etc.

Refer to Appendix: Credit 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, expressed 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

Please note that the current feature will be deprecated. Instead, please implement the 'corpCodes' node.

 /

@corpProgramCode

string

Y

Corporate Hotel Program of hotel supplier

CR

@corpId

string

Y

Corporate ID in the program account

A-1232

promoteCode

string

N

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

 /

guests

array[object]

Y

 /

 /

@firstName

string

Y

Guest First Name

James

@lastName

string

Y

Guest Last Name

Bond

@email

string

N

Guest Email

007@james.com

@phone

string

N

Guest phone number including country code

34123456789

@address

string

N

Guest home address

King's Road in Chelsea, specifically in Wellington Square

@age

integer

N

Age of guest

 /

@type

string

N

Type of guest: Adult, Child, or Infant.

Enum: [ Adult, Child, Infant ]

 /

@extensions

object

N

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

{ "key": "value"}

@index

integer

N

Indicate which guests will be allocated to which room.

For a 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]

N

Any preference or comment can be communicated in this field

[ "no smoking", "high floor" ]

roomRates

array[object]

Y

Min Item: 1; Max Item: 1

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

 /

@roomId

string

Y

Room ID in supplier system

10000101

@rateId

string

Y

Rate ID in supplier system

123456

@currency

string

Y

currency code [ISO-4217]

USD

@amountBeforeTax

array[number]

N

ABT, mandatory if AAT is not provided

The daily amount rate without tax and fee

[ 100, 100, 120 ]

@amountAfterTax

array[number]

C

AAT, mandatory if ABT is not provided

The daily amount of rate with tax and fee

[ 110, 110, 130 ]

@mealPlan

string

N

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

RO

@paymentType

enum

N

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

PayNow

guarantee

object

N

Guarantee information for this room rate

 /

@guaranteeType

string

Y

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

CCG

fees

array[object]

N

Fee or tax by date range

 /

dateRange

object

Y

 /

 /

@startDate

string

Y

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

2028-01-01

@endDate

string

Y

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

2028-01-04

fee

Y

 /

 /

@name

string

Y

pattern: \w[\w\d]+ starts with a word character (letter, number, or underscore) followed by one or more word characters or digits.

Service Charge

@type

enum

Y

Whether 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

Enum: [ PayLater, PayNow ]

Indicates if the fee is prepaid to hotels(PayNow) or paid at the hotel(PayLater). 

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).

cancelPolicy

object

N

The 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

 C

Code of cancellation policy

AD100P_100P

@description

string

 N

The description of the cancel policy

Non Refundable

cancelPenalties

array[object]

C

Details about the cancel Penalty

 /

@noShow

boolean

C

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

 /

@cancellable

boolean

N

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

 /

cancelDeadline

 object

N

Object for cancel deadline

 /

@offsetTimeDropType

enum

N

Enum: [ BeforeArrival ]

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

 /

@offsetTimeUnit

enum

N

Enum: [ D, H ]

 /

@offsetTimeValue

number

N

The number of offset times with the time unit

 /

@deadline

string

N

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

 /

penaltyCharge

object

N

 /

 /

@chargeBase

enum

N

Enum: [ FullStay, NightBase ]

If FullStay, it will be a percentage or an amount. If NightBase, the nights are required.

 /

@nights

number

N

It exists if the penalty charge is based on the night, like the first night.

 /

@amount

number

N

It exists if the penalty charge is a flat charge, like USD 30.00.

 /

@percent

number

N

It exists if the penalty charge is a percent, like 15.5 means 15.5%.

 /

 /

Corporate code in Distributor's system

Note: 

This field is primarily used by Travel Management Companies (TMCs) distributors.

threeDomainSecurity

object

N

 /

 /

@cavv

string

N

Cardholder Authentication Verification Value Information is 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

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

 /