v1

latestOpenAPI 3.0.02026-07-26866217.8 KB
Listing Calendar

Query Pricing Ratios

Return the per-channel pricing ratio of each OTA listing linked to a property (property_id) or a room type (room_type_id). Pricing ratio is the percentage Hostex multiplies a base (property/room-type level) price by to derive the actual price pushed to each listing. Use this endpoint at the skill layer to compose a 'change price by property / room type' workflow: read the ratios, compute target_price = round(base_price * ratio / 100) for every non-readonly listing, then call POST /listings/prices once per listing. Listings marked readonly: true are silently controlled by the channel (e.g. Airbnb child rate plans) and cannot be repriced via POST /listings/prices; skip them.

get/pricing_ratios

Query parameters

property_idinteger

Id of the property to read ratios for. Mutually exclusive with room_type_id; exactly one of the two must be supplied.

room_type_idinteger

Id of the room type to read ratios for. Mutually exclusive with property_id; exactly one of the two must be supplied.

Response

Pricing ratios for the listings under the given property or room type.

request_idstring required

Unique identifier for the request.

error_codeinteger required

Numeric error code representing the status of the response. A value of 200 indicates success. <br> See the Error Codes section for more information.

error_msgstring required

Message detailing the status of the response.

Example response

{
  "error_msg": "Done."
}