Skip to content

Latest commit

 

History

History
202 lines (139 loc) · 12.4 KB

StocksApi.md

File metadata and controls

202 lines (139 loc) · 12.4 KB
Raw

OpenAPI\Client\StocksApi

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

Method HTTP request Description
getActualStocks() GET /campaigns/{campaignId}/warehouses/{warehouseId}/stocks/actual Запрос информации об остатках
getStocks() POST /campaigns/{campaignId}/offers/stocks Информация об остатках и оборачиваемости
updateStocks() PUT /campaigns/{campaignId}/offers/stocks Передача информации об остатках

getActualStocks()

getActualStocks($campaign_id, $warehouse_id, $sku): \OpenAPI\Client\Model\GetActualStocksResponse

Запрос информации об остатках

{% note warning %} 29 мая 2023 года — последний день, когда на Маркете можно оформить и обработать заказ с внешней площадки. С 30 мая работать с такими заказами станет нельзя. {% endnote %} Запрашивает актуальную информацию по остаткам товаров на складе Маркета. |⚙️ Лимит: 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\StocksApi(
    // 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)
$warehouse_id = 56; // int | Идентификатор склада.
$sku = array('sku_example'); // string[] | Фильтр по SKU

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

Parameters

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

Return type

\OpenAPI\Client\Model\GetActualStocksResponse

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]

getStocks()

getStocks($campaign_id, $page_token, $limit, $get_warehouse_stocks_request): \OpenAPI\Client\Model\GetWarehouseStocksResponse

Информация об остатках и оборачиваемости

Возвращает данные об остатках товаров (для моделей FBY, FBS и Экспресс) и об оборачиваемости товаров (для модели FBY). {% note info "По умолчанию данные по оборачивамости не возращаются" %} Чтобы они были в ответе, передавайте true в поле withTurnover. {% endnote %} |⚙️ Лимит: 100 000 товаров в минуту| |-| [//]: <> (turnover: Среднее количество дней, за которое товар продается. Подробно об оборачиваемости рассказано в Справке https://yandex.ru/support/marketplace/analytics/turnover.html.)

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

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

Parameters

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

Return type

\OpenAPI\Client\Model\GetWarehouseStocksResponse

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]

updateStocks()

updateStocks($campaign_id, $update_stocks_request): \OpenAPI\Client\Model\EmptyApiResponse

Передача информации об остатках

Передает данные об остатках товаров на витрине. Обязательно указывайте SKU в точности так, как он указан в каталоге. Например, 557722 и 0557722 — это два разных SKU. {% note info "Данные в каталоге обновляются не мгновенно" %} Это занимает до нескольких минут. {% endnote %} |⚙️ Лимит: 100 000 товаров в минуту, не более 500 товаров в одном запросе с 1 марта 2024 года| |-|

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\StocksApi(
    // 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_stocks_request = new \OpenAPI\Client\Model\UpdateStocksRequest(); // \OpenAPI\Client\Model\UpdateStocksRequest

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

Parameters

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

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]