header

object

Y

 /

 /

@distributorId

string

Y

The ID of distributor in DerbySoft's system.

MaxLength: 32

GTA

@version

string

Y

Version of API. MaxLength: 20

v4

@token

string

Y

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

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

18393849028490234

hotels

array

Y

 /

 /

@supplierId

string

Y

The ID of hotel suppliers in DerbySoft's system.

MaxLength: 32

HILTON

@hotelId

string

Y

Hotel Supplier's Hotel ID

GATHI

@status

enum

N

Enum: [Actived, Deactived] 

Hotel status in distributor's system

Actived

@isAfterPromotion

boolean

N

The flag indicates calculate the available room rates with the promotion rules or not.

• true means to check the availability under the promotion rules provided by the supplier.
• false means no need to check the availability under any promotions, basic live-check only.

false

@promoteCode

string

N

Promote code defined by the hotel, is an optional field when you want to request the promotion rates. (isAfterPromotion = true).

If the promotion code is empty and there are multiple promotions available for one product at the same time, the promotion rule will be chosen according to multiPromotionsStategy.

 /

Used to specify if only requesting rates for the specific corpCodes or also the backup rates

true: only rates related to the corpCode

false: also other rates

Corporate ID for a specific company, consortia, negotiated rate used to retrieve rates related to that code.

Notes: 

1. It depends on the corporate code mapping between Go Distributors and hotel suppliers. If the mapping is not in place and corporate codes are passed, an error will occur.

2. The maximum number of corpCodes allowed is 10.

stayRange

object

Y

 /

 /

@checkin

string

Y

Check-in date expressed as YYYY-MM-DD

2028-01-01

@checkout

string

Y

Check out date expressed as YYYY-MM-DD

2028-01-04

roomCriteria

object

Y

 /

 /

@roomCount

integer

Y

Total room count per request

2

@adultCount

integer

Y

Number of adults staying per room

1

@childCount

integer

N

Number of children staying per room

2

@childAges

integer

N

Ensure the size of the child age array matches the number of children.

[4, 8]

IATA

string

N

IATA of distributor

/

{

    "key1": "value1",

    "key2": "value2"

}

header

object

Y

 /

 /

@distributorId

string

Y

The ID of distributor in DerbySoft's system.

MaxLength: 32

GTA

@version

string

Y

Version of API. MaxLength: 20

v4

@token

string

Y

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

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

18393849028490234

Check-in, expressed as YYYY-MM-DD

2028-01-01

Checkout, expressed as YYYY-MM-DD

2028-01-01

iata

string

N

IATA of distributor

 /

availHotels

array

Y

 /

 /

@supplierId

string

Y

The ID of hotel suppliers in DerbySoft's system.

MaxLength: 32

HILTON

@hotelId

string

Y

Hotel ID in supplier's system

GATHI

@status

enum

N

Enum:[Actived,Deactived]

Hotel status in distributor's system

Actived

stayRange

object

Y

Note:

The 'stayRange' node is deprecated and will be replaced by a new 'stayRange' node at the parent level in the next one or two API version releases.

 /

@checkin

string

Y

Check-in, expressed as YYYY-MM-DD

2028-01-01

@checkout

string

Y

Check out, expressed as YYYY-MM-DD

2028-01-04

iata

string

N

IATA of distributor

 /

availRoomRates

array

Y

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

@roomId

string

Y

Room ID in supplier's system

10000101

@rateId

string

Y

Rate ID in supplier's system

123456

Used to indicate if a specific rate is eligible for loyalty points.

True: means that the rate is eligible.

False: indicates the rate is not eligible for loyalty points.

@currency

string

Y

Currency code [ISO-4217]

USD

@amountBeforeTax

array[number]

C

The daily amount of rate without tax and fee.

Mandatory if AAT is not provided.

[100,100,120]

@amountAfterTax

array[number]

C

The daily amount of rate with tax and fee.

Mandatory if ABT is not provided.

[110,110,130]

@mealPlan

string

N

For the meal plan code, refer to the 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

C

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

CCG

fees

array[object]

C

Fee or tax by date range.

 /

dateRange

object

C

 /

 /

@startDate

string

C

Start date of date range expressed as YYYY-MM-DD

2028-01-01

@endDate

string

C

End date of the date range expressed as YYYY-MM-DD

2028-01-04

fee

object

C

 /

 /

@name

string

C

Name of the fee. Use regex 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

C

Indicates whether or not the fee or tax is included in the amount before tax.

Enum:  [Inclusive, Exclusive].

Exclusive

@amount

number

C

Amount value of the fee or tax

10

@amountType

string

C

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

Enum: [ Fix, Percent ].

Percent

@chargeType

enum

C

Enum: [ PerRoomPerNight, PerPersonPerNight, PerRoomPerStay, PerPersonPerStay ]

PerRoomPerNight

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

@effectivePerson

integer

N

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

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 a No-Show or a time range before a No-Show.

 /

@code

string

C

Code of cancellation policy. Max Length: 128

AD100P_100P

@description

string

N

Max Length: 1024

Description of the cancellation policy.

Non Refundable

cancelPenalties

array

Y

Details about the cancellation penalty

 /

@noShow

boolean

C

If true means the penalty charge was applied for a No-Show, the cancelable and cancelDeadline nodes will be omitted.

 /

@cancellable

boolean

N

Specifies whether cancellation is allowed. If false, cancellation is not allowed. If true, the cancelDeadline node will be present.

 /

cancelDeadline

object

N

 /

 /

@offsetTimeDropType

enum

N

An enumerated type indicates when the deadline drop time goes into effect.
Enum: [BeforeArrival].

 /

@offsetTimeUnit

enum

N

 Enum:[D,H]

 /

@offsetTimeValue

string

N

The number of offset times with the time unit

 /

@deadline

string

N

Deadline times for cancellation are typically based on the hotel's local time, usually at either 4 PM or 6 PM.

 /

penaltyCharge

object

C

 /

 /

@chargeBase

enum

N

Enum:[FullStay, NightBase]

If FullStay, it will be a percentage or amount. If NightBase, the 'nights' field will be provided.

 /

@nights

number

N

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

 /

@amount

number

N

Exists if the penalty charge is a flat charge, like USD 30.00

 /

@percent

number

N

Exists if the penalty charge is percent, like 15.5 means 15.5%

 /

Enum: [Exchange, Standard]

Indicates the connection type of products. 

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

Mandatory if AAT is not provided

Mandatory if ABT is not provided

roomCriteria

object

Y

/

/

@roomCount

integer

Y

Total room count per request

2

@adultCount

integer

Y

Number of adults staying per room

1

@childCount

integer

N

Number of children staying per room

2

@childAges

integer

N

Ensure the size of the child age array matches the number of children.

[4,8]

inventory

integer

Y

Available inventory count according to request criteria.

2

isAfterPromotion

boolean

N

The flag indicates calculate the available room rates with the promotion rules or not.

• true means to check the availability  under the promotion rules provided by the Supplier.
• false means no need to check the availability under any promotions, basic live-check only.

false

promoteCode

string

N

Promote code defined by the hotel, it's an optional field when you want to request the promotion rates (isAfterPromotion = true).

If the promotion code is empty and there are multiple promotions available for one product at the same time, the promotion rule will be chosen according to the multiPromotionsStategy.

 /