Получение списка активных или запланированных вендор-бонусов

Параметры

HTTP метод Права доступа URL Параметры Примечание
GET vendor_tool https://api.admitad.com/vendor_tool/v1/vendor_tool/ Список параметров для запроса

Возвращает список вендор-бонусов, которые доступны веб-мастеру*

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

Список параметров для запроса

Название Тип Допустимые значения Примечание
advcampaign_id comma-separated integers

Пример: advcampaign_id=12,23,34

Возвращает список вендор-бонусов для указанных партнерских программ

limit integer Параметры limit, offset  
offset integer Параметры limit, offset  

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

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

curl -L -H 'Authorization: Bearer access_token -X GET https://api.admitad.com/vendor_tool/v1/vendor_tool/

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

{
  "id": 29,
  "conditions": [
    {
      "action": {
        "name": "vendor_action_eralala",
        "hold_size_days": 30,
        "tariffs": [
          {
            "name": "Тариф по умолчанию",
            "rates": [
              {
                "size": "5.00",
                "price_s": "0.00",
                "country": null,
                "date_s": "2020-08-20",
                "is_percentage": true
              },
              {
                "size": "7.00",
                "price_s": "0.00",
                "country": null,
                "date_s": "2020-12-17",
                "is_percentage": true
              }
            ]
          }
        ]
      },
      "advcampaign": {
        "id": 15939,
        "name": "beard-bookerae-alie1"
      },
      "price_from": null,
      "price_up_to": null,
      "category": "",
      "brand": "",
      "product": "1,23,3",
      "supplier": "",
      "additional_filter_name": "",
      "additional_filter_value": ""
    }
  ],
  "name": "qweqwe",
  "status": "active",
  "start_datetime": null,
  "stop_datetime": null,
  "allow_all_webmasters": true,
  "allowed_to_you": true,
  "vendor_campaign": {
    "id": 15932,
    "name": "HIDDEN VENDOR eraoelgoselRs"
  }
}

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

Название Тип Описание
id int Идентификатор вендор-бонуса
name char

Название вендор-бонуса

status char

Статус вендор-бонуса на данный момент

start_datetime datetime

Дата начала действия вендор-бонуса в формате %Y-%m-%dT%H:%M:%S. Пример: 2020-12-02T17:15:28

stop_datetime datetime

Дата окончания действия вендор-бонуса в формате %Y-%m-%dT%H:%M:%S. Пример: 2020-12-02T17:15:28

allow_all_webmasters bool

Признак, действует ли вендор-бонус для всех веб-мастеров

allowed_to_you bool

Признак, разрешена ли клиенту, который выполнил запрос, работа с этим вендор-бонусом

conditions json-list Список объектов с информацией об условиях применения

Параметры объекта в списке conditions

Название Тип Описание
advcampaign json

Партнерская программа, на которую направляется трафик. Пример: “advcampaign”: { “id”: 15939, “name”: “beard-bookerae-alie1” }

action object Объект с информацией о потенциальном вознаграждении за целевое действие
price_from char

Минимальная стоимость товара

price_up_to char

Максимальная стоимость товара

category char Требование к принадлежности товара к определенной категории
brand char Требование к принадлежности товара к определенному бренду
product char

Требование к продаже конкретных товаров. Если бонус должен начисляться только за конкретные товары, product_id перечислены через запятую

supplier char

Требования к поставщику товара

additional_filter_name char

Дополнительное условие к товару, где additional_filter_name — ключ товара, additional_filter_value — значение товара

additional_filter_value char

Дополнительное условие к товару, где additional_filter_name — ключ товара, additional_filter_value — значение товара

Параметры объекта action

Название Тип Описание
hold_size_days int

Время холда (в днях)

tariffs json-list Список тарифов для этого действия

В каждом объекте action есть массив объектов tariffs, в котором содержится информация о ставках вознаграждения

Название Тип Описание
rates json-list

Список ставок вознаграждения для этого тарифа

rates.size char Ставка вознаграждения
rates.price_s char

Минимальный платеж

rates.country char

Код страны заказа для применения этой ставки

is_percentage bool

Признак, который показывает, является ли ставка процентной или фиксированной (расчет процента от суммы заказа или фиксированное вознаграждение)