B2C

Деактивация заказа

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

coreorders

Описание

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

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

application/json

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

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

sumRubEquivalent
numberrequired

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

sum
numberrequired

Сумма возврата

comment
stringoptional

Комментарий к возврату

Пример запроса
Язык
1curl --location --globoff --request PATCH 'https://baas.alfabank.ru/api/order-core/pp/v1/orders/{orderId}' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--data '{
5  "accountType": "Мили",
6  "sumRubEquivalent": 600,
7  "sum": 600,
8  "comment": "Добровольный возврат"
9}'
Параметры ответа
1Нет тела ответа
Нет тела ответа
BODY
атрибут
описание
error
stringoptional

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

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

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

Пример ошибки 400 (Bad Request)
1{
2  "error": "validation_error",
3  "error_description": "Field sum: 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 - эндпоинт не найден или неактивен;
  • •
    not_found - заказ не найден
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

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

  • •
    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 - не удалось отменить холдирование;
  • •
    Can't return miles - не удалось вернуть бонусные единицы
Пример ошибки 502 (Bad Gateway)
1{
2  "error": "bad_gateway",
3  "error_description": "Can't unhold miles"
4}
Нет тела ответа