Skip to content

Latest commit

 

History

History
198 lines (135 loc) · 11.8 KB

ContentApi.md

File metadata and controls

198 lines (135 loc) · 11.8 KB
Raw

OpenAPI\Client\ContentApi

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

Method HTTP request Description
getCategoryContentParameters() POST /category/{categoryId}/parameters Списки характеристик товаров по категориям
getOfferCardsContentStatus() POST /businesses/{businessId}/offer-cards Получение информации о заполненности карточек
updateOfferContent() POST /businesses/{businessId}/offer-cards/update Редактирование категорийных характеристик товара

getCategoryContentParameters()

getCategoryContentParameters($category_id): \OpenAPI\Client\Model\GetCategoryContentParametersResponse

Списки характеристик товаров по категориям

Возвращает список характеристик с допустимыми значениями для заданной категории. |⚙️ Лимит: 50 категорий в минуту | |-|

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\ContentApi(
    // 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
);
$category_id = 56; // int | Идентификатор категории на Маркете.  Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом [POST businesses/{businessId}/offer-cards](../../reference/content/getOfferCardsContentStatus.md).

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

Parameters

Name Type Description Notes
category_id int Идентификатор категории на Маркете. Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST businesses/{businessId}/offer-cards.

Return type

\OpenAPI\Client\Model\GetCategoryContentParametersResponse

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]

getOfferCardsContentStatus()

getOfferCardsContentStatus($business_id, $page_token, $limit, $get_offer_cards_content_status_request): \OpenAPI\Client\Model\GetOfferCardsContentStatusResponse

Получение информации о заполненности карточек

Возвращает сведения о состоянии контента для заданных товаров: * создана ли карточка товара и в каком она статусе; * заполненность карточки в процентах; * есть ли ошибки или предупреждения, связанные с контентом; * рекомендации по заполнению карточки. |⚙️ Лимит: 600 запросов в минуту, не более 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\ContentApi(
    // 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)
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается самая старая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.
$limit = 20; // int | Количество товаров на одной странице.
$get_offer_cards_content_status_request = new \OpenAPI\Client\Model\GetOfferCardsContentStatusRequest(); // \OpenAPI\Client\Model\GetOfferCardsContentStatusRequest

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

Parameters

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

Return type

\OpenAPI\Client\Model\GetOfferCardsContentStatusResponse

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]

updateOfferContent()

updateOfferContent($business_id, $update_offer_content_request): \OpenAPI\Client\Model\UpdateOfferContentResponse

Редактирование категорийных характеристик товара

Редактирует характеристики товара, которые специфичны для категории, к которой он относится. {% note warning "Здесь только то, что относится к конкретной категории" %} Если вам нужно изменить основные параметры товара (название, описание, изображения, видео, производитель, штрихкод), воспользуйтесь запросом POST businesses/{businessId}/offer-mappings/update. {% endnote %} Всегда передавайте список характеристик и значений целиком, даже если нужно изменить всего одну из них. Передача отсутствующего значения стирает значение, сохраненное ранее. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |⚙️ Лимит: 5000 товаров в минуту, не более 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\ContentApi(
    // 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)
$update_offer_content_request = new \OpenAPI\Client\Model\UpdateOfferContentRequest(); // \OpenAPI\Client\Model\UpdateOfferContentRequest

try {
    $result = $apiInstance->updateOfferContent($business_id, $update_offer_content_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentApi->updateOfferContent: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_id int Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
update_offer_content_request \OpenAPI\Client\Model\UpdateOfferContentRequest

Return type

\OpenAPI\Client\Model\UpdateOfferContentResponse

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]