OpenAPI\Client\OffersApi

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

Method	HTTP request	Description
deleteCampaignOffers()	POST /campaigns/{campaignId}/offers/delete	Удаление товаров из ассортимента магазина
getAllOffers()	GET /campaigns/{campaignId}/offers/all	Все предложения магазина
getCampaignOffers()	POST /campaigns/{campaignId}/offers	Список товаров, размещенных в заданном магазине, с параметрами размещения
getOfferRecommendations()	POST /businesses/{businessId}/offers/recommendations	Рекомендации Маркета, касающиеся цен
getOffers()	GET /campaigns/{campaignId}/offers	Предложения магазина
updateCampaignOffers()	POST /campaigns/{campaignId}/offers/update	Настройка размещения товаров в магазине

`deleteCampaignOffers()`

deleteCampaignOffers($campaign_id, $delete_campaign_offers_request): \OpenAPI\Client\Model\DeleteCampaignOffersResponse

Удаление товаров из ассортимента магазина

Удаляет заданные товары из заданного магазина. {% note warning "Запрос удаляет товары именно из конкретного магазина" %} На продажи в других магазинах и на наличие товара в общем каталоге он не влияет. {% endnote %} Товар не получится удалить, если он хранится на складах Маркета. |⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Example

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


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


$apiInstance = new OpenAPI\Client\Api\OffersApi(
    // 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)
$delete_campaign_offers_request = new \OpenAPI\Client\Model\DeleteCampaignOffersRequest(); // \OpenAPI\Client\Model\DeleteCampaignOffersRequest

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

Parameters

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

Return type

\OpenAPI\Client\Model\DeleteCampaignOffersResponse

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]

`getAllOffers()`

getAllOffers($campaign_id, $feed_id, $chunk): \OpenAPI\Client\Model\GetAllOffersResponse

Все предложения магазина

{% note alert "Deprecated" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет максимально быстро получить информацию обо всех предложениях магазина, размещенных на Маркете. Возвращает результат в виде сегментов нефиксированного размера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Яндекс Маркета, с которой соотнесено предложение, а также аукционные ставки на него. {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |⚙️ Лимит: рассчитывается по формуле| |-| [//]: <> (rule: суточный лимит товаров — среднее количество таваров в каталоге за неделю * 25)

Example

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


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


$apiInstance = new OpenAPI\Client\Api\OffersApi(
    // 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 | Идентификатор прайс-листа.
$chunk = 56; // int | Номер сегмента с результатами.  Значение по умолчанию: `0`.  {% note info %}  Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены.  {% endnote %}  {% note alert %}  Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д.  {% endnote %}

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

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
feed_id	int	Идентификатор прайс-листа.	[optional]
chunk	int	Номер сегмента с результатами. Значение по умолчанию: `0`. {% note info %} Номера сегментов запрашиваются последовательно, пока не будет получен сегмент с пустым ответом. Пустой ответ означает, что все предложения магазина получены. {% endnote %} {% note alert %} Нумерация начинается с 0. Чтобы запросить первую страницу, необходимо указать `chunk=0` и т. д. {% endnote %}	[optional]

Return type

\OpenAPI\Client\Model\GetAllOffersResponse

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]

`getCampaignOffers()`

getCampaignOffers($campaign_id, $get_campaign_offers_request, $page_token, $limit): \OpenAPI\Client\Model\GetCampaignOffersResponse

Список товаров, размещенных в заданном магазине, с параметрами размещения

Возвращает список товаров, размещенных в заданном магазине. Для каждого товара указываются параметры размещения. |⚙️ Лимит: 5000 товаров в минуту, не более 200 товаров в одном запросе| |-|

Example

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


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


$apiInstance = new OpenAPI\Client\Api\OffersApi(
    // 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)
$get_campaign_offers_request = new \OpenAPI\Client\Model\GetCampaignOffersRequest(); // \OpenAPI\Client\Model\GetCampaignOffersRequest
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается самая старая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.
$limit = 20; // int | Количество товаров на одной странице.

try {
    $result = $apiInstance->getCampaignOffers($campaign_id, $get_campaign_offers_request, $page_token, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getCampaignOffers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
get_campaign_offers_request	\OpenAPI\Client\Model\GetCampaignOffersRequest
page_token	string	Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.	[optional]
limit	int	Количество товаров на одной странице.	[optional]

Return type

\OpenAPI\Client\Model\GetCampaignOffersResponse

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]

`getOfferRecommendations()`

getOfferRecommendations($business_id, $get_offer_recommendations_request, $page_token, $limit): \OpenAPI\Client\Model\GetOfferRecommendationsResponse

Рекомендации Маркета, касающиеся цен

Метод возвращает рекомендации нескольких типов. 1. Рекомендованные цены для участия в софинансировании скидок. Показывает, какие цены для участия нужно установить, чтобы получить максимальные шансы на срабатывание скидок, софинансируемых Маркетом. Как это устроено 2. Оценка привлекательности цен на витрине. Привлекательность влияет на вероятность срабатывания скидок за счет Маркета. Как это устроено В запросе можно использовать фильтры. Результаты возвращаются постранично. |⚙️ Лимит: 100 запросов в минуту| |-|

Example

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


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


$apiInstance = new OpenAPI\Client\Api\OffersApi(
    // 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
);
$business_id = 56; // int | Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом [GET campaigns](../../reference/campaigns/getCampaigns.md#businessdto).  ℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)
$get_offer_recommendations_request = new \OpenAPI\Client\Model\GetOfferRecommendationsRequest(); // \OpenAPI\Client\Model\GetOfferRecommendationsRequest
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается самая старая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.
$limit = 20; // int | Количество товаров на одной странице.

try {
    $result = $apiInstance->getOfferRecommendations($business_id, $get_offer_recommendations_request, $page_token, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getOfferRecommendations: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_id	int	Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
get_offer_recommendations_request	\OpenAPI\Client\Model\GetOfferRecommendationsRequest
page_token	string	Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.	[optional]
limit	int	Количество товаров на одной странице.	[optional]

Return type

\OpenAPI\Client\Model\GetOfferRecommendationsResponse

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]

`getOffers()`

getOffers($campaign_id, $query, $feed_id, $shop_category_id, $currency, $matched, $page, $page_size): \OpenAPI\Client\Model\GetOffersResponse

Предложения магазина

{% note alert "Deprecated" %} Этот метод устарел. Не используйте его. {% endnote %} Позволяет фильтровать информацию о предложениях магазина, размещенных на Маркете, и искать предложения по заданному поисковому запросу. Поиск предложений, размещенных на Маркете, работает по поисковому запросу аналогично поиску Маркета. Результаты возвращаются с использованием пейджера. В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него. {% note info %} Из-за особенностей поиска Маркета иногда на последних страницах пейджера фактическое количество результатов оказывается меньше количества, указанного ранее на предыдущих страницах. В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы. {% endnote %} {% note info %} Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений. {% endnote %} |⚙️ Лимит: рассчитывается по формуле| |-| [//]: <> (rule: суточный лисит товаров — среднее количество таваров в каталоге за неделю * 25)

Example

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


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


$apiInstance = new OpenAPI\Client\Api\OffersApi(
    // 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)
$query = 'query_example'; // string | Поисковый запрос.  Поддерживается язык запросов.  Значение по умолчанию: все предложения магазина, размещенные на Маркете.
$feed_id = 56; // int | Идентификатор прайс-листа.
$shop_category_id = 'shop_category_id_example'; // string | Идентификатор категории предложения, указанный магазином в прайс-листе.  Параметр выводится только для предложений, у которых указана категория в прайс-листе.  Параметр доступен начиная с версии 2.0 партнерского API.
$currency = new \OpenAPI\Client\Model\CurrencyType(); // CurrencyType | Валюта, в которой указана цена предложения.  Возможные значения:  * `BYN` — белорусский рубль.  * `KZT` — казахстанский тенге.  * `RUR` — российский рубль.  * `UAH` — украинская гривна.
$matched = True; // bool | Фильтр по признаку соотнесения предложения и карточки модели.  Возможные значения:  * `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели.  * `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
$page = 1; // int | Номер страницы результатов.  Значение по умолчанию: 1.  Используется вместе с параметром `page_size`.  `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
$page_size = 56; // int | Размер страницы.  Используется вместе с параметром `page_number`.  `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

try {
    $result = $apiInstance->getOffers($campaign_id, $query, $feed_id, $shop_category_id, $currency, $matched, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OffersApi->getOffers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
campaign_id	int	Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
query	string	Поисковый запрос. Поддерживается язык запросов. Значение по умолчанию: все предложения магазина, размещенные на Маркете.	[optional]
feed_id	int	Идентификатор прайс-листа.	[optional]
shop_category_id	string	Идентификатор категории предложения, указанный магазином в прайс-листе. Параметр выводится только для предложений, у которых указана категория в прайс-листе. Параметр доступен начиная с версии 2.0 партнерского API.	[optional]
currency	CurrencyType	Валюта, в которой указана цена предложения. Возможные значения: * `BYN` — белорусский рубль. * `KZT` — казахстанский тенге. * `RUR` — российский рубль. * `UAH` — украинская гривна.	[optional]
matched	bool	Фильтр по признаку соотнесения предложения и карточки модели. Возможные значения: * `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели. * `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).	[optional]
page	int	Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.	[optional] [default to 1]
page_size	int	Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.	[optional]

Return type

\OpenAPI\Client\Model\GetOffersResponse

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]

`updateCampaignOffers()`

updateCampaignOffers($campaign_id, $update_campaign_offers_request): \OpenAPI\Client\Model\EmptyApiResponse

Настройка размещения товаров в магазине

Изменяет параметры размещения товаров в конкретном магазине: доступность товара, условия доставки и самовывоза, применяемую ставку НДС. |⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе| |-|

Example

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


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


$apiInstance = new OpenAPI\Client\Api\OffersApi(
    // 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)
$update_campaign_offers_request = new \OpenAPI\Client\Model\UpdateCampaignOffersRequest(); // \OpenAPI\Client\Model\UpdateCampaignOffersRequest

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

Parameters

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

Return type

\OpenAPI\Client\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]

Files

OffersApi.md

Latest commit

History

OffersApi.md

File metadata and controls

OpenAPI\Client\OffersApi

deleteCampaignOffers()

Example

Parameters

Return type

Authorization

HTTP request headers

getAllOffers()

Example

Parameters

Return type

Authorization

HTTP request headers

getCampaignOffers()

Example

Parameters

Return type

Authorization

HTTP request headers

getOfferRecommendations()

Example

Parameters

Return type

Authorization

HTTP request headers

getOffers()

Example

Parameters

Return type

Authorization

HTTP request headers

updateCampaignOffers()

Example

Parameters

Return type

Authorization

HTTP request headers

`deleteCampaignOffers()`

`getAllOffers()`

`getCampaignOffers()`

`getOfferRecommendations()`

`getOffers()`

`updateCampaignOffers()`