TABLE OF CONTENTS

Hotel List

The Retrieve Hotels API allows distributors to fetch a comprehensive list of available hotels, including key details such as hotel name, unique identifier, and its status (Active/Inactive). This is the first step in integrating hotels into your (distributor’s) system.


Distributors can use this API to:

  • Retrieve the list of hotels that are available for distribution.
  • Sync available hotels regularly, ideally on a daily schedule, to ensure the system is up to date.
GET /hotels/{supplierId}?distributorId={distributorId} HTTP/1.1
URL: {BookingUSB-Endpoint}/hotels/{supplierId}?distributorId={distributorId} 
Authorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc 
Content-Type: application/json;charset=utf-8
Accept-Encoding: gzip
Content-Encoding: gzip

Hotel List Request Schema

Request(METHOD: GET)
LevelField NameData TypeRequiredDescriptionExample
1supplierIdstringYThe code that uniquely identifies a supplier in DerbySoft's systemHILTON
1distributorIdstringYThe code that uniquely identifies a distributor in DerbySoft's system.TUI


Hotel List Request Example

Sample URL:
https://solo.derbysoft-test.com/bookingusbv4/hotels/GOHOTEL?distributorId=ABCDE


Hotel List Response Schema

Response

Level

Field Name

Data Type

Required

Description

Example

1

hotelId

string

Y

The code that uniquely identifies a single hotel in hotel suppliers system. Accepted characters only:

1. Digits (0-9) 

2. Uppercase letters (A-Z) 

3. Hyphen ('-')

100001 

GATHI 

00016 

PEP-B3T2

B8W7

1

hotelName

string

N

Hotel Name provided by hotel suppliers.

Hilton xxx Resort & Spa

1

supplierId

string

Y

The code that uniquely identifies a supplier in DerbySoft's system.

HILTON

1

status

enum

Y

Hotel Status provided by hotel suppliers [Actived, Deactived]:

Actived means the hotel is active for the distribution. 

Deactived means the hotel is NOT active for the distribution. ARI will not flow for deactivated hotels.

Actived

1

error

string

N

error response

Key not authorized

1

errorCode

string

C

error response

InvalidField

1

errorMessage

string

C

error response

Invalid Message


Hotel List Response Example

Success Response (HTTP Status 200)
[
  {
    "hotelId": "GATHI",
    "hotelName": "This is a test hotel",
    "supplierId": "HILTON",
    "status": "Actived"
  }
]
Error Response (HTTP Status 401)
{
  "error": "Key not authorized"
}


Error Response (HTTP Status 500)
{
  "errorCode": "InvalidField",
  "errorMessage": "Invalid Message"
}