B2C

Создание заказа в Альфа-Афише

Пром
POST https://baas.alfabank.ru/api/order-core/pp/v1/afisha/orders
Scope

afishaorder

Описание

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

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

application/json

Content-Type
stringrequired

application/json

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

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

externalId
stringrequired

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

accountType
stringoptional

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

ruleId
integeroptional

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

type
stringrequired

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

  • •
    EVENT - мероприятие
dateTime
stringrequired

Дата и время

totalSum
numberrequired

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

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

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

eventName
stringrequired

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

eventId
stringrequired

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

venue
stringrequired

Наименование площадки мероприятия

country
stringrequired

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

city
stringrequired

Код города мероприятия

date
stringrequired

Дата и время мероприятия

address
stringrequired

Адрес мероприятия

array of objectsoptional

Данные билетов

seat
stringoptional

Место

row
stringoptional

Ряд

sector
stringoptional

Сектор

Пример запроса
Язык
1curl --location 'https://baas.alfabank.ru/api/order-core/pp/v1/afisha/orders' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Content-Type: application/json' \
4--header 'Accept: application/json' \
5--data '{
6  "order": {
7    "externalId": "3248901",
8    "accountType": "Мили",
9    "ruleId": 12,
10    "type": "EVENT",
11    "dateTime": "2023-10-05T14:30:00.000Z",
12    "totalSum": 254.1,
13    "bonusPayment": [
14      {
15        "type": 0,
16        "sumRubEquivalent": 1000,
17        "sum": 500,
18        "comment": "Оплачиваю часть милями"
19      }
20    ],
21    "cashPayment": [
22      {
23        "type": "Оплата комиссии в пользу 3-их лиц",
24        "sum": 500,
25        "currency": "RUB"
26      }
27    ],
28    "content": {
29      "eventName": "Концерт A Studio",
30      "eventId": "AST_P_007",
31      "venue": "Зелёный театр",
32      "country": "RU",
33      "city": "MOW",
34      "date": "2029-10-05T14:30:00.000Z",
35      "address": "Г.Москва, 123134, улица Народного Ополчения",
36      "tickets": [
37        {
38          "seat": "32",
39          "row": "10",
40          "sector": "B8"
41        }
42      ]
43    }
44  }
45}'
Параметры ответа
Пример ответа 200 (OK)
1{
2  "orderId": "40b3c2d2-e491-4b19-94cd-461e6fa35a60",
3  "status": "Order already exists"
4}
BODY
атрибут
описание
orderId
stringoptional

Идентификатор заказа в Банке

status
stringoptional

Результат создания заказа

Пример ответа 200 (OK)
1{
2  "orderId": "40b3c2d2-e491-4b19-94cd-461e6fa35a60",
3  "status": "Order already exists"
4}
BODY
атрибут
описание
orderId
stringoptional

Идентификатор заказа в Банке

status
stringoptional

Результат создания заказа

Пример ответа 201 (Created)
1{
2  "orderId": "40b3c2d2-e491-4b19-94cd-461e6fa35a60",
3  "status": "Created"
4}
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

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

  • •
    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

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

Пример ошибки 502 (Bad Gateway)
1{
2  "error": "bad_gateway",
3  "error_description": "Can't hold miles"
4}
Нет тела ответа