Назад

Заявки

Работа с заявкиами. Все запросы для работы с заявками начинаются с https://api.virginiavip.ru/order/.

Создание заявки

Для создания заявки используется обращение к API по адресу: https://api.virginiavip.ru/order/create/.

Данные запроса необходимо передать HTTP-методом POST, данные заявки помещаются в тело запроса в формате JSON.

Параметры тела запроса:

Параметр Тип Описание
flightData object Содержит сериализованные данные полетных данных.
flightData[terminal] string Код VIP/Бизнес зала (список доступных кодов с наименованиями можно получить по запросу)
flightData[direction] string Направление: arrival - прилет; departure - вылет.
flightData[date] string Дата вылета/прилета в формате: YYYY-MM-DD
flightData[time] string Время вылета/прилета в формате: HH:MM
flightData[number] string Код авиакомпании и номер рейса.
flightData[wayIataFrom] string IATA-код аэропорта вылета.
flightData[wayIataTo] string IATA-код аэропорта прилета.
passengers[] array of objects Список сериализованных объектов данных по пассажирам.
passengers[][lastname] string Фамилия пассажира.
passengers[][name] string Имя пассажира.
passengers[][middlename] string Отчество пассажира.
passengers[][birthday] string Дата рождения пассажира в формате: YYYY-MM-DD
extraServices[] array of objects Список сериализованных объектов данных по дополнительным услугам. Список дополнительных услуг для каждого зала разные, поэтому предварительно нужно запросить список дополнительных услуг для конкретного зала.
extraServices[][code] string Код дополнительной услуги
extraServices[][count] integer Количество для дополнительной услуги (если допустимо для конкретной услуги)
extraServices[][text] string Текст для дополнительной услуги (если допустимо для конкретной услуги)
extraServices[][child][] array of objects Список параметров для дополнительной услуги (если допустимо для конкретной услуги)
extraServices[][child][][code] string Код параметра дополнительной услуги
extraServices[][child][][count] integer Количество для параметра дополнительной услуги (если допустимо для конкретной услуги)
extraServices[][child][][text] string Текст для параметра дополнительной услуги (если допустимо для конкретной услуги)
automobiles[] array of objects Список сериализованных объектов данных по автомобилям.
automobiles[][model] string Модель автомобиля
automobiles[][number] string Государственный номер автомобиля
contacts[] array of objects Список сериализованных объектов контактов. Передается только один.
contacts[][lastname] string Фамилия
contacts[][name] string Имя
contacts[][middlename] string Отчество
contacts[][phone] string Мобильный телефон
contacts[][phone2] string Дополнительный телефон
contacts[][email] string Электронная почта
Данные дополнительных услуг должны содержать только применяемые к заявке дополнительные услуги (в зависимости от передаваемого зала бронирования) с параметрами дополнительной услуги. Коды дополнительных услуг, отсутствующие в заявке, не должны содержаться в запросе. Дополнительные услуги для каждого зала бронирования можно получить запросом Список дополнительных услуг.

В результате будет возвращен ответ:

Параметр Тип Описание
status string Статус выполнения запроса: success - успешно; error - с ошибками.
data object Сериализованный результат ответа.
data[number] integer Номер сформированной заявки.
data[orderId] integer Номер сформированной заявки. Устаревший параметр и в будущих версиях будет исключен
data[sumTariff] float Сумма заявки по тарифам для пассажиров.
data[sumExtraService] float Сумма заявки по дополнительным услугам.
data[sumTotal] float Итоговая сумма заявки.

Расчет стоимости заявки

Для расчета стоимости заявки используется обращение к API по адресу: https://api.virginiavip.ru/order/calc/.

Данные запроса необходимо передать HTTP-методом POST, данные заявки помещаются в тело запроса в формате JSON.

Параметры тела запроса:

Параметр Тип Описание
flightData object Содержит сериализованные данные полетных данных.
flightData[terminal] string Код VIP/Бизнес зала (список доступных кодов с наименованиями можно получить по запросу)
flightData[direction] string Направление: arrival - прилет; departure - вылет.
flightData[date] string Дата вылета/прилета в формате: YYYY-MM-DD
flightData[time] string Время вылета/прилета в формате: HH:MM
flightData[number] string Код авиакомпании и номер рейса.
flightData[wayIataFrom] string IATA-код аэропорта вылета.
flightData[wayIataTo] string IATA-код аэропорта прилета.
passengers[] array of objects Список сериализованных объектов данных по пассажирам.
passengers[][birthday] string Дата рождения пассажира в формате: YYYY-MM-DD
extraService[] array of objects Список серализованных объектов данных по дополнительным услугам.
extraService[][code] string Код дополнительной услуги
extraService[][count] integer Количество для дополнительной услуги (если допустимо для конкретной услуги)
Данные дополнительных услуг должны содержать только применяемые к заявке дополнительные услуги (в зависимости от передаваемого зала бронирования) с параметрами дополнительной услуги. Коды дополнительных услуг, отсутствующие в заявке, не должны содержаться в запросе. Дополнительные услуги для каждого зала бронирования можно получить запросом Список дополнительных услуг.

В результате будет возвращен ответ:

Параметр Тип Описание
status string Статус выполнения запроса: success - успешно; error - с ошибками.
data object Сериализованный результат ответа.
data[sumTariff] float Сумма заявки по тарифам для пассажиров.
data[sumExtraService] float Сумма заявки по дополнительным услугам.
data[sumTotal] float Итоговая сумма заявки.

Список дополнительных услуг

Для получения списка дополнительных услуг используется обращение к API по адресу: https://api.virginiavip.ru/order/extra-services/.

Запроса необходимо передать HTTP-методом GET.

Параметры тела запроса:

Параметр Тип Описание
airport_code string Код зала бронирования, для которого необходимо получить список доступных дополнительных услуг. Если параметр не указан, то будут возвращены все возможные дополнительные услуги.

В результате будет возвращен ответ:

Параметр Тип Описание
status string Статус выполнения запроса: success - успешно; error - с ошибками.
data array of objects Сериализованный результат ответа.
data[][code] string Код дополнительной услуги.
data[][title_en] string Наименование дополнительной услуги на английском языке.
data[][title_ru] string Наименование дополнительной услуги на русском языке.
data[][customer_text] integer Если 1 - для дополнительной услуги необходим пользовательский текст, если 0 - пользовательский текст не предусмотрен.
data[][customer_count] integer Если 1 - для дополнительной услуги необходимо указать количество, если 0 - ввод количества не предусмотрен.
data[][unit_en] integer Наименование для количества на английском языке, если предусмотрен ввод количества.
data[][unit_ru] integer Наименование для количества на русском языке, если предусмотрен ввод количества.
data[][child] array of objects Набор парамтров дополнительной услуги.
data[][child][][code] string Код для параметра дополнительной услуги.
data[][child][][title_en] string Наименование для параметра дополнительной услуги на английском языке.
data[][child][][title_ru] string Наименование для параметра дополнительной услуги на русском языке.
data[][child][][customer_text] integer Если 1 - для параметра дополнительной услуги необходим пользовательский текст, если 0 - пользовательский текст не предусмотрен.
data[][child][][customer_count] integer Если 1 - для параметра дополнительной услуги необходимо указать количество, если 0 - ввод количества не предусмотрен.
data[][child][][unit_en] integer Наименование для количества на английском языке, если предусмотрен ввод количества (для параметра параметра дополнительной услуги).
data[][child][][unit_ru] integer Наименование для количества на русском языке, если предусмотрен ввод количества (для параметра параметра дополнительной услуги).

Получение данных по существующему бронированию

Для получения информации по заявке, которая уже сформирована, используется обращение к API по адресу: https://api.virginiavip.ru/order/view.

Данные запроса необходимо передать HTTP-методом GET, в качестве параметра запроса передается номер заявки: JSON.

Параметры тела запроса:

Параметр Тип Описание
number string Содержит номер заявки.

В результате будет возвращен ответ:

Параметр Тип Описание
number string Содержит номер заявки.
date string Дата создания заявки в формате: YYYY-MM-DD
status string Статус состояния заявки: issue - требует обработки; confirm - подтверждена; cancel - отменена; precancel - предварительная отмена (заявка отменена с уточнением штрафных санкций, переходит в cancel).
statusPay string Статус состояния оплаты: <пусто> - оплачена; wait - ожидает оплаты; paid - оплачена; refunded - оплата возвращена.
payType string Тип оплаты: <пусто> - не установлен; card - банковской картой; deposit - с депозита.
flightData object Содержит сериализованные данные полетных данных.
flightData[terminal] string Код VIP/Бизнес зала (список доступных кодов с наименованиями можно получить по запросу)
flightData[direction] string Направление: arrival - прилет; departure - вылет.
flightData[date] string Дата вылета/прилета в формате: YYYY-MM-DD
flightData[time] string Время вылета/прилета в формате: HH:MM
flightData[number] string Код авиакомпании и номер рейса.
flightData[way] string Маршрут: откуда - куда.
passengers[] array of objects Список серализованных объектов данных по пассажирам.
passengers[][lastname] string Фамилия пассажира.
passengers[][name] string Имя пассажира.
passengers[][middlename] string Отчество пассажира.
passengers[][birthday] string Дата рождения пассажира в формате: YYYY-MM-DD
automobiles[] array of objects Список сериализованных объектов данных по автомобилям.
automobiles[][model] string Модель автомобиля
automobiles[][number] string Государственный номер автомобиля
extraService[] array of objects Список сериализованных объектов данных по дополнительным услугам.
extraService[][code] string Код дополнительной услуги
extraService[][count] integer Количество для дополнительной услуги (если допустимо для конкретной услуги)
extraService[][text] string Текст для дополнительной услуги (если допустимо для конкретной услуги)
extraService[][child][] array of objects Список параметров для дополнительной услуги (если допустимо для конкретной услуги)
extraService[][child][][code] string Код параметра дополнительной услуги
extraService[][child][][count] integer Количество для параметра дополнительной услуги (если допустимо для конкретной услуги)
extraService[][child][][text] string Текст для параметра дополнительной услуги (если допустимо для конкретной услуги)
sum object Данные по итоговым суммам по заявке.
sum[sumTariff] float Сумма заявки по тарифам для пассажиров.
sum[sumExtraService] float Сумма заявки по дополнительным услугам.
sum[sumTotal] float Итоговая сумма заявки.

Получение списка созданных бронирований

Для получнеия списка заявок, которые уже сформированы, используется обращение к API по адресу: https://api.virginiavip.ru/order/list.

Данные запроса необходимо передать HTTP-методом GET, в качестве параметра запроса передается номер страницы списка: JSON.

Параметры тела запроса:

Параметр Тип Описание
page integer Содержит номер страницы. Если параметр не передан, то передается первая страница.

В результате будет возвращен ответ, содержащий до 50ти номеров заявок, которые были сформированы:

Параметр Тип Описание
orders[] array of objects Содержит сериализованные данные полетных данных.
orders[][number] string Содержит номер бронирования.
orders[][date] string Дата и время создания бронирования: YYYY-MM-DD HH:MM:SS.
paginator object Данные по страницам списка.
paginator[page] integer Номер текущей страницы.
paginator[pages] integer Всего страниц списка по 50 элементов.
paginator[totalCount] integer Всего доступных заявок.

Редактирование заявки

Для редактирования заявки используется обращение к API по адресу: https://api.virginiavip.ru/order/edit/.

Данные запроса необходимо передать HTTP-методом POST, данные заявки помещаются в тело запроса в формате JSON.

Параметры тела запроса:

Параметр Тип Описание
number integer Номер бронирование, редактирование которого выполняется.
confirmationCode string Код подтверждения операции, который возвращается при попытке отредактировать заявку с получением предупреждений. При первой отправке заявки на изменение этот код не передается.
flightData object Содержит сериализованные данные полетных данных.
flightData[terminal] string Код VIP/Бизнес зала (список доступных кодов с наименованиями можно получить по запросу)
flightData[direction] string Направление: arrival - прилет; departure - вылет.
flightData[date] string Дата вылета/прилета в формате: YYYY-MM-DD
flightData[time] string Время вылета/прилета в формате: HH:MM
flightData[number] string Код авиакомпании и номер рейса.
flightData[wayIataFrom] string IATA-код аэропорта вылета.
flightData[wayIataTo] string IATA-код аэропорта прилета.
passengers[] array of objects Список сериализованных объектов данных по пассажирам.
passengers[][lastname] string Фамилия пассажира.
passengers[][name] string Имя пассажира.
passengers[][middlename] string Отчество пассажира.
passengers[][birthday] string Дата рождения пассажира в формате: YYYY-MM-DD
extraServices[] array of objects Список сериализованных объектов данных по дополнительным услугам. Список дополнительных услуг для каждого зала разные, поэтому предварительно нужно запросить список дополнительных услуг для конкретного зала.
extraServices[][code] string Код дополнительной услуги
extraServices[][count] integer Количество для дополнительной услуги (если допустимо для конкретной услуги)
extraServices[][text] string Текст для дополнительной услуги (если допустимо для конкретной услуги)
extraServices[][child][] array of objects Список параметров для дополнительнеой услуги (если допустимо для конкретной услуги)
extraServices[][child][][code] string Код параметра дополнительной услуги
extraServices[][child][][count] integer Количество для параметра дополнительной услуги (если допустимо для конкретной услуги)
extraServices[][child][][text] string Текст для параметра дополнительной услуги (если допустимо для конкретной услуги)
automobiles[] array of objects Список сериализованных объектов данных по автомобилям.
automobiles[][model] string Модель автомобиля
automobiles[][number] string Государственный номер автомобиля
contacts[] array of objects Список сериализованных объектов контактов. Передается только один.
contacts[][lastname] string Фамилия
contacts[][name] string Имя
contacts[][middlename] string Отчество
contacts[][phone] string Мобильный телефон
contacts[][phone2] string Дополнительный телефон
contacts[][email] string Электронная почта
Данные дополнительных услуг должны содержать только применяемые к заявке дополнительные услуги (в зависимости от передаваемого зала бронирования) с параметрами дополнительной услуги. Коды дополнительных услуг, отсутствующие в заявке, не должны содержаться в запросе. Дополнительные услуги для каждого зала бронирования можно получить запросом Список дополнительных услуг.

В результате будет возвращен ответ:

Параметр Тип Описание
status string Статус выполнения запроса: success - успешно; error - с ошибками; confirm - требует подтверждения.
data object Сериализованный результат ответа.
data[number] integer Номер сформированной заявки.
data[orderId] integer Номер сформированной заявки. Устаревший параметр и в будущих версиях будет исключен
data[sumTariff] float Сумма заявки по тарифам для пассажиров.
data[sumExtraService] float Сумма заявки по дополнительным услугам.
data[sumTotal] float Итоговая сумма заявки.
confirmationCode string Код подтверждения операции, который возвращается при попытке отредактировать заявку с получением предупреждений. Необходимо передать при повторной подаче заявки.
notices object Сериализованный результат информационных сообщений. Используется для получения информации в случае статуса confirm
notices[code] integer Код сообщения.
notices[message] string Текст сообщения.
errors object Сериализованный результат сообщений об ошибках. Используется при статусе error
errors[code] integer Код сообщения.
errors[message] string Текст сообщения.
warnings object Сериализованный результат предупреждений.
warnings[code] integer Код сообщения.
warnings[message] string Текст сообщения.

Отмена заявки

Для отмены заявки используется обращение к API по адресу: https://api.virginiavip.ru/order/cancel/.

Данные запроса необходимо передать HTTP-методом POST, данные заявки помещаются в тело запроса в формате JSON.

Параметры тела запроса:

Параметр Тип Описание
number integer Номер бронирование, отмена которого выполняется.

В результате будет возвращен ответ:

Параметр Тип Описание
status string Статус выполнения запроса: success - успешно; error - с ошибками; confirm - требует подтверждения.
data object Сериализованный результат ответа.
data[request] string Результат обработки запроса: approve - операция завершена успешно; Если запрос завершен с ошибкой, то параметр не передается.
data[penaltyPercent] integer Размер штрафных санкция, передается в случае если при отмене применяется штраф.. Если запрос завершен с ошибкой, то параметр не передается.
notices object Сериализованный результат информационных сообщений. Используется для получения информации в случае статуса confirm
notices[code] integer Код сообщения.
notices[message] string Текст сообщения.
errors object Сериализованный результат сообщений об ошибках. Используется при статусе error
errors[code] integer Код сообщения.
errors[message] string Текст сообщения.
warnings object Сериализованный результат предупреждений.
warnings[code] integer Код сообщения.
warnings[message] string Текст сообщения.