Skip to content

Latest commit

 

History

History
206 lines (143 loc) · 14 KB

HiddenOffersApi.md

File metadata and controls

206 lines (143 loc) · 14 KB

OpenAPI\Client\HiddenOffersApi

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

Method HTTP request Description
addHiddenOffers() POST /campaigns/{campaignId}/hidden-offers Скрытие товаров и настройки скрытия
deleteHiddenOffers() DELETE /campaigns/{campaignId}/hidden-offers Возобновление показа товаров
getHiddenOffers() GET /campaigns/{campaignId}/hidden-offers Информация о скрытых вами товарах

addHiddenOffers()

addHiddenOffers($campaign_id, $add_hidden_offers_request): \OpenAPI\Client\Model\EmptyApiResponse

Скрытие товаров и настройки скрытия

Скрывает товары магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |⚙️ Лимит: 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\HiddenOffersApi(
    // 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)
$add_hidden_offers_request = new \OpenAPI\Client\Model\AddHiddenOffersRequest(); // \OpenAPI\Client\Model\AddHiddenOffersRequest | Запрос на скрытие оферов.

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

Parameters

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

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]

deleteHiddenOffers()

deleteHiddenOffers($campaign_id, $delete_hidden_offers_request): \OpenAPI\Client\Model\EmptyApiResponse

Возобновление показа товаров

Возобновляет показ скрытых вами товаров магазина на Маркете. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |⚙️ Лимит: 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\HiddenOffersApi(
    // 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_hidden_offers_request = new \OpenAPI\Client\Model\DeleteHiddenOffersRequest(); // \OpenAPI\Client\Model\DeleteHiddenOffersRequest | Запрос на возобновление показа оферов.

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

Parameters

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

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]

getHiddenOffers()

getHiddenOffers($campaign_id, $offer_id, $page_token, $limit, $offset, $page, $page_size): \OpenAPI\Client\Model\GetHiddenOffersResponse

Информация о скрытых вами товарах

Возвращает для заданного магазина список скрытых вами товаров. В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее. |⚙️ Лимит: 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\HiddenOffersApi(
    // 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)
$offer_id = array('offer_id_example'); // string[] | Идентификатор скрытого предложения.
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается самая старая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.
$limit = 20; // int | Количество товаров на одной странице.
$offset = 56; // int | Позиция в списке, начиная с которой возвращаются результаты ответа.  Используется вместе с параметром `limit`.  Если задан `offset`, параметры `page_number` и `page_size` игнорируются.  `offset` игнорируется, если задан `page_token`.
$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->getHiddenOffers($campaign_id, $offer_id, $page_token, $limit, $offset, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HiddenOffersApi->getHiddenOffers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
campaign_id int Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
offer_id string[] Идентификатор скрытого предложения. [optional]
page_token string Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются. [optional]
limit int Количество товаров на одной странице. [optional]
offset int Позиция в списке, начиная с которой возвращаются результаты ответа. Используется вместе с параметром `limit`. Если задан `offset`, параметры `page_number` и `page_size` игнорируются. `offset` игнорируется, если задан `page_token`. [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\GetHiddenOffersResponse

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]