Skip to content

Latest commit

 

History

History
212 lines (149 loc) · 30.4 KB

OfferMappingsApi.md

File metadata and controls

212 lines (149 loc) · 30.4 KB
Raw

OpenAPI\Client\OfferMappingsApi

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

Method HTTP request Description
getOfferMappingEntries() GET /campaigns/{campaignId}/offer-mapping-entries Список товаров в каталоге
getSuggestedOfferMappingEntries() POST /campaigns/{campaignId}/offer-mapping-entries/suggestions Рекомендованные карточки для ваших товаров
updateOfferMappingEntries() POST /campaigns/{campaignId}/offer-mapping-entries/updates Добавление и редактирование товаров в каталоге

getOfferMappingEntries()

getOfferMappingEntries($campaign_id, $offer_id, $shop_sku, $mapping_kind, $status, $availability, $category_id, $vendor, $page_token, $limit): \OpenAPI\Client\Model\GetOfferMappingEntriesResponse

Список товаров в каталоге

{% note alert "Deprecated" %} Этот метод устарел. Пожалуйста, пользуйтесь вместо него POST businesses/{businessId}/offer-mappings. {% endnote %} Для каждого товара, который вы размещаете на Маркете, возвращается информация о карточках Маркета, к которым привязан этот товар: * Идентификатор текущей карточки (marketSku), карточки, которая проходит модерацию и последней отклоненной карточки. * Описание товара, которое указано на карточке Маркета. Например, размер упаковки и вес товара. Результаты возвращаются постранично. Выходные данные содержат идентификатор следующей страницы. {% note info %} Количество товаров в каталоге магазина считается по данным за последние семь дней (не включая сегодня). {% 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\OfferMappingsApi(
    // 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[] | Идентификатор товара в каталоге.
$shop_sku = array('shop_sku_example'); // string[] | Ваш SKU товара.  Параметр может быть указан несколько раз, например:  ``` ...shop_sku=123&shop_sku=129&shop_sku=141... ```  В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
$mapping_kind = new \OpenAPI\Client\Model\OfferMappingKindType(); // OfferMappingKindType | Тип маппинга.
$status = array(new \OpenAPI\Client\Model\\OpenAPI\Client\Model\OfferProcessingStatusType()); // \OpenAPI\Client\Model\OfferProcessingStatusType[] | Фильтрация по статусу публикации товара:  * READY — товар прошел модерацию. * IN_WORK — товар проходит модерацию. * NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее. * NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара. * REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары. * SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары. * OTHER — товар не прошел модерацию по другой причине.  Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:  ``` ...status=READY,IN_WORK... ...status=READY&status=IN_WORK... ```  В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
$availability = array(new \OpenAPI\Client\Model\\OpenAPI\Client\Model\OfferAvailabilityStatusType()); // \OpenAPI\Client\Model\OfferAvailabilityStatusType[] | Фильтрация по планам поставок товара:  * ACTIVE — поставки будут. * INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять. * DELISTED — архив: товар закончился на складе, и его поставок больше не будет.  Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:  ``` ...availability=INACTIVE,DELISTED... ...availability=INACTIVE&availability=DELISTED... ```  В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
$category_id = array(56); // int[] | Фильтрация по идентификатору категории на Маркете.  Чтобы узнать идентификатор категории, откройте ее страницу и посмотрите на ее URL. Идентификатор — это число после «...?hid=». Например:  ##https://market.yandex.ru/catalog--bezmeny/65590/list?hid=13431995##  Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:  ``` ...category_id=14727164,14382343... ...category_id=14727164&category_id=14382343... ```  В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке.
$vendor = array('vendor_example'); // string[] | Фильтрация по бренду товара.  Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например:  ``` ...vendor=Aqua%20Minerale,Borjomi... ...vendor=Aqua%20Minerale&vendor=Borjomi... ```  Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional.  Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе [Кодирование URL русскоязычной Википедии](https://ru.wikipedia.org/wiki/URL#Кодирование_URL).  В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке.
$page_token = eyBuZXh0SWQ6IDIzNDIgfQ==; // string | Идентификатор страницы c результатами.  Если параметр не указан, возвращается самая старая страница.  Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе.  Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются.
$limit = 20; // int | Количество товаров на одной странице.

try {
    $result = $apiInstance->getOfferMappingEntries($campaign_id, $offer_id, $shop_sku, $mapping_kind, $status, $availability, $category_id, $vendor, $page_token, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OfferMappingsApi->getOfferMappingEntries: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
campaign_id int Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
offer_id string[] Идентификатор товара в каталоге. [optional]
shop_sku string[] Ваш SKU товара. Параметр может быть указан несколько раз, например: ``` ...shop_sku=123&shop_sku=129&shop_sku=141... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке. [optional]
mapping_kind OfferMappingKindType Тип маппинга. [optional]
status \OpenAPI\Client\Model\OfferProcessingStatusType[] Фильтрация по статусу публикации товара: * READY — товар прошел модерацию. * IN_WORK — товар проходит модерацию. * NEED_CONTENT — для товара без SKU на Маркете marketSku нужно найти карточку самостоятельно или создать ее. * NEED_INFO — товар не прошел модерацию из-за ошибок или недостающих сведений в описании товара. * REJECTED — товар не прошел модерацию, так как Маркет не планирует размещать подобные товары. * SUSPENDED — товар не прошел модерацию, так как Маркет пока не размещает подобные товары. * OTHER — товар не прошел модерацию по другой причине. Можно указать несколько статусов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...status=READY,IN_WORK... ...status=READY&status=IN_WORK... ``` В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке. [optional]
availability \OpenAPI\Client\Model\OfferAvailabilityStatusType[] Фильтрация по планам поставок товара: * ACTIVE — поставки будут. * INACTIVE — поставок не будет: товар есть на складе, но вы больше не планируете его поставлять. * DELISTED — архив: товар закончился на складе, и его поставок больше не будет. Можно указать несколько значений в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...availability=INACTIVE,DELISTED... ...availability=INACTIVE&availability=DELISTED... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке. [optional]
category_id int[] Фильтрация по идентификатору категории на Маркете. Чтобы узнать идентификатор категории, откройте ее страницу и посмотрите на ее URL. Идентификатор — это число после «...?hid=». Например: ##https://market.yandex.ru/catalog--bezmeny/65590/list?hid&#x3D;13431995## Можно указать несколько идентификаторов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...category_id=14727164,14382343... ...category_id=14727164&category_id=14382343... ``` В запросе можно указать либо параметр `shopSku`, либо любые параметры для фильтрации товаров. Совместное использование параметра `shopSku` и параметров для фильтрации приведет к ошибке. [optional]
vendor string[] Фильтрация по бренду товара. Можно указать несколько брендов в одном параметре, через запятую, или в нескольких одинаковых параметрах. Например: ``` ...vendor=Aqua%20Minerale,Borjomi... ...vendor=Aqua%20Minerale&vendor=Borjomi... ``` Чтобы товар попал в результаты фильтрации, его бренд должен точно совпадать с одним из указанных в запросе. Например, если указан бренд Schwarzkopf, то в результатах не будет товаров Schwarzkopf Professional. Если в названии бренда есть символы, которые не входят в таблицу ASCII (в том числе кириллические символы), используйте для них URL-кодирование. Например, пробел — %20, апостроф «'» — %27 и т. д. Подробнее см. в разделе Кодирование URL русскоязычной Википедии. В запросе можно указать либо параметр shopSku, либо любые параметры для фильтрации товаров. Совместное использование параметра shopSku и параметров для фильтрации приведет к ошибке. [optional]
page_token string Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token`, параметры `offset`, `page_number` и `page_size` игнорируются. [optional]
limit int Количество товаров на одной странице. [optional]

Return type

\OpenAPI\Client\Model\GetOfferMappingEntriesResponse

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]

getSuggestedOfferMappingEntries()

getSuggestedOfferMappingEntries($campaign_id, $get_suggested_offer_mapping_entries_request): \OpenAPI\Client\Model\GetSuggestedOfferMappingEntriesResponse

Рекомендованные карточки для ваших товаров

{% note alert "Deprecated" %} Этот метод устарел. Пожалуйста, пользуйтесь вместо него POST businesses/{businessId}/offer-mappings/suggestions. {% endnote %} Возвращает идентификаторы карточек товаров на Маркете, рекомендованных для ваших товаров. Каждому товару, который вы размещаете, должна соответствовать карточка товара на Маркете со своим идентификатором — SKU на Маркете. Он указывается в URL карточки товара, после «...sku=», например: ##https://market.yandex.ru/product--yandex-kniga/484830016?sku=484830016…## Чтобы получить для товаров рекомендованные SKU на Маркете, передайте в теле POST-запроса как можно больше информации о них: названия, производителей, штрихкоды, цены и т. д. Полученные SKU можно передать вместе с информацией о ваших товарах с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/updates. В одном запросе можно получить не более 500 рекомендаций. |⚙️ Лимит: 100 000 рекомендаций в час| |-|

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\OfferMappingsApi(
    // 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_suggested_offer_mapping_entries_request = new \OpenAPI\Client\Model\GetSuggestedOfferMappingEntriesRequest(); // \OpenAPI\Client\Model\GetSuggestedOfferMappingEntriesRequest

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

Parameters

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

Return type

\OpenAPI\Client\Model\GetSuggestedOfferMappingEntriesResponse

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]

updateOfferMappingEntries()

updateOfferMappingEntries($campaign_id, $update_offer_mapping_entry_request): \OpenAPI\Client\Model\EmptyApiResponse

Добавление и редактирование товаров в каталоге

{% note alert "Deprecated" %} Этот метод устарел. Пожалуйста, пользуйтесь вместо него POST businesses/{businessId}/offer-mappings/update. {% endnote %} Добавляет товары, указанные в запросе, в ваш каталог товаров и редактирует уже имеющиеся товары. Информацию о товарах нужно передать в теле POST-запроса. У каждого товара должен быть ваш SKU — уникальный код, который вы используете для идентификации товара: * Чтобы добавить в каталог новый товар, укажите в параметре shopSku ваш SKU, которого еще нет в каталоге. * Чтобы отредактировать товар из каталога, укажите в параметре shopSku ваш SKU этого товара в каталоге. В обоих случаях в запросе нужно передать полное описание товара, даже если вы хотите изменить только несколько характеристик. Если вы знаете, какой карточке товара на Маркете соответствует ваш товар, укажите ее идентификатор (SKU на Маркете) во входном параметре mapping. Получить SKU на Маркете рекомендованной карточки товара можно с помощью запроса POST campaigns/{campaignId}/offer-mapping-entries/suggestions или через личный кабинет. Если SKU на Маркете не указан, сотрудники Маркета сами подберут или создадут подходящую карточку товара, либо у него появится статус NEED_CONTENT (нужно найти карточку или создать ее самостоятельно) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries. Перед публикацией товары проходят модерацию. Если в одном из отправленных товаров найдена ошибка, ответ на запрос будет иметь HTTP-код 400 Bad Request, и ни один из товаров не отправится на модерацию. При этом если вы не передадите все обязательные параметры для какого‑либо товара, после модерации у него появится статус NEED_INFO (в описании товара не хватает информации) в выходных данных запроса GET campaigns/{campaignId}/offer-mapping-entries. В одном запросе можно добавить не более 500 товаров. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |⚙️ Лимит: 5 000 товаров в минуту| |-|

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\OfferMappingsApi(
    // 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_offer_mapping_entry_request = new \OpenAPI\Client\Model\UpdateOfferMappingEntryRequest(); // \OpenAPI\Client\Model\UpdateOfferMappingEntryRequest

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

Parameters

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

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]