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.

POST/rateshop

Mandatory Fields

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

Optional Fields

  • body

Parameter Details

NameInTypeRequiredDescription
bodybodynewrateshopOptionalnone

Responses

StatusMeaningDescriptionSchema
200OKSuccessschemarateshopinfo
400Bad RequestBad Request
401UnauthorizedAuthentication Failed or Account validity expired
500Internal Server ErrorInternal server error

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
}

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.