Offer

{
    "id": "offer_id",
    "url": "https://example.org/offer/12345",
    "name": "Double room",
    "features": {
        "boardBasis": "HB",
        "wifi": true
    },
    "tariffs": [
        <Tariff 1>,
        <Tariff 2>,
        ...
        <Tariff N>
    ]
}

Field

Required

Type

Restrictions

Description

url

Yes

String[]

max[i]=1000

The landing page URL. When the user goes to it, landing page parameters will be added to the request.

id

Yes

String

[a-zA-Z0-9-_]{1,255}

The offer ID. Used for updating information about this offer.

name

Yes

String[]

max[i]=255

The name of the offer.

features

No

Object

Room amenities.

features.boardBasis

No

String[]

Board. Possible values

features.wifi

No

Boolean

Wi-Fi availability.

tariffs

Yes

Object[]

The offer rates. The Tariff model.

Landing page parameters

Parameter

Number

Description

token

1

The token of the click to the landing page.

checkIn

1

The check-in date in ISO 8601 format.

checkOut

1

The check-out date in ISO 8601 format.

adults

1

How many adults can stay.

childAge

0 or more

The child's age. If lodging for multiple children is needed, multiple parameters are passed.

price.amount

1

The offer price shown to the user.

price.currency

1

The offer currency shown to the user.

tariffs.id

0 or more

The IDs of the selected rates.

Board types

Code

Description

AI

All inclusive

BB

Bed and breakfast

FB

Full board (breakfast, lunch, and dinner)

HB

Half board (breakfast and dinner)

RO

Room only

UAI

Ultra All Inclusive

LAI

Light All Inclusive

BD

Bed and dinner

Previous
Next