Quickstart Guide

Get started with the Wildberries TypeScript SDK in 5 minutes.

Русская версия | English Version

What You'll Learn

• Install the SDK
• Initialize with your API key
• Make your first API call
• Handle basic errors

Estimated Time: 5 minutes

---

Prerequisites

• Node.js ≥ 20.0.0
• npm ≥ 10.0.0
• Wildberries API key (get one here)

---

Step 1: Installation (1 minute)

Install the SDK via npm:

npm install wb-api-sdk

Verify installation:

npm list wb-api-sdk

---

Step 2: Initialize SDK (1 minute)

Create a new file index.ts and initialize the SDK:

import { WildberriesSDK } from 'wb-api-sdk';

// Initialize with your API key
const sdk = new WildberriesSDK({
  apiKey: 'YOUR_API_KEY_HERE' // Replace with your actual key
});

console.log('SDK initialized successfully!');

API Reference: See WildberriesSDK for complete initialization options and SDKConfig for all configuration parameters.

---

Step 3: Make Your First API Call (2 minutes)

Let's fetch product categories:

import { WildberriesSDK } from 'wb-api-sdk';

const sdk = new WildberriesSDK({
  apiKey: process.env.WB_API_KEY // Use environment variable
});

async function main() {
  try {
    // Fetch parent categories
    const categories = await sdk.products.getParentAll();

    console.log('Categories:', categories.data);
    console.log('Success! 🎉');
  } catch (error) {
    console.error('Error:', error.message);
  }
}

main();

Run it:

# Set your API key as environment variable
export WB_API_KEY='your_api_key_here'

# Run the script
npx tsx index.ts

Expected Output:

Categories: [
  { id: 1, name: 'Electronics' },
  { id: 2, name: 'Household chemicals' },
  ...
]
Success! 🎉

API Reference: See ProductsModule for all product management methods including getParentAll(), createProduct(), and updatePricing().

---

Common First-Time Issues

Issue: "Authentication error"

• ✅ Solution: Verify your API key is correct and active

Issue: "Rate limit exceeded"

• ✅ Solution: SDK automatically handles rate limits with retries

Issue: "Network timeout"

• ✅ Solution: Check your internet connection and Wildberries API status

---

Next Steps

Now that you've made your first API call, explore:

1. Tutorials - Step-by-step guides for common workflows
2. API Reference - Complete method documentation
   • All SDK Modules - 11 specialized modules
   • WildberriesSDK - Main SDK class
   • ProductsModule - Product management
   • OrdersFBSModule - Order fulfillment
   • FinancesModule - Financial data
   • AnalyticsModule - Performance metrics
3. Configuration Guide - Configure SDK for your environment
4. Best Practices - Production-ready patterns and error handling

---

Congratulations! You're ready to build with the Wildberries API. 🚀

← Back to Getting Started | Documentation Home