The Metadata Push and Metadata Audit APIs use these objects in multiple places.
| Field | Datatype | Required | Description |
|---|---|---|---|
| success | Boolean | Yes | True if the client successfully processes the entire request. False otherwise. |
| message | String | No | Status message describing the response |
| errors | Array | No | List of errors associated with objects sent in the request object. See the Error Codes List.
Required only in case there is a failure. |
| Field | Datatype | Required | Description |
|---|---|---|---|
| code | String | Yes | The bedtype code. |
| name | String | Yes | The bedtype name. |
| Field | Datatype | Required | Description |
|---|---|---|---|
| code | String | Yes | The amenity code. |
| name | String | Yes | The full name of the amenity. |
| Field | Datatype | Required | Description |
|---|---|---|---|
| index | Integer | Yes | The value of the index defines the recommended order in which this image should be displayed in the client system’s search results, for that roomtype or that hotel. The greater the index value for an image, the lower its priority when displayed to the customer. |
| name | String | No | The name of the image. |
| shortDescription | String | No | A short description of the image. |
| url | Array | Yes | An array of URL objects. |
Images are distributed to the client as part of the property and roomtype metadata, on an as-approved basis.
| Field | Datatype | Required | Description |
|---|---|---|---|
| size | String | No | The size of the image fetched by the URL. |
| url | String | Yes | The URL. |
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| name | String | Yes | The name of the rateplan. |
| code | String | Yes | A code provided by Hotel Trader identifies this rateplan.
It's unique for each rateplan for a property and is used while sending availability and rate information to the client. |
| currency | String | Yes | The currency used by the rateplan. Corresponds to the Currency standard object. |
| mealPlan | Object | Yes | Mealplan option for this rateplan. It holds meal plan-related data.
|
| shortDescription | String | Yes | A short description of the rateplan. |
| detailDescription | String | No | A detailed description of the rateplan. |
| commissionable | Boolean | No | If true, all rates sent to the client are commissionable, for this rateplan and the rates being supplied include the commission paid to the client. |
| commissionType | String | No | Describes the type of commission.
Possible values: PERCENT, FIXED, HYBRID. Mandatory if commissionable is true. |
| commissionAmount | Float | Yes | This is the fixed commission amount that the client shall receive for every reservation.
Applicable only if commissionable is true. |
| commissionPercent | Float | Yes | This is the commission percentage that the client shall receive for every reservation.
Applicable only if commissionable is true. |
| comments | String | No | Additional notes related to this rateplan. |
| cancellationPolicyCode | String | Yes | The default cancellation policy code associated with the rateplan. The cancellationPolicy object contains the rateplan cancellation policy definition and is sent in a separate message to the client. See here for more details. |
| seasonalPolicies | Object | No | A list of seasonal policies (overrides) associated with the rateplan based on date range. Each seasonal policy includes: name, code, startDate and endDate. |
| isTaxInclusive
|
Boolean
|
Yes | Indicates whether the taxes are included in the price. |
| isRefundable
|
Boolean | Yes | Indicates whether rateplan is refundable. |
| isPromo
|
Boolean
|
Yes
|
Indicates whether this rateplan is a promo on top of another base rateplan.
|
| rateplanType
|
Array | Yes | This field can have multiple values from one of the following:
Enum: B2B_Package, B2B_Room_Only, B2C_Package, B2B_Room_Only. Null value indicates no distribution limitations. |
| destinationExclusive
|
Array | No | List of Destinations for which the distribution is exclusive. This is just the supplementary data. Null value indicates no distribution limitations.
|
| destinationRestriction
|
Array | No | List of Destinations for which the distribution is restricted. This is just the supplementary data. Null value indicates no distribution limitations.
|
Mealplan
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| mealplanCode
|
String | Yes | A unique identifier for the meal plan.
Possible value: BI, LI, DI, AI, None |
| mealplanName
|
String | Yes | Name of the mealplan option.
|
| mealplanDescription
|
String | Yes | A more detailed description of the meal plan.
|
Destination
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| name
|
String | Yes | Name of the destination.
|
| code
|
String | Yes | Country or Region Code as follows:
Country: ISO 3166 Codes Region Codes: EMEA (Europe, the Middle East and Africa) NA (North America) LATAM (Latin America) APAC (Asia-Pacific) |
| type
|
String | Yes | Enum: COUNTRY, REGION
|
Seasonal Policy
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| name | String | Yes | Name of the cancellation policy |
| code | String | Yes | The cancellation policy code is the unique identifier for the policy. |
| startDate | String | Yes | Start date for the cancellation policy in YYYY-MM-DD format |
| endDate | Array | Yes | Start date for the cancellation policy in YYYY-MM-DD format |
| Field | Datatype | Required | Description |
|---|---|---|---|
| name | String | Yes | The name of the roomtype. |
| code | String | Yes | A code provided by Hotel Trader identifies this roomtype. This code is unique for each roomtype for a property. This code is used while sending availability and rate information to the client. |
| shortDescription | String | Yes | A short description of this roomtype. |
| longDescription | String | No | A long description of this roomtype. This field is sent to the client on an as-approved basis. |
| maxAdultOccupancy | Integer | Yes | The maximum number of adults allowed in one room of this roomtype. |
| minAdultOccupancy | Integer | Yes | The minimum number of adults allowed in the room. |
| maxChildOccupancy | Integer | Yes | The maximum number of children allowed in the room. |
| minChildOccupancy | Integer | Yes | The minimum number of children allowed in the room. |
| totalMaxOccupancy | Integer | Yes | The total number of occupants allowed in the room. |
| maxOccupancyForDefaultPrice | Integer | Yes | The minimum number of adults in the room, above which, additional pricing kicks in. |
| bedtypes | Array | No | An array of bedtype objects. |
| amenities | Array | No | An array of amenity objects. |
| images | Array | No | An array of image objects. |
| Field | Datatype | Required | Description |
|---|---|---|---|
| code | String | Yes | The currency code. |
| name | String | Yes | The full name of the currency. |
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| name | String | Yes | The name of the cancellation policy |
| code | String | Yes | A code provided by Hotel Trader that identifies this cancellation policy. This code is unique for each cancellation policy for a property. |
| description | String | Yes | A short description of the cancellation policy. |
| penaltyWindows | Array | Yes | An array of penalty window objects each specifying deadlines and penalties. |
Penalty Window
The penaltyWindow node must include either absoluteDeadline or relativeDeadline, but not both simultaneously.
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| absoluteDeadline | String | No | The absolute timestamp on the arrival day in HH: MM in 24-hour format. |
| relativeDeadline | Object | No | If the penalty window is relative to the check-in date or booking date, use the relative deadline object. |
| penalty | Object | Yes | Penalty details associated with this policy window. |
Relative Deadline
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| relativeTo | String | Yes | Indicates the reference point for the relative deadline. Possible values: BOOKING_CREATION, CHECKIN_TIME, CHECKIN_DAY_MIDNIGHT. |
| type | String | Yes | Specifies whether the relative deadline is before or after the reference point. Possible values: BEFORE, AFTER. |
| offsetUnit | String | Yes | The unit of the offset for the relative deadline. Possible values: DAY, HOUR, MINUTE. |
| offsetValue | Integer | Yes | The numeric value for the offset indicates how many units before or after the reference point the deadline is set. |
Penalty
For the penalty node, exactly one of flat, percent, or nights must be provided. Multiple values are not allowed.
| Field/Object | Datatype | Required | Description |
|---|---|---|---|
| flat | Float | No | Specifies the flat penalty amount. |
| percent | Float | No | Specifies the penalty as a percentage. |
| nights | Integer | No | Indicates the number of nights to which the penalty applies. |
| taxInclusive | Boolean | Yes | Indicates whether the penalty includes taxes. |
| Field | Datatype | Required | Description |
|---|---|---|---|
| objectCode | String | No | The object code for which the validation error occurs. Required in case of any validation errors for the object, such as a missing field or an invalid field value. |
| errorMessage | String | Yes | Error message describing the cause of the failure.
|
| errorCode | Integer | Yes | Error code for the failure. See the Error Codes List.
|