Distributor Knowledge Base

TABLE OF CONTENTS

Hotel Activation Pull Distributors

Hotel Activation Pull Distributors

The Hotel Activation (Pull) API is an optional step in the distribution process that enables distributors to initiate and manage the activation of hotels in DerbySoft GO. While activation is necessary to begin hotel distribution, the decision to perform it through this API rests with the distributor. They may choose to handle this process on their own or delegate it to DerbySoft, depending on their operational preference. This API is also used as an ongoing tool for managing hotel availability throughout the distribution cycle. It offers flexibility and control, allowing distributors to make adjustments as needed over time.

Pull Distributors can use this API to:

Activate or deactivate hotels in DerbySoft GO, enabling or disabling them for distribution.
Make explicit changes to hotel statuses via a POST request, providing full control over hotel availability at any point in the process.

POST /hotels/{supplierId}/setup HTTP/1.1
URL: {ShoppingEngine-Endpoint}/hotels/{supplierId}/setup
Authorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc
Accept-Encoding: gzip
Content-Encoding: gzip
Content-Type: application/json;charset=utf-8

Hotel Activation Pull Distributors Request Schema

Request(METHOD: POST)
Level	Field Name	Data Type	Required	Description	Example
1	header	object	Y	/	/
2	@distributorId	string	Y	The ID of the distributor in DerbySoft's system. MaxLength: 32	GTA
2	@version	string	Y	Version of API. Max Length: 20	v4
2	@token	string	Y	A unique identifier is used for requests and responses, typically a UUID. Max Length: 64. Note that this is an echo token, not an access token.	18393849028490234
1	hotels	array	Y	Hotel list to set up	/
2	@supplierId	string	Y	The ID of the hotel supplier in DerbySoft's system	HILTON
2	@hotelId	string	Y	ID of the hotel in the supplier's system	GATHI
2	@status	enum	Y	Enum:[Actived,Deactived] 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.	Actived

Hotel Activation Pull Distributor Request Example

Hotel Activation Pull Distributors Request Example

{
  "header": {
    "distributorId": "GTA",
    "version": "v4",
    "token": "18393849028490234"
  },
  "hotels": [
    {
      "supplierId": "HILTON",
      "hotelId": "GATHI",
      "status": "Actived"
    }
  ]
}

Hotel Activation Pull Distributors Response Schema

Response
Level	Field Name	Data Type	Required	Description	Example
1	header	object	Y	/	/
2	@distributorId	string	Y	Max Length: 32 The ID of the distributor in DerbySoft's system	GTA
2	@version	string	Y	Version of API Max Length: 20	v4
2	@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. Max Length: 64	18393849028490234
1	hotelCount	integer	N	Available inventory count according to request criteria.	100

Hotel Activation Pull Distributors Response Example

Success Response (HTTP Status 200)

{
  "header": {
    "distributorId": "GTA",
    "version": "v4",
    "token": "18393849028490234"
  },
  "hotelCount": 100
}

Error Response (HTTP Status 401)

{
    "error": "Key not authorised"
}

Error Response (HTTP Status 500)

{
  "errorCode": "InvalidField",
  "errorMessage": "Invalid Message"
}