diff --git a/src/api-explorer/v4-0/HotelService.swagger2.json b/src/api-explorer/v4-0/HotelService.swagger2-new.json similarity index 99% rename from src/api-explorer/v4-0/HotelService.swagger2.json rename to src/api-explorer/v4-0/HotelService.swagger2-new.json index e19466f839..bd8f0f058b 100644 --- a/src/api-explorer/v4-0/HotelService.swagger2.json +++ b/src/api-explorer/v4-0/HotelService.swagger2-new.json @@ -1847,6 +1847,9 @@ }, "searchSessionToken": { "$ref": "#/definitions/SearchSessionToken" + }, + "reshopInfo": { + "$ref": "#/definitions/ReshopInfo" } }, "required": [ @@ -2718,6 +2721,20 @@ "score" ], "type": "object" + }, + "ReshopInfo": { + "description": "Contains information required for reshopping a hotel booking.", + "properties": { + "gdsRecordLocator": { + "$ref": "#/definitions/GDSRecordLocator" + }, + "confirmationCodes": { + "items": { + "$ref": "#/definitions/ConfirmationCode" + }, + "type": "array" + } + } } }, "x-components": { diff --git a/src/api-reference/direct-connects/hotel-service-4/v4.endpoints.md b/src/api-reference/direct-connects/hotel-service-4/v4.endpoints-new.md similarity index 88% rename from src/api-reference/direct-connects/hotel-service-4/v4.endpoints.md rename to src/api-reference/direct-connects/hotel-service-4/v4.endpoints-new.md index 4044b888a7..e2cf5fa263 100644 --- a/src/api-reference/direct-connects/hotel-service-4/v4.endpoints.md +++ b/src/api-reference/direct-connects/hotel-service-4/v4.endpoints-new.md @@ -538,6 +538,201 @@ POST /hotels/ratedetails } ``` +## Rate Details during modify/reshop flow + +Retrieve hotel rate details for rates of a property. This endpoint is used and required when details including `guarantee`, `cancePenalties` and `nightlyRates` breakdown are missing from `/hotels/rates` call or `rateDetailsCallRequired` flag is set to true for a given rate. + +### URI + +```shell +POST /hotels/ratedetails +``` + +### Parameters + +|Name|Type|Format|Description| +|---|---|---|---| +`Accept-Language`|`string`|-|-| +`concur-correlationid`|`string`|-|**Required** This unique code can be used during troubleshooting as it identifies the API call in the log files.| +`body`|[`RateDetailsCriteria`](./v4.schemas.html#schemaratedetailscriteria)|-|**Required** Hotel rates criteria.| + +### Examples + +#### Request + +```json +{ + "requestorInfo": { + "posRequestorId": "abc1234", + "travelerUuid": "123e4567-e89b-12d3-a456-426614174000", + "loginId": "abc@concur.com", + "bookingForSelf": true + }, + "hotelPropertyRef": { + "chainCode": "HH", + "propertyCode": "HH498949" + }, + "ratePlanIds": [ + "44SM3FAsfvgcZs9ehGlNOQ" + ], + "checkin": "2021-10-20", + "checkout": "2021-10-23", + "rateCategories": [ + { + "otaCode": 1, + "value": "AAA" + } + ], + "numGuests": 1, + "guestCountryCode": "CA", + "searchSessionToken": "b41168ba-7ee1-4b68-9934-47f5c55337d6", + "reshopInfo": { + "gdsRecordLocator": { + "gdsName": "SABRE", + "pcc": "ABC123", + "recordLocator": "ABC123" + }, + "confirmationCodes": [ + { + "codeType": "SUPPLIER_CONFIRMATION", + "code": "3704188022P5683" + }, + { + "codeType": "PIN", + "code": "3704188022P5683" + } + ] + } +} +``` + +### Response + +```json +{ + "checkin": "2021-10-20", + "checkout": "2021-10-23", + "roomRates": [ + { + "rateDescription": [ + "Promotional Rate" + ], + "rateCategory": { + "otaCode": 1, + "value": "AAA" + }, + "rateChangesOverStay": true, + "roomId": "kVNU66KLxuggtu2H", + "ratePlanId": "44SM3FAsfvgcZs9ehGlNOQ", + "guarantee": { + "guaranteeType": "DEPOSIT_REQUIRED", + "acceptedPayments": [ + "VISA" + ], + "cvvRequired": true, + "amountPercent": { + "taxInclusive": true, + "feesInclusive": true, + "numberOfNights": 5, + "basisType": "FULL_STAY", + "applyAs": "FIRST_NIGHT_DEPOSIT", + "percent": 10.05, + "amount": { + "amount": 190.95, + "currencyCode": "USD" + } + } + }, + "prepayRequired": true, + "refundable": true, + "totalPrice": { + "totalBeforeTax": 170.95, + "taxes": 10, + "fees": 10, + "taxesBreakdown": [ + { + "amount": 5, + "fttCode": 1, + "inclusive": true + }, + { + "amount": 5, + "fttCode": 2, + "inclusive": true + } + ], + "feesBreakdown": [ + { + "amount": 5, + "fttCode": 5, + "inclusive": true + }, + { + "amount": 5, + "fttCode": 6, + "inclusive": true + } + ], + "totalAfterTax": 190.95, + "currencyCode": "USD", + "isTotalBeforeTaxDisplayEligible": true + }, + "nightlyPrices": [ + { + "basePrice": 89.95, + "taxes": { + "amount": 5.55, + "taxBreakdown": [ + { + "amount": 8.05, + "fttCode": 15, + "inclusive": true + } + ] + }, + "fees": { + "amount": 10.95, + "feeBreakdown": [ + { + "amount": 8.05, + "fttCode": 15, + "inclusive": true + } + ] + }, + "totalPrice": 100.05, + "startDate": "2021-12-01", + "endDate": "2021-12-31", + "currencyCode": "USD" + } + ], + "cancelPenalties": { + "description": "Some fees are not refundable", + "penalties": [ + { + "cancelDeadline": "2017-07-21T17:32:28", + "description": "Free cancellation up to 1 week before checkin", + "refundableStatus": "FULLY_REFUNDABLE", + "amountPercent": { + "taxInclusive": true, + "feesInclusive": true, + "numberOfNights": 5, + "basisType": "FULL_STAY", + "applyAs": "FIRST_NIGHT_DEPOSIT", + "percent": 10.05, + "amount": { + "amount": 190.95, + "currencyCode": "USD" + } + } + } + ] + } + } + ] +} +``` + ## Hotel Details Retrieve descriptive details about specified hotels. diff --git a/src/api-reference/direct-connects/hotel-service-4/v4.schemas.markdown b/src/api-reference/direct-connects/hotel-service-4/v4.schemas-new.markdown similarity index 99% rename from src/api-reference/direct-connects/hotel-service-4/v4.schemas.markdown rename to src/api-reference/direct-connects/hotel-service-4/v4.schemas-new.markdown index 7a7c453050..8efdfbe663 100644 --- a/src/api-reference/direct-connects/hotel-service-4/v4.schemas.markdown +++ b/src/api-reference/direct-connects/hotel-service-4/v4.schemas-new.markdown @@ -3,6 +3,8 @@ title: Direct Connect - Hotel Service v4 - Schemas layout: reference --- +{% include prerelease.html %} + # Direct Connect - Hotel Service v4 - Schemas ## SearchCriteria @@ -61,6 +63,7 @@ Reference to location details for search. `numGuests`|`integer`|`int32`|Number of guests for accommodation.| `guestCountryCode`|`string`|`ISO ALPHA-2`|Two-character ISO code for country.| `searchSessionToken`|[`SearchSessionToken`](#schemasearchsessiontoken)|-|Session token to be generated and provided by server on initial search call that can be referenced back for future calls on the same session.| +`reshopInfo`|[`ReshopInfo`](#schemareshopinfo)|-|Information related to reshopping, only available during modify (and not shopping) flow| ## HotelDetailsCriteria