Maintainers
Pricing
Enterprise
More
More
Documentation
Try Live
Rankings
Install
Blog
Docs7
Ask
New
Add Docs
Go Console Distributor
https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/
Admin
Provides support and solutions for the Go Console Distributor system.
Tokens:
271,223
Snippets:
548
Trust Score:
4.8
Update:
1 year ago
Context
Chat
Benchmark
Latest
Show doc for...
Code
Info
Show Results
Tokens:
Raw
Copy
Link
Tokens:
Raw
Copy
Link
### Hotel Product API: Net Model Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000668209-exchange-upgrade-guide This JSON object illustrates the structure for a hotel product using the Net rate model. It shares similarities with the Retail model but specifies 'Net' for the rateModel. This example is truncated to show the key difference in rate models. ```json { "hotelId": "GATHI", "hotelName": "This is a test hotel", "supplierId": "HILTON", "status": "Actived", "chainCode": "Hilton", "brandCode": "Hampton", "longitude": "41.40338", "latitude": "2.17403", "city": "string", "country": "string", "state": "string", "address": [ "AddressLine1", "AddressLine2", "AddressLine3", "AddressLine4", "AddressLine5" ], "phone": { "countryAccessCode": "string", "areaCityCode": "string", "phoneNumber": "string" }, "settings": { "key1": "value1", "key2": "value2" }, "extensions": { "key1": "value1", "key2": "value2" }, "ariType": "Daily", "timezone": "America/Los_Angeles", "rateType": "AmountBeforeTax", "maxChildAge": 17, "childRateType": "ByAge", "products": [ { "roomId": "10000101", "rateId": "123456", "rateModel": "Net", "connectionType": "Exchange", "stayType": "OverNightRoom", ``` -------------------------------- ### Hotel Product API - Product Addon Support Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000628877-product-addon-upgrade-guide This section details how the Hotel Product API has been updated to return product addon codes. It includes a response example showcasing the new `productAddons` field. ```APIDOC ## GET /api/hotels/{hotelId}/products ### Description This endpoint has been updated in GO v4.8 to return product addon information for hotel products. The `products` array now includes a `productAddons` field when applicable. ### Method GET ### Endpoint /api/hotels/{hotelId}/products ### Parameters #### Path Parameters - **hotelId** (string) - Required - The unique identifier for the hotel. ### Response #### Success Response (200) - **products** (array) - Contains details of hotel rooms and associated products. - **productAddons** (array) - Information about available product addons. - **type** (string) - Required - The type of product addon (e.g., "DisneyTicket"). - **required** (boolean) - Required - Indicates if the addon is mandatory. - **candidateCodes** (array of strings) - Required - A list of valid codes for the addon. #### Response Example ```json { "hotelId": "GATHI", "hotelName": "This is a test hotel", "supplierId": "HILTON", "status": "Actived", "chainCode": "Marriott", "brandCode": "Waldorf", "longitude": "41.40338", "latitude": "2.17403", "city": "string", "country": "string", "state": "string", "address": [ "AddressLine1", "AddressLine2", "AddressLine3", "AddressLine4", "AddressLine5" ], "phone": { "countryAccessCode": "string", "areaCityCode": "string", "phoneNumber": "string" }, "settings": { "key1": "value1", "key2": "value2" }, "ariType": "Daily", "timezone": "America/Los_Angeles", "rateType": "AmountBeforeTax", "maxChildAge": 17, "childRateType": "ByAge", "products": [ { "roomId": "10000101", "rateId": "123456", "stayType": "OverNightRoom", "status": "Actived", "roomName": "Double Room", "roomDescription": "Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.", "rateName": "Bar Rate", "rateDescription": "Begin your day with a hearty meal.", "occupancy": { "maxAdult": 3, "maxChild": 2, "maxOccupancy": 3 }, "paymentType": "PayNow", "guarantee": { "guaranteeType": "CCG" }, "cancelPolicies": [ { "dateRange": { "startDate": "2018-01-01", "endDate": "2018-01-04" }, "cancelPolicy": { "code": "AD100P_100P", "description": "Non Refundable", "cancelPenalties": [ { "noShow": true, "cancellable": true, "cancelDeadline": { "offsetTimeDropType": "BeforeArrival", "offsetTimeUnit": "D", "offsetTimeValue": 0, "deadline": "string" }, "penaltyCharge": { "chargeBase": "FullStay", "nights": 0, "amount": 0, "percent": 0 } } ] } } ], "fees": [ { "dateRange": { "startDate": "2018-01-01", "endDate": "2018-01-04" }, "fee": { "name": "Service Charge", "type": "Exclusive", "amount": 10, "amountType": "Percent", "chargeType": "PerRoomPerNight", "paymentType": "PayNow", "effectivePerson": 0 } } ], "bookingChannels": [ "channel", "channel" ], "sourceMarkets": [ "region", "region" ], "productAddons": [ { "type": "DisneyTicket", "required": true, "candidateCodes": [ "code", "code" ] } ] } ] } ``` ``` -------------------------------- ### Promotion Push API Request Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000532967-bookingusb-promotion-api This snippet shows an example HTTP POST request to the /promotion/push endpoint. It includes headers for authorization, content type, and encoding. This is part of the legacy BookingUSB-Promotion API. ```http POST /promotion/push HTTP/1.1 URL: {{endpoint}}/promotion/push Authorization: Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8 ``` -------------------------------- ### Hotel Promotion Request Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000532967-bookingusb-promotion-api This JSON structure represents an example request for setting up a hotel promotion. It includes details about the supplier, distributor, promotion type, booking windows, and various discount and restriction options. ```json { "header": { "supplierId": "HILTON", "distributorId": "GTA", "version": "v4", "token": "18393849028490234" }, "hotelPromotion": { "hotelId": "100001", "supplierId": "Hilton", "multiPromotionsStrategy": "Sequence", "promotions": [ { "promoteCode": "XXXX", "promoteName": "Mid-Annual Promotion", "description": "Stay 4 nights and get 1 night for free", "status": "Actived", "isCoupon": false, "sequence": 1, "productCandidates": [ { "roomId": "K1D", "rateId": "ODAD01" } ], "bookWindow": { "startDate": "2018-01-01", "endDate": "2018-01-04", "eachDayStartTime": "00:00:00", "eachDayEndTime": "12:00:00", "excludedDate": [ "2018-01-02", "2018-01-02" ] }, "stayWindow": { "startDate": "2018-01-01", "endDate": "2018-01-04", "weekdays": "1111111", "excludedDate": [ "2018-01-02", "2018-01-03" ] }, "promoteType": "FreeNight", "basicDiscount": { "discountType": "Percent", "discountValue": 10, "rateApplied": false, "rateApplyOn": "AmountAfterTax", "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "freeNight": { "stayNight": 4, "freeNight": 1, "recurring": true, "freeNightType": "LastNight", "rateApplied": false, "rateApplyOn": "AmountAfterTax", "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "lastMinute": { "discount": { "discountType": "Percent", "discountValue": 10 }, "rateApplied": false, "rateApplyOn": "AmountAfterTax", "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minAdvanceHour": 0, "maxAdvanceHour": 0, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "earlyBooker": { "discount": { "discountType": "Percent", "discountValue": 10 }, "rateApplied": false, "rateApplyOn": "AmountAfterTax", "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minAdvanceDay": 0, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "fixedPrice": { "type": "OccupancyRate", "occupancyRate": { "rate": [ { "adultCount": 1, "childCount": 2, "amountBeforeTax": 502.19, "amountAfterTax": 623.23 } ] }, "commonRate": { "amountBeforeTax": 502.19, "amountAfterTax": 623.23 }, "rateApplied": false, "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minAdvanceDay": 0, "maxAdvanceDay": 0, "minAdvanceHour": 0, "maxAdvanceHour": 0, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "giftPackage": { "description": "an extra dinner as gift is including in the price, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "cancelPolicy": { "code": "AD100P_100P", "description": "Non Refundable", "cancelPenalties": [ { "noShow": true, "cancellable": true, "cancelDeadline": { "offsetTimeDropType": "BeforeArrival" } } ] } } ] } } ``` -------------------------------- ### Query Reservations - Retail Model Response Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000668209-exchange-upgrade-guide This JSON represents a sample response for the Query Reservations API in the retail model. It includes reservation details, stay information, contact person, room criteria, connection type, total price, and commission. ```javascript "header": { "supplierId": "HILTON", "distributorId": "GTA", "version": "v4", "token": "18393849028490234" }, "reservations": [ { "reservationIds": { "distributorResId": "C2084DFL0", "derbyResId": "D15F893D34DF", "supplierResId": "89389494" }, "iata": "string", "hotelId": "GATHI", "stayRange": { "checkin": "2018-01-01", "checkout": "2018-01-04" }, "contactPerson": { "firstName": "James", "lastName": "Bond", "email": "007@james.com", "phone": "string", "address": "string" }, "roomCriteria": { "roomCount": 2, "adultCount": 1, "childCount": 2, "childAges": [ 4, 8 ] }, // change start "connectionType": "Exchange", // change end "total": { "amountBeforeTax": 640, "amountAfterTax": 700 }, // change start "commission": { "value": 10, "type": "Percent" } // change end "status": "Confirmed", "cancellationId": "C89389494", "result": "Successful" } ] } ``` -------------------------------- ### Hotel Product API: Retail Model Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000668209-exchange-upgrade-guide This JSON object demonstrates the structure for a hotel product using the Retail rate model. It includes details about room information, pricing, policies, fees, and commissions. The 'collectBy' field for fees and the 'commissions' array are highlighted as recent changes. ```json { "hotelId": "GATHI", "hotelName": "This is a test hotel", "supplierId": "HILTON", "status": "Actived", "chainCode": "Hilton", "brandCode": "Hampton", "longitude": "41.40338", "latitude": "2.17403", "city": "string", "country": "string", "state": "string", "address": [ "AddressLine1", "AddressLine2", "AddressLine3", "AddressLine4", "AddressLine5" ], "phone": { "countryAccessCode": "string", "areaCityCode": "string", "phoneNumber": "string" }, "settings": { "key1": "value1", "key2": "value2" }, "extensions": { "key1": "value1", "key2": "value2" }, "ariType": "Daily", "timezone": "America/Los_Angeles", "rateType": "AmountBeforeTax", "maxChildAge": 17, "childRateType": "ByAge", "products": [ { "roomId": "10000101", "rateId": "123456", "rateModel": "Retail", "connectionType": "Exchange", "stayType": "OverNightRoom", "status": "Actived", "roomName": "Double Room", "roomDescription": "Soak in city views in our Deluxe room, which features a well-appointed ensuite bathroom and up-to-date entertainment offerings.", "rateName": "Bar Rate", "rateDescription": "Begin your day with a hearty meal.", "occupancy": { "maxAdult": 3, "maxChild": 2, "maxOccupancy": 3 }, "paymentType": "PayNow", "guarantee": { "guaranteeType": "CCG" }, "cancelPolicies": [ { "dateRange": { "startDate": "2018-01-01", "endDate": "2018-01-04" }, "cancelPolicy": { "code": "1D1N_1N", "description": "Cancellations or changes to bookings for this room will be charged the first night of the booking in 1 day before arrival date, if no show, will be charged the first night of the booking.", "cancelPenalties": [ { "noShow": false, "cancellable": true, "cancelDeadline": { "offsetTimeDropType": "BeforeArrival", "offsetTimeUnit": "D", "offsetTimeValue": 1 }, "penaltyCharge": { "chargeBase": "NightBase", "nights": 1 } }, { "noShow": true, "penaltyCharge": { "chargeBase": "NightBase", "nights": 1 } } ] } } ], "fees": [ { "dateRange": { "startDate": "2018-01-01", "endDate": "2018-01-04" }, "fee": { "name": "Service Charge", "type": "Exclusive", "amount": 10, "amountType": "Percent", "chargeType": "PerRoomPerNight", "collectBy": "Distributor", "effectivePerson": 0 } } ], "bookingChannels": [ "channel", "channel" ], "sourceMarkets": [ "region", "region" ], "productAddons": [ { "type": "DisneyTicket", "required": true, "candidateCodes": [ "code", "code" ] } ], "commissions": [ { "startDate": "2018-01-01", "endDate": "2018-01-04", "value": 10, "type": "Percent" } ] } ] } ``` -------------------------------- ### Hotel Products API Request Example (HTTP) Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000675587-hotel-products This snippet shows an example HTTP GET request for the Hotel Products API. It includes the endpoint URL, necessary headers like Authorization, Accept-Encoding, and Content-Type, along with query parameters for supplierId, hotelId, and distributorId. This is used to retrieve product offerings for a specific hotel. ```http GET /hotel/{supplierId}/{hotelId}?distributorId={distributorId} HTTP/1.1 URL: {BookingUSB-Endpoint}/hotel/{supplierId}/{hotelId}?distributorId={distributorId} Authorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8 ``` -------------------------------- ### Get Hotels Request Example (HTTP) Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000675589-hotel-activation-push-distributors This snippet demonstrates the HTTP request format for retrieving a list of hotels from a supplier. It includes the necessary URL, headers, and authorization details for the API call. ```HTTP GET /hotels/{supplierId} HTTP/1.1 URL: {AvailabilityPeer-Endpoint}/hotels/{supplierId} Authorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8 ``` -------------------------------- ### Example JSON Configuration Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000532567-bookingusb-reservation-apis This snippet shows a basic JSON configuration structure for the Go Console Distributor. It includes examples of key-value pairs within an 'extensions' object. This configuration is typically used to define service extensions or features. ```json { "extensions": { "key1": "value1", "key2": "value2" } } ``` -------------------------------- ### JWT Token Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000658839-api-authentication-instructions An example of a JWT token issued by DerbySoft GO for distributor authentication. ```APIDOC ## JWT Token Example ### Description This is an example of a JSON Web Token (JWT) that DerbySoft GO uses for authentication. Distributors should validate this token using the obtained public keys before processing any business requests. ### Token Example ``` eyJraWQiOiIzOTRiNTZjM2VhNTI0ZWU1OTAxNWY5YTdlODg2NjMxMiIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwczovL2lkLzg0QTI2QjJGQTc3QkNEMUZGNTEzMDYzNkYwNEMzMEM1Ly53ZWxsLWtub3duL29wZW5pZC1jb25maWd1cmF0aW9uIiwiYXVkIjoiWktUIiwiZXhwIjoxNzAzNTYwMDkwLCJqdGkiOiJRWGNxem5ldVZCYlJQbjE5NGtzOUFRIiwiaWF0IjoxNzAzNTU5NzkwLCJuYmYiOjE3MDM1NTk2NzAsInN1YiI6ImRzLWdvLW1vZHVsZSJ9.mNmpBZMm1lPFMvea75PSY1tn64l2XjeN5Y21KkaHyY9HHNzh5JUaG-XCn97WQwPgw7uTKs8zn5zWGgng9mZ8mie312qY0DILxCebZ2c_7Qt3drssa7EnRJf5kbFRHIay9S6lmuG9BE9o9lkAlnfFqOa7qHpzEFt35yKRS8ummlH3k_RjrBRBke7wb5VePRDryPb9LTd0hfu7e7guWOSEkR21rS6drHrd89dHHKwB28-SCs4KYeWPaUZFbBHG9vVaYn99ELoKs7cAKfBS_SX9-Ag9Z7e_wLoD-mgG9Bi8e8Mf0bfV4YdfusLTScxKnHeZwjGZkDDZN70aWZKVIaqimQ ``` ### Usage 1. Obtain Public Keys using the `/keys` endpoint. 2. Decode and verify the JWT using the obtained public keys. 3. If the token is valid, proceed with the business request. ``` -------------------------------- ### Query Reservations - Net Model Response Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000668209-exchange-upgrade-guide This JSON represents a sample response for the Query Reservations API in the net model. It includes header information, reservation identifiers, stay details, contact information, room criteria, and connection type. ```javascript { "header": { "supplierId": "HILTON", "distributorId": "GTA", "version": "v4", "token": "18393849028490234" }, "reservations": [ { "reservationIds": { "distributorResId": "C2084DFL0", "derbyResId": "D15F893D34DF", "supplierResId": "89389494" }, "iata": "string", "hotelId": "GATHI", "stayRange": { "checkin": "2018-01-01", "checkout": "2018-01-04" }, "contactPerson": { "firstName": "James", "lastName": "Bond", "email": "007@james.com", "phone": "string", "address": "string" ``` -------------------------------- ### Shopping API Request Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000539202-shoppingengine-pull-model- This is an example of a POST request to the /shopping/multihotels endpoint. It includes the necessary headers, URL, and a JSON payload for querying room rates and inventory for multiple hotels. ```http POST /shopping/multihotels HTTP/1.1 URL: {{endpoint}}/shopping/multihotels Authorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8 ``` ```json { "header": { "distributorId": "GTA", "version": "v4", "token": "18393849028490234" }, "hotels": [ { "supplierId": "HILTON", "hotelId": "GATHI", "status": "Actived", "isAfterPromotion": false, "promoteCode": "string", "onlyExactMatch": false, "corpCodes": [ "CORPA", "CORPB" ] } ], "stayRange": { "checkin": "2018-01-01", "checkout": "2018-01-04" }, "roomCriteria": { "roomCount": 2, "adultCount": 1, "childCount": 2, "childAges": [ 4, 8 ] }, "iata": "string", "extensions": { "key1": "value1", "key2": "value2" } } ``` -------------------------------- ### Book API Request Example - Go Console Distributor Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000532567-bookingusb-reservation-apis This example demonstrates the structure of a POST request to the /reservation/book endpoint of the Go Console Distributor API. It includes the URL, HTTP method, and required headers for authorization and content type. ```javascript POST /reservation/book HTTP/1.1 URL: {{endpoint}}/reservation/book Authorization:Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8 ``` -------------------------------- ### JWT Token Example - Generic Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000658839-api-authentication-instructions An example of a JSON Web Token (JWT) used for authentication. This token contains claims such as issuer, audience, expiration time, issued at, and subject. ```Generic eyJraWQiOiIzOTRiNTZjM2VhNTI0ZWU1OTAxNWY5YTdlODg2NjMxMiIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwczovL2lkLzg0QTI2QjJGQTc3QkNEMUZGNTEzMDYzNkYwNEMzMEM1Ly53ZWxsLWtub3duL29wZW5pZC1jb25maWd1cmF0aW9uIiwiYXVkIjoiWktUIiwiZXhwIjoxNzAzNTYwMDkwLCJqdGkiOiJRWGNxem5ldVZCYlJQbjE5NGtzOUFRIiwiaWF0IjoxNzAzNTU5NzkwLCJuYmYiOjE3MDM1NTk2NzAsInN1YiI6ImRzLWdvLW1vZHVsZSJ9.mNmpBZMm1lPFMvea75PSY1tn64l2XjeN5Y21KkaHyY9HHNzh5JUaG-XCn97WQwPgw7uTKs8zn5zWGgng9mZ8mie312qY0DILxCebZ2c_7Qt3drssa7EnRJf5kbFRHIay9S6lmuG9BE9o9lkAlnfFqOa7qHpzEFt35yKRS8ummlH3k_RjrBRBke7wb5VePRDryPb9LTd0hfu7e7guWOSEkR21rS6drHrd89dHHKwB28-SCs4KYeWPaUZFbBHG9vVaYn99ELoKs7cAKfBS_SX9-Ag9Z7e_wLoD-mgG9Bi8e8Mf0bfV4YdfusLTScxKnHeZwjGZkDDZN70aWZKVIaqimQ ``` -------------------------------- ### Promotion Request Example in JSON Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000675595-promotion This JSON structure represents a promotion request. It includes header information, hotel details, and a list of promotions with various parameters such as dates, discounts, and restrictions. This example demonstrates a 'FreeNight' promotion type. ```json { "header": { "supplierId": "HILTON", "distributorId": "GTA", "version": "v4", "token": "18393849028490234" }, "hotelPromotion": { "hotelId": "100001", "supplierId": "Hilton", "multiPromotionsStrategy": "Sequence", "promotions": [ { "promoteCode": "XXXX", "promoteName": "Mid-Annual Promotion", "description": "Stay 4 nights and get 1 night for free", "status": "Actived", "isCoupon": false, "sequence": 1, "productCandidates": [ { "roomId": "K1D", "rateId": "ODAD01" } ], "bookWindow": { "startDate": "2018-01-01", "endDate": "2018-01-04", "eachDayStartTime": "00:00:00", "eachDayEndTime": "12:00:00", "excludedDate": [ "2018-01-02", "2018-01-02" ] }, "stayWindow": { "startDate": "2018-01-01", "endDate": "2018-01-04", "weekdays": "1111111", "excludedDate": [ "2018-01-02", "2018-01-03" ] }, "promoteType": "FreeNight", "basicDiscount": { "discountType": "Percent", "discountValue": 10, "rateApplied": false, "rateApplyOn": "AmountAfterTax", "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "freeNight": { "stayNight": 4, "freeNight": 1, "recurring": true, "freeNightType": "LastNight", "rateApplied": false, "rateApplyOn": "AmountAfterTax", "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "lastMinute": { "discount": { "discountType": "Percent", "discountValue": 10 }, "rateApplied": false, "rateApplyOn": "AmountAfterTax", "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minAdvanceHour": 0, "maxAdvanceHour": 0, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "earlyBooker": { "discount": { "discountType": "Percent", "discountValue": 10 }, "rateApplied": false, "rateApplyOn": "AmountAfterTax", "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minAdvanceDay": 0, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "fixedPrice": { "type": "OccupancyRate", "occupancyRate": { "rate": [ { "adultCount": 1, "childCount": 2, "amountBeforeTax": 502.19, "amountAfterTax": 623.23 } ] }, "commonRate": { "amountBeforeTax": 502.19, "amountAfterTax": 623.23 }, "rateApplied": false, "addOnDescription": "a welcome drink, hot spring, shuttle bus are included in this promotion, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minAdvanceDay": 0, "maxAdvanceDay": 0, "minAdvanceHour": 0, "maxAdvanceHour": 0, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "giftPackage": { "description": "an extra dinner as gift is including in the price, please ask to hotel reception while checking-in", "restriction": { "minStayThrough": 1, "maxStayThrough": 4, "minRoomPerOrder": 0, "maxRoomPerOrder": 0 } }, "cancelPolicy": { "code": "AD100P_100P", "description": "Non Refundable", "cancelPenalties": [ { "noShow": true, "cancellable": true, "cancelDeadline": { "deadline": 0, "unit": "Hour" } } ] } } ] } } ``` -------------------------------- ### Request Public Keys - HTTP GET Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000658839-api-authentication-instructions This is an example of an HTTP GET request to retrieve public keys for authentication. It specifies the endpoint and content type for the request. ```HTTP GET https://xxxxxx/id/84A26B2FA77BCD1FF5130636F04C30C5/keys HTTP/1.1 Content-Type: application/json;charset=utf-8 ``` -------------------------------- ### Hotel List API Request Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000675586-hotel-list Example of a GET request to the Retrieve Hotels API, including the URL, authorization, and content type headers. This endpoint is used to fetch a list of hotels based on supplier and distributor IDs. ```HTTP 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 ``` -------------------------------- ### Promotion Push API Request Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000675595-promotion This snippet demonstrates a POST request to the Promotion Push endpoint. It includes the HTTP method, URL, and necessary headers for authentication and content negotiation. Ensure the Promotion-Endpoint is correctly configured and the Authorization token is valid. ```HTTP POST /promotion/push HTTP/1.1 URL: {Promotion-Endpoint}/promotion/push Authorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8 ``` -------------------------------- ### Push ARI Ping API Request Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000675745-push-ari-ping This snippet shows an example HTTP GET request to the Push ARI Ping API endpoint. It includes headers such as Authorization and Content-Type, which are crucial for authentication and data formatting. The endpoint URL is also specified. ```HTTP GET /ping HTTP/1.1 URL: {AvailabilityPeer-Endpoint}}/ping Authorization: 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8 ``` -------------------------------- ### Get Hotel Product List and Status - HTTP Request Example Source: https://go-console-distributor.knowledgebase.derbysoftsec.com/en/support/solutions/articles/70000557518-availabilitypeer-push-model- This snippet shows the structure of an HTTP GET request to retrieve hotel product information and their active/deactivated status for a given supplier and hotel. It includes the URL, authorization header, and content encoding details. The request targets a specific hotel within a supplier's system. ```http GET /hotel/{supplierId}/{hotelId} HTTP/1.1 URL: {{endpoint}}/hotel/{supplierId}/{hotelId} Authorization:Bearer 53ac07777cdffac2d53000002d698728ce964432d7167596bc005c5fc Accept-Encoding: gzip Content-Encoding: gzip Content-Type: application/json;charset=utf-8 ```
