Logo
Try our API
POST/rateshop

Create Rateshop

This endpoint allows you to create a rate shop, which is a collection of hotel codes, source codes and related parameters: Length of Stay (LOS), Occupancy, Horizon, POS and Currency, for which rate information is requested. The maximum value allowed for the horizon is 365 days. Use any one of the horizon fields listed below.
  • •rateshopname: Your custom name for the RateShop
  • •los: Number of nights for the rate requested. Example: A LOS of 5 means the rate is for a 5-night stay
  • •occupancy: Room occupancy for the rate requested. Example: An occupancy of 2 means the rate is for a room that accommodates 2 people.
  • •currency: The currency in which the rate is retrieved. If the source does not offer it directly, we will convert from the available currency using the appropriate exchange rate. Example: To fetch rates in the United States Dollar, set the currency to USD.
  • •horizon: The number of consecutive days from the call date for data retrieval. Example: A horizon of 30 days will retrieve the rates from start date to the next 30 days in future.
  • •hotelcodes: The hotel codes to be included in the rateshop.
  • •compsets: Defines the comp set, consisting of the subject hotel and its competitors
    • ◦hotelcode: Subject hotel code to include in the rateshop
    • ◦competitorhotelcodes: Competitor hotel codes to include in the rateshop
  • •sources: The source codes to be included in the rateshop.
  • •horizonexpression: Customizable horizon for specific days in the future. Example: 2-10, 15, 20-25 retrieves data from days 2 to 10, the 15th day, and days 20 to 25 from the current date.
  • •pos: This parameter decides the rateshop call be made from which region to extract rates. POS for various regions - Americas – 0, Europe – 2, Asia - 1.
  • •horizonrange: A range of fixed dates for which the data is retrieved. Example: '2025/08/01-2025/08/31' retrieves data for the entire month of August 2025.
  • •directsource: Indicates whether a direct source is required. A value of '0' means it is not required, while '1' means it is required.
POST/rateshop

Mandatory Fields

  • rateshopname
  • los
  • occupancy
  • currency
  • horizonexpression or horizon or horizonrange
  • hotelcodes or compsets
  • sources
  • pos

Parameter Details

NameInTypeRequiredDescription
bodybodyRequirednone

Responses

StatusMeaningDescriptionSchema
200OKSuccess
400Bad RequestBad RequestNone
401UnauthorizedAuthentication Failed or Account validity expiredNone
500Internal Server ErrorInternal server errorNone

Example Request

# You can also use wget
curl -X POST /rateshop \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Body parameter

{
  "rateshopname": "string",
  "los": 0,
  "occupancy": 0,
  "currency": "string",
  "currencies": ["string"],
  "fetchtype": 0,
  "horizon": 0,
  "hotelcodes": [0],
  "compsets": [
    {
      "hotelcode": 0,
      "competitorhotelcodes": [0]
    }
  ],
  "sources": [0],
  "horizonexpression": "2-10, 11, 13, 15, 20-25",
  "pos": 0,
  "horizonrange": "2025/08/18,2025/08/20-2025/08/25",
  "directsource": 0
}

Example responses

200 Response
{
  "rateshopid": 0,
  "rateshopname": "string",
  "los": 0,
  "occupancy": 0,
  "currency": "string",
  "currencies": ["string"],
  "fetchtype": 0,
  "horizon": 0,
  "hotelcodes": [0],
  "compsets": [
    {
      "hotelcode": 0,
      "competitorhotelcodes": [0]
    }
  ],
  "sources": [0],
  "horizonexpression": "string",
  "pos": 0
}

Example 1

{
  "rateshopname": "Demo",
  "los": 1,
  "occupancy": 1,
  "currency": "INR",
  "horizon": 5,
  "hotelcodes": [
    763
  ],
  "sources": [
    1
  ],
  "pos": 0
}

Example 2 with horizon expression

{
  "rateshopname": "Demo1",
  "los": 1,
  "occupancy": 2,
  "currency": "INR",
  "currencies": [
    "string"
  ],
  "fetchtype": 0,
  "hotelcodes": [
    4307067
  ],
  "sources": [
    2, 3
  ],
  "horizonexpression": "2-10",
  "pos": 0,
  "directsource": 1
}

Example 3 with compset

{
  "rateshopname": "Demo2",
  "los": 1,
  "occupancy": 1,
  "currency": "MYR",
  "currencies": [
    "string"
  ],
  "fetchtype": 0,
  "horizon": 5,
  "hotelcodes": [
    0
  ],
  "compsets": [
    {
      "hotelcode": 4307067,
      "competitorhotelcodes": [
        169770, 763, 30388
      ]
    }
  ],
  "sources": [
    1, 5
  ],
  "pos": 0,
  "directsource": 0
}
PreviousGet Sourcemap
NextGet Rateshop List

Need Support?

Our team is here to help you integrate and make the most of our APIs. Get in touch for technical support, custom solutions, or any questions.

Contact Support