The Products Metadata Audit API verifies that product metadata sent by Hotel Trader is accurately stored on the client system. This API audits all product details for a specific rate plan or rateplans to ensure data consistency and alignment with the Products Metadata Push. The audit can be run for all rate plans for a given list of rate plans for a single property.
Initiator - Hotel Trader
Endpoint
[POST] https://<client-base-url>/products-audit
Request
HTTP Headers
All the HTTP Headers are mandatory. These headers are applicable and remain the same for both end-points of the Product Audit API.
| Header Name | Type |
|---|---|
| Content-Type | application/json |
| Accept-Encoding | gzip |
| Authorization | Bearer <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 products with these rateplan codes. |
Example
{
"messageId": "funnssq-6c1d-4e12-b374-c76735b49fc9",
"propertyCode": "NYCMIL",
"rateplanCodes": ["HTPKG"]
}
Response
Success
Response object description
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| messageId | String | Yes | The same messageId string which is sent in the request. |
| status | Object | Yes | The standard status object describing the success/error status, and the error message, if any. |
| propertyCode | String | Yes | The property code which is sent in the request. |
| rateplanCodes | Array | No | An array of product objects, which contain the rateplan metadata. |
Sample
{
"messageId": "funnssq-6c1d-4e12-b374-c76735b49fc9",
"propertyCode": "NYCMIL",
"status": {
"success": true
},
"products": [{
"rateplanCode": "HTPKG",
"roomtypeCode": "KING",
"taxes": [
"code1",
"code2"
]
}]
}
Error
This API follows the Standard Response model of the Metadata Push API.