### Install OpenAPI Generator with Scoop Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/ymarket/README.en.md Install the OpenAPI generator command-line interface using Scoop on Windows. This is another alternative installation method. ```bash scoop install openapi-generator-cli ``` -------------------------------- ### Pagination Request Example Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/product_cards/POST__content_v2_cards_error_list.md Use this JSON structure for the initial request to start paginating through error lists. Set the limit for the number of batches per request. ```json { "cursor": { "limit": 100 }, "order": { "ascending": true } } ``` -------------------------------- ### Install OpenAPI Generator with Homebrew Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/ymarket/README.en.md Install the OpenAPI generator command-line interface using Homebrew on macOS. This is an alternative installation method. ```bash brew install openapi-generator ``` -------------------------------- ### Install OpenAPI Generator CLI with npm Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/ymarket/README.en.md Install the OpenAPI generator command-line interface globally using npm. This is a prerequisite for generating API client code. ```bash npm install @openapitools/openapi-generator-cli -g ``` -------------------------------- ### Launch Campaign Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/promotion/campaigns_management/index.md Starts or launches a specified campaign. ```APIDOC ## GET /adv/v0/start ### Description Starts or launches a specified campaign. ### Method GET ### Endpoint /adv/v0/start ``` -------------------------------- ### Get Products with Prices Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/prices_and_discounts/index.md Retrieve a list of products with their associated prices. ```APIDOC ## GET /api/v2/list/goods/filter ### Description Retrieves a list of products with their associated prices. ### Method GET ### Endpoint /api/v2/list/goods/filter ``` -------------------------------- ### Get Report Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/reports/returns_and_product_movement_report/index.md Retrieves the Returns and Product Movement Report. ```APIDOC ## GET /api/v1/analytics/goods-return ### Description Retrieves the Returns and Product Movement Report. ### Method GET ### Endpoint /api/v1/analytics/goods-return ``` -------------------------------- ### GET /api/v1/analytics/antifraud-details Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/reports/retention_reports/GET__api_v1_analytics_antifraud_details.md Returns a report with self-purchase deductions. The report is generated weekly and can also include all data starting from August 2023. ```APIDOC ## GET /api/v1/analytics/antifraud-details ### Description Returns report with self-purchase deductions. The report is generated on Wednesdays at 7:00 UTC+4 and contains weekly data. Also you can get all data starting from August 2023. ### Method GET ### Endpoint `https://seller-analytics-api.wildberries.ru/api/v1/analytics/antifraud-details` ### Parameters #### Query Parameters - **date** (string) - Optional - Date from report period, `YYYY-MM-DD`, for example `2023-12-01`. To get all data from August 2023 do not use this parameter. *Example: `2023-12-01`* ### Responses #### Success Response (200) - **detail** (string) - Error details - **origin** (string) - WB internal service ID - **requestId** (string) - Unique request ID - **title** (string) - Error title #### Error Response (400) - **detail** (string) - Error details - **origin** (string) - WB internal service ID - **requestId** (string) - Unique request ID - **title** (string) - Error title ``` -------------------------------- ### Set Prices and Discounts Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/prices_and_discounts/index.md Upload a task to set prices and discounts for products. ```APIDOC ## POST /api/v2/upload/task ### Description Sets prices and discounts for products. ### Method POST ### Endpoint /api/v2/upload/task ``` -------------------------------- ### Get Brand Share Report Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/reports/share_of_brand_in_sales/GET__api_v1_analytics_brand_share.md Retrieves a report on the brand's share in sales for a given category and date range. The data can be fetched for periods up to 365 days, starting from November 1, 2022. ```APIDOC ## GET /api/v1/analytics/brand-share ### Description Returns a report on the brand's share in sales. Data can be obtained starting from 1 November 2022, for up to 365 days. ### Method GET ### Endpoint https://seller-analytics-api.wildberries.ru/api/v1/analytics/brand-share ### Parameters #### Query Parameters - **parentId** (integer) - Required - Parent category ID *Example: `1`* - **brand** (string) - Required - Brand *Example: `H%26M`* - **dateFrom** (string) - Required - Report period start, `YYYY-MM-DD` *Example: `2025-02-28`* - **dateTo** (string) - Required - Report period end, `YYYY-MM-DD` *Example: `2025-03-21`* ### Responses #### Success Response (200) (No specific fields documented for success response) #### Error Response (400) - **detail** (string) - Error details - **origin** (string) - WB internal service ID - **requestId** (string) - Unique request ID - **title** (string) - Error title #### Error Response (401) Unauthorized #### Error Response (402) Payment Required #### Error Response (429) Too Many Requests ``` -------------------------------- ### List WB Product Cards (Wildberries) Source: https://context7.com/neteraf0/ru-marketplaces-api-docs/llms.txt Retrieves a paginated list of created product cards. Use cursor-based pagination for more than 100 cards. Rate limit is 100 requests per minute. ```bash curl -X POST \ -H "Authorization: Bearer YOUR_WB_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"orders": [13833711]}' \ "https://marketplace-api.wildberries.ru/api/v3/orders/stickers?type=zplv&width=58&height=40" ``` -------------------------------- ### Get Parent Categories of Brand Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/reports/share_of_brand_in_sales/GET__api_v1_analytics_brand_share_parent_subjects.md Retrieves the parent categories for a given brand. Data can be fetched for a period of up to 365 days, starting from November 1, 2022. Request limits are in place per seller account. ```APIDOC ## GET /api/v1/analytics/brand-share/parent-subjects ### Description Returns parent categories of the brand. Data can be obtained starting from 1 November 2022, for up to 365 days. ### Method GET ### Endpoint https://seller-analytics-api.wildberries.ru/api/v1/analytics/brand-share/parent-subjects ### Parameters #### Query Parameters - **locale** (string) - Optional - Language of the response field `parentName`: `ru` (Russian), `en` (English), `zh` (Chinese). Example: `ru` - **brand** (string) - Required - Brand. Example: `H%26M` - **dateFrom** (string) - Required - Report period start, `YYYY-MM-DD`. Example: `2025-02-28` - **dateTo** (string) - Required - Report period end, `YYYY-MM-DD`. Example: `2025-03-21` ### Responses #### Success Response (200) OK - **detail** (string) - Error details - **origin** (string) - WB internal service ID - **requestId** (string) - Unique request ID - **title** (string) - Error title #### Error Responses - **400** Bad request - **401** Unauthorized - **402** Payment Required - **429** Too Many Requests ``` -------------------------------- ### Create a Single Product Card Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/creating_product_cards/POST__content_v2_cards_upload.md Use this example to create an individual product card. Ensure all required fields, including subjectID and variant details, are correctly populated. ```json { "subjectID": 1234, "variants": [ { "vendorCode": "ABC-123", "title": "Example Product Title", "description": "Detailed product description.", "characteristics": [ { "name": "Color", "value": "Red" }, { "name": "Material", "value": "Cotton" } ], "dimensions": { "width": 10, "height": 20, "length": 30 }, "weight": { "weightUnit": "kg", "weightValue": 1 } } ] } ``` -------------------------------- ### Create Merged Product Cards Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/creating_product_cards/POST__content_v2_cards_upload.md This example demonstrates how to create merged product cards. Multiple variants with the same `vendorCode` can be grouped together. ```json { "subjectID": 1234, "variants": [ { "vendorCode": "ABC-123", "title": "Product A", "characteristics": [ { "name": "Color", "value": "Red" } ] }, { "vendorCode": "ABC-123", "title": "Product B", "characteristics": [ { "name": "Color", "value": "Blue" } ] } ] } ``` -------------------------------- ### Get Unanswered Questions Count Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/user-communication/questions/GET__api_v1_questions_count_unanswered.md The method allows you to get the number of unanswered questions for today and for all time. ```APIDOC ## GET /api/v1/questions/count-unanswered ### Description Retrieves the count of unanswered questions for today and for all time. ### Method GET ### Endpoint /api/v1/questions/count-unanswered ### Responses #### Success Response (200) - **data** (object) - Contains question count data. - **error** (boolean) - Indicates if an error occurred. - **errorText** (string) - Description of the error, if any. - **additionalErrors** (array) - Additional error details. #### Error Response (401) Unauthorized #### Error Response (402) Payment Required #### Error Response (403) Access denied. - **data** (object) - Contains error details. - **error** (boolean) - Error flag. - **errorText** (string) - Description of the error. - **additionalErrors** (array) - Additional error details. - **requestId** (string) - Unique identifier for the request. #### Error Response (429) Too Many Requests ``` -------------------------------- ### Launch Campaign Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/promotion/campaigns_management/GET__adv_v0_start.md Initiates a campaign that is either ready to launch or paused. Ensure sufficient budget before execution. ```APIDOC ## GET /adv/v0/start ### Description This method allows to run campaigns that are in statuses `4` — ready to launch or `11` — paused campaign. To run a campaign, check its budget. If the budget is insufficient, replenish it. Request limit per one seller's account: | Period | Limit | Interval | Burst | | --- | --- | --- | --- | | 1 s | 5 requests | 200 ms | 5 requests | ### Method GET ### Endpoint `https://advert-api.wildberries.ru/adv/v0/start` ### Parameters #### Query Parameters - **id** (integer) - Required - Campaign ID *Example: `1234`* ### Responses #### Success Response (200) No specific fields mentioned for success. #### Error Response (400) - **error** (string) - Description of the error (e.g., IncorrectId, AdvertNotFound, LowBudget). #### Error Response (422) - (string) - Indicates that the status could not be changed, likely due to the campaign not being in a suitable state for the requested action. #### Error Response (401) Unauthorized. #### Error Response (429) Too Many Requests. ``` -------------------------------- ### Create a Tag Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/tags/index.md Creates a new product tag. ```APIDOC ## POST /content/v2/tag ### Description Creates a new product tag. ### Method POST ### Endpoint /content/v2/tag ``` -------------------------------- ### GET /content/v2/directory/colors Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/categories__subjects__and_characteristics/GET__content_v2_directory_colors.md Fetches a list of available colors. You can specify a locale to get color names in different languages. ```APIDOC ## GET /content/v2/directory/colors ### Description Provides values of color characteristic. ### Method GET ### Endpoint /content/v2/directory/colors ### Parameters #### Query Parameters - **locale** (string) - Optional - Language for response of the `subjectName` and `name` fields: - `ru` — Russian - `en` — English - `zh` — Chinese Not used in the sandbox *Example: `en`* ### Responses #### Success Response (200) - **data** () - - **error** (boolean) - Error flag - **errorText** (string) - Error description - **additionalErrors** (string) - Additional errors #### Error Response (400) - **data** (object) - Error data - **error** (boolean) - Error flag - **errorText** (string) - Error text - **additionalErrors** (object) - Additional errors #### Error Response (403) - **data** (object) - Error data - **error** (boolean) - Error flag - **errorText** (string) - Error text - **additionalErrors** (string) - Additional errors ``` -------------------------------- ### Get Passes Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/orders-fbs/fbs_passes/GET__api_v3_passes.md Retrieves a list of all seller's passes. This endpoint is used to get information about passes associated with a seller's account. ```APIDOC ## GET /api/v3/passes ### Description Returns a list of all seller's passes. ### Method GET ### Endpoint `/api/v3/passes` ### Responses #### Success Response (200) An array of pass objects, where each object contains: - `firstName` (string) - First name of the pass holder. - `dateEnd` (string) - The expiration date of the pass. - `lastName` (string) - Last name of the pass holder. - `carModel` (string) - The model of the car associated with the pass. - `carNumber` (string) - The license plate number of the car. - `officeName` (string) - The name of the office associated with the pass. - `officeAddress` (string) - The address of the office. - `officeId` (integer) - The unique identifier for the office. - `id` (integer) - The unique identifier for the pass. #### Response Example (200) ```json [ { "firstName": "Alex", "dateEnd": "2022-07-31 17:53:13+00:00", "lastName": "Petrov", "carModel": "Lamborghini", "carNumber": "A456BC123", "officeName": "Koledino", "officeAddress": "Kosmonavtov 10А", "officeId": 15, "id": 1 } ] ``` #### Error Responses - **401** Unauthorized - **402** Payment Required - **403** Forbidden - **429** Too Many Requests ``` -------------------------------- ### Create a Group of Individual Product Cards Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/creating_product_cards/POST__content_v2_cards_upload.md This example shows how to create a group of individual product cards within a single request. Each object in the `variants` array represents a distinct product. ```json { "subjectID": 1234, "variants": [ { "vendorCode": "IND-001", "title": "Individual Product 1", "characteristics": [ { "name": "Size", "value": "M" } ] }, { "vendorCode": "IND-002", "title": "Individual Product 2", "characteristics": [ { "name": "Size", "value": "L" } ] } ] } ``` -------------------------------- ### GET /api/v2/list/goods/filter Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/prices_and_discounts/GET__api_v2_list_goods_filter.md Fetches product data. Can be used to get a single product by its article number (`filterNmID`) or to paginate through all products using `limit` and `offset`. ```APIDOC ## GET /api/v2/list/goods/filter ### Description Returns product data. You can specify only one article in one request. To get data for all products, do not set the article, set `limit=1000`, and use the `offset` field to set the data offset. The offset should be calculated using the formula: `offset` plus `limit` from the previous request. Repeat the request until you receive a response with an empty array. ### Method GET ### Endpoint `/api/v2/list/goods/filter` ### Parameters #### Query Parameters - **limit** (integer) - Required - Number of elements per page (pagination) *Example: `10`* - **offset** (integer) - Optional - How many results to skip. For example, with value `10`, the response will start with the 11 element - **filterNmID** (integer) - Optional - WB article for search *Example: `44589768676`* ### Responses #### Success Response (200) OK - **data** (object) - Error data - **error** (boolean) - Error flag - **errorText** (string) - Error text #### Error Response (400) Bad request - **data** (object) - Error data - **error** (boolean) - Error flag - **errorText** (string) - Error text #### Error Response (403) Access denied - **data** (object) - Error data - **error** (boolean) - Error flag - **errorText** (string) - Error text ``` -------------------------------- ### POST /content/v2/cards/upload Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/creating_product_cards/POST__content_v2_cards_upload.md Creates product cards. You can specify product description and characteristics. Product cards are created asynchronously and may take up to 30 minutes to synchronize. ```APIDOC ## POST /content/v2/cards/upload ### Description Creates product cards. You can specify product description and characteristics. ### Method POST ### Endpoint https://content-api.wildberries.ru/content/v2/cards/upload ### Parameters #### Request Body Content-Type: `application/json` *Array of:* | Field | Type | Req | Description | |-------|------|-----|-------------| | `subjectID` | integer | ✓ | Subject ID | | `variants` | array | ✓ | Merged product cards. To create individual card, pass only one object. | ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) | Field | Type | Req | Description | |-------|------|-----|-------------| | `data` | object | | Response data | | `error` | boolean | | Error flag | | `errorText` | string | | Error description | | `additionalErrors` | | | Any additional errors | #### Response Example ```json { "example": "response body" } ``` ### Error Handling - **400** Bad request: Invalid request format, missing required characteristics, non-unique characteristics, or category does not exist. - **401** Unauthorized - **402** Payment Required - **413** The request body size exceeds the given limit. - **429** Too Many Requests ``` -------------------------------- ### jQuery AJAX Call Example Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/bitrix24/tutorials/telephony/index.md An example of using jQuery AJAX to send data to a server-side script. This snippet is part of a larger HTML structure for handling user interactions. ```javascript auth = BX24.getAuth(); $.ajax({ url: "", data: { action: 'drop', user1: $( "#user1" ).val(), user2: $( "#user2" ).val(), DOMAIN: auth['domain'] }, success: function( result ) { $( "#debug" ).html( result ); } }); }); ``` -------------------------------- ### POST /api/v2/upload/task Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/prices_and_discounts/POST__api_v2_upload_task.md Sets prices and discounts for products. Includes details on request limits and error handling. ```APIDOC ## POST /api/v2/upload/task ### Description Sets prices and discounts for products. ### Method POST ### Endpoint /api/v2/upload/task ### Request Body (No specific schema provided in the source) ### Responses #### Success Response (200) OK #### Error Responses - **400** Bad request: Provides detailed error information including `data`, `error`, and `errorText` fields. Specific error examples include `UploadLimitExceeded`, `DuplicateItemNos`, `TheSpecifiedPricesAndDiscountsAreAlreadySet`, `InvalidDataFormat`, `PriceShouldBeAWholeNumber`, `InvalidPriceValue`, `InvalidDiscountValue`, `InvalidItemNo`, `PriceAndDiscountNotSpecified`, `EmptyData`, and `AllItemNosAreSpecifiedIncorrectlyOrPricesAndDiscounts`. - **401** Unauthorized - **402** Payment Required - **403** Access denied: Provides detailed error information including `data`, `error`, and `errorText` fields. Example: `AccessDenied`. - **409** Error while switching currency: Provides detailed error information including `data`, `error`, and `errorText` fields. Example: `CurrencySwitchingError`. - **422** Unexpected result: Provides detailed error information including `data`, `error`, and `errorText` fields. Example: `UnexpectedResult`. - **429** Too Many Requests ``` -------------------------------- ### API Response Time Information Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/bitrix24/api-reference/crm/universal/product-rows/crm-item-productrow-fields.md This JSON object contains timing details for an API request, including start and finish times, duration, processing time, and formatted date-time strings for the start and finish. ```json { "time":{ "start":1716812240.400023, "finish":1716812242.151703, "duration":1.7516798973083496, "processing":0.09682416915893555, "date_start":"2024-05-27T15:17:20+03:00", "date_finish":"2024-05-27T15:17:22+03:00" } } ``` -------------------------------- ### Create or Update Ozon Products Source: https://context7.com/neteraf0/ru-marketplaces-api-docs/llms.txt Import or update product listings on Ozon. Each request can handle up to 100 products and requires comprehensive data including attributes, dimensions, and pricing. Check daily quotas using the `/v4/product/info/limit` endpoint. ```bash curl -X POST \ -H "Client-Id: YOUR_CLIENT_ID" \ -H "Api-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "items": [ { "offer_id": "143210608", "name": "Protective Film Kit for X3 NFC", "description_category_id": 17028922, "barcode": "112772873170", "price": "1000", "old_price": "1100", "currency_code": "RUB", "vat": "0.1", "weight": 100, "weight_unit": "g", "depth": 10, "width": 150, "height": 250, "dimension_unit": "mm", "images": ["https://cdn.example.com/img/product1.jpg"], "primary_image": "https://cdn.example.com/img/product1_main.jpg", "attributes": [ { "id": 85, "complex_id": 0, "values": [{ "dictionary_value_id": 5060050, "value": "Samsung" }] }, { "id": 9048, "complex_id": 0, "values": [{ "value": "Protective Film Kit for X3 NFC" }] } ] } ] }' \ "https://api-seller.ozon.ru/v3/product/import" ``` -------------------------------- ### Get Brands Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/categories__subjects__and_characteristics/index.md Retrieves a list of brands. ```APIDOC ## GET /api/content/v1/brands ### Description Retrieves a list of brands. ### Method GET ### Endpoint /api/content/v1/brands ### Response #### Success Response (200) - **brands** (array) - List of brands. ``` -------------------------------- ### Get Product Sizes with Prices Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/prices_and_discounts/index.md Retrieve product sizes along with their prices. ```APIDOC ## GET /api/v2/list/goods/size/nm ### Description Retrieves product sizes along with their prices. ### Method GET ### Endpoint /api/v2/list/goods/size/nm ``` -------------------------------- ### Get All Subjects Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/categories__subjects__and_characteristics/index.md Retrieves a list of all subjects. ```APIDOC ## GET /content/v2/object/all ### Description Retrieves a list of all subjects. ### Method GET ### Endpoint /content/v2/object/all ### Response #### Success Response (200) - **subjects** (array) - List of subjects. ``` -------------------------------- ### Get Warehouses Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/seller_warehouses/index.md Retrieves a list of seller warehouses. ```APIDOC ## GET /api/v3/warehouses ### Description Retrieves a list of seller warehouses. ### Method GET ### Endpoint /api/v3/warehouses ``` -------------------------------- ### Get Offices Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/seller_warehouses/index.md Retrieves a list of available offices. ```APIDOC ## GET /api/v3/offices ### Description Retrieves a list of available offices. ### Method GET ### Endpoint /api/v3/offices ``` -------------------------------- ### Get Ozon Product Info by IDs Source: https://context7.com/neteraf0/ru-marketplaces-api-docs/llms.txt Retrieve detailed information for up to 1000 Ozon products per request. You can query using `offer_id`, `product_id`, or `sku`, but only one identifier type is allowed per request. ```bash curl -X POST \ -H "Client-Id: YOUR_CLIENT_ID" \ -H "Api-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "offer_id": ["143210608", "SKU-002", "SKU-003"] }' \ "https://api-seller.ozon.ru/v3/product/info/list" ``` ```bash curl -X POST \ -H "Client-Id: YOUR_CLIENT_ID" \ -H "Api-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "product_id": [180550366, 180550367] }' \ "https://api-seller.ozon.ru/v3/product/info/list" ``` -------------------------------- ### Get Seasons Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/categories__subjects__and_characteristics/index.md Retrieves a list of available seasons. ```APIDOC ## GET /content/v2/directory/seasons ### Description Retrieves a list of available seasons. ### Method GET ### Endpoint /content/v2/directory/seasons ### Response #### Success Response (200) - **seasons** (array) - List of seasons. ``` -------------------------------- ### Get Genders Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/categories__subjects__and_characteristics/index.md Retrieves a list of available genders. ```APIDOC ## GET /content/v2/directory/kinds ### Description Retrieves a list of available genders. ### Method GET ### Endpoint /content/v2/directory/kinds ### Response #### Success Response (200) - **genders** (array) - List of genders. ``` -------------------------------- ### Generate API Client with npm Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/ymarket/README.en.md Generate an API client library using the OpenAPI generator CLI with npm. Specify the OpenAPI specification file, the target language generator, and the output directory. ```bash npx @openapitools/openapi-generator-cli generate -i -g -o ``` -------------------------------- ### Create Warehouse Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/seller_warehouses/index.md Creates a new seller warehouse. ```APIDOC ## POST /api/v3/warehouses ### Description Creates a new seller warehouse. ### Method POST ### Endpoint /api/v3/warehouses ``` -------------------------------- ### Get Colors Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/categories__subjects__and_characteristics/index.md Retrieves a list of available colors. ```APIDOC ## GET /content/v2/directory/colors ### Description Retrieves a list of available colors. ### Method GET ### Endpoint /content/v2/directory/colors ### Response #### Success Response (200) - **colors** (array) - List of colors. ``` -------------------------------- ### Get Wildberries Product Cards (Paginated) Source: https://context7.com/neteraf0/ru-marketplaces-api-docs/llms.txt Fetch product cards with options for sorting and filtering. Use the cursor from the response to retrieve subsequent pages until all items are fetched. ```bash curl -X POST \ -H "Authorization: Bearer YOUR_WB_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "settings": { "sort": { "ascending": true }, "cursor": { "limit": 100 }, "filter": { "withPhoto": -1 } } }' \ "https://content-api.wildberries.ru/content/v2/get/cards/list?locale=en" ``` ```bash curl -X POST \ -H "Authorization: Bearer YOUR_WB_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "settings": { "sort": { "ascending": true }, "cursor": { "limit": 100, "updatedAt": "2024-01-15T10:30:00Z", "nmID": 123456789 }, "filter": { "withPhoto": -1 } } }' \ "https://content-api.wildberries.ru/content/v2/get/cards/list?locale=en" ``` -------------------------------- ### Get Campaigns List Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/promotion/campaigns/index.md Retrieves a list of campaigns. ```APIDOC ## GET /adv/v1/promotion/count ### Description Retrieves a count of campaigns. ### Method GET ### Endpoint /adv/v1/promotion/count ``` -------------------------------- ### Get Passes Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/orders-fbs/fbs_passes/index.md Retrieves a list of FBS passes. ```APIDOC ## GET /api/v3/passes ### Description Get Passes ### Method GET ### Endpoint /api/v3/passes ``` -------------------------------- ### POST /adv/v1/budget/deposit Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/promotion/finances/POST__adv_v1_budget_deposit.md This endpoint allows you to top up the campaign budget. You can specify the amount, use promo bonuses, and choose the top-up source. The `return` parameter controls whether the updated budget size is returned. ```APIDOC ## POST /adv/v1/budget/deposit ### Description This method tops up the campaign budget. To launch the campaign after topping up the budget, use the Launch campaign method. ### Method POST ### Endpoint `https://advert-api.wildberries.ru/adv/v1/budget/deposit` ### Parameters #### Query Parameters - **id** (integer) - Required - Campaign ID *Example: `1234567`* ### Request Body Content-Type: `application/json` - **sum** (integer) - Optional - Budget top-up amount *Example: `5000`* - **cashback_sum** (integer) - Optional - Top-up budget sum paid with promo bonuses. You can top up only a certain percentage of the amount, indicated in the `percent` field of the response from the method for getting balance. Promo bonuses are only applicable to these top-up sources: - `0` — account - `1` — balance sheet *Example: `1000`* - **cashback_percent** (integer) - Optional - The percentage of the top-up amount that can be paid with promo bonuses. You need to specify the value of the `percent` field from the response for the method for getting balance. If you specified `cashback_sum`, the `cashback_percent` parameter becomes required *Example: `50`* - **type** (integer) - Optional - Type of top-up source: - `0` — Account - `1` — Balance - `3` — Bonuses *Example: `1`* - **return** (boolean) - Optional - Response return flag (`true` means updated campaign budget size will be returned in the response, `false` or empty means nothing will be returned). ### Request Example ```json { "sum": 5000, "cashback_sum": 1000, "cashback_percent": 50, "type": 1, "return": true } ``` ### Response #### Success Response (200) - **id** (integer) - Campaign ID - **budget** (integer) - Current campaign budget #### Response Example ```json { "id": 1234567, "budget": 6000 } ``` #### Error Response (400) - **error** (string) - Error message #### Error Response Examples - `DepositAmountMultiple50` - `MinimumDepositAmountIs500` - `IncorrectType` #### Other Responses - **401** Unauthorized - **429** Too Many Requests ``` -------------------------------- ### Get Document Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/financial-reports-and-accounting/documents/index.md Downloads a specific document by its identifier. ```APIDOC ## GET /api/v1/documents/download ### Description Downloads a specific document. ### Method GET ### Endpoint /api/v1/documents/download ``` -------------------------------- ### Set Size Prices Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/prices_and_discounts/index.md Upload a task to set size-specific prices for products. ```APIDOC ## POST /api/v2/upload/task/size ### Description Sets size-specific prices for products. ### Method POST ### Endpoint /api/v2/upload/task/size ``` -------------------------------- ### POST /api/advert/v1/bids/min Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/promotion/campaigns_creation/POST__api_advert_v1_bids_min.md Sets the minimum bids for product cards in kopecks. ```APIDOC ## POST /api/advert/v1/bids/min ### Description Method allows minimum bids for product cards in kopecks depending on the payment type and placements. ### Method POST ### Endpoint `/api/advert/v1/bids/min` ### Request Body Content-Type: `application/json` - **advert_id** (integer) - Required - Campaign ID - **nm_ids** (array) - Required - WB articles list - **payment_type** (string) - Required - Payment type: `cpm` (per mille) or `cpc` (per click) - **placement_types** (array) - Required - Placements: `search`, `recommendation`, or `combined` ### Request Example ```json { "advert_id": 12345, "nm_ids": [ 987654, 543210 ], "payment_type": "cpc", "placement_types": [ "search", "recommendation" ] } ``` ### Response #### Success Response (200) - **bids** (array) - Required - List of product cards with bids #### Response Example ```json { "bids": [ { "nm_id": 987654, "bid": 100000 }, { "nm_id": 543210, "bid": 120000 } ] } ``` #### Error Response (400) - **detail** (string) - Required - Error details - **origin** (string) - Required - WB internal service ID - **request_id** (string) - Required - Unique request ID - **status** (integer) - Required - HTTP Status Code - **title** (string) - Required - Error title ``` -------------------------------- ### Get Inventory Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/seller_warehouses_inventory/index.md Retrieves the inventory stock for a specific warehouse. ```APIDOC ## POST /api/v3/stocks/{warehouseId} ### Description Retrieves the inventory stock for a specific warehouse. ### Method POST ### Endpoint /api/v3/stocks/{warehouseId} ### Parameters #### Path Parameters - **warehouseId** (string) - Required - The ID of the warehouse to retrieve inventory from. ``` -------------------------------- ### POST /content/v2/cards/upload/add Source: https://github.com/neteraf0/ru-marketplaces-api-docs/blob/main/wb/work-with-products/creating_product_cards/POST__content_v2_cards_upload_add.md Creates product cards by merging them with existing individual cards and groups of merged cards. The dimensions of the products can only be specified in `centimeters`, and the weight of packed products must be specified in `kilograms`. Product cards are created asynchronously. ```APIDOC ## POST /content/v2/cards/upload/add ### Description Creates product cards by merging them with existing individual cards and groups of merged cards. There can be no more than 30 cards in one group of merged product cards, respectively, you can create no more than 29 product cards in one request. The dimensions of the products can only be specified in `centimeters`, and the weight of packed products must be specified in `kilograms`. Product cards are created asynchronously. ### Method POST ### Endpoint `/content/v2/cards/upload/add` ### Request Body Content-Type: `application/json` - **imtID** (integer) - Optional - `imtID` of an individual product card or group of merged product cards to which the created cards are added - **cardsToAdd** (array) - Optional - Added product cards ### Request Example ```json { "imtID": 12345, "cardsToAdd": [ { "vendorCode": "string", "title": "string", "description": "string", "categoryID": 0, "brandID": 0, "brandName": "string", "dimensions": { "width": 0, "height": 0, "length": 0, "weight": 0 }, "barcode": "string", "article": "string", "supplierArticle": "string", "price": { "RUB": 0, "currency": "string" }, "userKey": "string" } ] } ``` ### Responses #### Success Response (200) - **data** (object) - Response data - **error** (boolean) - Error flag - **errorText** (string) - Error description - **additionalErrors** (any) - Any additional errors #### Response Example (200) ```json { "data": {}, "error": false, "errorText": "", "additionalErrors": null } ``` #### Error Response (400) - **data** (object) - Error data - **error** (boolean) - Error flag - **errorText** (string) - Error text - **additionalErrors** (object) - Additional errors #### Error Response (413) - **title** (string) - Error title - **detail** (string) - Error details - **code** (string) - Internal error code - **requestId** (string) - Unique request ID - **origin** (string) - WB internal service ID - **status** (number) - HTTP status code - **statusText** (string) - Text of the HTTP status code ```