You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(docs): Correct SDK method name getOrdersNew in all documentation
Fix incorrect method name getNewOrders() to getOrdersNew() throughout
the codebase. The SDK method is named getOrdersNew(), not getNewOrders().
This fixes CI validation errors that were incorrectly flagging valid SDK
method calls as non-existent.
Changes:
- Examples: Fixed 5 TypeScript files
- Documentation: Fixed 14 markdown files
- Both ordersFBS and inStorePickup modules affected
Files modified:
- examples/orders-fbs-fulfillment.ts
- examples/integration-product-order-finance.ts
- examples/in-store-pickup-workflow.ts
- docs/FAQ.md, GLOSSARY.md, performance-tuning.md
- docs/ru/README.md, FAQ.md, GLOSSARY.md, performance-tuning.md
- docs/examples/* (multiple files)
- docs/api/classes/* (TypeDoc generated files)
Historical files in docs/stories/ and docs/qa/stories/ were intentionally
left unchanged as they represent task specifications and historical records.
Copy file name to clipboardExpand all lines: docs/api/classes/WildberriesSDK.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -95,12 +95,12 @@ const sdk = new WildberriesSDK({
95
95
| ------ | ------ | ------ | ------ | ------ |
96
96
| <aid="general"></a> `general`|`readonly`|[`GeneralModule`](GeneralModule.md)| General API module Provides access to general utility endpoints: - Ping (connectivity testing) - Server timestamps **See**[GeneralModule](GeneralModule.md) for available methods **Example**`const response = await sdk.general.ping(); console.log('Server time:', response.TS);`|[index.ts:92](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L92)|
97
97
| <aid="products"></a> `products`|`readonly`|[`ProductsModule`](ProductsModule.md)| Products API module Provides access to product management endpoints: - Product card creation and editing - Category and characteristic management - Media (images, videos) upload - Pricing and stock management **See**[ProductsModule](ProductsModule.md) for available methods **Example**`// Get parent categories const parents = await sdk.products.getParentAll(); // Get categories by parent const categories = await sdk.products.getObjectAll({ parentID: 479 }); // Get characteristics for a category const characteristics = await sdk.products.getObjectCharc(105);`|[index.ts:117](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L117)|
98
-
| <aid="ordersfbs"></a> `ordersFBS`|`readonly`|[`OrdersFbsModule`](OrdersFbsModule.md)| Orders FBS (Fulfillment by Seller) API module Provides access to FBS order management endpoints: - New order retrieval - Order listing with filters and pagination - Order status tracking (supplier and WB system status) **See**[OrdersFbsModule](OrdersFbsModule.md) for available methods **Example**`// Get new orders awaiting processing const newOrders = await sdk.ordersFBS.getNewOrders(); // Get orders from last 7 days const sevenDaysAgo = Math.floor(Date.now() / 1000) - (7 * 24 * 60 * 60); const orders = await sdk.ordersFBS.getOrders({ dateFrom: sevenDaysAgo }); // Check order statuses const orderIds = orders.orders.map(o => o.id); const statuses = await sdk.ordersFBS.getOrderStatuses(orderIds);`|[index.ts:143](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L143)|
98
+
| <aid="ordersfbs"></a> `ordersFBS`|`readonly`|[`OrdersFbsModule`](OrdersFbsModule.md)| Orders FBS (Fulfillment by Seller) API module Provides access to FBS order management endpoints: - New order retrieval - Order listing with filters and pagination - Order status tracking (supplier and WB system status) **See**[OrdersFbsModule](OrdersFbsModule.md) for available methods **Example**`// Get new orders awaiting processing const newOrders = await sdk.ordersFBS.getOrdersNew(); // Get orders from last 7 days const sevenDaysAgo = Math.floor(Date.now() / 1000) - (7 * 24 * 60 * 60); const orders = await sdk.ordersFBS.getOrders({ dateFrom: sevenDaysAgo }); // Check order statuses const orderIds = orders.orders.map(o => o.id); const statuses = await sdk.ordersFBS.getOrderStatuses(orderIds);`|[index.ts:143](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L143)|
99
99
| <aid="ordersfbw"></a> `ordersFBW`|`readonly`|[`OrdersFbwModule`](OrdersFbwModule.md)| Orders FBW (Fulfillment by Wildberries) API module Provides access to FBW warehouse supply and acceptance endpoints: - Warehouse selection and availability - Acceptance coefficient checking - Supply planning and management - Transit tariff calculation **See**[OrdersFbwModule](OrdersFbwModule.md) for available methods **Example**`// Get available warehouses const warehouses = await sdk.ordersFBW.getWarehouses(); // Check acceptance coefficients for next 14 days const coefficients = await sdk.ordersFBW.getAcceptanceCoefficients(); // Get acceptance options for goods const goods = [{ barcode: '1234567891234', quantity: 10 }]; const options = await sdk.ordersFBW.getAcceptanceOptions(goods); // Get supply details const details = await sdk.ordersFBW.getSupplyDetails(12345);`|[index.ts:172](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L172)|
100
100
| <aid="finances"></a> `finances`|`readonly`|[`FinancesModule`](FinancesModule.md)| Finances API module Provides access to financial data endpoints: - Balance and transaction retrieval - Financial reports (sales reports by period) - Document management (categories, list, download) **See**[FinancesModule](FinancesModule.md) for available methods **Example**`// Get current balance const balance = await sdk.finances.getBalance(); console.log(`Available: ${balance.for_withdraw} ${balance.currency}`); // Get transaction history const transactions = await sdk.finances.getTransactions({ dateFrom: '2024-01-01', dateTo: '2024-01-31', period: 'weekly' }); // Download documents const docs = await sdk.finances.getDocuments();`|[index.ts:201](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L201)|
| <a id="communications"></a> `communications` | `readonly` | [`CommunicationsModule`](CommunicationsModule.md) | Communications API module Provides access to customer communication endpoints: **Chat Management:** - Get all chat conversations - Poll for new chat events - Send messages to customers (with file attachments) - Extract chat metadata (replySign, chatID) **Product Q&A Management:** - Get product questions (answered/unanswered, with filtering) - Answer or reject customer questions - Mark questions as viewed **Customer Reviews Management:** - Get customer reviews (answered/unanswered, with filtering) - View review details (text, photos, videos, ratings) - Respond to reviews - Edit review responses **See** [CommunicationsModule](CommunicationsModule.md) for available methods **Example** `// Chat: Get all chats and send a message const chats = await sdk.communications.getChats(); const replySign = chats.result[0].replySign; await sdk.communications.sendMessage(replySign, 'Thank you for your message!'); // Q&A: Get and answer product questions const questions = await sdk.communications.getQuestions({ isAnswered: false, take: 10, skip: 0, }); await sdk.communications.answerQuestion(questions.data.questions[0].id, 'This product is made of cotton.'); // Reviews: Get and respond to customer reviews const reviews = await sdk.communications.getReviews({ isAnswered: false, take: 10, skip: 0, }); await sdk.communications.respondToReview(reviews.data.feedbacks[0].id, 'Thank you for your feedback!');` | [index.ts:282](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L282) |
103
103
| <a id="reports"></a> `reports` | `readonly` | [`ReportsModule`](ReportsModule.md) | Reports API module Provides access to reporting and analytics data endpoints: - Inbound shipments (incomes) with pagination - Stock levels with quantity breakdown - Customer orders tracking - Sales and returns analysis - Excise/compliance reports - Async warehouse remains reports **See** [ReportsModule](ReportsModule.md) for available methods **Example** `// Get inbound shipments const incomes = await sdk.reports.getIncomes('2024-01-01'); // Get current stock levels const stocks = await sdk.reports.getStocks('2024-01-01'); // Generate and download warehouse remains report const task = await sdk.reports.createWarehouseRemainsReport({ locale: 'ru' }); const status = await sdk.reports.checkReportStatus(task.data.taskId, 'warehouse_remains'); if (status.data.status === 'done') { const blob = await sdk.reports.downloadReport(task.data.taskId, 'warehouse_remains'); }` | [index.ts:313](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L313) |
104
104
| <a id="promotion"></a> `promotion` | `readonly` | [`PromotionModule`](PromotionModule.md) | Promotion API module Provides access to promotional campaign endpoints: - Campaign creation, management, and control - Campaign count and information retrieval - Auction (manual bid) campaign management - Configuration values and minimum bids - Budget deposits and management - Product and category selection for campaigns - Statistics and performance tracking **See** [PromotionModule](PromotionModule.md) for available methods **Example** `// Get campaign count summary const summary = await sdk.promotion.getPromotionCount(); // Create a new campaign const campaignId = await sdk.promotion.createSeacatSaveAd({ name: 'Winter Sale Campaign', nms: [12345, 67890], bid_type: 'manual', placement_types: ['search', 'recommendations'] }); // Get minimum bids for products const minBids = await sdk.promotion.createBidsMin({ advert_id: campaignId, nm_ids: [12345, 67890], payment_type: 'cpm', placement_types: ['search', 'recommendation'] });` | [index.ts:351](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L351) |
105
105
| <aid="tariffs"></a> `tariffs`|`readonly`|[`TariffsModule`](TariffsModule.md)| Tariffs API module Provides access to tariff and commission information: - Commission rates by category - Box storage tariffs - Pallet storage tariffs - Return handling tariffs **See**[TariffsModule](TariffsModule.md) for available methods **Example**`// Get commission rates for all categories const commissions = await sdk.tariffs.getTariffsCommission(); // Get box storage tariffs const boxTariffs = await sdk.tariffs.getTariffsBox(); // Get pallet storage tariffs const palletTariffs = await sdk.tariffs.getTariffsPallet(); // Get return handling tariffs const returnTariffs = await sdk.tariffs.getTariffsReturn();`|[index.ts:379](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L379)|
106
-
| <a id="instorepickup"></a> `inStorePickup` | `readonly` | [`InStorePickupModule`](InStorePickupModule.md) | In-Store Pickup API module (Click & Collect) Provides comprehensive methods for managing click & collect orders: - Order assembly lifecycle management (new → confirm → prepare → receive/reject) - Customer verification at pickup - Product metadata management (SGTIN, UIN, IMEI, GTIN) - Order queries and status tracking **See** [InStorePickupModule](InStorePickupModule.md) for available methods **Examples** `// 1. Get new pickup orders const newOrders = await sdk.inStorePickup.getNewOrders(); const order = newOrders.orders[0]; // 2. Confirm and start assembly await sdk.inStorePickup.confirmOrder(order.id); // 3. Complete assembly await sdk.inStorePickup.prepareOrder(order.id); // 4. Customer arrives - verify identity const verification = await sdk.inStorePickup.verifyCustomerIdentity({ orderCode: order.orderCode, passcode: '1234' // From customer's app }); // 5. Complete handover await sdk.inStorePickup.receiveOrder(order.id);` `// Set SGTIN codes (Честный знак marking) await sdk.inStorePickup.setSGTINCode(orderId, ['1234567890123456']); // Set IMEI for electronics await sdk.inStorePickup.setIMEICode(orderId, '123456789012345'); // Get all metadata const metadata = await sdk.inStorePickup.getOrderMetadata(orderId);` | [index.ts:426](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L426) |
106
+
| <a id="instorepickup"></a> `inStorePickup` | `readonly` | [`InStorePickupModule`](InStorePickupModule.md) | In-Store Pickup API module (Click & Collect) Provides comprehensive methods for managing click & collect orders: - Order assembly lifecycle management (new → confirm → prepare → receive/reject) - Customer verification at pickup - Product metadata management (SGTIN, UIN, IMEI, GTIN) - Order queries and status tracking **See** [InStorePickupModule](InStorePickupModule.md) for available methods **Examples** `// 1. Get new pickup orders const newOrders = await sdk.inStorePickup.getOrdersNew(); const order = newOrders.orders[0]; // 2. Confirm and start assembly await sdk.inStorePickup.confirmOrder(order.id); // 3. Complete assembly await sdk.inStorePickup.prepareOrder(order.id); // 4. Customer arrives - verify identity const verification = await sdk.inStorePickup.verifyCustomerIdentity({ orderCode: order.orderCode, passcode: '1234' // From customer's app }); // 5. Complete handover await sdk.inStorePickup.receiveOrder(order.id);` `// Set SGTIN codes (Честный знак marking) await sdk.inStorePickup.setSGTINCode(orderId, ['1234567890123456']); // Set IMEI for electronics await sdk.inStorePickup.setIMEICode(orderId, '123456789012345'); // Get all metadata const metadata = await sdk.inStorePickup.getOrderMetadata(orderId);` | [index.ts:426](https://github.com/salacoste/daytona-wildberries-typescript-sdk/blob/c8fc381eae7a16d563b3d9f7ec9624f796368e0c/src/index.ts#L426) |
0 commit comments