Вызов методов
Запросы к партнерскому API передаются по протоколу HTTPS, таймаут — 10 секунд, Keep-Alive не поддерживается.
Запросы можно задавать в двух форматах — с указанием версии API и без указания версии. Оба формата одинаково поддерживаются.
<http_method> https://api.partner.market.yandex.ru/v<version>/<resource>.<format>?<parameters>
где:
-
<http_method>― DELETE, GET, POST или PUT. -
<version>― номер текущей версии API. На данный момент текущая версия — 2. -
<resource>― URL ресурса, над которым выполняется действие. Названия ресурсов приведены в описании соответствующих методов.Здесь передаются параметры пути (path parameters) — данные, которые отличаются в зависимости от магазина или кабинета.
Пример
https://api.partner.market.yandex.ru/campaigns/{campaignId}/{campaignId}— параметр пути, где вы указываете свой идентификатор кампании. -
<format>― это необязательная часть запроса, которая влияет на способ представления ответа. Формат ответа может быть указан в HTTP-заголовкеAccept. Данные передаются в формате JSON. В описании каждого метода приведены примеры запросов и ответов. -
<query parameters>― обязательные и необязательные параметры запроса.Здесь передается ключ и его значение, которые нужны для уточнения запроса, фильтрации и сортировки входящей информации, пагинации.
Параметры запроса отделяются от URL ресурса вопросительным знаком, а между парами «ключ-значение» используется амперсанд (&).
Пример
https://api.partner.market.yandex.ru/reports/shows-sales/generate?format=CSV?format=CSV— параметр запроса.
<http_method> https://api.partner.market.yandex.ru/<resource>.<format>?<parameters>
где:
-
<http_method>― DELETE, GET, POST или PUT. -
<resource>― URL ресурса, над которым выполняется действие. Названия ресурсов приведены в описании соответствующих методов.Здесь передаются параметры пути (path parameters) — данные, которые отличаются в зависимости от магазина или кабинета.
Пример
https://api.partner.market.yandex.ru/campaigns/{campaignId}/{campaignId}— параметр пути, где вы указываете свой идентификатор кампании. -
<format>― это необязательная часть запроса, которая влияет на способ представления ответа. Формат ответа может быть указан в HTTP-заголовкеAccept. Данные передаются в формате JSON. В описании каждого метода приведены примеры запросов и ответов. -
<query parameters>― обязательные и необязательные параметры запроса.Здесь передается ключ и его значение, которые нужны для уточнения запроса, фильтрации и сортировки входящей информации, пагинации.
Параметры запроса отделяются от URL ресурса вопросительным знаком, а между парами «ключ-значение» используется амперсанд (&).
Пример
https://api.partner.market.yandex.ru/reports/shows-sales/generate?format=CSV?format=CSV— параметр запроса.
Для продавцов Market Yandex Go: также прочтите инструкцию.
Если произошла ошибка, прекращается обработка запроса и возвращается информация о ней. Типы ошибок и что с ними делать