reservationIds

Object[reservationIds]

Mandatory

reservationIds/distributorResId

String

Mandatory

Reservation id in distributor’s system.

reservationIds/derbyResId

String

Mandatory

Reservation id in derbysoft system, this is an unqiue id as DerbySoft would do splitting reservation.

reservationIds/supplierResId

String

Mandatory

Reservation id in PMS.

distributorId

String

Mandatory

Id of distributor in DerbySoft’s system

You can find full list of all distributor ids in the console.

iata

String

Optional

IATA of distributor

hotelId

String

Mandatory

Hotel unique id of PMS

stayRange

Object[stayRange]

Mandatory

stayRange/checkin

Date:yyyy-MM-dd

Mandatory

Checkin

stayRange/checkout

Date:yyyy-MM-dd

Mandatory

Checkout

contactPerson

Object[contactPerson]

Mandatory

contactPerson/firstName

String

Mandatory

First Name of Contact

This is the original names from distributors, which could be non-latin characters

contactPerson/lastName

String

Mandatory

Last Name of Contact

contactPerson/firstNameRoma

String

Optional

First Name of Contact in Latin characters

DerbySoft Property Connect will translate the non-Latin characters into Latin characters in case your PMS doesn’t support

contactPerson/lastNameRoma

String

Optional

First Name of Contact in Latin characters

contactPerson/email

String

Optional

Email of Contact

contactPerson/phone

String

Optional

Phone of Contact

contactPerson/address

String

Optional

Address of Contact

roomCriteria

Object[roomCriteria]

Mandatory

roomCriteria/roomCount

Integer

Mandatory

Room count to be booked

DerbySoft Property Connect will split the reservation into single room ones by default, so that the acutal stay status can be delivered back easily in the future. But you can ask us to disable the splitting if your PMS can handle them well.

roomCriteria/adultCount

Integer

Mandatory

Adult count

roomCriteria/childCount

Integer

Optional

Child count

roomCriteria/childAges

List[Integer]

Optional

Ages of each guests

total

Object[total]

Mandatory

Total rate

total/amountBeforeTax

BigDecimal

Optional

Total rate without tax & fee

total/amountAfterTax

BigDecimal

Optional

Total rate with tax & fee

payment

Object[payment]

Optional

This could be empty if your PMS doesn’t compliance with PCI-DSS, or no payment provided by distributors

payment/cardCode

Enum:

• VI: Visa

• MC: Master Card

• AX: American Express

• BC: Bank Card

• BL: Carte Bleu

• CB: Carte Blanche

• DN: Diners Club

• DS: Discover Card

• EC: Eurocard

• JC: Japanese Credit Bureau Credit Card

• TP: Universal Air Travel Card

• CU: China Unionpay

• MA: Maestro Card

Mandatory

VI, MC, AX etc.

Please refer to Appendix - Payment Card Code

payment/cardNumber

String

Mandatory

Credit card number

payment/cardHolderName

String

Mandatory

Card holder name

payment/expireDate

Date: MMYY

Mandatory

It should be 2 digits for month, 2 digits for year, as “MMYY”

example: 0119

guests

List[guests]

Mandatory

guests/firstName

String

Mandatory

First name of guest

guests/lastName

String

Mandatory

Last name of guest

guests/firstNameRoma

String

Optional

First Name of guest in Latin characters

DerbySoft Property Connect will translate the non-Latin characters into Latin characters in case your PMS doesn’t support

guests/lastNameRoma

String

Optional

Last Name of guest in Latin characters

guests/email

String

Optional

Email of guest

guests/phone

String

Optional

Phone of guest

guests/address

String

Optional

Address of guest

guests/age

Integer

Optional

Guest age

guests/type

Enum

• Adult

• Child

• Infant

Optional

Guest type indicates Adult, Child or Infant

marketCode

String

Optional

currently only synxis channel support

comments

List[String]

Optional

roomRate

Object[roomRate]

Mandatory

roomRate/roomId

String

Mandatory

Room type id of PMS

roomRate/rateId

String

Mandatory

Rate plan id of PMS

roomRate/currency

String

Mandatory

Currency code with ISO 4217 standard

roomRate/amountBeforeTax

List[BigDecimal]

Optional

Daily rate without tax & fee

roomRate/amountAfterTax

List[BigDecimal]

Optional

Daily rate with tax & fee

roomRate/mealPlan

String

Please refer to Appendix - Meal Plan

roomRate/paymentType

Enum

• PayNow

• PayLater

• CreditPay

• Other

Mandatory

Payment type

roomRate/guarantee

Object[guarantee]

Optional

guarantee/guaranteeType

Enum

-CCG

-GTTA

-GTC

-GTP

-NG

Optional

CCG: Credit Card Guarantee
GTTA: Guarantee to Travel Agent
GTC: Guarantee to Company
GTP: Guarantee to Property
NG: No Guarantee/Direct Bill

fees

List[fees]

Optional

List of tax and fee

fees/dateRange

Object[dateRange]

Mandatory

dateRange/startDate

Date:yyyy-MM-dd

Mandatory

Start date

dateRange/endDate

Date:yyyy-MM-dd

Mandatory

End date

Include end date

fees/fee

Object[fee]

Mandatory

fee/name

String

Mandatory

The name of fee or tax

fee/type

Enum

• Inclusive

• Exclusive

Mandatory

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

fee/amount

String

Mandatory

Amount value of fee or tax

fee/amountType

Enum

• Fix

• Percent

Mandatory

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

fee/chargeType

Enum

• PerRoomPerNight

• PerPersonPerNight

• PerRoomPerStay

• PerPersonPerStay

Mandatory

fee/paymentType

Enum

• PayLater

• PayNow

Optional

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

Enum:PayLater/PayNow

cancelPolicy

Object[cancelPolicy]

Optional

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

cancelPolicy/code

String

Mandatory

Please refer to Appendix - Cancel Policy

cancelPolicy/description

String

Mandatory

resProfiles

List[ResProfile]

Optional

Profile info attached in the reservation

resProfiles/id

String

Mandatory

Profile id

resProfiles/name

String

Mandatory

Profile name

resProfiles/type

Enum

• COMPANY

• TRAVEL_AGENT

Mandatory

Profile type

resProfiles/contact

Object[Contact]

Optional

Profile contact info

contact/email

String

Optional

Email of contact

corpAccount

Object[CorpAccount]

Optional

corpAccount/corpProgramCode

String

Mandatory

Corporate Hotel Program of hotel supplier

corpAccount/corpId

String

Mandatory

Corporate id in the program account

memberAccount

Object[MemberAccount]

Optional

memberAccount/programCode

String

Optional

Loyalty program code of the supplier

memberAccount/memberLevel

String

Optional

Member level

memberAccount/memberId

String

Mandatory

Member id or Loyalty program account id

notify

Boolean

Mandatory

A flag indicates Booking Notify or Booking Request

1. true: Booking Notify mode. In this way, the distributor has already confirmed the reservation to the customer, your PMS has to accept it no matter availability or rates is valid or not.

2. false: Booking Request mode. In this way, the distributor will confirm the reservation to the customer according to the result of your PMS.

extensions

Map<String:String>

Optional

A extension structure in case there is some additional fields to be supported

threeDomainSecurity

Object[ThreeDomainSecurity]

Optional

ThreeDomainSecurity/cavv

String

Optional

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

ThreeDomainSecurity/eci

String

Optional

The electronic commerce indicator.

ThreeDomainSecurity/xid

String

Optional

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

ThreeDomainSecurity/threeDomainSecurityVersion

String

Optional

Include this only for 3D Secure 2.

ThreeDomainSecurity/merchantName

String

Optional

Identifier of the merchant completing the 3DS transaction.

reservationIds

Object[reservationIds]

Mandatory

reservationIds/distributorResId

String

Mandatory

Reservation id in distributor’s system.

reservationIds/derbyResId

String

Mandatory

Reservation id in derbysoft system, this is an unqiue id as DerbySoft would do splitting reservation.

reservationIds/supplierResId

String

Mandatory

Reservation id in PMS.

extensions

Map<String:String>

Optional

A extension structure in case there is some additional fields to be supported