--- metadata: - name: generator content: Diplodoc Platform v5.55.0 alternate: - https://yandex.com/dev/market/partner-api/doc/en/step-by-step/reports.md - https://yandex.com/dev/market/partner-api/doc/ru/step-by-step/reports.md - https://yandex.com/dev/market/partner-api/doc/zh/step-by-step/reports.md - href: en/step-by-step/reports.md type: text/markdown title: Markdown version - href: ../llms.txt type: text/markdown title: llms.txt --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/market/partner-api/doc/en/llms.txt # How to receive reports and documents Yandex Market API allows you to receive reports and documents. [Their types](#generate) Generation takes time, so first you need to make a request for the generation itself, and then to receive the finished report or document. ```mermaid %%{ init: { 'theme': 'base', 'themeVariables': { 'primaryColor': '#FDF3E8', 'primaryTextColor': '#000000', 'primaryBorderColor': '#BA9C80', 'lineColor': '#BA9C80', 'secondaryColor': '#94E1C4', 'tertiaryColor': '#F84E57', 'noteBkgColor': '#FED58D' } } }%% sequenceDiagram participant Merchant as Your store participant Market as Yandex Market rect rgb(251, 243, 232) note right of Merchant: Receiving a report or document Merchant ->>+ Market: POST v2/reports//generate Market ->> Market: Places the report or document
in the generation queue. Market -->>- Merchant: OK: identifier with which
the finished report or document can be obtained,
as well as the expected generation time
(reportId + estimatedGenerationTime). end opt rect rgb(251, 243, 232) note right of Merchant: Optional step note right of Merchant: Checking generation status Merchant ->> Market: GET v2/reports/info/ Market -->> Merchant: OK: status and estimated time remaining
(status + estimatedGenerationTime). end end rect rgb(251, 243, 232) note right of Merchant: Retrieving the finished report or document after the time specified in estimatedGenerationTime has passed Merchant ->> Market: GET v2/reports/info/ Market -->> Merchant: OK: status and link.
If generation was successful — status = DONE + file.
If generation failed — status = FAILED or status = NODATA. end ``` ## How to order a report or document {#generate} Make a request that matches the type of report or document you need. In the request, set the settings and filters, and specify the format in which you want to get the result. The available formats are specified in the description of each method. #| || **Type of report or document** | **How to start generation** || || Report on convergence with closing documents |[POST v2/reports/closure-documents/detalization/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateClosureDocumentsDetalizationReport.md)|| || Marketing Account Report |[POST v1/businesses/{businessId}/reports/marketing-detalization/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateMarketingDetalizationReport.md)|| || Coverage Promotion Report |[POST v2/reports/banners-statistics/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateBannersStatisticsReport.md) || || Impression Boost Report |[POST v2/reports/shows-boost/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateShowsBoostReport.md) || || Sales Boost Report |[POST v2/reports/boost-consolidated/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateBoostConsolidatedReport.md) || || Shelf Report |[POST v2/reports/shelf-statistics/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateShelfsStatisticsReport.md) || || Closing documents |[POST v2/reports/closure-documents/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateClosureDocumentsReport.md) || || Assembly Sheet |[POST v2/reports/documents/shipment-list/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateShipmentListDocumentReport.md) || || A file with product barcodes |[POST v1/reports/documents/barcodes/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateBarcodesReport.md) || || Sales Analytics Report |[POST v2/reports/shows-sales/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateShowsSalesReport.md) || || Sales Geography Report |[POST v2/reports/sales-geography/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateSalesGeographyReport.md) || || Report on the movement of goods |[POST v2/reports/goods-movement/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateGoodsMovementReport.md) || || Order Report |[POST v2/reports/united-orders/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateUnitedOrdersReport.md) || || Jewelry Order Report |[POST v2/reports/jewelry-fiscal/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateJewelryFiscalReport.md) || || Report on key indicators |[POST v2/reports/key-indicators/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateKeyIndicatorsReport.md) || || Competitive Position Report |[POST v2/reports/competitors-position/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateCompetitorsPositionReport.md) || || Report on non-purchases and refunds |[POST v2/reports/united-returns/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateUnitedReturnsReport.md) || || Turnover Report |[POST v2/reports/goods-turnover/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateGoodsTurnoverReport.md) || || Warehouse balance report |[POST v2/reports/stocks-on-warehouses/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateStocksOnWarehousesReport.md) || || Product Reviews Report |[POST v2/reports/goods-feedback/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateGoodsFeedbackReport.md) || || Payment report: * about payments for the period; * about the payment order; * about Yandex. Market points. |[POST v2/reports/united-netting/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateUnitedNettingReport.md) || || Implementation Report |[POST v2/reports/goods-realization/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateGoodsRealizationReport.md) || || Report on the cost of services: * by the date of service accrual; * by the date of the act's formation. |[POST v2/reports/united-marketplace-services/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateUnitedMarketplaceServicesReport.md) || || The Prices Report |[POST v2/reports/goods-prices/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateGoodsPricesReport.md) || || Labels for all boxes in multiple orders |[POST v2/reports/documents/labels/generate](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/generateMassOrderLabelsReport.md) || |# ## How do I know if a report or document is ready? {#status} Make a request [GET v2/reports/info/{reportId}](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/getReportInfo.md). You will receive the status of the report or document generation and the estimated time remaining until the generation is completed. ## How to get a ready-made report or document {#get} After the generation time is over, repeat the request. [GET v2/reports/info/{reportId}](https://yandex.com/dev/market/partner-api/doc/en/reference/reports/getReportInfo.md).

If the report or document has been generated, you will receive a link to download it.

{% note warning "Срок действия ссылки" %}

The link is relevant **60 minutes** from the moment of receiving the response. With each request `GET /v2/reports/info/{reportId}` a new signed link is generated, which has a limited validity period.

**Recommendation for integrations:** immediately after receiving the link, download the report and save it to yourself. Do not save the link for later use. — it will become invalid after the expiration date.

:no-translate[{% endnote %}]