Skip to content

docs: [HOTEL-20922] add reshopInfo field to rate details criteria #1412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Jun 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1847,6 +1847,9 @@
},
"searchSessionToken": {
"$ref": "#/definitions/SearchSessionToken"
},
"reshopInfo": {
"$ref": "#/definitions/ReshopInfo"
}
},
"required": [
Expand Down Expand Up @@ -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": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -538,6 +538,201 @@ POST /hotels/ratedetails
}
```

## Rate Details during modify/reshop flow <a id="opIdratedetails"></a>

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": "[email protected]",
"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 <a id="opIdhoteldetails"></a>

Retrieve descriptive details about specified hotels.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Direct Connect - Hotel Service v4 - Schemas
layout: reference
---

{% include prerelease.html %}

# Direct Connect - Hotel Service v4 - Schemas

## <a id="schemasearchcriteria"></a> SearchCriteria
Expand Down Expand Up @@ -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|

## <a id="schemahoteldetailscriteria"></a> HotelDetailsCriteria

Expand Down