OpenAPI\Client\ReportsApi

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

Method	HTTP request	Description
generateGoodsMovementReport()	POST /reports/goods-movement/generate	Отчет по движению товаров
generateGoodsRealizationReport()	POST /reports/goods-realization/generate	Отчет по реализации
generateGoodsTurnoverReport()	POST /reports/goods-turnover/generate	Отчет по оборачиваемости
generatePricesReport()	POST /reports/prices/generate	Отчет «Цены на рынке»
generateShowsSalesReport()	POST /reports/shows-sales/generate	Отчет «Аналитика продаж»
generateStocksOnWarehousesReport()	POST /reports/stocks-on-warehouses/generate	Отчет по остаткам на складах
generateUnitedMarketplaceServicesReport()	POST /reports/united-marketplace-services/generate	Отчет по стоимости услуг
generateUnitedNettingReport()	POST /reports/united-netting/generate	Отчет по платежам
generateUnitedOrdersReport()	POST /reports/united-orders/generate	Отчет по заказам
getReportInfo()	GET /reports/info/{reportId}	Статус генерации и скачивание готовых отчетов

`generateGoodsMovementReport()`

generateGoodsMovementReport($generate_goods_movement_report_request, $format): \OpenAPI\Client\Model\GenerateReportResponse

Отчет по движению товаров

Запускает генерацию отчета по движению товаров. Что это за отчет Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}. |⚙️ Лимит: 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\ReportsApi(
    // 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
);
$generate_goods_movement_report_request = new \OpenAPI\Client\Model\GenerateGoodsMovementReportRequest(); // \OpenAPI\Client\Model\GenerateGoodsMovementReportRequest
$format = new \OpenAPI\Client\Model\ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    $result = $apiInstance->generateGoodsMovementReport($generate_goods_movement_report_request, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateGoodsMovementReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_goods_movement_report_request	\OpenAPI\Client\Model\GenerateGoodsMovementReportRequest
format	ReportFormatType	Формат отчета.	[optional]

Return type

\OpenAPI\Client\Model\GenerateReportResponse

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]

`generateGoodsRealizationReport()`

generateGoodsRealizationReport($generate_goods_realization_report_request, $format): \OpenAPI\Client\Model\GenerateReportResponse

Отчет по реализации

Запускает генерацию отчета по реализации за заданный период. Что это за отчет Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}. |⚙️ Лимит: 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\ReportsApi(
    // 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
);
$generate_goods_realization_report_request = new \OpenAPI\Client\Model\GenerateGoodsRealizationReportRequest(); // \OpenAPI\Client\Model\GenerateGoodsRealizationReportRequest
$format = new \OpenAPI\Client\Model\ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    $result = $apiInstance->generateGoodsRealizationReport($generate_goods_realization_report_request, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateGoodsRealizationReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_goods_realization_report_request	\OpenAPI\Client\Model\GenerateGoodsRealizationReportRequest
format	ReportFormatType	Формат отчета.	[optional]

Return type

\OpenAPI\Client\Model\GenerateReportResponse

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]

`generateGoodsTurnoverReport()`

generateGoodsTurnoverReport($generate_goods_turnover_request, $format): \OpenAPI\Client\Model\GenerateReportResponse

Отчет по оборачиваемости

Запускает генерацию отчета по оборачиваемости за заданный период. Что это за отчет Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}. |⚙️ Лимит: 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\ReportsApi(
    // 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
);
$generate_goods_turnover_request = new \OpenAPI\Client\Model\GenerateGoodsTurnoverRequest(); // \OpenAPI\Client\Model\GenerateGoodsTurnoverRequest
$format = new \OpenAPI\Client\Model\ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    $result = $apiInstance->generateGoodsTurnoverReport($generate_goods_turnover_request, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateGoodsTurnoverReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_goods_turnover_request	\OpenAPI\Client\Model\GenerateGoodsTurnoverRequest
format	ReportFormatType	Формат отчета.	[optional]

Return type

\OpenAPI\Client\Model\GenerateReportResponse

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]

`generatePricesReport()`

generatePricesReport($generate_prices_report_request, $format): \OpenAPI\Client\Model\GenerateReportResponse

Отчет «Цены на рынке»

Запускает генерацию отчета «Цены на рынке». Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}. |⚙️ Лимит: 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\ReportsApi(
    // 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
);
$generate_prices_report_request = new \OpenAPI\Client\Model\GeneratePricesReportRequest(); // \OpenAPI\Client\Model\GeneratePricesReportRequest
$format = new \OpenAPI\Client\Model\ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    $result = $apiInstance->generatePricesReport($generate_prices_report_request, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generatePricesReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_prices_report_request	\OpenAPI\Client\Model\GeneratePricesReportRequest
format	ReportFormatType	Формат отчета.	[optional]

Return type

\OpenAPI\Client\Model\GenerateReportResponse

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]

`generateShowsSalesReport()`

generateShowsSalesReport($generate_shows_sales_report_request, $format): \OpenAPI\Client\Model\GenerateReportResponse

Отчет «Аналитика продаж»

Запускает генерацию отчета «Аналитика продаж» за заданный период. Что это за отчет Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}. |⚙️ Лимит: 10 запросов в час| |-|

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\ReportsApi(
    // 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
);
$generate_shows_sales_report_request = new \OpenAPI\Client\Model\GenerateShowsSalesReportRequest(); // \OpenAPI\Client\Model\GenerateShowsSalesReportRequest
$format = new \OpenAPI\Client\Model\ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    $result = $apiInstance->generateShowsSalesReport($generate_shows_sales_report_request, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateShowsSalesReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_shows_sales_report_request	\OpenAPI\Client\Model\GenerateShowsSalesReportRequest
format	ReportFormatType	Формат отчета.	[optional]

Return type

\OpenAPI\Client\Model\GenerateReportResponse

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]

`generateStocksOnWarehousesReport()`

generateStocksOnWarehousesReport($generate_stocks_on_warehouses_report_request, $format): \OpenAPI\Client\Model\GenerateReportResponse

Отчет по остаткам на складах

Запускает генерацию отчета по остаткам на складах. Отчет содержит данные: * Для модели FBY — об остатках на складах Маркета. Такой отчет поддерживает фильтры. * Для модели FBS — об остатках на соответствующем складе магазина и всегда выводится целиком. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}. |⚙️ Лимит: 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\ReportsApi(
    // 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
);
$generate_stocks_on_warehouses_report_request = new \OpenAPI\Client\Model\GenerateStocksOnWarehousesReportRequest(); // \OpenAPI\Client\Model\GenerateStocksOnWarehousesReportRequest
$format = new \OpenAPI\Client\Model\ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    $result = $apiInstance->generateStocksOnWarehousesReport($generate_stocks_on_warehouses_report_request, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateStocksOnWarehousesReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_stocks_on_warehouses_report_request	\OpenAPI\Client\Model\GenerateStocksOnWarehousesReportRequest
format	ReportFormatType	Формат отчета.	[optional]

Return type

\OpenAPI\Client\Model\GenerateReportResponse

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]

`generateUnitedMarketplaceServicesReport()`

generateUnitedMarketplaceServicesReport($generate_united_marketplace_services_report_request, $format): \OpenAPI\Client\Model\GenerateReportResponse

Отчет по стоимости услуг

Запускает генерацию отчета по стоимости услуг за заданный период. Что это за отчет Тип отчета зависит от того, какие поля заполнены в запросе: |Тип отчета |Какие поля нужны | |-------------------------|-----------------------------| |По дате начисления услуги|dateTimeFrom и dateTimeTo| |По дате формирования акта|year и month | Заказать отчеты обоих типов одним запросом нельзя. Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}. |⚙️ Лимит: 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\ReportsApi(
    // 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
);
$generate_united_marketplace_services_report_request = new \OpenAPI\Client\Model\GenerateUnitedMarketplaceServicesReportRequest(); // \OpenAPI\Client\Model\GenerateUnitedMarketplaceServicesReportRequest
$format = new \OpenAPI\Client\Model\ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    $result = $apiInstance->generateUnitedMarketplaceServicesReport($generate_united_marketplace_services_report_request, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateUnitedMarketplaceServicesReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_united_marketplace_services_report_request	\OpenAPI\Client\Model\GenerateUnitedMarketplaceServicesReportRequest
format	ReportFormatType	Формат отчета.	[optional]

Return type

\OpenAPI\Client\Model\GenerateReportResponse

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]

`generateUnitedNettingReport()`

generateUnitedNettingReport($generate_united_netting_report_request, $format): \OpenAPI\Client\Model\GenerateReportResponse

Отчет по платежам

Запускает генерацию отчета по платежам за заданный период. Что это за отчет Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}. Тип отчета зависит от того, какие поля заполнены в запросе: |Тип отчета |Какие поля нужны | |---------------------|-----------------------------------| |О платежах за период |dateTimeFrom и dateTimeTo | |О платежном поручении|bankOrderId и bankOrderDateTime| Заказать отчеты обоих типов одним запросом нельзя. |⚙️ Лимит: 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\ReportsApi(
    // 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
);
$generate_united_netting_report_request = new \OpenAPI\Client\Model\GenerateUnitedNettingReportRequest(); // \OpenAPI\Client\Model\GenerateUnitedNettingReportRequest
$format = new \OpenAPI\Client\Model\ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    $result = $apiInstance->generateUnitedNettingReport($generate_united_netting_report_request, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateUnitedNettingReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_united_netting_report_request	\OpenAPI\Client\Model\GenerateUnitedNettingReportRequest
format	ReportFormatType	Формат отчета.	[optional]

Return type

\OpenAPI\Client\Model\GenerateReportResponse

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]

`generateUnitedOrdersReport()`

generateUnitedOrdersReport($generate_united_orders_request, $format): \OpenAPI\Client\Model\GenerateReportResponse

Отчет по заказам

Запускает генерацию отчета по заказам за заданный период. Что это за отчет {% note info "" %} Это новый отчет. Раньше мы так называли генерацию детальной информации по заказам. Как получить детальную информацию по заказам {% endnote %} Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}. |⚙️ Лимит: 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\ReportsApi(
    // 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
);
$generate_united_orders_request = new \OpenAPI\Client\Model\GenerateUnitedOrdersRequest(); // \OpenAPI\Client\Model\GenerateUnitedOrdersRequest
$format = new \OpenAPI\Client\Model\ReportFormatType(); // ReportFormatType | Формат отчета.

try {
    $result = $apiInstance->generateUnitedOrdersReport($generate_united_orders_request, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReportsApi->generateUnitedOrdersReport: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
generate_united_orders_request	\OpenAPI\Client\Model\GenerateUnitedOrdersRequest
format	ReportFormatType	Формат отчета.	[optional]

Return type

\OpenAPI\Client\Model\GenerateReportResponse

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]

`getReportInfo()`

getReportInfo($report_id): \OpenAPI\Client\Model\GetReportInfoResponse

Статус генерации и скачивание готовых отчетов

Возвращает статус генерации заданного отчета и, если отчет готов, ссылку для скачивания. Чтобы воспользоваться этим запросом, вначале нужно запустить генерацию отчета. Инструкция |⚙️ Лимит: 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\ReportsApi(
    // 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
);
$report_id = 'report_id_example'; // string | Идентификатор отчета, который вы получили после запуска генерации.

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

Parameters

Name	Type	Description	Notes
report_id	string	Идентификатор отчета, который вы получили после запуска генерации.

Return type

\OpenAPI\Client\Model\GetReportInfoResponse

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]

Files

ReportsApi.md

Latest commit

History

ReportsApi.md

File metadata and controls

OpenAPI\Client\ReportsApi

generateGoodsMovementReport()

Example

Parameters

Return type

Authorization

HTTP request headers

generateGoodsRealizationReport()

Example

Parameters

Return type

Authorization

HTTP request headers

generateGoodsTurnoverReport()

Example

Parameters

Return type

Authorization

HTTP request headers

generatePricesReport()

Example

Parameters

Return type

Authorization

HTTP request headers

generateShowsSalesReport()

Example

Parameters

Return type

Authorization

HTTP request headers

generateStocksOnWarehousesReport()

Example

Parameters

Return type

Authorization

HTTP request headers

generateUnitedMarketplaceServicesReport()

Example

Parameters

Return type

Authorization

HTTP request headers

generateUnitedNettingReport()

Example

Parameters

Return type

Authorization

HTTP request headers

generateUnitedOrdersReport()

Example

Parameters

Return type

Authorization

HTTP request headers

getReportInfo()

Example

Parameters

Return type

Authorization

HTTP request headers

`generateGoodsMovementReport()`

`generateGoodsRealizationReport()`

`generateGoodsTurnoverReport()`

`generatePricesReport()`

`generateShowsSalesReport()`

`generateStocksOnWarehousesReport()`

`generateUnitedMarketplaceServicesReport()`

`generateUnitedNettingReport()`

`generateUnitedOrdersReport()`

`getReportInfo()`