Scope
promocodes
Описание
Метод позволяет клиенту получить список своих промокодов.
Параметры запроса
Bearer {access_token}, полученный по Authorization Code Flow
application/json
1curl --location 'https://baas.alfabank.ru/api/order-core/pp/v1/promocodes' \
2--header 'Authorization: Bearer {access-token}' \
3--header 'Accept: application/json'Параметры ответа
1[
2 {
3 "value": "XWH25NYQA8UW",
4 "status": "ASSIGNED",
5 "redemptionDeadlineAt": "2024-12-31T23:59:59",
6 "activationDeadlineAt": "2024-12-15T23:59:59",
7 "updatedAt": "2024-12-31T23:59:59",
8 "name": "1000 рублей в Альфа-Тревел",
9 "description": "Промокод на возврат 1000 рублей за покупку от 10 000 рублей в сервисе Альфа-Тревел. Срок действия промокода - 30 дней",
10 "termsPdfUrl": "https://alfabank.servicecdn.ru/site-upload/a3/91/2366/rules_promocode1000_alfatravel_3092025.pdf,https://alfachannels.servicecdn.ru/docs/Promotion_code_FAQ_Travel.pdf",
11 "minOrderAmount": "3000",
12 "amount": "500",
13 "pictureUrl": "https://alfa-mobile.alfabank.ru/mobile/s3/static/loyalty/discoball.png",
14 "deepLink": "alfabank://webFeature?type=recommendation&url=https%3A%2F%2Fweb.alfabank.ru%2Fpartner-offers%2Ftravel-router%3Fpartner%3DALFASITE",
15 "deepLinkButtonText": "За покупками",
16 "detailedFaqPdfUrl": "https://storage.example.com/faq/summer2024_faq.pdf",
17 "offerPictureUrl": "https://storage.example.com/offers/summer_main.jpg",
18 "campaignId": "POEHALI"
19 }
20]Значение промокода
Статус промокода. Принимает возможные значения:
-
•
ASSIGNED- промокод закреплён за клиентом, ожидание активации; -
•
ACTIVATED- промокод активирован, счётчик создан
Срок применения активированного промокода. Дата и время (включительно) в формате ISO 8601, до которой должна быть выполнена оплата по активированному промокоду. Рассчитывается в момент активации промокода в сервисе партнёра
Срок активации промокода. Дата и время (включительно) в формате ISO 8601, до которой клиент должен ввести промокод в сервисе партнёра
Дата обновления промокода в формате ISO 8601
Заголовок промокода
Описание промокода
Ссылка на подробные условия
Минимальная сумма покупки в минорных единицах (копейки)
Номинал промокода в минорных единицах (копейки)
Ссылка на хранилище картинок
Диплинк на раздел приложения, в котором можно использовать промокод
Название кнопки, на которой будет размещён диплинк
Ссылка на часто задаваемые вопросы для сервиса партнёра
Расположение картинки для главного фото в карточке промокода
Кампейн ID (Универсальный промокод)
1[
2 {
3 "value": "XWH25NYQA8UW",
4 "status": "ASSIGNED",
5 "redemptionDeadlineAt": "2024-12-31T23:59:59",
6 "activationDeadlineAt": "2024-12-15T23:59:59",
7 "updatedAt": "2024-12-31T23:59:59",
8 "name": "1000 рублей в Альфа-Тревел",
9 "description": "Промокод на возврат 1000 рублей за покупку от 10 000 рублей в сервисе Альфа-Тревел. Срок действия промокода - 30 дней",
10 "termsPdfUrl": "https://alfabank.servicecdn.ru/site-upload/a3/91/2366/rules_promocode1000_alfatravel_3092025.pdf,https://alfachannels.servicecdn.ru/docs/Promotion_code_FAQ_Travel.pdf",
11 "minOrderAmount": "3000",
12 "amount": "500",
13 "pictureUrl": "https://alfa-mobile.alfabank.ru/mobile/s3/static/loyalty/discoball.png",
14 "deepLink": "alfabank://webFeature?type=recommendation&url=https%3A%2F%2Fweb.alfabank.ru%2Fpartner-offers%2Ftravel-router%3Fpartner%3DALFASITE",
15 "deepLinkButtonText": "За покупками",
16 "detailedFaqPdfUrl": "https://storage.example.com/faq/summer2024_faq.pdf",
17 "offerPictureUrl": "https://storage.example.com/offers/summer_main.jpg",
18 "campaignId": "POEHALI"
19 }
20]Код ошибки. Принимает возможные значения:
-
•
validation_error/invalid_request- неверные входные параметры запроса
Описание ошибки
1{
2 "error": "validation_error",
3 "error_description": "Field sum: must not be null"
4}Код ошибки. Принимает возможные значения:
-
•
invalid_token- предоставленный токен просрочен, отозван, имеет неправильный формат или недействителен по другим причинам. При истечении срока жизни токена необходимо обновить его с помощьюrefresh_token. При отзыве токена необходимо заново пройти авторизацию
Описание ошибки
1{
2 "error": "invalid_token",
3 "error_description": "The access token provided is expired, revoked, malformed, or invalid for other reasons"
4}Код ошибки. Принимает возможные значения:
-
•
access_denied- доступ к счету запрещён; -
•
insufficient_scope- у пользователя нет прав на использование запрашиваемого сервиса, доступ к которому не предусмотрен настройками scope
Описание ошибки
1{
2 "error": "insufficient_scope",
3 "error_description": "The request requires higher privileges than provided by the access token"
4}Код ошибки. Принимает возможные значения:
-
•
unknown_endpoint- эндпоинт не найден или неактивен
Описание ошибки
1{
2 "error": "unknown_endpoint",
3 "error_description": "Endpoint is not found or not active"
4}Код ошибки. Принимает возможные значения:
-
•
internal_server_error- внутренняя ошибка сервиса при выполнении обработки запроса
Описание ошибки
1{
2 "error": "internal_server_error",
3 "error_description": "Internal server error"
4}Код ошибки. Принимает возможные значения:
-
•
external_error- ошибка взаимодействия с внешним сервисом при обработке запроса; -
•
cant_get_promocodes- не удалось найти промокоды
Описание ошибки
1{
2 "error": "external_error",
3 "error_description": "External error"
4}