### Get Promos Request Body Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/promos/getPromos.md An example JSON body for the Get Promos request. You can filter promotions by participation status and mechanics type. ```json { "participation": "PARTICIPATING_NOW", "mechanics": "DIRECT_DISCOUNT" } ``` -------------------------------- ### Example HTTP Request with API Key Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/concepts/error-codes.md Demonstrates a typical GET request to the Yandex Market API, including the Host and Api-Key headers. ```http GET /campaigns/10003/orders HTTP/1.1 Host: api.partner.market.yandex.ru Accept: */* Api-Key: ACMA:I4c4CxCSYaI41RSC2uYWP2qj3Rhhm4knMiBEga5K:151c0664a ``` -------------------------------- ### Example Authorization Header Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/concepts/oauth-2_0.md An example of a correctly formatted `Authorization` header with a valid OAuth token. ```http Authorization: Bearer y0_BfRRRRRV2L8sWWvNkSNNNNSrLHaNXg4cCMswFbL6MWab9lktL2KPsMw ``` -------------------------------- ### Install OpenAPI Generator with Scoop Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/concepts/openapi.md Install the OpenAPI generator on Windows using the Scoop package manager. ```bash scoop install openapi-generator-cli ``` -------------------------------- ### Example OAuth Token URL Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/concepts/oauth-2_0.md An example of a fully formed URL for generating an OAuth token, after substituting the client ID. ```text https://oauth.yandex.ru/authorize?response_type=token&client_id=5473335а275a5nb8e2648q12n8r378l7 ``` -------------------------------- ### Cabinet-Level Method Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/overview.md This is an example of a cabinet-level method. The cabinet ID (businessId) is passed in the path parameters. ```http POST v2/businesses/{businessId}/settings ``` -------------------------------- ### Store-Level Method Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/overview.md This is an example of a store-level method. To call these methods, a campaign ID (campaignId) is required and is passed in the path parameters. ```http GET v2/campaigns/{campaignId}/orders/{orderId} ``` -------------------------------- ### Response Body Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/push-notifications/concepts/data-format.md This is an example of the JSON payload that the store should return to Yandex.Market. ```json { "version": "1.0.0", "name": "name", "time": "2025-01-16T10:09:49.759084017Z" } ``` -------------------------------- ### Calculate Tariffs Request Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/tariffs/calculateTariffs.md This is an example of a request to calculate tariffs. Note: This endpoint is no longer supported and an alternative should be used. ```APIDOC ## POST /tariffs/calculate ### Description Calculates tariffs based on provided parameters and offer details. This endpoint is no longer supported. ### Method POST ### Endpoint /tariffs/calculate ### Request Body - **parameters** (object) - Required - Parameters for tariff calculation. - **campaignId** (integer) - Required - The ID of the campaign. - **sellingProgram** (string) - Required - The selling program (e.g., FBY). - **frequency** (string) - Required - The frequency of calculation (e.g., DAILY). - **currency** (string) - Required - The currency code (e.g., RUR). - **offers** (array) - Required - A list of offers to calculate tariffs for. - **categoryId** (integer) - Required - The category ID of the offer. - **price** (number) - Required - The price of the offer. - **length** (number) - Required - The length of the offer. - **width** (number) - Required - The width of the offer. - **height** (number) - Required - The height of the offer. - **weight** (number) - Required - The weight of the offer. - **quantity** (integer) - Optional - The quantity of the offer. Defaults to 1. ### Request Example ```json { "parameters": { "campaignId": 0, "sellingProgram": "FBY", "frequency": "DAILY", "currency": "RUR" }, "offers": [ { "categoryId": 0, "price": 0, "length": 0, "width": 0, "height": 0, "weight": 0, "quantity": 1 } ] } ``` ### Response #### Success Response (200) - **status** (string) - The type of response. Possible values: `OK`, `ERROR`. - **errors** (array) - A list of errors. Each error object contains: - **code** (string) - The error code. - **message** (string) - The error message. #### Response Example ```json { "status": "OK", "errors": [ { "code": "string", "message": "string" } ] } ``` ### Error Handling - **420 Method Failure**: The resource access limit has been exceeded. - **500 Internal Server Error**: Internal error of the Market. ``` -------------------------------- ### Install OpenAPI Generator with npm Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/concepts/openapi.md Install the OpenAPI generator globally using npm. This command is for any operating system. ```bash npm install @openapitools/openapi-generator-cli -g ``` -------------------------------- ### JSON Response Structure for Get Offer Mapping Entries Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/offer-mappings/getOfferMappingEntries.md This is an example of the JSON response structure when successfully retrieving offer mapping entries. It includes pagination details and a list of offer mapping entries. ```json { "status": "OK", "result": { "paging": { "nextPageToken": "string", "prevPageToken": "string" }, "offerMappingEntries": [ { "offer": { "name": "Ударная дрель Makita HP1630, 710 Вт", "shopSku": "string", "category": "string", "vendor": "LEVENHUK", ``` -------------------------------- ### Request Body Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/push-notifications/concepts/data-format.md This is an example of the JSON payload sent by Yandex.Market to the store. ```json { "notificationType": "PING", "time": "2025-01-16T10:09:49.759084017Z" } ``` -------------------------------- ### Install OpenAPI Generator with Homebrew Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/concepts/openapi.md Install the OpenAPI generator on macOS using the Homebrew package manager. ```bash brew install openapi-generator ``` -------------------------------- ### Example API Response for Campaigns Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/step-by-step/quick-start-js.md This is an example of the JSON response you can expect when successfully retrieving campaign data using the getCampaigns method. ```json { "campaigns": [ { "domain": "Shop 1", "id": 12345678, "clientId": 87654321, "business": { "id": 123456, "name": "My shop" }, "placementType": "FBS" }, { "domain": "Shop 2", "id": 23456789, "clientId": 98765432, "business": { "id": 123456, "name": "My shop" }, "placementType": "DBS" }, { "domain": "GoodShop", "id": 34567891, "clientId": 19876543, "business": { "id": 123456, "name": "My shop" }, "placementType": "FBY" }, ], "pager": { "total": 3, "from": 1, "to": 3, "currentPage": 1, "pagesCount": 1, "pageSize": 3 } } ``` -------------------------------- ### Install Dependencies and Build Project Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/step-by-step/quick-start-js.md After generating the client, navigate to the output directory and run these commands to install project dependencies and build the client library. ```bash npm install npm run build ``` -------------------------------- ### Get Stocks Request Body Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/stocks/getStocks.md This is an example of the request body structure for the Get Stocks API. It includes parameters for filtering stock information. ```json { "stocksWarehouseId": 0, "hasStocks": false, "withTurnover": false, "archived": false, "offerIds": [ "string" ] } ``` -------------------------------- ### Offer Parameters Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/business-assortment/getOfferMappings.md Demonstrates how to provide multiple values for the same product parameter, such as color, when transmitting offer characteristics. ```json { "params": [ { "name": "Цвет для фильтра", "value": "Зеленый" }, { "name": "Цвет для фильтра", "value": "Желтый" } ] } ``` -------------------------------- ### Offer Parameters Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/business-assortment/getOfferMappings.md Demonstrates how to send multiple values for the same product parameter using the 'params' field. Each distinct parameter value should have a unique entry with the same 'name' and a different 'value'. ```json "params": [ { "name": "Цвет для фильтра", "value": "синий" }, { "name": "Цвет для фильтра", "value": "красный" } ] ``` -------------------------------- ### Get Orders Stats Request Body Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/stats/getOrdersStats.md This is an example of the request body for the Get Orders Stats endpoint. It allows specifying date ranges, update ranges, specific orders, and statuses. ```json { "dateFrom": "string", "dateTo": "string", "updateFrom": "string", "updateTo": "string", "orders": [ 0 ], "statuses": [ "CANCELLED_BEFORE_PROCESSING" ], "hasCis": false } ``` -------------------------------- ### Get Supply Requests Request Body Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/supply-requests/getSupplyRequests.md This is an example of the request body for the Get Supply Requests API. It allows filtering by request IDs, dates, types, subtypes, statuses, and sorting. ```json { "requestIds": [ 0 ], "requestDateFrom": "2022-12-29T18:02:01Z", "requestDateTo": "2022-12-29T18:02:01Z", "requestTypes": [ "SUPPLY" ], "requestSubtypes": [ "DEFAULT" ], "requestStatuses": [ "CREATED" ], "sorting": { "direction": "ASC", "attribute": "ID" } } ``` -------------------------------- ### Generate Goods Feedback Report Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/reports/generateGoodsFeedbackReport.md Starts the generation of a report on product reviews. You can find out the generation status and get a link to the finished report using a request to GET v2/reports/info/{reportId}. ```APIDOC ## POST /v2/reports/goods/feedback ### Description Starts the generation of a report on product reviews. ### Method POST ### Endpoint /v2/reports/goods/feedback ### Parameters #### Query Parameters - **token** (string) - Required - API Key token with 'communication' or 'all-methods' access. ### Request Example ```json { "reportTaskType": "PAID_OPINION_MODELS" } ``` ### Response #### Success Response (200) - **taskId** (string) - The ID of the report generation task. #### Response Example ```json { "taskId": "1234567890" } ``` ``` -------------------------------- ### Cabinet-level Methods Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/overview.md This example shows how to interact with cabinet-level methods, which operate on a business unit regardless of connected models. The cabinet ID is passed as a path parameter. ```APIDOC ## POST v2/businesses/{businessId}/settings ### Description This endpoint is an example of a cabinet-level method that operates on a specific business unit. It requires the `businessId` as a path parameter. ### Method POST ### Endpoint v2/businesses/{businessId}/settings ### Parameters #### Path Parameters - **businessId** (string) - Required - The unique identifier for the business cabinet. ``` -------------------------------- ### Generate Shows Boost Report Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/reports/generateShowsBoostReport.md Starts the generation of a summary report on the boost of impressions for the specified period. You can find out the generation status and get a link to the finished report using a request to GET v2/reports/info/{reportId}. ```APIDOC ## POST /v2/reports/generateShowsBoostReport ### Description Starts the generation of a summary report on the boost of impressions for the specified period. ### Method POST ### Endpoint /v2/reports/generateShowsBoostReport ### Parameters #### Query Parameters - **dateFrom** (string) - Required - The start date for the report (YYYY-MM-DD). - **dateTo** (string) - Required - The end date for the report (YYYY-MM-DD). ### Request Example ```json { "dateFrom": "2023-01-01", "dateTo": "2023-01-31" } ``` ### Response #### Success Response (200) - **reportId** (string) - The ID of the generated report. #### Response Example ```json { "reportId": "12345abcde" } ``` ``` -------------------------------- ### Store-level Methods Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/overview.md This example demonstrates a store-level method, which operates on individual shops within a business unit. It requires a `campaignId` and can be used to retrieve orders. ```APIDOC ## GET v2/campaigns/{campaignId}/orders/{orderId} ### Description This endpoint is an example of a store-level method used to retrieve a specific order within a campaign. It requires both `campaignId` and `orderId` as path parameters. ### Method GET ### Endpoint v2/campaigns/{campaignId}/orders/{orderId} ### Parameters #### Path Parameters - **campaignId** (string) - Required - The unique identifier for the store campaign. - **orderId** (string) - Required - The unique identifier for the order. ``` -------------------------------- ### Get Prices Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/prices/getPrices.md Returns a list of prices that you have set for products in any way: for example, via the API or in a catalog file. ```APIDOC ## GET /v2/campaigns/{campaignId}/offer-prices ### Description Retrieves a list of prices set for products. ### Method GET ### Endpoint https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/offer-prices ### Parameters #### Path Parameters - **campaignId** (integer) - Required - The campaign ID. #### Query Parameters - **archived** (boolean) - Optional - Filter by location in the archive. Defaults to `false`. - **limit** (integer) - Optional - The number of values per page. Minimum value is `1`. - **page_token** (string) - Optional - ID of the results page. If omitted, the first page is returned. It is recommended to transmit the value of the `nextPageToken` output parameter received during the last request. If `page_token` is set, and the request has `page` and `pageSize` parameters, they are ignored. ``` -------------------------------- ### Request Body Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/chats/getChatHistory.md The JSON body for the request, specifying the starting message ID to retrieve subsequent messages. ```json { "messageIdFrom": 0 } ``` -------------------------------- ### Generate Sales Report Method Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/overview.md This example shows how to initiate the generation of a sales report. Depending on the report type, you may need both businessId and campaignId. ```http POST v2/reports/shows-sales/generate ``` -------------------------------- ### Generate Goods Movement Report Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/reports/generateGoodsMovementReport.md Starts the generation of a report on the movement of goods. This method is available for the FBY model. You can find out the generation status and get a link to the finished report using the GET v2/reports/info/{reportId} request. ```APIDOC ## POST /v2/reports/goods/generate ### Description Starts the generation of a report on the movement of goods. ### Method POST ### Endpoint /v2/reports/goods/generate ### Parameters #### Query Parameters - **report_type** (string) - Required - Specifies the type of report to generate. Possible values: `movement_by_sku`, `movement_by_type`. ### Request Example ```json { "report_type": "movement_by_sku" } ``` ### Response #### Success Response (200) - **report_id** (string) - The unique identifier for the generated report. #### Response Example ```json { "report_id": "12345abcde" } ``` ``` -------------------------------- ### Generate Turnover Report Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/reports/generateGoodsTurnoverReport.md Starts the generation of the turnover report for the specified date. The report can be generated for the FBY model. You can check the generation status and get a link to the finished report using the GET v2/reports/info/{reportId} method. ```APIDOC ## POST /v2/reports/turnover ### Description Starts the generation of the turnover report for the specified date. ### Method POST ### Endpoint /v2/reports/turnover ### Parameters #### Query Parameters - **date** (string) - Required - The date for which the report should be generated (YYYY-MM-DD). ### Request Example ```json { "date": "2023-10-27" } ``` ### Response #### Success Response (200) - **reportId** (string) - The ID of the generated report. #### Response Example ```json { "reportId": "12345abcde" } ``` ``` -------------------------------- ### Reports Generation Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/overview.md This example shows how to initiate the generation of a sales report. Depending on the report type, `businessId` and/or `campaignId` might be required. ```APIDOC ## POST v2/reports/shows-sales/generate ### Description This endpoint initiates the generation of a sales report. Depending on the specific report, it may require `businessId` and/or `campaignId`. ### Method POST ### Endpoint v2/reports/shows-sales/generate ### Parameters #### Query Parameters - **businessId** (string) - Optional - The unique identifier for the business cabinet. - **campaignId** (string) - Optional - The unique identifier for the store campaign. ``` -------------------------------- ### Get Chats Request Body Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/chats/getChats.md This JSON body can be used to filter the chats you want to retrieve. You can specify order IDs, contexts, types, and statuses. ```json { "orderIds": [ 0 ], "contexts": [ { "type": "ORDER", "id": 0 } ], "types": [ "CHAT" ], "statuses": [ "NEW" ] } ``` -------------------------------- ### Get Goods Statistics Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/assortment/getGoodsStats.md Returns a detailed report on the products that you have placed on the Market. You can use the report to find out, for example, about stock balances, storage conditions for your goods, and so on. ```APIDOC ## POST /v2/campaigns/{campaignId}/stats/skus ### Description Returns a detailed report on the products that you have placed on the Market. You can use the report to find out, for example, about stock balances, storage conditions for your goods, and so on. ### Method POST ### Endpoint https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/stats/skus ### Parameters #### Path Parameters - **campaignId** (integer) - Required - The campaign ID. You can find it using a query GET v2/campaigns or find it in the seller's office on the Market. #### Request Body - **shopSkus** (string[]) - Required - A list of your SKU IDs. Your SKU is the product identifier in your system. Each product must have its own SKU. An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before. ### Request Example { "shopSkus": [ "string" ] } ``` -------------------------------- ### Example: Campaign Resource Path Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/concepts/method-call.md Illustrates how to specify a path parameter, such as a campaign ID, within the resource URL for versioned API requests. ```http https://api.partner.market.yandex.ru/campaigns/{campaignId} ``` -------------------------------- ### Generate Sales Boost Consolidated Report Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/reports/generateBoostConsolidatedReport.md Starts the generation of a summary report on the sales boost for the specified period. The report contains information on all campaigns created both through the API and in the dashboard. You can find out the generation status and get a link to the finished report using a request to GET v2/reports/info/{reportId}. ```APIDOC ## POST /v2/reports/business/boost/generate ### Description Starts the generation of a summary report on the sales boost for the specified period. The report contains information on all campaigns created both through the API and in the dashboard. ### Method POST ### Endpoint /v2/reports/business/boost/generate ### Parameters #### Query Parameters - **dateFrom** (string) - Required - The start date for the report in YYYY-MM-DD format. - **dateTo** (string) - Required - The end date for the report in YYYY-MM-DD format. ### Request Body This endpoint does not require a request body. ### Response #### Success Response (200) - **reportId** (string) - The ID of the generated report. This ID can be used to retrieve the report status and link. #### Response Example ```json { "reportId": "12345abcde" } ``` ### Error Handling - **400 Bad Request**: Invalid date format or parameters. - **403 Forbidden**: Insufficient permissions to access this method. - **429 Too Many Requests**: Rate limit exceeded. ``` -------------------------------- ### Generate Orders Report Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/reports/generateUnitedOrdersReport.md Starts the generation of a report on orders for a specified period. The generation status and a link to the finished report can be obtained using the GET v2/reports/info/{reportId} request. ```APIDOC ## POST /v2/reports/orders ### Description Starts the generation of a report on orders for a specified period. ### Method POST ### Endpoint /v2/reports/orders ### Parameters #### Query Parameters - **dateFrom** (string) - Required - The start date for the report period (YYYY-MM-DD). - **dateTo** (string) - Required - The end date for the report period (YYYY-MM-DD). ### Request Example ```json { "dateFrom": "2023-01-01", "dateTo": "2023-01-31" } ``` ### Response #### Success Response (200) - **reportId** (string) - The ID of the generated report. #### Response Example ```json { "reportId": "12345abcde" } ``` ``` -------------------------------- ### Get Report Information Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/reports/getReportInfo.md Returns the generation status of the specified report or document and, if it is ready, a download link. To use this request, you first need to start generating a report or document. ```APIDOC ## Get Report Information ### Description Returns the generation status of the specified report or document and, if it is ready, a download link. ### Method GET ### Endpoint /reports/{report_id} ### Parameters #### Path Parameters - **report_id** (string) - Required - The unique identifier of the report or document. ### Response #### Success Response (200) - **status** (string) - The current status of the report generation (e.g., "PROCESSING", "READY", "FAILED"). - **download_link** (string) - The URL to download the report if the status is "READY". #### Response Example ```json { "status": "READY", "download_link": "https://example.com/path/to/your/report.csv" } ``` ``` -------------------------------- ### Generate Jewelry Fiscal Report Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/reports/generateJewelryFiscalReport.md Starts generating a report on jewelry orders. The report generation status and a link to the finished report can be obtained using the GET v2/reports/info/{reportId} request. ```APIDOC ## POST /v2/reports/generateJewelryFiscalReport ### Description Generates a report on jewelry orders. The status and link to the report can be retrieved using the `GET /v2/reports/info/{reportId}` endpoint. ### Method POST ### Endpoint /v2/reports/generateJewelryFiscalReport ### Parameters #### Query Parameters - **fields** (string) - Optional - Specifies the fields to include in the response. ### Response #### Success Response (200) - **reportId** (string) - The ID of the generated report. #### Response Example ```json { "reportId": "12345e8a-67b4-4b1a-8f1e-3a7b9c0d1e2f" } ``` ``` -------------------------------- ### Example: Query Parameter for Reports Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/concepts/method-call.md Shows how to append query parameters to a resource URL to refine requests, like specifying the format for a reports generation. ```http https://api.partner.market.yandex.ru/reports/shows-sales/generate?format=CSV ``` -------------------------------- ### Get Return Response Body Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/orders/getReturn.md This JSON structure represents a successful response (200 OK) containing detailed information about a return, including its status, dates, amounts, and item specifics. ```json { "status": "OK", "result": { "id": 0, "orderId": 0, "creationDate": "2020-02-02T14:30:30+03:00", "updateDate": "2020-02-02T14:30:30+03:00", "refundStatus": "STARTED_BY_USER", "logisticPickupPoint": { "id": 0, "name": "string", "address": { "country": "Россия", "city": "Москва", "street": "Стрелецкая улица", "house": "9к2", "postcode": 123518 }, "instruction": "string", "type": "WAREHOUSE", "logisticPartnerId": 0 }, "pickupTillDate": "2020-02-02T14:30:30+03:00", "shipmentRecipientType": "SHOP", "shipmentStatus": "CREATED", "refundAmount": 0, "amount": { "value": 0, "currencyId": "RUR" }, "items": [ { "marketSku": 0, "shopSku": "string", "count": 0, "decisions": [ { "returnItemId": 0, "count": 0, "comment": "string", "reasonType": "BAD_QUALITY", "subreasonType": "USER_DID_NOT_LIKE", "decisionType": "FAST_REFUND_MONEY", "refundAmount": 0, "amount": { "value": 0, "currencyId": "RUR" }, "partnerCompensation": 0, "partnerCompensationAmount": { "value": 0, "currencyId": "RUR" }, "images": [ "string" ] } ], "instances": [ { "stockType": "FIT", "status": "CREATED", "cis": "string", "imei": "string" } ], "tracks": [ { "trackCode": "string" } ] } ], "returnType": "UNREDEEMED", "fastReturn": false } } ``` -------------------------------- ### GetOfferDTO Request Body Example Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/business-assortment/getOfferMappings.md This is an example of the JSON body that can be sent with a request to the GetOfferDTO endpoint, specifying criteria for retrieving offer mappings. ```json { "offerIds": [ "string" ], "cardStatuses": [ "HAS_CARD_CAN_NOT_UPDATE" ], "categoryIds": [ 0 ], "vendorNames": [ "string" ], "tags": [ "string" ], "archived": false } ``` -------------------------------- ### Generate Mass Order Labels Report Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/orders/generateMassOrderLabelsReport.md Starts the generation of a PDF file with shortcuts for transferred orders. The generation status and a link to the finished file can be obtained using the GET v2/reports/info/{reportId} request. ```APIDOC ## POST /v2/orders/generateMassOrderLabelsReport ### Description Starts the generation of a PDF file with shortcuts for transferred orders. Details about why they are needed and what they look like are described in the Help of the Market for sellers. You can find out the generation status and get a link to the finished file using a request. GET v2/reports/info/{reportId}. ### Method POST ### Endpoint /v2/orders/generateMassOrderLabelsReport ### Parameters #### Query Parameters - **orderIds** (array of integer) - Required - List of order IDs for which labels need to be generated. ### Request Example ```json { "orderIds": [12345, 67890] } ``` ### Response #### Success Response (200) - **reportId** (string) - The ID of the generated report, which can be used to track its status and retrieve the download link. #### Response Example ```json { "reportId": "a1b2c3d4-e5f6-7890-1234-567890abcdef" } ``` ``` -------------------------------- ### Generate Shelfs Statistics Report Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/reports/generateShelfsStatisticsReport.md Starts the generation of a summary report on shelves. The report contains advertising blocks with banners or videos and a set of products. After generation, the status and a link to the report can be obtained using the GET v2/reports/info/{reportId} endpoint. ```APIDOC ## POST /v2/reports/shelfs/statistics ### Description Starts the generation of a summary report on shelves. ### Method POST ### Endpoint /v2/reports/shelfs/statistics ### Parameters #### Query Parameters - **date_from** (string) - Required - The start date for the report in YYYY-MM-DD format. - **date_to** (string) - Required - The end date for the report in YYYY-MM-DD format. - **use_processing_date** (boolean) - Optional - If true, the report will be generated based on the processing date instead of the event date. ### Response #### Success Response (200) - **reportId** (string) - The ID of the generated report. #### Response Example { "reportId": "12345-abcdef-67890-ghijkl" } ``` -------------------------------- ### Set Bids for Business Source: https://github.com/dragonsigh/yandex-market-api-docs/blob/master/reference/bids/putBidsForBusiness.md Launches a sales boost by creating and activating a campaign, adding products, and assigning bids. This method can be used to initially set up a campaign or to update bids for existing products. If a product with the specified SKU does not exist, it will be ignored but automatically added if it appears in the catalog later. The API always operates on a single, highest-priority campaign created via the API. ```APIDOC ## PUT /bids/for/business ### Description Sets bids for products to enable a sales boost and create or update a campaign. ### Method PUT ### Endpoint /v2/campaigns/{campaignId}/bids/for/business ### Parameters #### Request Body - **bids** (array[object]) - Required - A list of bids for products. - **offerId** (string) - Required - The SKU of the product. - **bid** (number) - Required - The bid amount for the product. Set to 0 to stop promotion of individual products. ### Request Example ```json { "bids": [ { "offerId": "SKU123", "bid": 100 }, { "offerId": "SKU456", "bid": 0 } ] } ``` ### Response #### Success Response (200 OK) Returns an empty response body upon successful execution. #### Response Example ```json {} ``` ### Rate Limiting 1,000 requests per minute. ```