Документация API
GET ships
Получение списка теплоходов
Описание query
| Имя | Пример | Описание |
|---|---|---|
| key | your_key | Ваш API-ключ |
Описание полей
Ответ содержит массив объектов, каждый из которых имеет следующие поля
| Поле | Тип | Описание |
|---|---|---|
| id | Integer | ID теплохода |
| name | String | Название теплохода |
| description | String | Описание теплохода |
| schema_url | Boolean | URL схемы теплохода |
| photo | String | Фото теплохода |
| cabin_types | Array of Objects | Категории кают |
| cabins | String | Каюты |
| decks | String | Палубы |
Поля массива cabin_types:
| Поле | Тип | Описание |
|---|---|---|
| id | Integer | ID категории каюты |
| title | String | Название категории каюты |
| description | String | Описание категории каюты |
| photos | Array of Objects | Фотографии категорий каюты |
Поля массива photos:
| Поле | Тип | Описание |
|---|---|---|
| url | String | URL фотографии |
Поля массива cabins:
| Поле | Тип | Описание |
|---|---|---|
| id | Integer | ID каюты |
| deck_id | Integer | ID палубы |
| title | String | Название каюты |
| description | String | Описание каюты |
| number | Integer | Номер каюты |
| type_id | Integer | ID типа каюты |
| cabin_type_id | Integer | ID категории каюты |
Поля массива decks:
| Поле | Тип | Описание |
|---|---|---|
| id | Integer | ID палубы |
| title | String | Название палубы |
| schema_url | String | URL схемы палубы |
GET cruises
Получение списка круизов
Описание query
| Имя | Пример | Описание |
|---|---|---|
| key | your_key | Ваш API-ключ |
| shipId | 42 | ID теплохода, для получение всех опустите этот параметр |
Описание полей
Ответ содержит массив объектов, каждый из которых имеет следующие поля
| Поле | Тип | Описание |
|---|---|---|
| id | Integer | ID круиза |
| ship_id | Integer | ID теплохода |
| name | String | Название круиза |
| url | String | Cсылка на круиз |
| slug | String | Псевдокод круиза |
| min_price | Integer | Минимальная цена (руб.) |
| max_price | Integer | Максимальная цена (руб.) |
| free_cabins_number | Integer | Число свободных кают |
| date_start | Datetime | Дата и время начала круиза |
| date_end | Datetime | Дата и время окончания круиза |
| direction | Object | Маршрутные точки |
Поля обьекта direction:
| Поле | Тип | Описание |
|---|---|---|
| name | String | Маршрут круиза |
| points | Array of Objects | Маршрутные точки |
Поля массива points:
| Поле | Тип | Описание |
|---|---|---|
| name | String | Название маршрутной точки |
| departure_time | Datetime | Дата и время отправления |
| arrival_time | Datetime | Дата и время прибытия |
| index | Integer | Порядковый номер |
GET cruise/{id_cruise}/cabin-statuses
Получение списка статусов кают круиза
Описание query
| Имя | Пример | Описание |
|---|---|---|
| key | your_key | Ваш API-ключ |
Описание params
| Имя | Пример | Описание |
|---|---|---|
| id_cruise | 1343 | ID круиза |
Описание полей
Ответ содержит массив объектов, каждый из которых имеет следующие поля
| Поле | Тип | Описание |
|---|---|---|
| cabinId | Integer | ID каюты |
| cruiseId | Integer | ID круиза |
| number | String | Номер каюты |
| countPlaces | Integer | Количество мест в каюте |
| prices | Array of Objects | Цены кают в зависимости от количества мест |
| status | String | Статус каюты ("free" - свободна, "booked" - забронированна) |
Поля массива prices:
| Поле | Тип | Описание |
|---|---|---|
| countPeople | Integer | Количество мест |
| priceForPlace | Integer | Цена (руб.) |
POST create-order
Создание заказа агентом
Пример запроса
Описание query
| Имя | Пример | Описание |
|---|---|---|
| key | your_key | Ваш API-ключ |
Описание JSON
Объект customer
| Имя | Тип | Описание |
|---|---|---|
| name | string | Имя клиента |
| phone | string | Номер телефона клиента |
| string | Email клиента (необязательное) |
Массив объектов cruises
| Имя | Тип | Описание |
|---|---|---|
| cruises | array | Массив круизов |
Объект массива cruises
| Имя | Тип | Описание |
|---|---|---|
| id | integer | id круиза |
| cabins | array | массив кают |
Объект массива cabins
| Имя | Тип | Описание |
|---|---|---|
| id | integer | id каюты |
| passengers | array | массив пассажиров |
| children | integer | кол-во детей (необязательное) |
Объект массива passengers
| Имя | Тип | Описание |
|---|---|---|
| type | integer | тарифы |
| first_name | string | фамилия пассажира (необязательное) |
| last_name | string | имя пассажира (необязательное) |
| middle_name | string | отчество пассажира (необязательное) |
| birth_date | string | дата рождения (необязательное) |
| gender | integer | пол (необязательное) |
| document_number | string | номер документа (необязательное) |
Тарифы
| Имя | Тип | Описание |
|---|---|---|
| adult | взрослый | |
| child_16 | ребёнок до 16 лет, при размещении на основном месте | |
| pensioner | пенсионер | |
| student | студент | |
| invalid | инвалид | |
| veteran | ветеран |
Описание полей
Ответ содержит массив объектов, каждый из которых имеет следующие поля
| Поле | Тип | Описание |
|---|---|---|
| message | String | Сообщение ответа |
| order_id | Integer | id заказа |
| code | Integer | Код ответа |
GET cancel-order/{id_order}?your_key=api_key
Отмена заказа агентом
Описание query
| Имя | Пример | Описание |
|---|---|---|
| key | your_key | Ваш API-ключ |
Описание params
| Имя | Пример | Описание |
|---|---|---|
| id_order | 1343 | ID заказа |
Описание полей
Ответ содержит массив, элементы которого имеют следующие поля
| Поле | Тип | Описание |
|---|---|---|
| message | String | Сообщение ответа |
| order_id | Integer | Id заказа |
| code | Integer | Код ответа |