Список акций

Описание

GET /promo/catalog

Возвращает список действующих на Маркете акций. Вы можете создать ссылку на страницу акций в Яндекс Дистрибуции, разместить ее на своей площадке и получать вознаграждение за заказы на Маркете.

URL ресурса:

https://api.content.market.yandex.ru/v3/affiliate/promo/catalog

Входные данные

Параметр	Тип	Значение
Необязательные
`format`	Enum	Формат выходных данных: `json` `xml` Значение по умолчанию: `json`.
`clid`	Int64	Ваш идентификатор в партнерской сети. Передайте идентификатор CLID, с которым связан указанный в запросе авторизационный ключ. Идентификатор можно найти в интерфейсе Яндекс Дистрибуции, на странице Продукты, или узнать у персонального менеджера. В запросе можно передать только один идентификатор.
`vid`	String	Дополнительный идентификатор партнерской ссылки. С помощью идентификатора VID можно отслеживать данные отдельно по каждой партнерской ссылке Маркета или сравнивать статистику по всем ссылкам на разных страницах. Подробнее о VID см. в разделе Дополнительный идентификатор инструмента VID Справки партнерской сети. Если идентификатор указан в запросе, партнерская ссылка будет содержать этот VID. По умолчанию возвращаются ссылки без дополнительных идентификаторов. В запросе можно передать только один дополнительный идентификатор VID.
`page`	Int8	Номер страницы результатов: от `1` до `50`. Значение по умолчанию: `1`.
`count`	Int8	Количество результатов на странице: от `1` до `30`. Значение по умолчанию: `10`.
`sortingField`	Enum	Тип сортировки. Допустимые значения: `NONE` — используется внутренняя сотрировка сервиса. `START_DATE` — дата начала акции. `END_DATE` — дата завершения акции. `CATALOG_PUBLISH_DATE` — дата публикации акции в каталоге. Значение по умолчанию: `NONE`.
`sortingOrder`	Enum	Порядок сортировки. Допустимые значения: `ASC` — сортировка по возрастанию. `DESC` — сортировка по убыванию. Значение по умолчанию: `ASC`.
`promoTypes`	String	Фильтрация по типу акции (можно перечислить несколько значений через запятую): `FIXED_PROMOCODE` — промокод на определенную сумму. `PERCENT_PROMOCODE` — промокод, который дает скидку в процентах. `N_IS_N_PLUS_1` — акция «Больше за ту же цену».
`catalogPublishDateFrom`	Date	Фильтрация по начальной дате, когда акция была опубликована в каталоге. Формат даты: `ГГГГ‑ММ‑ДД`. Можно задать вместе с `catalogPublishDateTo` или отдельно. По умолчанию фильтрация не применяется.
`catalogPublishDateTo`	Date	Фильтрация по конечной дате, когда акция была опубликована в каталоге. Формат даты: `ГГГГ‑ММ‑ДД`. Можно задать вместе с `catalogPublishDateFrom` или отдельно. По умолчанию фильтрация не применяется.
`categories`	Int32	Идентификатор категории. Чтобы узнать идентификатор, откройте страницу категории на Маркете и посмотрите на ее URL. Идентификатор — это набор цифр после «...?hid=». Например: `https://market.yandex.ru/catalog--vytiazhki/54935/list?hid=90581` В запросе можно указать идентификатор категории только первого и второго уровней. Например, Бытовая техника и Крупная техника для кухни — категории первых двух уровней, подкатегория Холодильники — третьего уровня и указать ее уже нельзя. Возвращаются акции, в которых есть хотя бы одно предложение с товарами из заданных категорий. По умолчанию фильтрация не применяется.
`searchSubstring`	String	Текстовый поиск. Возвращаются акции, в которых есть совпадения в названии акции или в значении промокода. Не чувствителен к регистру. По умолчанию фильтрация не применяется.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

JSON

XML

           
{
  "hasMoreData": "{boolean}",
  "promos": 
  [
    {
      "id": "{string}",
      "description": "{string}",
      "type": "{enum}",
      "startDate": "{date}",
      "endDate": "{date}",
      "discountValueRub": "{Int32}",
      "discountValuePercent": "{Int32}",
      "extraItemFreeMinCount": "{Int32}",
      "promocodeConditions":  
      {
        "promocodeValue": "{enum}",
        "bucketMinPrice": "{Int32}",
        "maxDiscount": "{Int32}",
        "firstMarketOrderPromocode": {boolean},
        "oneOrderPromocode": {boolean}
      },
      "partnerUrl": "{string}",
      "partnerShortUrl": "{string}"
    }
  ]
}


<catalog>
  <promos>
    <promo>
      <id>{string}</id>
      <description>{string}</description>
      <type>{enum}</type>
      <startDate>{date}</startDate>
      <endDate>{date}</endDate>
      <discountValueRub>{Int32}</discountValueRub>
      <discountValuePercent>{Int32}</discountValuePercent>
      <extraItemFreeMinCount>{Int32}</extraItemFreeMinCount>
      <promocodeConditions>
        <promocodeValue>{enum}</promocodeValue>
        <bucketMinPrice>{Int32}</bucketMinPrice>
        <maxDiscount>{Int32}</maxDiscount>
        <firstMarketOrderPromocode>{boolean}</firstMarketOrderPromocode>
        <oneOrderPromocode>{boolean}</oneOrderPromocode>
      </promocodeConditions>
      <partnerUrl>{string}</partnerUrl>
      <partnerShortUrl>{string}</partnerShortUrl>
    </promo>
  </promos>
  <hasMoreData>{boolean}</hasMoreData>
</catalog>

Описание параметров:

Параметр для формата JSON	Параметр для формата XML	Тип	Описание
`hasMoreData`	`hasMoreData`	Boolean	Есть ли акции на следующей странице. Допустимые значения: `true` — есть. `false` — нет.
`promos`	`promos`		Информация обо всех акциях.
	`promo`		Информация об акции.
Параметры, вложенные в `promos`/`promo`
`id`	`id`	String	ID акции.
`description`	`description`	String	Название акции.
`type`	`type`	Enum	Тип акции. Доступные значения: `FIXED_PROMOCODE` — промокод на определенную сумму. `PERCENT_PROMOCODE` — промокод, который дает скидку в процентах. `N_IS_N_PLUS_1` — акция «Больше за ту же цену».
`startDate`	`startDate`	Date	Дата начала акции. Формат даты: `ГГГГ‑ММ‑ДД`.
`endDate`	`endDate`	Date	Дата окончания акции. Формат даты: `ГГГГ‑ММ‑ДД`. Акция может завершиться досрочно.
`discountValueRub`	`discountValueRub`	Int32	Размер скидки в рублях. Параметр возвращается только для типа акции `FIXED_PROMOCODE`.
`discountValuePercent`	`discountValuePercent`	Int32	Размер скидки в процентах. Параметр возвращается только для типа акции `PERCENT_PROMOCODE`.
`extraItemFreeMinCount`	`extraItemFreeMinCount`	Int32	Минимальное количество товаров по акции «Больше за ту же цену». Параметр возвращается только для типа акции `N_IS_N_PLUS_1`.
`partnerUrl`	`partnerUrl`	String	Cсылка на страницу акции.
`partnerShortUrl`	`partnerShortUrl`	String	Короткая ссылка на страницу акции.
`promocodeConditions`	`promocodeConditions`		Условия, при которых применяется скидка.
Параметры, вложенные в `promocodeConditions`
`promocodeValue`	`promocodeValue`	String	Значение промокода.
`bucketMinPrice`	`bucketMinPrice`	Int32	Минимальная стоимость заказа, при которой применяется промокод.
`maxDiscount`	`maxDiscount`	Int32	Максимальный размер скидки.
`firstMarketOrderPromocode`	`firstMarketOrderPromocode`	Boolean	Когда применяется промокод. Допустимые значения: `true` — только при первом заказе пользователя. `false` — не только при первом заказе пользователя.
`oneOrderPromocode`	`oneOrderPromocode`	Boolean	Сколько раз применяется промокод. Допустимые значения: `true` — только на один заказ. `false` — на несколько заказов.

Ошибки

В случае ошибки сервер возвращает HTTP‑код ответа и краткое описание ошибки.

Примеры

JSON

XML

Запрос:

curl -i \
-H 'Authorization: <ключ>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/promo/catalog'\
'&format=json'

Ответ:

HTTP/1.1 200 OK
Date: Mon, 13 Aug 2022 17:37:54 GMT
Content-Type: application/json;charset=utf-8
...
              
{
  "hasMoreData": true,
  "promos": 
  [
    {
      "id": "#17448",
      "description": "Игрушки для кошек и собак",
      "type": "N_IS_N_PLUS_1",
      "startDate": "2022-07-01",
      "endDate": "2022-12-31",
      "discountValueRub": 0,
      "discountValuePercent": 0,
      "extraItemFreeMinCount": 3,
      "partnerUrl": "https://market.yandex.ru/special/cheapest-as-gift-2-3-landing?shopPromoId=%2317448&clid=2521695&pp=941&utm_term=promo_cat&utm_campaign=2521695&utm_medium=link&distr_type=7&mclid=1003&utm_source=partner_network",
      "partnerShortUrl": "https://ya.cc/m/3XtUZM"
    },
    {
      "id": "#18245",
      "description": "Аксессуары для плавания и водных видов спорта, влажные салфетки, тренировочные снаряды для бокса и единоборств и еще 181 категория",
      "type": "PERCENT_PROMOCODE",
      "startDate": "2022-06-01",
      "endDate": "2022-08-31",
      "discountValueRub": 0,
      "discountValuePercent": 10,
      "extraItemFreeMinCount": 0,
      "promocodeConditions": 
      {
        "promocodeValue": "KIDS10",
        "bucketMinPrice": 0,
        "maxDiscount": 0,
        "firstMarketOrderPromocode": false,
        "oneOrderPromocode": false
      },
      "partnerUrl": "https://market.yandex.ru/special/promo-code-landing?shopPromoId=%2318245&clid=2521695&pp=941&utm_term=promo_cat&utm_campaign=2521695&utm_medium=link&distr_type=7&mclid=1003&utm_source=partner_network",
      "partnerShortUrl": "https://ya.cc/m/3XtUZH"
    },
    {
      "id": "1000625_AWEWF5TU",
      "description": "Лекарственные растения, средства для сердца и сосудов, витамины и минералы и еще 6 категорий",
      "type": "FIXED_PROMOCODE",
      "startDate": "2022-08-12",
      "endDate": "2022-08-23",
      "discountValueRub": 150,
      "discountValuePercent": 0,
      "extraItemFreeMinCount": 0,
      "promocodeConditions": 
      {
        "promocodeValue": "AWEWF5TU",
        "bucketMinPrice": 0,
        "maxDiscount": 0,
        "firstMarketOrderPromocode": false,
        "oneOrderPromocode": false
      },
      "partnerUrl": "https://market.yandex.ru/special/promo-code-landing?shopPromoId=1000625_AWEWF5TU&clid=2521695&pp=941&utm_term=promo_cat&utm_campaign=2521695&utm_medium=link&distr_type=7&mclid=1003&utm_source=partner_network",
      "partnerShortUrl": "https://ya.cc/m/3ZGJqS"
    }
  ]
}

Запрос:

curl -i \
-H 'Authorization: <ключ>' \
'https://api.content.market.yandex.ru/v3/affiliate'\
'/promo/catalog'\
'&format=xml'

Ответ:

HTTP/1.1 200 OK
Date: Mon, 13 Aug 2022 17:37:54 GMT
Content-Type: application/xml;charset=utf-8
...
              
<catalog>
  <promos>
    <promo>
      <id>#17448</id>
      <description>Игрушки для кошек и собак</description>
      <type>N_IS_N_PLUS_1</type>
      <startDate>2022-07-01</startDate>
      <endDate>2022-12-31</endDate>
      <discountValueRub>0</discountValueRub>
      <discountValuePercent>0</discountValuePercent>
      <extraItemFreeMinCount>3</extraItemFreeMinCount>
      <partnerUrl>https://market.yandex.ru/special/cheapest-as-gift-2-3-landing?shopPromoId=%2317448&clid=2521695&pp=941&utm_term=promo_cat&utm_campaign=2521695&utm_medium=link&distr_type=7&mclid=1003&utm_source=partner_network</partnerUrl>
      <partnerShortUrl>https://ya.cc/m/3XtUZM</partnerShortUrl>
    </promo>
    <promo>
      <id>#18245</id>
      <description>Аксессуары для плавания и водных видов спорта, влажные салфетки, тренировочные снаряды для бокса и единоборств и еще 181 категория</description>
      <type>PERCENT_PROMOCODE</type>
      <startDate>2022-06-01</startDate>
      <endDate>2022-08-31</endDate>
      <discountValueRub>0</discountValueRub>
      <discountValuePercent>10</discountValuePercent>
      <extraItemFreeMinCount>0</extraItemFreeMinCount>
      <promocodeConditions>
        <promocodeValue>KIDS10</promocodeValue>
        <bucketMinPrice>0</bucketMinPrice>
        <maxDiscount>0</maxDiscount>
        <firstMarketOrderPromocode>false</firstMarketOrderPromocode>
        <oneOrderPromocode>false</oneOrderPromocode>
      </promocodeConditions>
      <partnerUrl>https://market.yandex.ru/special/promo-code-landing?shopPromoId=%2318245&clid=2521695&pp=941&utm_term=promo_cat&utm_campaign=2521695&utm_medium=link&distr_type=7&mclid=1003&utm_source=partner_network</partnerUrl>
      <partnerShortUrl>https://ya.cc/m/3XtUZH</partnerShortUrl>
    </promo>
    <promo>
      <id>1000625_AWEWF5TU</id>
      <description>Лекарственные растения, средства для сердца и сосудов, витамины и минералы и еще 6 категорий</description>
      <type>FIXED_PROMOCODE</type>
      <startDate>2022-08-12</startDate>
      <endDate>2022-08-23</endDate>
      <discountValueRub>150</discountValueRub>
      <discountValuePercent>0</discountValuePercent>
      <extraItemFreeMinCount>0</extraItemFreeMinCount>
      <promocodeConditions>
        <promocodeValue>AWEWF5TU</promocodeValue>
        <bucketMinPrice>0</bucketMinPrice>
        <maxDiscount>0</maxDiscount>
        <firstMarketOrderPromocode>false</firstMarketOrderPromocode>
        <oneOrderPromocode>false</oneOrderPromocode>
      </promocodeConditions>
      <partnerUrl>https://market.yandex.ru/special/promo-code-landing?shopPromoId=1000625_AWEWF5TU&clid=2521695&pp=941&utm_term=promo_cat&utm_campaign=2521695&utm_medium=link&distr_type=7&mclid=1003&utm_source=partner_network</partnerUrl>
      <partnerShortUrl>https://ya.cc/m/3ZGJqS</partnerShortUrl>
    </promo>
  </promos>
  <hasMoreData>true</hasMoreData>
</catalog>

Была ли статья полезна?

Варианты товара

Создание партнерских ссылок Маркета