Запросы API

Для управления промоакциями

Документация перемещена
Информация на этой странице не обновляется и может быть устаревшей. 
Наиболее полная и актуальная версия документации для разработчиков доступна по новому адресу:
​https://developers.koshelek.app​
get
https://api.cardsmobile.ru/promo
/v1/all
Получение списка существующих акций
Параметры ответа:
Параметр
Тип
Обязательно
Значение
metadata
Object
Да
Объект метаданных, содержащий указанные в запросе значения фильтров и ограничений, а также значение общего количества записей.
metadata.limit
Number
Да
Количество выводимых элементов списка.
metadata.offset
Number
Да
Количество пропускаемых элементов списка.
metadata.totalCount
Number
Да
Общее количество записей.
metadata.activeOnly
Boolean
Да
true — вывести только активные акции.
false — вывести все акции.
items
Array
Да
Массив объектов Item, содержащих сведения об акциях. Описание объекта Item см. в разделе Объекты API.
get
https://api.cardsmobile.ru/promo
/v1/details?promoId={id}
Получение информации об акции по идентификатору
Тело запроса пустое.
Параметры ответа:
Параметр
Тип
Обязательно
Значение
promoId
Number
Да
Уникальный идентификатор акции.
name
String
Да
Наименование акции.
startDate
String
Да
Дата начала акции в формате YYYY-MM-DDTHH:MM:SS+00.
endDate
String
Нет
Дата окончания акции в формате YYYY-MM-DDTHH:MM:SS+00.
null — бессрочная акция (актуально для source = rmc).
status
String
Да
Статус акции, рассчитанный исходя из срока ее действия:
active — активная акция;
completed — завершенная акция;
planned — запланированная акция.
images
Object
Да
Графические изображения акции для отображения на экране предъявления карты в Кошельке.
images.imageWide
String
Да
Гиперссылка на файл с большим изображением предложения акции (1080×420 пикселей).
images.imageSquare
String
Да
Гиперссылка на файл с малым изображением предложения акции (600×600 пикселей).
description
String
Да
Текстовое описание предложения в разметке HTML для отображения в каталоге Кошелька.
discount
Number
Да
Размер скидки по акции. Отображается в качестве ярлыка на изображении предложения.
0 — нет скидки по акции.
source
String
Да
Источник загрузки данных акции в Кошелёк:
api — источником является Promo API.
rmc — источником является Личный кабинет ритейлера.
post
https://api.cardsmobile.ru/promo
/v1/create
​Создание новой акции
Параметры ответа:
Параметр
Тип
Обязательно
Значение
promoId
Number
Да
Уникальный идентификатор акции.
status
String
Да
Текущий статус акции, рассчитанный исходя из срока ее действия:
active — активная акция;
completed — завершенная акция;
planned — запланированная акция.
post
https://api.cardsmobile.ru/promo
/v1/update
Обновление данных существующей акции
Параметры ответа:
Параметр
Тип
Обязательно
Значение
promoId
Number
Да
Уникальный идентификатор акции.
status
String
Да
Статус акции, рассчитанный исходя из срока ее действия:
active — активная акция;
completed — завершенная акция;
planned — запланированная акция.

Параметр	Тип	Обязательно	Значение
`metadata`	Object	Да	Объект метаданных, содержащий указанные в запросе значения фильтров и ограничений, а также значение общего количества записей.
`metadata.limit`	Number	Да	Количество выводимых элементов списка.
`metadata.offset`	Number	Да	Количество пропускаемых элементов списка.
`metadata.totalCount`	Number	Да	Общее количество записей.
`metadata.activeOnly`	Boolean	Да	`true` — вывести только активные акции. `false` — вывести все акции.
`items`	Array	Да	Массив объектов Item, содержащих сведения об акциях. Описание объекта Item см. в разделе Объекты API.

Параметр	Тип	Обязательно	Значение
`promoId`	Number	Да	Уникальный идентификатор акции.
`name`	String	Да	Наименование акции.
`startDate`	String	Да	Дата начала акции в формате `YYYY-MM-DDTHH:MM:SS+00`.
`endDate`	String	Нет	Дата окончания акции в формате `YYYY-MM-DDTHH:MM:SS+00`. `null` — бессрочная акция (актуально для `source` = `rmc`).
`status`	String	Да	Статус акции, рассчитанный исходя из срока ее действия: `active` — активная акция; `completed` — завершенная акция; `planned` — запланированная акция.
`images`	Object	Да	Графические изображения акции для отображения на экране предъявления карты в Кошельке.
`images.imageWide`	String	Да	Гиперссылка на файл с большим изображением предложения акции (1080×420 пикселей).
`images.imageSquare`	String	Да	Гиперссылка на файл с малым изображением предложения акции (600×600 пикселей).
`description`	String	Да	Текстовое описание предложения в разметке HTML для отображения в каталоге Кошелька.
`discount`	Number	Да	Размер скидки по акции. Отображается в качестве ярлыка на изображении предложения. `0` — нет скидки по акции.
`source`	String	Да	Источник загрузки данных акции в Кошелёк: `api` — источником является Promo API. `rmc` — источником является Личный кабинет ритейлера.

Параметр	Тип	Обязательно	Значение
`promoId`	Number	Да	Уникальный идентификатор акции.
`status`	String	Да	Текущий статус акции, рассчитанный исходя из срока ее действия: `active` — активная акция; `completed` — завершенная акция; `planned` — запланированная акция.

Параметр	Тип	Обязательно	Значение
`promoId`	Number	Да	Уникальный идентификатор акции.
`status`	String	Да	Статус акции, рассчитанный исходя из срока ее действия: `active` — активная акция; `completed` — завершенная акция; `planned` — запланированная акция.

Cardsmobile Promo API - Previous

Обзор сценариев промоакций

Next - Cardsmobile Promo API

Объекты API

Last modified 25d ago