B2C

Обновление заказа в Альфа-Тревел

Пром
PUT https://baas.alfabank.ru/api/order-core/pp/v1/travel/orders/{orderId}
Scope

travelorder

Описание

Метод позволяет обновить заказ в Альфа-Тревел.

Параметры запроса
HEADERS
Атрибут
Описание
Authorization
stringrequired
Content-Type
stringrequired

application/json

PATH
Атрибут
Описание
orderId
stringrequired
BODY
Атрибут
Описание
objectrequired

Данные заказа

externalId
stringrequired

Идентификатор заказа в системе партнёра

type
stringrequired

Тип заказа. Возможные значения:

  • •
    AVIA - авиабилеты;
  • •
    RAILWAY - железнодорожные билеты;
  • •
    HOTEL - бронирование отелей;
  • •
    TOUR - пакетные туры
dateTime
stringrequired

Дата и время

totalSum
numberrequired

Общая сумма заказа (RUB)

ruleId
integeroptional

Идентификатор правила расчёта комиссии (Банк сообщает правило партнёру при настройке интеграции)

changeReason
stringrequired

Причина изменения в заказе. Возможные значения:

  • •
    ADDITIONAL_SERVICES - доп. услуги;
  • •
    EXCHANGE - обмен;
  • •
    CHANGE_TIMETABLE - изменение расписания;
  • •
    PARTLY_REFUNDED - частичный возврат
array of objectsoptional

Данные транзакции

sum
numberrequired

Сумма оплаты

currency
stringrequired

Валюта оплаты

maskedCardNumber
stringrequired

Маскированный номер карты

rrn
stringrequired

Уникальный идентификатор банковской транзакции

tokenCode
stringoptional

Номер токена, полученный при оплате через GooglePay/ApplePay

dateTime
stringrequired

Дата и время транзакции (GMT+3)

objectoptional

Данные о кэшбэке

totalSum
numberrequired

Общая сумма кэшбэка

array of objectsoptional

Данные детальной информации кэшбэка

contentId
stringoptional

Идентификатор товарной категории

sum
numberoptional

Суммарный кэшбэк за категорию

accountType
stringoptional

Тип бонусного счёта для оплаты

array of objectsoptional

Данные бонусной части оплаты заказа

type
integerrequired

Тип бонусной операции. Возможные значения

  • •
    0 - оплата основного заказа;
  • •
    1 - фиксированная ставка;
  • •
    2 - процент от суммы;
  • •
    3 - комиссия третьих лиц
sumRubEquivalent
numberrequired

Сумма оплаты бонусными единицами в рублёвом эквиваленте

sum
numberrequired

Сумма оплаты

comment
stringoptional

Комментарий к оплате бонусной частью

array of objectsoptional

Данные денежной части оплаты заказа

type
stringrequired

Тип оплаты рублями

sum
numberrequired

Сумма оплаты

currency
stringrequired

Валюта оплаты

objectrequired

Содержимое заказа

utilizationDate
stringoptional

Дата утилизации тура

reservationSource
stringrequired

Источник бронирования. Возможные значения:

  • •
    WEBVIEW - вебвью;
  • •
    SITE - сайт
array of objectsoptional

Данные дополнительных услуг

name
stringrequired

Наименование доп. услуги

type
stringrequired

Тип доп. услуги

sum
numberrequired

Сумма оплаты

currency
stringrequired

Валюта оплаты

tripType
stringoptional

Тип путешествия. Возможные значения:

  • •
    OW - в одну сторону;
  • •
    RT - туда-обратно;
  • •
    CX - сложный маршрут
array of objectsoptional

Данные перелёта или ЖД переезда

class
stringoptional

Класс билета

type
stringrequired

Тип рейса/поезда

sequence
integeroptional

Последовательность

number
stringoptional

Номер рейса/поезда

supplier
stringoptional

Название перевозчика

direction
stringoptional

Направление

objectrequired

Данные отправления

dateTime
stringoptional

Дата и время

city
stringrequired

Код города отправления/прибытия

country
stringrequired

Код страны отправления/прибытия:

  • •
    для перелётов в формате ISO 3166-1 Alpha-2;
  • •
    для ЖД переездов в соответствии со справочником РЖД
point
stringrequired

Код аэропорта/вокзала отправления/прибытия:

  • •
    для аэропортов в формате IATA Alpha-3;
  • •
    для вокзалов в соответствии со справочником РЖД
pointName
stringoptional

Наименование аэропорта

objectrequired

Данные прибытия

dateTime
stringoptional

Дата и время

city
stringrequired

Код города отправления/прибытия

country
stringrequired

Код страны отправления/прибытия:

  • •
    для перелётов в формате ISO 3166-1 Alpha-2;
  • •
    для ЖД переездов в соответствии со справочником РЖД
point
stringrequired

Код аэропорта/вокзала отправления/прибытия:

  • •
    для аэропортов в формате IATA Alpha-3;
  • •
    для вокзалов в соответствии со справочником РЖД
pointName
stringoptional

Наименование аэропорта

array of objectsoptional

Данные багажа

type
stringrequired

Тип багажа

amount
integerrequired

Количество багажа

weight
numberrequired

Вес багажа (кг)

width
numberoptional

Ширина багажа (см)

length
numberoptional

Длина багажа (см)

height
numberoptional

Высота багажа (см)

objectoptional

Данные отеля

name
stringrequired

Наименование отеля

roomType
stringrequired

Тип комнаты

checkInDate
stringrequired

Дата и время заезда

checkOutDate
stringrequired

Дата и время выезда

city
stringrequired

Код города отеля

country
stringrequired

Код страны отеля (ISO 3166-1 Alpha-2)

stars
integeroptional

Количество звёзд отеля

mealType
stringoptional

Тип питания

objectoptional

Данные тура

operator
stringrequired

Наименование оператора тура

provider
stringoptional

Наименование провайдера тура

objectrequired

Данные путешественников

adults
integerrequired

Количество взрослых

children
integerrequired

Количество детей

infants
integerrequired

Количество младенцев

objectoptional

Данные для аналитики

bookingType
stringoptional

Тип бронирования

startPrice
numberoptional

Цена нетто (RUB)

markup
numberoptional

Наценка (RUB)

aviakassaFee
numberoptional

Комиссия авиакассы (RUB)

supplierFee
numberoptional

Комиссия поставщика (RUB)

gdsBonus
numberoptional

Комиссия GDS (RUB)

comissionFee
numberoptional

Комиссионное вознаграждение (RUB)

array of objectsoptional

Данные билетов и идентификаторов пассажиров

id
integeroptional

Идентификатор пассажира

ticketNumber
stringoptional

Номер билета

array of objectsoptional

Данные перелёта

flightNumber
stringoptional

Номер рейса

locator
stringoptional

Локатор

Пример запроса
Язык 
1curl --location --globoff --request PUT 'https://baas.alfabank.ru/api/order-core/pp/v1/travel/orders/{orderId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--data '{
5  "order": {
6    "externalId": "3248901",
7    "type": "AVIA",
8    "dateTime": "2023-10-05T14:30:00.000Z",
9    "totalSum": 254.1,
10    "ruleId": 12,
11    "changeReason": "CHANGE_TIMETABLE",
12    "transaction": [
13      {
14        "sum": 800,
15        "currency": "RUB",
16        "maskedCardNumber": "12345678******78912",
17        "rrn": "1498745362575217925125545565",
18        "tokenCode": "65941241914",
19        "dateTime": "2023-10-05T14:30:00.000Z",
20        "cashback": {
21          "totalSum": 1850,
22          "cashbackDetailList": [
23            {
24              "contentId": "12",
25              "sum": 800
26            }
27          ]
28        }
29      }
30    ],
31    "accountType": "Мили",
32    "bonusPayment": [
33      {
34        "type": 0,
35        "sumRubEquivalent": 1000,
36        "sum": 500,
37        "comment": "Оплачиваю часть милями"
38      }
39    ],
40    "cashPayment": [
41      {
42        "type": "Оплата комиссии в пользу 3-их лиц",
43        "sum": 500,
44        "currency": "RUB"
45      }
46    ],
47    "content": {
48      "utilizationDate": "2023-10-05T14:30:00.000Z",
49      "reservationSource": "WEBVIEW",
50      "additionalServices": [
51        {
52          "name": "Выбор места",
53          "type": "place_choice",
54          "sum": 500,
55          "currency": "RUB"
56        }
57      ],
58      "tripType": "OW",
59      "segments": [
60        {
61          "class": "A",
62          "type": "REGULAR",
63          "sequence": 1,
64          "number": "P-06-28921",
65          "supplier": "Ural Airlines",
66          "direction": "0",
67          "departure": {
68            "dateTime": "2023-10-05T14:30:00.000Z",
69            "city": "MOW",
70            "country": "RU",
71            "point": "VKO",
72            "pointName": "Внуково"
73          },
74          "arrival": {
75            "dateTime": "2023-10-05T14:30:00.000Z",
76            "city": "MOW",
77            "country": "RU",
78            "point": "VKO",
79            "pointName": "Внуково"
80          },
81          "luggage": [
82            {
83              "type": "Wheeled Duffel Bags",
84              "amount": 5,
85              "weight": 10,
86              "width": 10,
87              "length": 5,
88              "height": 5
89            }
90          ]
91        }
92      ],
93      "hotel": {
94        "name": "Горный пик",
95        "roomType": "Номер эконом с 1 двуспальной кроватью",
96        "checkInDate": "2020-10-12T12:00:00.000Z",
97        "checkOutDate": "2020-10-14T15:00:00.000Z",
98        "city": "MOW",
99        "country": "RU",
100        "stars": 4,
101        "mealType": "halfBoardDinner"
102      },
103      "tour": {
104        "operator": "SpaceTravel",
105        "provider": "Travel"
106      },
107      "travelers": {
108        "adults": 2,
109        "children": 1,
110        "infants": 1
111      }
112    },
113    "reportData": {
114      "bookingType": "GDS",
115      "startPrice": 255.55,
116      "markup": 255.96,
117      "aviakassaFee": 100000,
118      "supplierFee": 555657,
119      "gdsBonus": 1000,
120      "comissionFee": 5898,
121      "passengers": [
122        {
123          "id": 756,
124          "ticketNumber": "E584"
125        }
126      ],
127      "flights": [
128        {
129          "flightNumber": "ST006",
130          "locator": "26W4GS"
131        }
132      ]
133    }
134  }
135}'
Параметры ответа
1Нет тела ответа
Нет тела ответа
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    validation_error - неверные входные параметры запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 400 (Bad Request) 
1{
2  "error": "validation_error",
3  "error_description": "Field order.type: must not be null"
4}
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    invalid_token - предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощью refresh_token. При отзыве токена необходимо заново пройти авторизацию
error_description
stringoptional

Описание ошибки

Пример ошибки 401 (Unauthorized) 
1{
2  "error": "invalid_token",
3  "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}
BODY
атрибут
описание
error
stringoptional

Описание ошибки. Принимает возможные значения:

  • •
    forbidden / insufficient_scope - у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
error_description
stringoptional

Описание ошибки

Пример ошибки 403 (Forbidden) 
1{
2  "error": "insufficient_scope",
3  "error_description": "The request requires higher privileges than provided by the access token"
4}
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    unknown_endpoint - эндпоинт не найден или неактивен
error_description
stringoptional

Описание ошибки

Пример ошибки 404 (Not Found) 
1{
2  "error": "unknown_endpoint",
3  "error_description": "Endpoint is not found or not active"
4}
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    incorrect_status - некорректный статус заказа
error_description
stringoptional

Описание ошибки

Пример ошибки 422 (Unprocessable Entity) 
1{
2  "error": "incorrect_status",
3  "error_description": "Incorrect status"
4}
Нет тела ответа
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    internal_server_error - внутренняя ошибка сервиса при выполнении обработки запроса
error_description
stringoptional

Описание ошибки

Пример ошибки 500 (Internal Server Error) 
1{
2  "error": "internal_server_error",
3  "error_description": "Internal server error"
4}
BODY
атрибут
описание
error
stringoptional

Код ошибки. Принимает возможные значения:

  • •
    bad_gateway - ошибка взаимодействия с внешним сервисом при обработке запроса
error_description
stringoptional

Описание ошибки. Принимает возможные значения:

  • •
    Can't unhold miles - не удалось отменить холдирование бонусных единиц;
  • •
    Delete order - не удалось выполнить холдирование бонусных единиц после отмены холдирования, удалите заказ;
  • •
    Can't hold miles - не удалось выполнить холдирование;
  • •
    Can't return miles - не удалось вернуть бонусные единицы
Пример ошибки 502 (Bad Gateway) 
1{
2  "error": "bad_gateway",
3  "error_description": "Can't unhold miles"
4}
Нет тела ответа
Создание заказа в Альфа-ТревелСоздание заказа в Альфа-Афише