Appearance
Списки промокодов
Метод возвращает список всех существующих списков промокодов.
Список промокодов можно рассматривать как папку, которая в свою очередь содержит конечные промокоды. Данный метод отдает только списки и статистику.
GET https://api.rees46.ru/promo_codesПараметры
| Параметр | Обязателен? | Описание |
|---|---|---|
| shop_id | Да | API-ключ |
| shop_secret | Да | Секретный ключ API |
| limit | Нет | Количество элементов в ответе. Не более 50 |
| offset | Нет | Смещение от первого элемента в ответе для постраничного вывода |
| active | Нет | Вернуть только списки, в которых есть хотя бы один невыданный промокод (булевый параметр) |
| exclude | Нет | Идентификаторы списков через запятую, которые нужно исключить из выдачи |
| include | Нет | Идентификаторы списков через запятую, которые нужно включить в выдачу |
Запрос
Пример запроса:
shell
curl https://api.rees46.ru/promo_codes?shop_id=...&shop_secret=...&offset=0&limit=30&active=true&exclude=3,1,44Ответ
Пример ответа сервера:
json
{
"success": true,
"payload": [
{
"id": 3184,
"name": "Abandoned cart trigger discount codes",
"available": 3744
}
]
}Расшифровка ответа:
| Параметр | Описание |
|---|---|
| success | Запрос выполнен успешно или нет |
| payload | Массив списков |
| payload[] | Объект списка |
| payload[].id | Идентификатор списка |
| payload[].name | Название списка |
| payload[].available | Количество свободных промокодов |
В случае ошибки ответ будет в формате:
json
{
"success": false,
"payload": {
"message": "Shop not found"
}
}