# Купоны
# Список купонов <span id="list-of-coupons" />

## Параметры <span id="list-of-coupons-parameters" />

| HTTP метод | Права доступа                      | URL                                                                                | Параметры                                                                | Примечание                                                         |
| ---------- | ---------------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------ |
| GET        | [coupons](/article/ru/308#coupons) | [https://api.admitad.com/coupons/](https://api.admitad.com/coupons/)               | [Список параметров для запроса](#list-of-coupons-parameter-request-list) | Возвращает список купонов веб-мастера\*                            |
| GET        | [coupons](/article/ru/308#coupons) | [https://api.admitad.com/coupons/{id}/](https://api.admitad.com/coupons/%7Bid%7D/) |                                                                          | Возвращает купон для площадки, где id — это идентификатор купона\* |

\* Возвращает результат в формате JSON.

## Список параметров для запроса <span id="list-of-coupons-parameter-request-list" />

| Название                | Тип     | Допустимые значения                                                                                       |
| ----------------------- | ------- | --------------------------------------------------------------------------------------------------------- |
| campaign                | integer | [Список партнерских программ](/article/ru/312#list-affiliate-programs)                                    |
| category                | integer | [Категории купонов](#coupon-categories)                                                                   |
| campaign\_category      | integer | [Категории партнерских программ](/article/ru/316#categories-of-affiliate-programs)                        |
| type                    | integer |                                                                                                           |
| search                  | string  | Поиск по названию и описанию купона, названию партнерской программы                                       |
| date\_start             | date    | %d.%m.%Y                                                                                                  |
| date\_end               | date    | %d.%m.%Y                                                                                                  |
| offset                  | integer | [Параметры limit, offset](/article/ru/310)                                                                |
| limit                   | integer | [Параметры limit, offset](/article/ru/310)                                                                |
| order\_by\*             | string  | name                                                                                                      |
|                         |         | rating                                                                                                    |
|                         |         | date\_start                                                                                               |
|                         |         | date\_end                                                                                                 |
|                         |         | Знак '-' перед значением означает обратный порядок. Например, order\_by\=-rating\&order\_by\=date\_start. |
| region                  | string  | [Регионы площадок](/article/ru/316#ad-space-regions)                                                      |
| language                | string  | [Системные языки](/article/ru/316#system-languages)                                                       |
| is\_tracking\_promocode | bool    | Трекинговые купоны (is\_tracking\_promocode\=true)                                                        |
| has\_affiliate\_link    | bool    | Трекинговые купоны с партнерской ссылкой (has\_affiliate\_link\=true)                                     |
| customer\_type          | string  | Купоны доступны:                                                                                          |
|                         |         | только новым пользователям (customer\_type\=new\_customers)                                               |
|                         |         | всем пользователям  (customer\_type\=all\_customers)                                                      |

## Пример использования <span id="list-of-coupons-example-of-use" />

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

```
curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/coupons/?region=KZ&limit=1
```

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

```
{  
    "results": [  
        {  
            "status": "active",  
            "rating": "2.50",  
            "campaign": {  
                "id": 8,  
                "name": "Campaign_8",  
                "site_url": "http://example.com/"  
            },  
            "description": "description",  
            "short_name": "coupon",  
            "exclusive": false,  
            "date_end": "2018-07-25T23:59:59",  
            "date_start": "2018-11-10T00:00:00",  
            "id": 3,  
            "regions": [  
                "KZ"  
            ],  
            "language": "en",  
            "discount": "20%",  
            "types": [  
                {  
                    "id": 1,  
                    "name": "Type name 1"  
                },  
                {  
                    "id": 2,  
                    "name": "Type name 2"  
                }  
            ],  
            "image": "//cdn.admitad.com/media/campaign/images/2018/06/13/1d37869cf370a26b091f726cc4b24025.jpg",  
            "species": "promocode",  
            "categories": [  
                {  
                    "id": 1,  
                    "name": "Category name 1"  
                },  
                {  
                    "id": 2,  
                    "name": "Category name 2"  
                },  
            ],  
            "name": "Coupon1"  
        }  
    ],  
    "_meta": {  
        "count": 8,  
        "limit": 1,  
        "offset": 1  
    }  
}
```

## Описание полей ответа API-сервера <span id="list-of-coupons-description-of-api-server-response-fields" />

| Название                  | Описание                                                                                                               |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| id                        | Идентификатор купона                                                                                                   |
| name                      | Название купона                                                                                                        |
| image                     | Изображение купона                                                                                                     |
| status                    | Статус купона                                                                                                          |
| rating                    | Рейтинг купона                                                                                                         |
| description               | Описание купона                                                                                                        |
| campaign                  | Рекламная программа купона                                                                                             |
| date\_start               | Дата начала действия купона                                                                                            |
| date\_end                 | Дата окончания действия купона (если значение поля — null, то купон бессрочный)                                        |
| categories                | Категории купонов                                                                                                      |
| types                     | Типы купонов                                                                                                           |
| exclusive                 | Эксклюзивный                                                                                                           |
| discount                  | Скидка для купона (необязательное поле)                                                                                |
| species                   | Разновидность купона ('promocode', 'action')                                                                           |
| is\_personal              | Персональный промокод. Для отслеживания действий обязателен переход по партнерской ссылке.                             |
| is\_unique                | Уникальный промокод. Он не требует перехода по партнерской ссылке для отслеживания действий.                           |
| regions                   | [Регионы площадок](/article/ru/316#ad-space-regions)                                                                   |
| language                  | [Системные языки](/article/ru/316#system-languages)                                                                    |
| is\_tracking\_promo\_code | Трекинговый купон                                                                                                      |
| has\_affiliate\_link      | Трекинговый купон с партнерской ссылкой                                                                                |
| customer\_type            | Купон доступен:                                                                                                        |
|                           | только новым пользователям                                                                                             |
|                           | всем пользователям                                                                                                     |
| merchant                  | Мерчант купона. Заполняется только для купонов партнерской программы Takedeals. Для остальных купонов значение — null. |

# Список купонов для площадки <span id="list-of-coupons-for-the-ad-space" />

## Параметры <span id="list-of-coupons-for-the-ad-space-parameters" />

| HTTP метод | Права доступа                                                | URL                                                     | Параметры                                                                     | Примечание                                                                                                 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------- | ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| GET        | [coupons\_for\_website](/article/ru/308#coupons-for-website) | https://api.admitad.com/coupons/website/{w\_id}/        | [Список параметров для запроса](#list-of-coupons-for-the-ad-space-parameters) | Возвращает список купонов для площадки, где w\_id — это идентификатор площадки\*                           |
| GET        | [coupons\_for\_website](/article/ru/308#coupons-for-website) | https://api.admitad.com/coupons/{c\_id}/website/{w\_... |                                                                               | Возвращает купон для площадки, где w\_id — это идентификатор площадки и c\_id — это идентификатор купона\* |

\* Возвращает результат в формате JSON.

## Список параметров для запроса <span id="list-of-coupons-for-the-ad-space-parameter-request-list-ad-space" />

| Название                | Тип     | Допустимые значения                                                                                       |
| ----------------------- | ------- | --------------------------------------------------------------------------------------------------------- |
| campaign                | integer | [Список партнерских программ](/article/ru/312#list-affiliate-programs)                                    |
| category                | integer | [Категории купонов](#coupon-categories)                                                                   |
| campaign\_category      | integer | [Категории партнерских программ](/article/ru/316#categories-of-affiliate-programs)                        |
| type                    | integer |                                                                                                           |
| search                  | string  | Поиск по названию и описанию купона, названию партнерской программы                                       |
| date\_start             | date    | %d.%m.%Y                                                                                                  |
| date\_end               | date    | %d.%m.%Y                                                                                                  |
| offset                  | integer | [Параметры limit, offset](/article/ru/310)                                                                |
| limit                   | integer | [Параметры limit, offset](/article/ru/310)                                                                |
| region                  | string  | [Регионы площадок](/article/ru/316#ad-space-regions)                                                      |
|                         |         | 99 — фильтровать по регионам, подходящим площадке                                                         |
| language                | string  | [Системные языки](/article/ru/316#system-languages)                                                       |
| order\_by \*            | string  | name                                                                                                      |
|                         |         | rating                                                                                                    |
|                         |         | date\_start                                                                                               |
|                         |         | date\_end                                                                                                 |
|                         |         | Знак '-' перед значением означает обратный порядок. Например, order\_by\=-rating\&order\_by\=date\_start. |
| is\_tracking\_promocode | bool    | Трекинговые купоны (is\_tracking\_promocode\=true)                                                        |
| has\_affiliate\_link    | bool    | Трекинговые купоны с партнерской ссылкой (has\_affiliate\_link\=true)                                     |
| customer\_type          | string  | Купоны доступны:                                                                                          |
|                         |         | только новым пользователям (customer\_type\=new\_customers)                                               |
|                         |         | всем пользователям  (customer\_type\=all\_customers)                                                      |

### Пример использования <span id="list-of-coupons-for-the-ad-space-example-of-use" />

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

```
curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/coupons/website/22/?limit=1  

  
curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/coupons/1/website/22/?region=KZ
```

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

```
{  
    "results": [  
        {  
            "status": "active",  
            "rating": "2.50",  
            "date_start": "2018-11-10T00:00:00",  
            "campaign": {  
                "id": 8,  
                "name": "Campaign_8",  
                "site_url": "http://example.com/"  
            },  
            "short_name": "coupon",  
            "exclusive": false,  
            "name": "Coupon1",  
            "date_end": "2018-07-25T23:59:59",  
            "promocode": "PRABCABC",  
            "id": 3,  
            "regions": [  
                "KZ"  
            ],  
            "language": "en",  
            "discount": "20%",  
            "types": [  
                {  
                    "id": 1,  
                    "name": "Type name 1"  
                },  
                {  
                    "id": 2,  
                    "name": "Type name 2"  
                }  
            ],  
            "image": "//cdn.admitad.com/media/campaign/images/2018/06/13/1d37869cf370a26b091f726cc4b24025.jpg",  
            "frameset_link": "http://ad.admitad.com/coupon/292e71c4f659505879f503dd58751b/",  
            "goto_link": "http://ad.admitad.com/goto/4cd0ab308859505879f503dd58751b/",  
            "species": "promocode",  
            "categories": [  
                {  
                    "id": 1,  
                    "name": "Category name 1"  
                },  
                { 
                    "id": 2,  
                    "name": "Category name 2"  
                },  
            ],  
            "description": "description"  
        }  
    ],  
    "_meta": {  
        "count": 8,  
        "limit": 1,  
        "offset": 1  
    }  
}
```

### Описание полей ответа API-сервера <span id="list-of-coupons-for-the-ad-space-description-of-api-server-response-fields" />

| Название                  | Описание                                                                                                               |
| ------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| id                        | Идентификатор купона                                                                                                   |
| name                      | Название купона                                                                                                        |
| image                     | Изображение купона                                                                                                     |
| status                    | Статус купона                                                                                                          |
| rating                    | Рейтинг купона                                                                                                         |
| description               | Описание купонов                                                                                                       |
| campaign                  | Рекламная программа купона                                                                                             |
| date\_start               | Дата начала действия купона                                                                                            |
| date\_end                 | Дата окончания действия купона (если значение поля — null, то купон бессрочный)                                        |
| categories                | Категории купонов                                                                                                      |
| types                     | Типы купонов                                                                                                           |
| frameset\_link            | Ссылка на фреймсет с шапкой                                                                                            |
| goto\_link                | Прямая ссылка для перехода                                                                                             |
| promocode                 | Промокод                                                                                                               |
| exclusive                 | Эксклюзивный                                                                                                           |
| is\_personal              | Персональный промокод. Для отслеживания действий переходить по партнерской ссылке необязательно.                       |
| is\_unique                | Уникальный промокод. Он не требует перехода по партнерской ссылке для отслеживания действий.                           |
| discount                  | Скидка для купона (необязательное поле)                                                                                |
| species                   | Разновидность купона ('promocode', 'action')                                                                           |
| regions                   | [Регионы площадок](/article/ru/316#ad-space-regions)                                                                   |
| language                  | [Системные языки](/article/ru/316#system-languages)                                                                    |
| is\_tracking\_promo\_code | Трекинговый купон                                                                                                      |
| has\_affiliate\_link      | Трекинговый купон с партнерской ссылкой                                                                                |
| customer\_type            | Купон доступен:                                                                                                        |
|                           | только новым пользователям                                                                                             |
|                           | всем пользователям                                                                                                     |
| merchant                  | Мерчант купона. Заполняется только для купонов партнерской программы Takedeals. Для остальных купонов значение — null. |

## Категории купонов <span id="coupon-categories" />

### Параметры <span id="coupon-categories-parameters" />

| HTTP метод | Права доступа                          | URL                                                                                                      | Параметры      | Примечание                                                           |
| ---------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------- |
| GET        | [public\_data](/article/ru/308#public) | [https://api.admitad.com/coupons/categories/](https://api.admitad.com/coupons/categories/)               | *limit\*\* \** | Возвращает категории купонов\*                                       |
|            |                                        |                                                                                                          | *offset\*\**   |                                                                      |
| GET        | [public\_data](/article/ru/308#public) | [https://api.admitad.com/coupons/categories/{id}/](https://api.admitad.com/coupons/categories/%7Bid%7D/) |                | Возвращает категорию купонов, где id — это идентификатор категории\* |

*\* Возвращает результат в формате JSON.*

*\*\* Задаёт пропуск и количество возвращаемых записей. Например,* [*limit\=5\&offset\=2*](/article/ru/310)*.*

### Пример использования <span id="coupon-categories-example-of-use" />

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

```
curl -L -H 'Authorization: Bearer access_token' -X GET  

https://api.admitad.com/coupons/categories/?limit=2
```

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

```
{  
    "results": [  
        {  
            "name": "Category name 1",  
            "id": 1  
        },  
        {  
            "name": "Category name 2",  
            "id": 2  
        }  
    ],  
    "_meta": {  
        "count": 10,  
        "limit": 2,  
        "offset": 0  
    }  
}
```

### Описание полей ответа API-сервера <span id="coupon-categories-description-of-api-server-response-fields" />

| Название | Описание                       |
| -------- | ------------------------------ |
| id       | Идентификатор категории купона |
| name     | Название категории купона      |