### Support and Troubleshooting Source: https://seller.wildberries.ru/instructions/ru/ru/material/A-517_categoryid=banking&gobackoption=prevRoute Information on how to get support and resolve technical issues. ```APIDOC ## Contacting Support Service ### Description How to reach the Wildberries support service for assistance. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Seller Support ### Description Information and resources for seller support. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Technical Issues ### Description Guidance on resolving common technical issues. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Clearing Temporary Browser Files (Cache and Cookies) ### Description Instructions on how to clear browser cache and cookies to resolve issues. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Claims ### Description Information on how to file claims. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Pre-trial Settlement ### Description Information regarding the pre-trial settlement process. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Rights Holders ### Description Information relevant to rights holders. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Digital Arbitration ### Description Information about the digital arbitration process. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Wildberries Seller API Overview Source: https://seller.wildberries.ru/instructions/ru/ru/category/orders-management-with-fbw-model This section provides general information about the Wildberries Seller API, its purpose, and how to get started with integration. ```APIDOC ## What is WB API and how to work with it ### Description This section explains what the WB API is and provides guidance on how to integrate with it for various seller operations. ### Method GET ### Endpoint /api/v1/getting-started ### Parameters #### Query Parameters - **apiKey** (string) - Required - Your unique API key for authentication. ### Request Example ``` GET /api/v1/getting-started?apiKey=YOUR_API_KEY ``` ### Response #### Success Response (200) - **documentation_url** (string) - URL to the main API documentation. - **support_contact** (string) - Email address for API support. #### Response Example ```json { "documentation_url": "https://suppliers-portal.wildberries.ru/api/v2/documentation", "support_contact": "api.support@wildberries.ru" } ``` ``` -------------------------------- ### Promotional Tools API Source: https://seller.wildberries.ru/instructions/ru/ru/category/items-promotion APIs for managing product promotions, including setting up discounts, participating in campaigns, and utilizing advertising tools. ```APIDOC ## POST /api/promotions/campaigns ### Description Creates and manages promotional campaigns, including auto-actions and specific sales events. ### Method POST ### Endpoint /api/promotions/campaigns ### Parameters #### Request Body - **campaign_name** (string) - Required - Name of the campaign. - **type** (string) - Required - Type of campaign (e.g., 'auto_action', 'flash_sale'). - **settings** (object) - Required - Campaign specific settings. - **discount_depth** (number) - Optional - Depth of discount in percent. - **start_date** (string) - Optional - Campaign start date. - **end_date** (string) - Optional - Campaign end date. - **product_ids** (array) - Optional - List of product IDs to include in the campaign. ### Request Example ```json { "campaign_name": "Summer Sale 2023", "type": "auto_action", "settings": { "discount_depth": 15, "start_date": "2023-11-01", "end_date": "2023-11-15" }, "product_ids": ["P1001", "P1002"] } ``` ### Response #### Success Response (200) - **campaign_id** (string) - Unique ID for the created campaign. - **message** (string) - Confirmation message. #### Response Example ```json { "campaign_id": "CAMP001", "message": "Campaign created successfully." } ``` ``` ```APIDOC ## POST /api/promotions/wb_media ### Description Manages advertising campaigns through 'WB Media', including setting up daily or impression-based campaigns. ### Method POST ### Endpoint /api/promotions/wb_media ### Parameters #### Request Body - **campaign_details** (object) - Required - Details of the WB Media campaign. - **name** (string) - Required - Campaign name. - **type** (string) - Required - Campaign type ('daily_budget', 'impressions'). - **budget** (number) - Optional - Daily budget for the campaign. - **target_audience** (string) - Optional - Description of the target audience. ### Request Example ```json { "campaign_details": { "name": "New Product Launch Ad", "type": "impressions", "budget": 5000, "target_audience": "Young adults interested in electronics" } } ``` ### Response #### Success Response (200) - **campaign_id** (string) - Unique ID for the WB Media campaign. - **message** (string) - Confirmation message. #### Response Example ```json { "campaign_id": "WBMEDIA555", "message": "WB Media campaign setup initiated." } ``` ``` -------------------------------- ### Promotions and Discounts Source: https://seller.wildberries.ru/instructions/ru/ru/category/communication-with-customers Endpoints for managing promotions, sales, and applying discounts to products. ```APIDOC ## POST /api/promotions ### Description Creates a new promotion or sale event. ### Method POST ### Endpoint /api/promotions ### Request Body - **name** (string) - Required - The name of the promotion. - **startDate** (string) - Required - The start date of the promotion (YYYY-MM-DD). - **endDate** (string) - Required - The end date of the promotion (YYYY-MM-DD). - **discountPercentage** (number) - Optional - The percentage discount applied during the promotion. - **products** (array) - Optional - List of product IDs included in the promotion. ### Request Example ```json { "name": "Summer Sale", "startDate": "2024-07-01", "endDate": "2024-07-31", "discountPercentage": 15, "products": ["XYZ001", "ABC789"] } ``` ### Response #### Success Response (201) - **promotionId** (string) - The unique identifier for the created promotion. - **message** (string) - Confirmation message. #### Response Example ```json { "promotionId": "PROMO101", "message": "Promotion created successfully." } ``` ``` ```APIDOC ## GET /api/promotions ### Description Retrieves a list of active and upcoming promotions. ### Method GET ### Endpoint /api/promotions ### Query Parameters - **status** (string) - Optional - Filter promotions by status (e.g., 'active', 'upcoming', 'expired'). ### Response #### Success Response (200) - **promotions** (array) - List of promotion objects. - **promotionId** (string) - Unique identifier for the promotion. - **name** (string) - Name of the promotion. - **startDate** (string) - Start date. - **endDate** (string) - End date. #### Response Example ```json { "promotions": [ { "promotionId": "PROMO101", "name": "Summer Sale", "startDate": "2024-07-01", "endDate": "2024-07-31" } ] } ``` ``` -------------------------------- ### Wildberries Seller API - General Information Source: https://seller.wildberries.ru/instructions/ru/ru/subcategory/how-to-improve-item-card Overview of the Wildberries Seller API (WB API), how to work with it, and general integration procedures. ```APIDOC ## Wildberries Seller API ### Description Information on what the Wildberries Seller API (WB API) is and how to work with it for seller integrations. ### Method N/A (Informational) ### Endpoint N/A (Informational) ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Product Promotion and Marketing Source: https://seller.wildberries.ru/instructions/ru/ru/material/A-517_categoryid=banking&gobackoption=prevRoute Endpoints related to product promotion, including discounts, campaigns, and media tools. ```APIDOC ## Promotions and Discounts ### Description Information on managing promotions and discounts for your products. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Promotion Calendar ### Description Details about the promotion calendar and planning promotional activities. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Product Ranking in Promotions ### Description Understanding how products are ranked within promotional campaigns. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Auto Promotions ### Description Information on setting up and managing automatic promotions. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Wildberries Promotions ### Description General information about promotions available on the Wildberries platform. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Setting Minimum Price and Blocking in Auto Promotions ### Description How to set minimum prices and blocking rules for auto promotions. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Seller Co-financing of Installment Plans ### Description Information on how sellers can co-finance installment plans. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Adding All Suitable Products to Auto Promotion with One Button ### Description Functionality to easily add multiple products to auto promotions. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Discount Depth in Auto Promotions ### Description Understanding and managing the depth of discounts in auto promotions. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## WB Media Campaigns ### Description Information about creating and managing media campaigns. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Campaign by Days ### Description Details on setting up campaigns based on specific days. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Campaign by Impressions ### Description Details on setting up campaigns based on impressions. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## WB Promotion ### Description General information about the WB Promotion service. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## WB Promotion: Payment Models and Principles of Operation ### Description Explanation of payment models and how WB Promotion works. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Launching and Editing a Promotion Campaign ### Description Instructions for starting and modifying promotion campaigns. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Choosing a Bid for Promotion ### Description Guidance on selecting the appropriate bid for your promotion campaigns. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Budget and Payment for Promotion Campaigns ### Description Information on managing budgets and payments for promotion campaigns. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Statistics and Promotion Management ### Description Tools for tracking statistics and managing your promotion campaigns. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Brand Zone ### Description Information about the Brand Zone feature. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## WB Influence ### Description Information about the WB Influence feature. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Wibes Content Platform ### Description Information about the Wibes Content Platform. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Seller Profile Management Source: https://seller.wildberries.ru/instructions/ru/ru/material/A-517_categoryid=banking&gobackoption=prevRoute Endpoints for managing seller profiles, user roles, and account settings. ```APIDOC ## Seller Profile and User Roles ### Description Information about managing your seller profile and user roles within the Wildberries platform. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Profile Section on Seller Portal ### Description Details regarding the 'Profile' section available on the seller portal for managing account information. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Users and Permissions ### Description Management of users and their access permissions within your seller account. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Changing Seller Data ### Description Instructions on how to modify your seller information. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Changing Phone Number ### Description Specific steps for updating the phone number associated with your seller account. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Restoring Account Access ### Description Procedures for recovering access to your personal account if you lose it. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Changing Seller Data (Detailed) ### Description More comprehensive instructions on how to change your seller data. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Data Security ### Description Information on how to protect your account and personal data from fraudulent activities. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Protecting Your Account with Two-Factor Authentication ### Description Guidance on setting up and using two-factor authentication to enhance account security. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Changing Email Address ### Description Steps to update the email address associated with your seller account. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Seller Profile and Data Security ### Description Overview of security measures related to your seller profile and data. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### API Integration Source: https://seller.wildberries.ru/instructions/ru/ru/category/items-promotion Information on how to integrate with the Wildberries API using authentication tokens. ```APIDOC ## POST /api/integration/token ### Description Creates, retrieves, or revokes API access tokens for integrating external systems with the Wildberries platform. ### Method POST ### Endpoint /api/integration/token ### Parameters #### Request Body - **action** (string) - Required - Action to perform ('create', 'revoke'). - **token_id** (string) - Optional - Identifier for the token if revoking. ### Request Example ```json { "action": "create" } ``` ### Response #### Success Response (200) - **token** (string) - The generated API access token (if action is 'create'). - **message** (string) - Confirmation message. #### Response Example ```json { "token": "your_api_access_token_here", "message": "API token created successfully." } ``` ``` -------------------------------- ### Product Catalog and Pricing Source: https://seller.wildberries.ru/instructions/ru/ru/category/communication-with-customers Endpoints for managing product information, pricing, and applying discounts or promotions. ```APIDOC ## POST /api/products ### Description Adds a new product to the catalog. ### Method POST ### Endpoint /api/products ### Request Body - **name** (string) - Required - The name of the product. - **description** (string) - Optional - A detailed description of the product. - **price** (number) - Required - The base price of the product. - **category** (string) - Required - The category the product belongs to. ### Request Example ```json { "name": "Stylish T-Shirt", "description": "A comfortable and fashionable t-shirt made from premium cotton.", "price": 25.99, "category": "Apparel" } ``` ### Response #### Success Response (201) - **productId** (string) - The unique identifier for the newly created product. - **message** (string) - Confirmation message. #### Response Example ```json { "productId": "XYZ001", "message": "Product created successfully." } ``` ``` ```APIDOC ## PUT /api/products/{productId}/price ### Description Updates the price of an existing product. ### Method PUT ### Endpoint /api/products/{productId}/price ### Path Parameters - **productId** (string) - Required - The identifier of the product whose price needs updating. ### Request Body - **newPrice** (number) - Required - The new price for the product. ### Request Example ```json { "newPrice": 23.50 } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message indicating the price update. #### Response Example ```json { "message": "Product price updated successfully." } ``` ``` -------------------------------- ### Product Promotion and Advertising Source: https://seller.wildberries.ru/instructions/ru/ru/category/orders-management-with-freight-shipments APIs for managing product promotions, discounts, and advertising campaigns. ```APIDOC ## Product Promotion and Advertising Management ### Description APIs to manage product promotions, set up discounts, participate in sales events, and configure advertising campaigns. ### Method GET, POST, PUT ### Endpoint /api/v1/promotions/campaigns /api/v1/promotions/discounts /api/v1/advertising/wbmedia ### Parameters #### Path Parameters None #### Query Parameters - **campaign_id** (string) - Optional - Retrieve details for a specific campaign. - **status** (string) - Optional - Filter campaigns by status (e.g., 'active', 'ended'). #### Request Body - **campaign_details** (object) - Required for creating/updating campaigns. - **name** (string) - Required - Name of the campaign. - **start_date** (string) - Required - Campaign start date (YYYY-MM-DD). - **end_date** (string) - Required - Campaign end date (YYYY-MM-DD). - **product_ids** (array) - Required - List of product IDs included in the campaign. - **discount_percentage** (number) - Optional - Discount percentage for the campaign. ### Request Example ```json { "campaign_details": { "name": "Summer Sale 2024", "start_date": "2024-06-01", "end_date": "2024-06-30", "product_ids": ["PROD001", "PROD002"], "discount_percentage": 15 } } ``` ### Response #### Success Response (200) - **campaigns** (array) - List of active and past campaigns. - **campaign_id** (string) - ID of the created or updated campaign. - **status** (string) - Status of the campaign. #### Response Example ```json { "campaigns": [ { "campaign_id": "CAMP1234", "name": "Summer Sale 2024", "status": "ACTIVE" } ], "campaign_id": "CAMP1234" } ``` ``` -------------------------------- ### Wildberries Seller API - Token Authentication Source: https://seller.wildberries.ru/instructions/ru/ru/subcategory/how-to-improve-item-card Instructions on how to connect to the WB API using a token. ```APIDOC ## POST /api/token/connect ### Description Connect to the WB API using a token for authentication. ### Method POST ### Endpoint `/api/token/connect` ### Parameters #### Query Parameters - **token** (string) - Required - The API token for authentication. ### Request Example ```json { "token": "YOUR_API_TOKEN" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the connection. - **message** (string) - A confirmation message. #### Response Example ```json { "status": "success", "message": "Successfully connected via token." } ``` ``` -------------------------------- ### WB API Integration Source: https://seller.wildberries.ru/instructions/ru/ru/material/A-517_categoryid=banking&gobackoption=prevRoute Information on integrating with the Wildberries API, including obtaining tokens and understanding authentication methods. ```APIDOC ## WB API Integration ### Description This section details how to integrate with the Wildberries API, including obtaining necessary authentication tokens and understanding different connection methods. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Connecting to WB API via Token ### Description Instructions on how to connect to the Wildberries API using an access token. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Connecting to WB API via OAuth 2.0 ### Description Instructions on how to connect to the Wildberries API using the OAuth 2.0 protocol. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ## Managing WB API Tokens ### Description Guidance on how to create, update, or delete your WB API access tokens. ### Method N/A (Informational) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### Promotions and Discounts API Source: https://seller.wildberries.ru/instructions/ru/ru/category/problem-solutions APIs for managing promotions, discounts, and participation in sales events. ```APIDOC ## Promotions and Discounts API ### Description APIs to manage promotional campaigns, set discounts, participate in sales events, and configure auto-promotions. ### Method POST, PUT, GET ### Endpoint `/api/v1/promotions` `/api/v1/discounts` `/api/v1/auto-promotions` ### Parameters #### Path Parameters - **promotion_id** (string) - Required - The unique identifier for a promotion. #### Query Parameters - **status** (string) - Optional - Filter promotions by status (e.g., 'active', 'scheduled', 'ended'). - **product_id** (string) - Optional - Filter promotions associated with a specific product. #### Request Body - **promotion_name** (string) - Required - Name of the promotion. - **start_date** (string) - Required - Promotion start date (ISO format). - **end_date** (string) - Required - Promotion end date (ISO format). - **discount_percentage** (number) - Optional - The percentage discount. - **fixed_amount** (number) - Optional - A fixed amount discount. - **product_ids** (array) - Required - List of product IDs to include in the promotion. - **auto_promotion_rules** (object) - Optional - Rules for auto-generated promotions. ### Request Example ```json { "promotion_name": "Summer Sale 2024", "start_date": "2024-07-01T00:00:00Z", "end_date": "2024-07-31T23:59:59Z", "discount_percentage": 15, "product_ids": ["PROD111", "PROD222"] } ``` ### Response #### Success Response (200) - **promotion_id** (string) - ID of the created promotion. - **message** (string) - Confirmation message. - **discount_applied** (boolean) - Status of discount application. #### Response Example ```json { "promotion_id": "PROMO567", "message": "Promotion created successfully.", "discount_applied": true } ``` ``` -------------------------------- ### Wildberries API Integration Source: https://seller.wildberries.ru/instructions/ru/ru/category/orders-management-with-dbw-model Information on how to connect and use the Wildberries API for integration purposes. ```APIDOC ## What is WB API and how to work with it ### Description Explains the purpose and basic usage of the Wildberries API for sellers. ### Method GET ### Endpoint /api/v1/wb_api_info ## How to connect via API using a token ### Description Provides a step-by-step guide on establishing an API connection using authentication tokens. ### Method POST ### Endpoint /api/v1/auth/token ### Parameters #### Request Body - **grant_type** (string) - Required - Specifies the grant type for authentication. - **client_id** (string) - Required - Your application's client ID. - **client_secret** (string) - Required - Your application's client secret. ### Request Example ```json { "grant_type": "client_credentials", "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET" } ``` ### Response #### Success Response (200) - **access_token** (string) - The generated access token for API requests. - **token_type** (string) - The type of token (e.g., Bearer). - **expires_in** (integer) - The token's expiration time in seconds. #### Response Example ```json { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "token_type": "Bearer", "expires_in": 3600 } ``` ## How to connect via API using OAuth 2.0 ### Description Details the process of integrating with the Wildberries API using the OAuth 2.0 authorization framework. ### Method GET ### Endpoint /oauth2/authorize ### Parameters #### Query Parameters - **client_id** (string) - Required - Your application's client ID. - **redirect_uri** (string) - Required - The URI to redirect the user to after authorization. - **response_type** (string) - Required - Should be 'code'. - **scope** (string) - Optional - The scope of the requested permissions. ## How to create, update, or delete a WB API token ### Description Guides you through the management of API tokens, including creation, modification, and deletion operations. ### Method PUT / POST / DELETE ### Endpoint /api/v1/tokens/{tokenId} ### Parameters #### Path Parameters - **tokenId** (string) - Required - The unique identifier of the token to manage. #### Request Body (for Create/Update) - **permissions** (array) - Optional - A list of permissions for the token. ### Request Example (Create Token) ```json { "permissions": [ "read:orders", "write:products" ] } ``` ### Response #### Success Response (200 or 201) - **message** (string) - Confirmation of the token operation. #### Response Example ```json { "message": "Token created successfully." } ``` ``` -------------------------------- ### Wildberries Seller API - OAuth 2.0 Authentication Source: https://seller.wildberries.ru/instructions/ru/ru/subcategory/how-to-improve-item-card Instructions on how to connect to the WB API using OAuth 2.0. ```APIDOC ## POST /api/oauth/connect ### Description Connect to the WB API using OAuth 2.0 for authorization. ### Method POST ### Endpoint `/api/oauth/connect` ### Parameters #### Query Parameters - **client_id** (string) - Required - Your application's client ID. - **redirect_uri** (string) - Required - The URI to redirect to after authorization. - **scope** (string) - Required - The scope of access requested. ### Request Example ```json { "client_id": "YOUR_CLIENT_ID", "redirect_uri": "https://your-app.com/callback", "scope": "read_write" } ``` ### Response #### Success Response (200) - **authorization_url** (string) - The URL to redirect the user to for authorization. #### Response Example ```json { "authorization_url": "https://oauth.wildberries.ru/authorize?client_id=YOUR_CLIENT_ID&redirect_uri=https://your-app.com/callback&scope=read_write" } ``` ``` -------------------------------- ### WB API Integration Source: https://seller.wildberries.ru/instructions/ru/ru/material/A-84_recommended=true Information on how to connect and work with the Wildberries Seller API, including token-based and OAuth 2.0 authentication. ```APIDOC ## WB API Integration ### Description This section covers the process of integrating with the Wildberries Seller API (WB API). It details how to connect to the API using different authentication methods. ### Connect via API Token This guide explains how to establish an API connection using a generated token. ### Connect via OAuth 2.0 This guide explains how to establish an API connection using the OAuth 2.0 protocol. ### Token Management Details on how to create, update, or delete WB API tokens. ``` -------------------------------- ### Product Catalog API Source: https://seller.wildberries.ru/instructions/ru/ru/category/problem-solutions APIs for managing product information, including creation, updates, and retrieval for various sales models. ```APIDOC ## Product Catalog API ### Description APIs for managing product details, attributes, and listings across different sales models like FBS, FBW, and EDBS. ### Method POST, PUT, GET, DELETE ### Endpoint `/api/v1/products` `/api/v1/products/{product_id}` ### Parameters #### Path Parameters - **product_id** (string) - Required - The unique identifier for a product. #### Query Parameters - **model** (string) - Optional - Filter products by sales model (e.g., 'FBS', 'FBW', 'EDBS'). - **category_id** (string) - Optional - Filter products by category. #### Request Body - **name** (string) - Required - The name of the product. - **description** (string) - Required - A detailed description of the product. - **price** (number) - Required - The selling price of the product. - **attributes** (object) - Required - Key-value pairs of product attributes (e.g., color, size). - **category_id** (string) - Required - The ID of the product's category. - **sales_model** (string) - Required - The sales model to associate the product with (e.g., 'FBS', 'FBW'). ### Request Example ```json { "name": "Stylish Jeans", "description": "Comfortable and durable denim jeans.", "price": 1999.99, "attributes": { "color": "Blue", "size": "M" }, "category_id": "CAT001", "sales_model": "FBS" } ``` ### Response #### Success Response (200) - **product_id** (string) - The ID of the created or updated product. - **status** (string) - The status of the product listing. - **message** (string) - Confirmation message. #### Response Example ```json { "product_id": "PROD9876", "status": "active", "message": "Product details updated successfully." } ``` ``` -------------------------------- ### Profile and User Management API Source: https://seller.wildberries.ru/instructions/ru/ru/category/items-promotion Endpoints for managing seller profile information, user roles, permissions, and security settings. ```APIDOC ## PUT /api/profile/seller_data ### Description Updates seller profile information, such as contact details and business information. ### Method PUT ### Endpoint /api/profile/seller_data ### Parameters #### Request Body - **field_name** (string) - Required - The name of the field to update (e.g., 'phone_number', 'email'). - **new_value** (string) - Required - The new value for the field. ### Request Example ```json { "field_name": "phone_number", "new_value": "+79998887766" } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation of the profile update. #### Response Example ```json { "message": "Phone number updated successfully." } ``` ``` ```APIDOC ## POST /api/profile/users/roles ### Description Manages user roles and permissions within the seller's account, allowing for granular access control. ### Method POST ### Endpoint /api/profile/users/roles ### Parameters #### Request Body - **user_id** (string) - Required - The ID of the user. - **role** (string) - Required - The role to assign (e.g., 'admin', 'viewer'). - **permissions** (array) - Optional - Specific permissions to grant. ### Request Example ```json { "user_id": "USER123", "role": "editor", "permissions": ["edit_products", "view_orders"] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation of role/permission update. #### Response Example ```json { "message": "User role and permissions updated." } ``` ``` -------------------------------- ### WB API Authentication Source: https://seller.wildberries.ru/instructions/ru/ru/subcategory/labeled-items Information on how to connect to the Wildberries Seller API using either a token or OAuth 2.0. ```APIDOC ## Connecting to WB API ### Description Details on establishing a connection to the Wildberries Seller API. Two primary methods are supported: direct token authentication and OAuth 2.0. ### Method GET, POST ### Endpoint `/api/auth/token` or `/api/auth/oauth2` (Illustrative endpoints) ### Parameters #### Path Parameters None #### Query Parameters - **client_id** (string) - Required - Your application's client ID for OAuth 2.0. - **redirect_uri** (string) - Required - The URL to redirect to after authentication. #### Request Body - **grant_type** (string) - Required - Specifies the grant type, e.g., `client_credentials` for token or `authorization_code` for OAuth 2.0. - **client_secret** (string) - Required - Your application's client secret for OAuth 2.0. - **code** (string) - Required - The authorization code received during the OAuth 2.0 flow. ### Request Example ```json { "grant_type": "client_credentials", "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET" } ``` ### Response #### Success Response (200) - **access_token** (string) - The token used to authenticate API requests. - **token_type** (string) - The type of token, e.g., `Bearer`. - **expires_in** (integer) - The duration in seconds until the token expires. #### Response Example ```json { "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "token_type": "Bearer", "expires_in": 3600 } ``` ``` -------------------------------- ### Wildberries Seller API - Token Management Source: https://seller.wildberries.ru/instructions/ru/ru/subcategory/how-to-improve-item-card How to create, update, or delete WB API tokens. ```APIDOC ## API Endpoint for Token Management ### Description Endpoints for managing WB API tokens, including creation, updating, and deletion. ### Method POST /api/token/create PUT /api/token/update DELETE /api/token/delete ### Endpoint `/api/token/create` `/api/token/update` `/api/token/delete` ### Parameters #### Request Body (for POST and PUT) - **token_name** (string) - Required - The name of the token. - **permissions** (array of strings) - Optional - The permissions associated with the token. #### Query Parameters (for DELETE) - **token_id** (string) - Required - The ID of the token to delete. ### Request Example (Create Token) ```json { "token_name": "MyIntegrationToken", "permissions": ["read_orders", "write_products"] } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation of the action. - **token_id** (string, optional) - The ID of the created or updated token. #### Response Example (Create Token) ```json { "message": "Token created successfully.", "token_id": "123e4567-e89b-12d3-a456-426614174000" } ``` ``` -------------------------------- ### Wildberries Seller API Integration Source: https://seller.wildberries.ru/instructions/ru/ru/subcategory/card-specifics-by-category This section covers the basics of working with the Wildberries Seller API, including how to connect via API using tokens or OAuth 2.0, and how to manage API tokens. ```APIDOC ## Wildberries Seller API (WB API) ### Description This documentation outlines how to integrate with the Wildberries Seller API. It covers the general concept of WB API, connection methods, and token management. ### What is WB API and How to Work With It This subsection explains the fundamental aspects of the Wildberries Seller API and provides guidance on its usage. ### How to Connect via API using a Token Details on establishing an API connection using a security token. ### How to Connect via API using OAuth 2.0 Information on connecting to the API leveraging the OAuth 2.0 authorization framework. ### How to Create, Update, or Delete a WB API Token Instructions for managing your API access tokens, including creation, modification, and deletion. ``` -------------------------------- ### Working with Express Marketplace (EDBS) Source: https://seller.wildberries.ru/instructions/ru/ru/category/orders-management-with-freight-shipments APIs related to managing orders, inventory, and commissions for the 'Vitrina Express' (EDBS) sales model. ```APIDOC ## Product Management and Operations for EDBS ### Description APIs for managing product inventory, order fulfillment, and understanding commission structures for the 'Vitrina Express' (EDBS) sales model. ### Method GET, POST, PUT, DELETE (specific methods depend on the operation) ### Endpoint /api/v1/edbs/products /api/v1/edbs/orders /api/v1/edbs/commissions ### Parameters #### Path Parameters None #### Query Parameters - **status** (string) - Optional - Filter orders by status. - **product_id** (string) - Optional - Filter inventory for a specific product. #### Request Body - **product_data** (object) - Required for POST/PUT - Contains product details like name, description, price, etc. - **order_update** (object) - Required for updating order status. ### Request Example ```json { "product_data": { "name": "Example Product", "description": "A sample product for EDBS", "price": 1000, "quantity": 50 } } ``` ### Response #### Success Response (200) - **products** (array) - List of products managed under EDBS. - **orders** (array) - List of orders for the EDBS model. - **commission_rate** (number) - The commission rate for a specific transaction. #### Response Example ```json { "products": [ { "product_id": "12345", "name": "Example Product", "quantity": 45 } ], "commission_rate": 0.15 } ``` ```