Список купонов

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET coupons https://api.admitad.com/coupons/
  • offset **
  • limit **
  • campaign ***
  • campaign_category ***
  • category ***
  • type ***
  • order_by ****
Возвращает список купонов веб-мастера.*
GET coupons https://api.admitad.com/coupons/{id}/   Возвращает купон для площадки, где id - это идентификатор купона.*
  • * Возвращает результат в формате JSON.

  • ** Задаёт пропуск и количество возвращаемых записей. Например limit=5&offset=2.

  • *** Фильтр по рекламным программам, категориям рекламных программ, категориям купонов и типам купонов соответственно. Например campaign_category=3&campaign_category=7&campaign=8, где значения - это идентификаторы фильтруемых категорий.

  • **** Порядок сортировки. Возможные значения:

    • name
    • date_start
    • date_end
    • rating

    Знак ‘-‘ перед значением означает обратный порядок. Например order_by=-rating&order_by=date_start.

Пример использования

Пример запроса с использованием утилиты curl:

curl -L -H 'Authorization: Bearer access_token' -X GET https://api.admitad.com/coupons/?limit=1

Пример ответа API-сервера в формате JSON:

{
    "results": [
        {
            "status": "active",
            "rating": "2.50",
            "campaign": {
                "id": 8,
                "name": "Campaign3"
            },
            "name": "Coupon1",
            "short_name": "coupon",
            "date_end": "2013-07-25 23:59:59",
            "date_start": "2011-11-10 00:00:00",
            "exclusive": false,
            "discount": "20%",
            "species": "promocode",
            "categories": [
                {
                    "name": "Детские товары",
                    "id": 1
                },
                {
                    "name": "Красота & здоровье",
                    "id": 2
                }
            ],
            "image": "//cdn.admitad.com/media/campaign/images/2012/06/13/1d37869cf370a26b091f726cc4b24025.jpg",
            "id": 3,
            "types": [
                {
                    "name": "Бесплатная доставка",
                    "id": 1
                },
                {
                    "name": "Платная доставка",
                    "id": 3
                }
            ],
            "description": "description"
        }
    ],
    "_meta": {
        "count": 8,
        "limit": 1,
        "offset": 1
    }
}

Описание полей ответа API-сервера

Название Описание
id Идентификатор купона
name Название купона
image Изображение купона
short_name Короткое название купона
status Статус купона
rating Рейтинг купона
description Описание купона
campaign Рекламная программа купона
date_start Дата начала действия купона
date_end Дата окончания действия купона
categories Категории купонов
types Типы купонов
exclusive Эксклюзивный
discount Скидка для купона (необязательное поле)
species Разновидность купона(‘promocode’, ‘action’)