Получить страницу утилизаций акций по подпискам за период
/info/subscriptions/allPreferencesUsage
Получить страницу утилизаций акций по подпискам за период
Запрос
Header Parameters
Возможные значения: <= 32 characters
, Value must match regular expression ^[0-9a-fA-F]{32}$
Уникальный идентификатор запроса
Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Идентификатор внешней системы
Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Идентификатор внешней подсистемы
- application/json
Body
required
Array [
]
Возможные значения: [SBER_ID
, EPC_RB_ID
, EPC_CB_ID
, ERIB_ID
, MDM_ID
, DIALOG_ID
, MOBILE_PHONE
, EMAIL
, ESIA_ID
, SUB
, CRM_ID
, CRM_ID_NO_CLIENT
]
Тип внешнего идентификатора потребителя (По умолчанию SUB)
Значение должно соответствовать регулярному выражению ^[A-Fa-f0-9]{16,100}$
Внешний идентификатор клиента (Примечание: Допускается конвертация значения данного поля шлюзом интеграции при keyType = SUB)
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\d$
День начала периода включительно
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\d$
День завершения периода включительно
Возможные значения: <= 100
Перечень идентификаторов агрегаторов группы пакетов (При отсутствии производится поиск действующих подписок по всем агрегаторам)
paging
object
Параметры пагинации
Возможные значения: >= 0
и <= 1000000
Номер страницы
Возможные значения: >= 0
и <= 1000000
Количество элементов на странице
sorts
object[]
Possible values: <= 30
Параметры сортировки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Наименование поля
Возможные значения: [ASC
, DESC
]
Направление сортировки
OK
- application/json
- Схема
- Пример из схемы
Schema
Array [
Array [
]
Array [
Array [
]
]
]
preferences
object[]
required
Possible values: <= 1000
Список представлений операций по подпискам клиента
Возможные значения: >= 0
и <= 1000000
Базовая стоимость пакета
Возможные значения: >= 0
и <= 1000000
Текущая расчетная стоимость следующего периода
Возможные значения: >= 0
и <= 1000000
Сумма скидок которые могут быть применены к оплате следующего периода
Возможные значения: >= 0
и <= 2147483647
Количество дней которые могут быть применены к оплате следующего периода для его увеличения
currentPreferences
object[]
Possible values: <= 1000
Перечень акций которые могут быть применены к оплате следующего периода
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Мнемоническое наименование системы владельца акции
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Мнемоническое н аименование подсистемы владельца акции
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Z-_ ]{1,36}$
Идентификатор акционной компании
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Наименование акции преференции
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,100}$
Артикул ячейки корзины
appliedPreferences
object[]
required
Possible values: <= 1000
Перечень заказов с примененными преференциями
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Z-_ ]{1,32}$
Идентификатор заказа
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d\d\d$
Дата время авторизации платежа
preferences
object[]
required
Possible values: <= 100
Перечень примененны х преференций
Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Мнемоническое наименование системы владельца акции
Значение должно соответствовать регулярному выражению ^[0-9A-Z_. -]{1,50}$
Мнемоническое наименование подсистемы владельца акции
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,36}$
Идентификатор акционной компании
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,200}$
Наименование акции преференции
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Артикул ячейки корзины
Возможные значения: >= 0
и <= 1000000
Примененная к платежу сумма скидки
Возможные значения: >= 0
и <= 1000000
Использованное в платеже количество дней прибавки к сроку действия подписки
page
object
Параметры пагинации
Возможные значения: >= 0
и <= 1000000
Номер страницы
Возможные значения: >= 0
и <= 2147483647
Количество элементов на странице
Возможные значения: >= 0
и <= 2147483647
Всего страниц
Возможные значения: >= 0
и <= 2147483647
Всего элем ентов
{
"preferences": [
{
"packetOfferPrice": 123.25,
"currentCalculatedPacketOfferPrice": 123.25,
"currentCalculatedDiscountAmount": 123.25,
"currentCalculatedPaymentExpiredIncreaseDays": 257,
"currentPreferences": [
{
"system": "MASS_PERS",
"subSystem": "BLOCK_C",
"id": "54531d01-ec26-41c0-ada4-d0609080dbd9",
"name": "700 Лет Тульскому прянику",
"article": "32423243-32423"
}
],
"appliedPreferences": [
{
"orderId": "12321-12321",
"authDate": "2019-03-12T23:34:12.456+0300",
"preferences": [
{
"system": "MASS_PERS",
"subSystem": "BLOCK_C",
"id": "54531d01-ec26-41c0-ada4-d0609080dbd9",
"name": "700 Лет Тульскому прянику",
"article": "32423243-32423",
"utilizationAmount": 1500,
"utilizationPaymentExpiredIncreaseDays": 10
}
]
}
]
}
],
"page": {
"number": 15,
"size": 100,
"totalPages": 38,
"totalElements": 412
}
}
Bad Request
- application/json
- Схема
- Пример из схемы
Schema
- SberapiError
- HttpError
Array [
]
oneOf
Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$
Код ошибки
Возможные значения: <= 50 characters
, Value must match regular expression ^(.*)$
Описание ошибки
Возможные значения: <= 250 characters
, Value must match regular expression ^(.*)$
Дополнительная информация
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$
Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)
Возможные значения: >= -2147483648
и <= 2147483647
Статус
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Описание статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Бизнес-код ошибки
Значение должно соответств овать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Сообщение об ошибке для отображения на UI без локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$
Описание причины ошибки
params
object[]
Possible values: <= 100
Перечень параметров ошибки для локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Код параметра ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Значение параметра ошибки
{}
Unauthorized
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$
Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)
Возможные значения: >= -2147483648
и <= 2147483647
Статус
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Описание статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Бизнес-код ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Сообщение об ошибке для отображения на UI без локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$
Описание причины ошибки
params
object[]
Possible values: <= 100
Перечень параметров ошибки для локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Код параметра ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Значение параметра ошибки
{
"timestamp": "2020-12-18T06:12:44.672+00:00",
"status": 404,
"error": "Not Found",
"errorCode": "UNKNOWN_ERROR",
"message": "Запись не найдена в БД",
"reason": "Ошибка БД",
"params": [
{
"code": "id",
"value": "b439162d-e60d-426d-979d-17641f2b6ae4"
}
]
}
Forbidden
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$
Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)
Возможные значения: >= -2147483648
и <= 2147483647
Статус
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Описание статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Бизнес-код ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Сообщение об ошибке для отображения на UI без локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$
Описание причины ошибки
params
object[]
Possible values: <= 100
Перечень параметров ошибки для локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Код параметра ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Значение параметра ошибки
{
"timestamp": "2020-12-18T06:12:44.672+00:00",
"status": 404,
"error": "Not Found",
"errorCode": "UNKNOWN_ERROR",
"message": "Запись не найдена в БД",
"reason": "Ошибка БД",
"params": [
{
"code": "id",
"value": "b439162d-e60d-426d-979d-17641f2b6ae4"
}
]
}
Not Found
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$
Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)
Возможные значения: >= -2147483648
и <= 2147483647
Статус
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Описание статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Бизнес-код ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Сообщение об ошибке для отображения на UI без локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$
Описание причины ошибки
params
object[]
Possible values: <= 100
Перечень параметров ошибки для локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Код параметра ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Значение параметра ошибки
{
"timestamp": "2020-12-18T06:12:44.672+00:00",
"status": 404,
"error": "Not Found",
"errorCode": "UNKNOWN_ERROR",
"message": "Запись не найдена в БД",
"reason": "Ошибка БД",
"params": [
{
"code": "id",
"value": "b439162d-e60d-426d-979d-17641f2b6ae4"
}
]
}
Request Timeout
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$
Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)
Возможные значения: >= -2147483648
и <= 2147483647
Статус
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Описание статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Бизнес-код ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Сообщение об ошибке для отображения на UI без локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$
Описание причины ошибки
params
object[]
Possible values: <= 100
Перечень параметров ошибки для локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Код параметра ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Значение параметра ошибки
{
"timestamp": "2020-12-18T06:12:44.672+00:00",
"status": 404,
"error": "Not Found",
"errorCode": "UNKNOWN_ERROR",
"message": "Запись не найдена в БД",
"reason": "Ошибка БД",
"params": [
{
"code": "id",
"value": "b439162d-e60d-426d-979d-17641f2b6ae4"
}
]
}
Conflict
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$
Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)
Возможные значения: >= -2147483648
и <= 2147483647
Статус
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Описание статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Бизнес-код ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Сообщение об ошибке для отображения на UI без локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$
Описание причины ошибки
params
object[]
Possible values: <= 100
Перечень параметров ошибки для локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Код параметра ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Значение параметра ошибки
{
"timestamp": "2020-12-18T06:12:44.672+00:00",
"status": 404,
"error": "Not Found",
"errorCode": "UNKNOWN_ERROR",
"message": "Запись не найдена в БД",
"reason": "Ошибка БД",
"params": [
{
"code": "id",
"value": "b439162d-e60d-426d-979d-17641f2b6ae4"
}
]
}
Unprocessable Entity
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$
Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)
Возможные значения: >= -2147483648
и <= 2147483647
Статус
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Описание статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Бизнес-код ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Сообщение об ошибке для отображения на UI без локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$
Описание причины ошибки
params
object[]
Possible values: <= 100
Перечень параметров ошибки для локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Код параметра ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Значение параметра ошибки
{
"timestamp": "2020-12-18T06:12:44.672+00:00",
"status": 404,
"error": "Not Found",
"errorCode": "UNKNOWN_ERROR",
"message": "Запись не найдена в БД",
"reason": "Ошибка БД",
"params": [
{
"code": "id",
"value": "b439162d-e60d-426d-979d-17641f2b6ae4"
}
]
}
Internal Server Error
- application/json
- Схема
- Пример из схемы
Schema
- SberapiError
- HttpError
Array [
]
oneOf
Значение должно соответствовать регулярному выражению ^[0-9]{1,3}$
Код ошибки
Возможные значения: <= 50 characters
, Value must match regular expression ^(.*)$
Описание ошибки
Возможные значения: <= 250 characters
, Value must match regular expression ^(.*)$
Дополнительная информация
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$
Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)
Возможные значения: >= -2147483648
и <= 2147483647
Статус
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Описание статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Бизнес-код ошибки
Значение должно соотв етствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Сообщение об ошибке для отображения на UI без локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$
Описание причины ошибки
params
object[]
Possible values: <= 100
Перечень параметров ошибки для локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Код параметра ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Значение параметра ошибки
{}
Service Unavailable
- application/json
- Схема
- Пример из схемы
Schema
Array [
]
Значение должно соответствовать регулярному выражению ^\d{4}-\d\d-\d\dT\d\d:\d\d:\d\d\.\d\d\d[+-]\d\d:\d\d$
Дата время ошибки (ISO - 2020-12-18T06:12:44.672+00:00, GMT - 2020-12-18T06:12:44.672+0000)
Возможные значения: >= -2147483648
и <= 2147483647
Статус
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Описание статуса
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Бизнес-код ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,1024}$
Сообщение об ошибке для отображения на UI без локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,4000}$
Описание причины ошибки
params
object[]
Possible values: <= 100
Перечень параметров ошибки для локализации
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,50}$
Код параметра ошибки
Значение должно соответствовать регулярному выражению ^[0-9a-zA-Zа-яА-ЯеЁ\\+.,"«» &-_№!?:]{0,255}$
Значение параметра ошибки
{
"timestamp": "2020-12-18T06:12:44.672+00:00",
"status": 404,
"error": "Not Found",
"errorCode": "UNKNOWN_ERROR",
"message": "Запись не найдена в БД",
"reason": "Ошибка БД",
"params": [
{
"code": "id",
"value": "b439162d-e60d-426d-979d-17641f2b6ae4"
}
]
}