YandexMarketApi\FeedsApi

All URIs are relative to https://api.partner.market.yandex.ru, except if the operation defines another base path.

Method	HTTP request	Description
getFeed()	GET /campaigns/{campaignId}/feeds/{feedId}	Информация о прайс-листе
getFeedIndexLogs()	GET /campaigns/{campaignId}/feeds/{feedId}/index-logs	Отчет по индексации прайс-листа
getFeeds()	GET /campaigns/{campaignId}/feeds	Список прайс-листов магазина
refreshFeed()	POST /campaigns/{campaignId}/feeds/{feedId}/refresh	Сообщить, что прайс-лист обновился
setFeedParams()	POST /campaigns/{campaignId}/feeds/{feedId}/params	Изменение параметров прайс-листа

`getFeed()`

getFeed($campaign_id, $feed_id): \YandexMarketApi\Model\GetFeedResponse

Информация о прайс-листе

{% note alert "Deprecated" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает информацию о прайс-листе, размещенном на Маркете для заданного магазина. Также ресурс возвращает результаты автоматических проверок прайс-листа. |⚙️ Лимит: 1000 запросов в час| |-|

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = YandexMarketApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new YandexMarketApi\Api\FeedsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$feed_id = 56; // int | Идентификатор прайс-листа.

try {
    $result = $apiInstance->getFeed($campaign_id, $feed_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->getFeed: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
feed_id	int	Идентификатор прайс-листа.

Return type

\YandexMarketApi\Model\GetFeedResponse

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getFeedIndexLogs()`

getFeedIndexLogs($campaign_id, $feed_id, $limit, $published_time_from, $published_time_to, $status): \YandexMarketApi\Model\GetFeedIndexLogsResponse

Отчет по индексации прайс-листа

{% note alert "Deprecated" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает отчет по индексации прайс-листа для заданного магазина. Отчет позволяет получить статистику загрузки прайс-листа и результаты его автоматических проверок. Данные в отчете возвращаются в порядке убывания значений параметра generationId. |⚙️ Лимит: 1 000 запросов в час| |-|

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = YandexMarketApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new YandexMarketApi\Api\FeedsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$feed_id = 56; // int | Идентификатор прайс-листа.
$limit = 20; // int | Количество товаров на одной странице.
$published_time_from = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.  Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`.  Значение по умолчанию: последние восемь дней со времени отправки запроса.
$published_time_to = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете.  Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`.  Значение по умолчанию: дата и время отправки запроса.  {% note info %}  Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего.  {% endnote %}
$status = new \YandexMarketApi\Model\FeedIndexLogsStatusType(); // FeedIndexLogsStatusType | Статус индексации и проверки прайс-листа на соответствие техническим требованиям.  Возможные значения: * `ERROR` — произошли ошибки. * `OK` — обработан без ошибок. * `WARNING` — наблюдались некритичные проблемы.

try {
    $result = $apiInstance->getFeedIndexLogs($campaign_id, $feed_id, $limit, $published_time_from, $published_time_to, $status);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->getFeedIndexLogs: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
feed_id	int	Идентификатор прайс-листа.
limit	int	Количество товаров на одной странице.	[optional]
published_time_from	\DateTime	Начальная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-21T00:42:42+03:00`. Значение по умолчанию: последние восемь дней со времени отправки запроса.	[optional]
published_time_to	\DateTime	Конечная дата. Используется для фильтрации записей — по дате и времени публикации предложений на Яндекс Маркете. Формат даты: ISO 8601 со смещением относительно UTC. Например, `2017-11-31T00:42:42+03:00`. Значение по умолчанию: дата и время отправки запроса. {% note info %} Если во время переключения между страницами выходных данных на Яндекс Маркете появятся новые результаты индексации прайс-листа, вы не получите часть данных. Чтобы этого не произошло, зафиксируйте выходные данные с помощью входного параметра `published_time_to`. Значение параметра не должно быть датой из будущего. {% endnote %}	[optional]
status	FeedIndexLogsStatusType	Статус индексации и проверки прайс-листа на соответствие техническим требованиям. Возможные значения: * `ERROR` — произошли ошибки. * `OK` — обработан без ошибок. * `WARNING` — наблюдались некритичные проблемы.	[optional]

Return type

\YandexMarketApi\Model\GetFeedIndexLogsResponse

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getFeeds()`

getFeeds($campaign_id): \YandexMarketApi\Model\GetFeedsResponse

Список прайс-листов магазина

{% note alert "Deprecated" %} Этот метод устарел. Не используйте его. {% endnote %} Возвращает список прайс-листов, размещенных на Маркете для магазина. Также ресурс возвращает результаты автоматических проверок прайс-листов. |⚙️ Лимит: 1000 запросов в час| |-|

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = YandexMarketApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new YandexMarketApi\Api\FeedsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)

try {
    $result = $apiInstance->getFeeds($campaign_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->getFeeds: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете

Return type

\YandexMarketApi\Model\GetFeedsResponse

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`refreshFeed()`

refreshFeed($campaign_id, $feed_id): \YandexMarketApi\Model\EmptyApiResponse

Сообщить, что прайс-лист обновился

{% note alert "Deprecated" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет сообщить, что магазин обновил прайс-лист. После этого Маркет начнет обновление данных на сервисе. 1. Магазин обновляет прайс-лист, ссылку на который он указал в кабинете. 2. Магазин отправляет Маркету запрос методом POST campaigns/{campaignId}/feeds/{feedId}/refresh. 3. Маркет начинает обновление данных магазина на сервисе. {% note alert %} Запрос работает только для включенных магазинов. Если магазин выключен, данные на Маркете не обновятся, даже если HTTP-код — 200 OK. Проверить статус магазина можно с помощью базовых запросов или на странице бизнес-аккаунта. {% endnote %} |⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = YandexMarketApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new YandexMarketApi\Api\FeedsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$feed_id = 56; // int | Идентификатор прайс-листа.

try {
    $result = $apiInstance->refreshFeed($campaign_id, $feed_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->refreshFeed: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
feed_id	int	Идентификатор прайс-листа.

Return type

\YandexMarketApi\Model\EmptyApiResponse

Authorization

OAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`setFeedParams()`

setFeedParams($campaign_id, $feed_id, $set_feed_params_request): \YandexMarketApi\Model\EmptyApiResponse

Изменение параметров прайс-листа

{% note alert "Deprecated" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет магазину изменить параметры прайс-листа. Чтобы отредактировать параметр прайс-листа, передайте в теле запроса: name (название параметра) и value (значение параметра). Чтобы отменить установленное значение, передайте в теле запроса: name (название параметра) и delete=true (удалить значение). |⚙️ Лимит: 3 запроса в час для одного прайс-листа| |-|

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: OAuth
$config = YandexMarketApi\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new YandexMarketApi\Api\FeedsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$campaign_id = 56; // int | Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.  Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$feed_id = 56; // int | Идентификатор прайс-листа.
$set_feed_params_request = new \YandexMarketApi\Model\SetFeedParamsRequest(); // \YandexMarketApi\Model\SetFeedParamsRequest

try {
    $result = $apiInstance->setFeedParams($campaign_id, $feed_id, $set_feed_params_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FeedsApi->setFeedParams: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
feed_id	int	Идентификатор прайс-листа.
set_feed_params_request	\YandexMarketApi\Model\SetFeedParamsRequest

Return type

\YandexMarketApi\Model\EmptyApiResponse

Authorization

OAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FeedsApi.md

FeedsApi.md

YandexMarketApi\FeedsApi

`getFeed()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getFeedIndexLogs()`

Example

Parameters

Return type

Authorization

HTTP request headers

`getFeeds()`

Example

Parameters

Return type

Authorization

HTTP request headers

`refreshFeed()`

Example

Parameters

Return type

Authorization

HTTP request headers

`setFeedParams()`

Example

Parameters

Return type

Authorization

HTTP request headers

Files

FeedsApi.md

Latest commit

History

FeedsApi.md

File metadata and controls

YandexMarketApi\FeedsApi

getFeed()

Example

Parameters

Return type

Authorization

HTTP request headers

getFeedIndexLogs()

Example

Parameters

Return type

Authorization

HTTP request headers

getFeeds()

Example

Parameters

Return type

Authorization

HTTP request headers

refreshFeed()

Example

Parameters

Return type

Authorization

HTTP request headers

setFeedParams()

Example

Parameters

Return type

Authorization

HTTP request headers

`getFeed()`

`getFeedIndexLogs()`

`getFeeds()`

`refreshFeed()`

`setFeedParams()`