Skip to content

Списки промокодов

Метод возвращает список всех существующих списков промокодов.

Список промокодов можно рассматривать как папку, которая в свою очередь содержит конечные промокоды. Данный метод отдает только списки и статистику.

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"
  }
}