The Rateplan Metadata Audit API ensures that the rateplan metadata pushed from Hotel Trader to the client system aligns with what is stored on the client’s side. It verifies that all rateplan details for a given property match the original data sent during the Rateplan Metadata Push.
The audit can be for a single rateplan or all rateplans of the property.
Appropriate alert messages will be sent to Partner systems after the audit.
Initiator - Hotel Trader
Endpoint
[POST] https://<client-base-url>/rateplan-audit
Request
HTTP Headers
All HTTP headers are mandatory and apply consistently across both endpoints of the API.
Clients must provide their username and password to Hotel Trader. For more information on username and password encoding, please refer to the Authentication page in our Knowledge Base.
| Header Name | Type |
|---|---|
| Content-Type | application/json |
| Accept-Encoding | gzip |
| Authorization | Basic <token> |
Request Description
All the fields in the request are described below.
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| messageId | String | Yes | A string that uniquely identifies this particular message. This should be returned in the response. |
| propertyCode | String | Yes | The unique property code of the hotel for which rateplan metadata is requested. |
| rateplanCodes | Array | No | If present, return only the rateplans with these codes. |
Example
{
"messageId": "funnssq-6c1d-4e12-b374-c76735b49fc9",
"propertyCode": "NYCMIL",
"rateplanCodes": ["HTPKG"]
}Response
Success
All the fields in the response are described below.
Object Description
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| messageId | String | Yes | The same messageId string that is sent in the request. |
| status | Object | Yes | The standard status object describes the success/error status and the error message, if any. |
| propertyCode | String | Yes | The property code that was sent in the request. |
| rateplans | Array | Yes | An array of rateplan objects, which contain the rateplan metadata. |
Example
{
"messageId": "funnssq-6c1d-4e12-b374-c76735b49fc9",
"status": {
"success": true
},
"propertyCode": "NYCMIL",
"rateplans": [
{
"name": "Package Rate",
"code": "HTPKG",
"currency": {
"name": "US Dollar",
"code": "USD"
},
"shortDescription": "Hotel Trader Package Rate",
"detailDescription": "Hotel Trader Package Rate - the best package rates for Row NYC.",
"cancellationPolicyCode": "24H",
"isTaxInclusive": false,
"mealplan": {
"mealplanCode": "BI",
"mealplanName": "Breakfast Included",
"mealPlanDescription": "Breakfast Included",
},
"isRefundable": true,
"rateplanType": ["B2B_PACKAGE"],
"isPromo": false,
"destinationExclusive": {
"type": "country",
"code": "US"
},
"destinationExclusive": null,
"seasonalPolicies": [
{
"name": "24 hour cancellation",
"code": "24H",
"startDate": "2025-12-01",
"endDate": "2025-12-31"
},
{
"name": "24 hour cancellation",
"code": "24H",
"startDate": "2025-01-01",
"endDate": "2025-11-30"
}
]
}
]
}
Error
This API follows the Standard Response model of the Content API for error response.