Skip to content

Wildberries API TypeScript SDK / ProductsModule

Class: ProductsModule

Defined in: modules/products/index.ts:37

Constructors

Constructor

ts
new ProductsModule(client: BaseClient): ProductsModule;

Defined in: modules/products/index.ts:38

Parameters

ParameterType
clientBaseClient

Returns

ProductsModule

Methods

getParentAll()

ts
getParentAll(options?: {
  locale?: string;
}): Promise<GetParentAllResponse>;

Defined in: modules/products/index.ts:61

Родительские категории товаров

Returns parent category names and IDs for product card creation (e.g., Electronics, Household chemicals).

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ locale?: string; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<GetParentAllResponse>

Parent categories list

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getParentAll({ locale: 'ru' });
console.log(result.data); // Parent categories array

getObjectAll()

ts
getObjectAll(options?: {
  locale?: string;
  name?: string;
  limit?: number;
  offset?: number;
  parentID?: number;
}): Promise<{
  data?: {
     subjectID?: number;
     parentID?: number;
     subjectName?: string;
     parentName?: string;
  }[];
  error?: boolean;
  errorText?: string;
  additionalErrors?: string;
}>;

Defined in: modules/products/index.ts:96

Список предметов

Returns parent category names and their subjects with IDs (e.g., category "Toys" contains "Kaleidoscopes", "Dolls", "Balls").

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ locale?: string; name?: string; limit?: number; offset?: number; parentID?: number; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')
options.name?stringSubject name filter
options.limit?numberNumber of items to return
options.offset?numberItems offset
options.parentID?numberParent category ID filter

Returns

Promise<{ data?: { subjectID?: number; parentID?: number; subjectName?: string; parentName?: string; }[]; error?: boolean; errorText?: string; additionalErrors?: string; }>

List of subjects with their parent categories

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getObjectAll({ parentID: 306, locale: 'ru', limit: 50 });
console.log(result.data); // [{ subjectID, parentID, subjectName, parentName }]

getObjectCharc()

ts
getObjectCharc(subjectId: number, options?: {
  locale?: string;
}): Promise<{
  data?: {
     charcID?: number;
     subjectName?: string;
     subjectID?: number;
     name?: string;
     required?: boolean;
     unitName?: string;
     maxCount?: number;
     popular?: boolean;
     charcType?: number;
  }[];
  error?: boolean;
  errorText?: string;
  additionalErrors?: string;
}>;

Defined in: modules/products/index.ts:142

Характеристики предмета

Returns characteristic parameters for a subject: names, data types, units of measure, etc. Use separate methods for Color, Gender, Country, Season, VAT, and TNVED values.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
subjectIdnumberID предмета
options?{ locale?: string; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<{ data?: { charcID?: number; subjectName?: string; subjectID?: number; name?: string; required?: boolean; unitName?: string; maxCount?: number; popular?: boolean; charcType?: number; }[]; error?: boolean; errorText?: string; additionalErrors?: string; }>

Subject characteristics list

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getObjectCharc(105, { locale: 'ru' });
console.log(result.data); // [{ charcID, name, required, unitName, charcType }]

getDirectoryColors()

ts
getDirectoryColors(options?: {
  locale?: string;
}): Promise<GetDirectoryColorsResponse>;

Defined in: modules/products/index.ts:203

Цвет

Returns possible values for the "Color" product characteristic.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ locale?: string; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<GetDirectoryColorsResponse>

Available color values

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getDirectoryColors({ locale: 'ru' });
console.log(result.data); // Available color values

getDirectoryKinds()

ts
getDirectoryKinds(options?: {
  locale?: string;
}): Promise<{
  data?: string[];
  error?: boolean;
  errorText?: string;
  additionalErrors?: string;
}>;

Defined in: modules/products/index.ts:234

Пол

Returns possible values for the "Gender" product characteristic.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ locale?: string; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<{ data?: string[]; error?: boolean; errorText?: string; additionalErrors?: string; }>

Available gender values

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getDirectoryKinds({ locale: 'ru' });
console.log(result.data); // ['Мужской', 'Женский', 'Унисекс']

getDirectoryCountries()

ts
getDirectoryCountries(options?: {
  locale?: string;
}): Promise<GetDirectoryCountriesResponse>;

Defined in: modules/products/index.ts:269

Страна производства

Returns possible values for the "Country of manufacture" product characteristic.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ locale?: string; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<GetDirectoryCountriesResponse>

Available country values

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getDirectoryCountries({ locale: 'ru' });
console.log(result.data); // Available country values

getDirectorySeasons()

ts
getDirectorySeasons(options?: {
  locale?: string;
}): Promise<{
  data?: string[];
  error?: boolean;
  errorText?: string;
  additionalErrors?: string;
}>;

Defined in: modules/products/index.ts:302

Сезон

Returns possible values for the "Season" product characteristic.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ locale?: string; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<{ data?: string[]; error?: boolean; errorText?: string; additionalErrors?: string; }>

Available season values

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getDirectorySeasons({ locale: 'ru' });
console.log(result.data); // ['Лето', 'Зима', 'Демисезон', 'Всесезон']

getDirectoryVat()

ts
getDirectoryVat(options?: {
  locale?: string;
}): Promise<{
  data?: string[];
  error?: boolean;
  errorText?: string;
  additionalErrors?: string;
}>;

Defined in: modules/products/index.ts:337

Ставка НДС

Returns possible values for the "VAT rate" product characteristic.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ locale?: string; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<{ data?: string[]; error?: boolean; errorText?: string; additionalErrors?: string; }>

Available VAT rate values

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getDirectoryVat({ locale: 'ru' });
console.log(result.data); // Available VAT rate values

getDirectoryTnved()

ts
getDirectoryTnved(options?: {
  subjectID: number;
  search?: number;
  locale?: string;
}): Promise<{
  data?: {
     tnved?: string;
     isKiz?: boolean;
  }[];
  error?: boolean;
  errorText?: string;
  additionalErrors?: string;
}>;

Defined in: modules/products/index.ts:374

ТНВЭД-код

Returns list of TNVED codes by subject ID and optional code fragment search.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ subjectID: number; search?: number; locale?: string; }Query parameters
options.subjectID?numberSubject ID (required)
options.search?numberTNVED code fragment to search
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<{ data?: { tnved?: string; isKiz?: boolean; }[]; error?: boolean; errorText?: string; additionalErrors?: string; }>

TNVED codes with KIZ marking flag

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getDirectoryTnved({ subjectID: 105, search: 6403 });
console.log(result.data); // [{ tnved: '6403919100', isKiz: true }]

getBrands()

ts
getBrands(subjectId: number, next?: number): Promise<BrandsResponse>;

Defined in: modules/products/index.ts:427

Бренды

Метод возвращает список брендов по ID предмета. Используйте курсорную пагинацию с параметром next для получения всех результатов.

Rate limit: 1 запрос в секунду, всплеск 5

Parameters

ParameterTypeDescription
subjectIdnumberID предмета
next?numberКурсор пагинации из предыдущего ответа

Returns

Promise<BrandsResponse>

Пагинированный список брендов с общим количеством

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Kategorii-predmety-i-harakteristiki

Example

typescript
// Получить первую страницу брендов для предмета 1234
const result = await sdk.products.getBrands(1234);
console.log(`Всего брендов: ${result.total}`);

// Пагинация по всем брендам
let next: number | undefined;
do {
  const page = await sdk.products.getBrands(1234, next);
  page.brands.forEach(b => console.log(b.name));
  next = page.next;
} while (next);

getContentTags()

ts
getContentTags(): Promise<GetContentTagsResponse>;

Defined in: modules/products/index.ts:456

Список ярлыков

Returns all seller tags for grouping and filtering products.

Rate limit: 100 req/min, 600ms interval, burst 5

Returns

Promise<GetContentTagsResponse>

Seller tags list

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getContentTags();
console.log(result.data); // Seller tags array

createContentTag()

ts
createContentTag(data: {
  color?: string;
  name?: string;
}): Promise<ResponseContentError>;

Defined in: modules/products/index.ts:487

Создание ярлыка

Creates a seller tag. Max 15 tags per seller, max 15 characters per tag name.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data{ color?: string; name?: string; }Tag creation data
data.color?stringTag color
data.name?stringTag name (max 15 characters)

Returns

Promise<ResponseContentError>

Creation result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createContentTag({ color: '#ff0000', name: 'Sale' });
console.log(result);

updateContentTag()

ts
updateContentTag(id: number, data: {
  color?: string;
  name?: string;
}): Promise<ResponseContentError>;

Defined in: modules/products/index.ts:518

Изменение ярлыка

Replaces tag data: name and color.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
idnumberЧисловой ID ярлыка
data{ color?: string; name?: string; }Tag update data
data.color?stringNew tag color
data.name?stringNew tag name

Returns

Promise<ResponseContentError>

Update result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.updateContentTag(42, { color: '#00ff00', name: 'New Arrivals' });
console.log(result);

deleteContentTag()

ts
deleteContentTag(id: number): Promise<ResponseContentError>;

Defined in: modules/products/index.ts:549

Удаление ярлыка

Deletes a tag from the seller's tag list.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
idnumberЧисловой ID ярлыка

Returns

Promise<ResponseContentError>

Deletion result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.deleteContentTag(42);
console.log(result);

ts
createNomenclatureLink(data: {
  nmID?: number;
  tagsIDs?: number[];
}): Promise<ResponseContentError>;

Defined in: modules/products/index.ts:580

Управление ярлыками в карточке товара

Adds or removes tags from a product card. Max 15 tags per card. Removing a tag from a card does not delete it from the seller's tag list.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data{ nmID?: number; tagsIDs?: number[]; }Tag link data
data.nmID?numberProduct card nomenclature ID
data.tagsIDs?number[]Array of tag IDs to link/unlink

Returns

Promise<ResponseContentError>

Link result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createNomenclatureLink({ nmID: 12345678, tagsIDs: [1, 2, 3] });
console.log(result);

getCardsList()

ts
getCardsList(data: {
  settings?: {
     sort?: {
        ascending?: boolean;
     };
     filter?: {
        withPhoto?: number;
        textSearch?: string;
        tagIDs?: number[];
        allowedCategoriesOnly?: boolean;
        objectIDs?: number[];
        brands?: string[];
        imtID?: number;
     };
     cursor?: {
        limit?: number;
        updatedAt?: string;
        nmID?: number;
     };
  };
}, options?: {
  locale?: string;
}): Promise<{
  cards?: {
     nmID?: number;
     imtID?: number;
     nmUUID?: string;
     subjectID?: number;
     subjectName?: string;
     vendorCode?: string;
     brand?: string;
     title?: string;
     description?: string;
     needKiz?: boolean;
     photos?: {
        big?: string;
        c246x328?: string;
        c516x688?: string;
        square?: string;
        tm?: string;
     }[];
     video?: string;
     wholesale?: {
        enabled?: boolean;
        quantum?: number;
     };
     dimensions?: {
        length?: number;
        width?: number;
        height?: number;
        weightBrutto?: number;
        isValid?: boolean;
     };
     characteristics?: {
        id?: number;
        name?: string;
        value?: unknown;
     }[];
     sizes?: {
        chrtID?: number;
        techSize?: string;
        wbSize?: string;
        skus?: string[];
     }[];
     tags?: {
        id?: number;
        name?: string;
        color?: string;
     }[];
     createdAt?: string;
     updatedAt?: string;
  }[];
  cursor?: {
     updatedAt?: string;
     nmID?: number;
     total?: number;
  };
}>;

Defined in: modules/products/index.ts:620

Список карточек товаров

Returns a paginated list of product cards. Trashed cards are excluded; use getTrashedCards() instead. Use cursor-based pagination with updatedAt and nmID from the response cursor to fetch more than 100 cards.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data{ settings?: { sort?: { ascending?: boolean; }; filter?: { withPhoto?: number; textSearch?: string; tagIDs?: number[]; allowedCategoriesOnly?: boolean; objectIDs?: number[]; brands?: string[]; imtID?: number; }; cursor?: { limit?: number; updatedAt?: string; nmID?: number; }; }; }Request body with settings, filters, and cursor
data.settings?{ sort?: { ascending?: boolean; }; filter?: { withPhoto?: number; textSearch?: string; tagIDs?: number[]; allowedCategoriesOnly?: boolean; objectIDs?: number[]; brands?: string[]; imtID?: number; }; cursor?: { limit?: number; updatedAt?: string; nmID?: number; }; }-
data.settings.sort?{ ascending?: boolean; }-
data.settings.sort.ascending?boolean-
data.settings.filter?{ withPhoto?: number; textSearch?: string; tagIDs?: number[]; allowedCategoriesOnly?: boolean; objectIDs?: number[]; brands?: string[]; imtID?: number; }-
data.settings.filter.withPhoto?number-
data.settings.filter.textSearch?string-
data.settings.filter.tagIDs?number[]-
data.settings.filter.allowedCategoriesOnly?boolean-
data.settings.filter.objectIDs?number[]-
data.settings.filter.brands?string[]-
data.settings.filter.imtID?number-
data.settings.cursor?{ limit?: number; updatedAt?: string; nmID?: number; }-
data.settings.cursor.limit?number-
data.settings.cursor.updatedAt?string-
data.settings.cursor.nmID?number-
options?{ locale?: string; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<{ cards?: { nmID?: number; imtID?: number; nmUUID?: string; subjectID?: number; subjectName?: string; vendorCode?: string; brand?: string; title?: string; description?: string; needKiz?: boolean; photos?: { big?: string; c246x328?: string; c516x688?: string; square?: string; tm?: string; }[]; video?: string; wholesale?: { enabled?: boolean; quantum?: number; }; dimensions?: { length?: number; width?: number; height?: number; weightBrutto?: number; isValid?: boolean; }; characteristics?: { id?: number; name?: string; value?: unknown; }[]; sizes?: { chrtID?: number; techSize?: string; wbSize?: string; skus?: string[]; }[]; tags?: { id?: number; name?: string; color?: string; }[]; createdAt?: string; updatedAt?: string; }[]; cursor?: { updatedAt?: string; nmID?: number; total?: number; }; }>

Product cards with pagination cursor

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getCardsList({
  settings: {
    cursor: { limit: 100 },
    filter: { withPhoto: -1 },
  },
}, { locale: 'ru' });
console.log(result.cards); // Product cards array
console.log(result.cursor?.total); // Total count

createErrorList()

ts
createErrorList(data: RequestPublicViewerPublicErrorsTableListV2, options?: {
  locale?: string;
}): Promise<ResponsePublicViewerPublicErrorsTableListV2>;

Defined in: modules/products/index.ts:763

Список несозданных карточек товаров с ошибками

Returns product cards (drafts) that failed during creation or editing, with error descriptions. Data is returned in batches. Use cursor pagination with updatedAt and batchUUID.

Rate limit: 10 req/min, 6s interval, burst 5

Parameters

ParameterTypeDescription
dataRequestPublicViewerPublicErrorsTableListV2Request body with cursor and order settings
options?{ locale?: string; }Query parameters
options.locale?stringLanguage locale (e.g., 'ru', 'en')

Returns

Promise<ResponsePublicViewerPublicErrorsTableListV2>

Error list with pagination

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createErrorList(
  { cursor: { limit: 100 }, order: { ascending: true } },
  { locale: 'ru' }
);
console.log(result);

createCardsUpdate()

ts
createCardsUpdate(data?: {
  nmID: number;
  vendorCode: string;
  brand?: string;
  title?: string;
  description?: string;
  dimensions?: {
     length?: number;
     width?: number;
     height?: number;
     weightBrutto?: number;
  };
  characteristics?: {
     id: number;
     value: unknown;
  }[];
  sizes: {
     chrtID?: number;
     techSize?: string;
     wbSize?: string;
     skus?: string[];
  }[];
}[]): Promise<ResponseCardCreate>;

Defined in: modules/products/index.ts:802

Редактирование карточек товаров

Updates product cards. Card is fully overwritten, so all parameters must be sent including unchanged ones. Cannot edit barcodes, photos, video, or tags. Max 3000 cards per request, 10 MB max. Dimensions in cm, weight in kg.

Rate limit: 10 req/min, 6s interval, burst 5

Parameters

ParameterTypeDescription
data?{ nmID: number; vendorCode: string; brand?: string; title?: string; description?: string; dimensions?: { length?: number; width?: number; height?: number; weightBrutto?: number; }; characteristics?: { id: number; value: unknown; }[]; sizes: { chrtID?: number; techSize?: string; wbSize?: string; skus?: string[]; }[]; }[]Array of product cards to update

Returns

Promise<ResponseCardCreate>

Update result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createCardsUpdate([{
  nmID: 12345678,
  vendorCode: 'ART-001',
  title: 'Updated Product',
  sizes: [{ techSize: '42', skus: ['1234567890123'] }],
  characteristics: [{ id: 1, value: 'Blue' }],
}]);
console.log(result);

createCardsMovenm()

ts
createCardsMovenm(data?: 
  | RequestMoveNmsImtConn
| RequestMoveNmsImtDisconn): Promise<ResponseCardCreate>;

Defined in: modules/products/index.ts:846

Объединение и разъединение карточек товаров

Merges or splits product cards by imtID. With imtID: merge (max 30 cards, same subject only). Without imtID: split (new imtID generated). Max request size 10 MB.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data?| RequestMoveNmsImtConn | RequestMoveNmsImtDisconnMerge/split request (with or without imtID)

Returns

Promise<ResponseCardCreate>

Operation result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
// Merge cards under a single imtID
const result = await sdk.products.createCardsMovenm({
  imtID: 98765,
  nmIDs: [12345678, 12345679],
});
console.log(result);

createDeleteTrash()

ts
createDeleteTrash(data: {
  nmIDs?: number[];
}): Promise<{
  data?: Record<string, never>;
  error?: boolean;
  errorText?: string;
  additionalErrors?: Record<string, never>;
}>;

Defined in: modules/products/index.ts:878

Перенос карточек товаров в корзину

Moves product cards to trash. Cards are not deleted and can be recovered. Cards get a new imtID after trashing. Auto-deleted after 30 days.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data{ nmIDs?: number[]; }Request body with nmIDs to trash
data.nmIDs?number[]Array of product card IDs to move to trash

Returns

Promise<{ data?: Record<string, never>; error?: boolean; errorText?: string; additionalErrors?: Record<string, never>; }>

Trash operation result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createDeleteTrash({ nmIDs: [12345678, 12345679] });
console.log(result);

createCardsRecover()

ts
createCardsRecover(data: {
  nmIDs?: number[];
}): Promise<{
  data?: Record<string, never>;
  error?: boolean;
  errorText?: string;
  additionalErrors?: Record<string, never>;
}>;

Defined in: modules/products/index.ts:915

Восстановление карточек товаров из корзины

Restores product cards from trash. Card retains the imtID assigned when it was trashed.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data{ nmIDs?: number[]; }Request body with nmIDs to recover
data.nmIDs?number[]Array of product card IDs to restore

Returns

Promise<{ data?: Record<string, never>; error?: boolean; errorText?: string; additionalErrors?: Record<string, never>; }>

Recovery result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createCardsRecover({ nmIDs: [12345678] });
console.log(result);

getTrashedCards()

ts
getTrashedCards(data: {
  settings?: {
     sort?: {
        ascending?: boolean;
     };
     cursor?: {
        limit?: number;
        trashedAt?: string;
        nmID?: number;
     };
     filter?: {
        textSearch?: string;
     };
  };
}, options?: {
  locale?: "ru" | "en" | "zh";
}): Promise<{
  cards?: {
     nmID?: number;
     vendorCode?: string;
     subjectID?: number;
     subjectName?: string;
     photos?: {
        big?: string;
        c246x328?: string;
        c516x688?: string;
        square?: string;
        tm?: string;
     }[];
     video?: string;
     wholesale?: {
        enabled?: boolean;
        quantum?: number;
     };
     sizes?: {
        chrtID?: number;
        techSize?: string;
        wbSize?: string;
        skus?: string[];
     }[];
     dimensions?: {
        length?: number;
        width?: number;
        height?: number;
        weightBrutto?: number;
        isValid?: boolean;
     };
     characteristics?: {
        id?: number;
        name?: string;
        value?: unknown;
     }[];
     createdAt?: string;
     trashedAt?: string;
  }[];
  cursor?: {
     trashedAt?: string;
     nmID?: number;
     total?: number;
  };
}>;

Defined in: modules/products/index.ts:955

Список карточек товаров в корзине

Returns trashed product cards with cursor-based pagination (trashedAt + nmID).

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data{ settings?: { sort?: { ascending?: boolean; }; cursor?: { limit?: number; trashedAt?: string; nmID?: number; }; filter?: { textSearch?: string; }; }; }Request body with settings, cursor, and filter
data.settings?{ sort?: { ascending?: boolean; }; cursor?: { limit?: number; trashedAt?: string; nmID?: number; }; filter?: { textSearch?: string; }; }-
data.settings.sort?{ ascending?: boolean; }-
data.settings.sort.ascending?boolean-
data.settings.cursor?{ limit?: number; trashedAt?: string; nmID?: number; }-
data.settings.cursor.limit?number-
data.settings.cursor.trashedAt?string-
data.settings.cursor.nmID?number-
data.settings.filter?{ textSearch?: string; }-
data.settings.filter.textSearch?string-
options?{ locale?: "ru" | "en" | "zh"; }Query parameters
options.locale?"ru" | "en" | "zh"Language locale ('ru', 'en', 'zh')

Returns

Promise<{ cards?: { nmID?: number; vendorCode?: string; subjectID?: number; subjectName?: string; photos?: { big?: string; c246x328?: string; c516x688?: string; square?: string; tm?: string; }[]; video?: string; wholesale?: { enabled?: boolean; quantum?: number; }; sizes?: { chrtID?: number; techSize?: string; wbSize?: string; skus?: string[]; }[]; dimensions?: { length?: number; width?: number; height?: number; weightBrutto?: number; isValid?: boolean; }; characteristics?: { id?: number; name?: string; value?: unknown; }[]; createdAt?: string; trashedAt?: string; }[]; cursor?: { trashedAt?: string; nmID?: number; total?: number; }; }>

Trashed product cards with pagination cursor

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getTrashedCards({
  settings: { cursor: { limit: 100 }, filter: { textSearch: 'shoes' } },
}, { locale: 'ru' });
console.log(result.cards); // Trashed cards array

getCardsLimits()

ts
getCardsLimits(): Promise<{
  data?: {
     freeLimits?: number;
     paidLimits?: number;
  };
  error?: boolean;
  errorText?: string;
  additionalErrors?: string;
}>;

Defined in: modules/products/index.ts:1047

Лимиты карточек товаров

Returns free and paid limits for product card creation. Available cards = (freeLimits + paidLimits) - created cards count.

Rate limit: 100 req/min, 600ms interval, burst 5

Returns

Promise<{ data?: { freeLimits?: number; paidLimits?: number; }; error?: boolean; errorText?: string; additionalErrors?: string; }>

Card creation limits

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.getCardsLimits();
console.log(result.data); // { freeLimits: 1000, paidLimits: 500 }

createContentBarcode()

ts
createContentBarcode(data: {
  count?: number;
}): Promise<{
  data?: string[];
  error?: boolean;
  errorText?: string;
  additionalErrors?: string;
}>;

Defined in: modules/products/index.ts:1084

Генерация баркодов

Generates unique barcodes for product card size creation. Use when you don't have your own barcodes.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data{ count?: number; }Request body
data.count?numberNumber of barcodes to generate

Returns

Promise<{ data?: string[]; error?: boolean; errorText?: string; additionalErrors?: string; }>

Generated barcodes array

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createContentBarcode({ count: 5 });
console.log(result.data); // ['1234567890123', '1234567890124', ...]

createCardsUpload()

ts
createCardsUpload(data?: {
  subjectID: number;
  variants: {
     brand?: string;
     title?: string;
     description?: string;
     vendorCode: string;
     wholesale?: {
        enabled?: boolean;
        quantum?: number;
     };
     dimensions?: {
        length?: number;
        width?: number;
        height?: number;
        weightBrutto?: number;
     };
     sizes?: {
        techSize?: string;
        wbSize?: string;
        price?: number;
        skus?: string[];
     }[];
     characteristics?: {
        id: number;
        value: unknown;
     }[];
  }[];
}[]): Promise<ResponseCardCreate>;

Defined in: modules/products/index.ts:1127

Создание карточек товаров

Creates product cards asynchronously. Max 100 merged cards (imtID) with 30 cards each per request, 10 MB max. Dimensions in cm, weight in kg. Check error list if 200 response but some cards were not created.

Rate limit: 10 req/min, 6s interval, burst 5

Parameters

ParameterTypeDescription
data?{ subjectID: number; variants: { brand?: string; title?: string; description?: string; vendorCode: string; wholesale?: { enabled?: boolean; quantum?: number; }; dimensions?: { length?: number; width?: number; height?: number; weightBrutto?: number; }; sizes?: { techSize?: string; wbSize?: string; price?: number; skus?: string[]; }[]; characteristics?: { id: number; value: unknown; }[]; }[]; }[]Array of product card groups to create

Returns

Promise<ResponseCardCreate>

Creation result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createCardsUpload([{
  subjectID: 105,
  variants: [{
    vendorCode: 'ART-001',
    brand: 'MyBrand',
    title: 'Product Name',
    sizes: [{ techSize: '42', skus: ['1234567890123'] }],
    characteristics: [{ id: 1, value: 'Blue' }],
  }],
}]);
console.log(result);

createUploadAdd()

ts
createUploadAdd(data?: {
  imtID?: number;
  cardsToAdd?: {
     brand?: string;
     vendorCode: string;
     wholesale?: {
        enabled?: boolean;
        quantum?: number;
     };
     title?: string;
     description?: string;
     dimensions?: {
        length?: number;
        width?: number;
        height?: number;
        weightBrutto?: number;
     };
     sizes?: {
        techSize?: string;
        wbSize?: string;
        price?: number;
        skus?: string[];
     }[];
     characteristics?: {
        id: number;
        value: unknown;
     }[];
  }[];
}): Promise<ResponseCardCreate>;

Defined in: modules/products/index.ts:1177

Создание карточек товаров с присоединением

Creates new product cards and joins them to existing cards by imtID. Async processing, 10 MB max. Dimensions in cm, weight in kg.

Rate limit: 10 req/min, 6s interval, burst 5

Parameters

ParameterTypeDescription
data?{ imtID?: number; cardsToAdd?: { brand?: string; vendorCode: string; wholesale?: { enabled?: boolean; quantum?: number; }; title?: string; description?: string; dimensions?: { length?: number; width?: number; height?: number; weightBrutto?: number; }; sizes?: { techSize?: string; wbSize?: string; price?: number; skus?: string[]; }[]; characteristics?: { id: number; value: unknown; }[]; }[]; }Cards to create and join to existing imtID
data.imtID?number-
data.cardsToAdd?{ brand?: string; vendorCode: string; wholesale?: { enabled?: boolean; quantum?: number; }; title?: string; description?: string; dimensions?: { length?: number; width?: number; height?: number; weightBrutto?: number; }; sizes?: { techSize?: string; wbSize?: string; price?: number; skus?: string[]; }[]; characteristics?: { id: number; value: unknown; }[]; }[]-

Returns

Promise<ResponseCardCreate>

Creation result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createUploadAdd({
  imtID: 98765,
  cardsToAdd: [{
    vendorCode: 'ART-002',
    sizes: [{ techSize: '44', skus: ['1234567890124'] }],
    characteristics: [{ id: 1, value: 'Red' }],
  }],
});
console.log(result);

createMediaFile()

ts
createMediaFile(): Promise<{
  data?: Record<string, never>;
  error?: boolean;
  errorText?: string;
  additionalErrors?: Record<string, never>;
}>;

Defined in: modules/products/index.ts:1217

Загрузить медиафайл

Uploads a single media file to a product card. Images: max 30 per card, min 700x900px, max 32MB, formats JPG/PNG/BMP/GIF/WebP. Video: max 1 per card, max 50MB, formats MOV/MP4.

Rate limit: 100 req/min, 600ms interval, burst 5

Returns

Promise<{ data?: Record<string, never>; error?: boolean; errorText?: string; additionalErrors?: Record<string, never>; }>

Upload result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createMediaFile();
console.log(result);

createMediaSave()

ts
createMediaSave(data: {
  nmId?: number;
  data?: string[];
}): Promise<{
  data?: Record<string, never>;
  error?: boolean;
  errorText?: string;
  additionalErrors?: Record<string, never>;
}>;

Defined in: modules/products/index.ts:1259

Загрузить медиафайлы по ссылкам

Uploads media files to a product card via URLs. New files fully replace old ones. Links must be direct file URLs (no auth required). If any file fails validation, none are uploaded.

Rate limit: 100 req/min, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data{ nmId?: number; data?: string[]; }Request body
data.nmId?numberProduct card nomenclature ID
data.data?string[]Array of direct file URLs

Returns

Promise<{ data?: Record<string, never>; error?: boolean; errorText?: string; additionalErrors?: Record<string, never>; }>

Upload result

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products

Example

typescript
const result = await sdk.products.createMediaSave({
  nmId: 12345678,
  data: ['https://example.com/photo1.jpg', 'https://example.com/photo2.jpg'],
});
console.log(result);

createUploadTask()

ts
createUploadTask(data: Goods): Promise<UploadTaskResponse>;

Defined in: modules/products/index.ts:1298

Установить цены и скидки

Sets prices and discounts for products. Use createTaskSize() for per-size pricing. Track upload status via getHistoryTasks() and getGoodsTask().

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
dataGoodsGoods pricing data

Returns

Promise<UploadTaskResponse>

Upload task response

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.createUploadTask({
  data: [{ nmID: 12345678, price: 1500, discount: 10 }],
});
console.log(result);

createTaskSize()

ts
createTaskSize(data: SizeGoodsBody): Promise<UploadTaskResponse>;

Defined in: modules/products/index.ts:1329

Установить цены для размеров

Sets prices per size for eligible products (editableSizePrice: true). Use createUploadTask() for product-level pricing.

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
dataSizeGoodsBodySize pricing data

Returns

Promise<UploadTaskResponse>

Upload task response

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.createTaskSize({
  data: [{ nmID: 12345678, sizeID: 100, price: 2000 }],
});
console.log(result);

createTaskClubDiscount()

ts
createTaskClubDiscount(data: ClubDisc): Promise<UploadTaskResponse>;

Defined in: modules/products/index.ts:1359

Установить скидки WB Клуба

Sets WB Club subscription discounts for products.

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
dataClubDiscClub discount data

Returns

Promise<UploadTaskResponse>

Upload task response

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.createTaskClubDiscount({
  data: [{ nmID: 12345678, clubDiscount: 15 }],
});
console.log(result);

getHistoryTasks()

ts
getHistoryTasks(options?: {
  uploadID: number;
}): Promise<TaskHistoryResponse>;

Defined in: modules/products/index.ts:1388

Состояние обработанной загрузки

Returns processed upload status for prices, size prices, and WB Club discounts.

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ uploadID: number; }Query parameters
options.uploadID?numberUpload task ID to check

Returns

Promise<TaskHistoryResponse>

Task history with status

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.getHistoryTasks({ uploadID: 12345 });
console.log(result);

getGoodsTask()

ts
getGoodsTask(options?: {
  limit: number;
  offset?: number;
  uploadID: number;
}): Promise<GoodsHistoryResponse>;

Defined in: modules/products/index.ts:1418

Детализация обработанной загрузки

Returns per-item details and errors from a processed price/discount upload.

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ limit: number; offset?: number; uploadID: number; }Query parameters
options.limit?numberNumber of items to return
options.offset?numberItems offset
options.uploadID?numberUpload task ID

Returns

Promise<GoodsHistoryResponse>

Goods history with errors

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.getGoodsTask({ limit: 100, uploadID: 12345 });
console.log(result);

getBufferTasks()

ts
getBufferTasks(options?: {
  uploadID: number;
}): Promise<TaskBufferResponse>;

Defined in: modules/products/index.ts:1450

Состояние необработанной загрузки

Returns pending upload status (promo calendar discounts not yet applied).

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ uploadID: number; }Query parameters
options.uploadID?numberUpload task ID to check

Returns

Promise<TaskBufferResponse>

Buffer task status

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.getBufferTasks({ uploadID: 12345 });
console.log(result);

getBufferGoodsTask()

ts
getBufferGoodsTask(options?: {
  limit: number;
  offset?: number;
  uploadID: number;
}): Promise<GoodsBufferResponse>;

Defined in: modules/products/index.ts:1480

Детализация необработанной загрузки

Returns per-item details and errors from a pending (promo calendar) discount upload.

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ limit: number; offset?: number; uploadID: number; }Query parameters
options.limit?numberNumber of items to return
options.offset?numberItems offset
options.uploadID?numberUpload task ID

Returns

Promise<GoodsBufferResponse>

Buffer goods with errors

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.getBufferGoodsTask({ limit: 100, uploadID: 12345 });
console.log(result);

getGoodsFilter()

ts
getGoodsFilter(options?: {
  limit: number;
  offset?: number;
  filterNmID?: number;
}): Promise<GoodsFilterResponse>;

Defined in: modules/products/index.ts:1515

Получить товары с ценами

Returns product pricing info: prices, currency, discounts, WB Club discounts. Use limit/offset pagination for all products, or filterNmID for a single article.

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ limit: number; offset?: number; filterNmID?: number; }Query parameters
options.limit?numberNumber of items to return (max 1000)
options.offset?numberItems offset for pagination
options.filterNmID?numberFilter by single article ID

Returns

Promise<GoodsFilterResponse>

Goods with pricing information

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.getGoodsFilter({ limit: 1000, offset: 0 });
console.log(result);

createGoodsFilter()

ts
createGoodsFilter(data: {
  nmIDs: number[];
}): Promise<GoodsFilterByNmResponse>;

Defined in: modules/products/index.ts:1547

Получить товары с ценами по артикулам

Returns pricing info for multiple products by article IDs.

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
data{ nmIDs: number[]; }Request body with article IDs
data.nmIDsnumber[]Array of article IDs to fetch pricing for

Returns

Promise<GoodsFilterByNmResponse>

Goods with pricing information filtered by nmIDs

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.createGoodsFilter({ nmIDs: [12345678, 87654321] });
console.log(result);

getSizeNm()

ts
getSizeNm(options?: {
  limit: number;
  offset?: number;
  nmID: number;
}): Promise<SizeGoodsResponse>;

Defined in: modules/products/index.ts:1578

Получить размеры товара с ценами

Returns per-size pricing info for a single product (only for categories with editableSizePrice: true).

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ limit: number; offset?: number; nmID: number; }Query parameters
options.limit?numberNumber of items to return
options.offset?numberItems offset
options.nmID?numberProduct article ID

Returns

Promise<SizeGoodsResponse>

Size-level pricing data

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.getSizeNm({ limit: 100, nmID: 12345678 });
console.log(result);

getQuarantineGoods()

ts
getQuarantineGoods(options?: {
  limit: number;
  offset?: number;
}): Promise<QuarantineGoodsResponse>;

Defined in: modules/products/index.ts:1612

Получить товары в карантине

Returns quarantined products (price dropped 3x or more). Quarantine does not apply to per-size pricing. Products sell at old price while quarantined. Remove via API or seller dashboard.

Rate limit: 10 req/6s, 600ms interval, burst 5

Parameters

ParameterTypeDescription
options?{ limit: number; offset?: number; }Query parameters
options.limit?numberNumber of items to return
options.offset?numberItems offset

Returns

Promise<QuarantineGoodsResponse>

Quarantined goods list

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ceny-i-skidki

Example

typescript
const result = await sdk.products.getQuarantineGoods({ limit: 100, offset: 0 });
console.log(result);

getStocks()

ts
getStocks(warehouseId: number, data: {
  skus: string[];
}): Promise<{
  stocks?: {
     sku?: string;
     amount?: number;
  }[];
}>;

Defined in: modules/products/index.ts:1644

Получить остатки товаров

Returns stock amounts for products at a seller's warehouse. A 409 response counts as 10 requests.

Rate limit: 300 req/min, 200ms interval, burst 20

Parameters

ParameterTypeDescription
warehouseIdnumberID склада продавца
data{ skus: string[]; }Request body with SKUs
data.skusstring[]Array of SKU barcodes to check

Returns

Promise<{ stocks?: { sku?: string; amount?: number; }[]; }>

Stock amounts per SKU

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ostatki-na-skladah-prodavca

Example

typescript
const result = await sdk.products.getStocks(12345, { skus: ['1234567890123', '1234567890124'] });
console.log(result.stocks); // [{ sku: '1234567890123', amount: 50 }]

updateStock()

ts
updateStock(warehouseId: number, data?: {
  stocks: {
     sku?: string;
     amount?: number;
  }[];
}): Promise<void>;

Defined in: modules/products/index.ts:1679

Обновить остатки товаров

Updates stock amounts for products at a seller's warehouse. Parameter names are not validated; incorrect names return 204 but do not update stocks. A 409 response counts as 10 requests.

Rate limit: 300 req/min, 200ms interval, burst 20

Parameters

ParameterTypeDescription
warehouseIdnumberID склада продавца
data?{ stocks: { sku?: string; amount?: number; }[]; }Stock update data
data.stocks?{ sku?: string; amount?: number; }[]Array of SKU/amount pairs

Returns

Promise<void>

void on success (204)

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ostatki-na-skladah-prodavca

Example

typescript
await sdk.products.updateStock(12345, {
  stocks: [{ sku: '1234567890123', amount: 100 }],
});

deleteStock()

ts
deleteStock(warehouseId: number, data: {
  skus?: string[];
}): Promise<void>;

Defined in: modules/products/index.ts:1712

Удалить остатки товаров

Irreversibly deletes stock records. Must re-upload stocks to resume sales. A 409 response counts as 10 requests.

Rate limit: 300 req/min, 200ms interval, burst 20

Parameters

ParameterTypeDescription
warehouseIdnumberID склада продавца
data{ skus?: string[]; }Request body with SKUs to delete
data.skus?string[]Array of SKU barcodes to delete

Returns

Promise<void>

void on success

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Ostatki-na-skladah-prodavca

Example

typescript
await sdk.products.deleteStock(12345, { skus: ['1234567890123'] });

offices()

ts
offices(): Promise<Office[]>;

Defined in: modules/products/index.ts:1739

Получить список складов WB

Returns all WB warehouses for binding to seller warehouses (FBS model).

Rate limit: 300 req/min, 200ms interval, burst 20

Returns

Promise<Office[]>

Array of WB office/warehouse locations

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Sklady-prodavca

Example

typescript
const result = await sdk.products.offices();
console.log(result); // [{ id: 1, name: 'Коледино', ... }]

warehouses()

ts
warehouses(): Promise<Warehouse[]>;

Defined in: modules/products/index.ts:1764

Получить список складов продавца

Returns all seller warehouses. Use warehouse IDs to manage stock.

Rate limit: 300 req/min, 200ms interval, burst 20

Returns

Promise<Warehouse[]>

Array of seller warehouses

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Sklady-prodavca

Example

typescript
const result = await sdk.products.warehouses();
console.log(result); // [{ id: 12345, name: 'Main Warehouse', officeId: 1 }]

createWarehouse()

ts
createWarehouse(data: {
  name: string;
  officeId: number;
}): Promise<{
  id?: number;
}>;

Defined in: modules/products/index.ts:1794

Создать склад продавца

Creates a seller warehouse bound to a WB office for FBS fulfillment. Cannot bind a WB warehouse that is already in use.

Rate limit: 300 req/min, 200ms interval, burst 20

Parameters

ParameterTypeDescription
data{ name: string; officeId: number; }Warehouse creation data
data.namestringWarehouse name
data.officeIdnumberWB office ID to bind

Returns

Promise<{ id?: number; }>

Created warehouse with ID

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Sklady-prodavca

Example

typescript
const result = await sdk.products.createWarehouse({ name: 'Main Warehouse', officeId: 1 });
console.log(result.id); // New warehouse ID

updateWarehouse()

ts
updateWarehouse(warehouseId: number, data: {
  name: string;
  officeId: number;
}): Promise<void>;

Defined in: modules/products/index.ts:1825

Обновить склад продавца

Updates seller warehouse data. WB office binding can be changed once per day. Cannot bind a WB warehouse that is already in use.

Rate limit: 300 req/min, 200ms interval, burst 20

Parameters

ParameterTypeDescription
warehouseIdnumberID склада продавца
data{ name: string; officeId: number; }Warehouse update data
data.namestringUpdated warehouse name
data.officeIdnumberUpdated WB office ID

Returns

Promise<void>

void on success

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Sklady-prodavca

Example

typescript
await sdk.products.updateWarehouse(12345, { name: 'Updated Warehouse', officeId: 2 });

deleteWarehouse()

ts
deleteWarehouse(warehouseId: number): Promise<void>;

Defined in: modules/products/index.ts:1855

Удалить склад продавца

Deletes a seller warehouse from the list.

Rate limit: 300 req/min, 200ms interval, burst 20

Parameters

ParameterTypeDescription
warehouseIdnumberID склада продавца

Returns

Promise<void>

void on success

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Sklady-prodavca

Example

typescript
await sdk.products.deleteWarehouse(12345);

getWarehousesContact()

ts
getWarehousesContact(warehouseId: number): Promise<{
  contacts?: {
     comment?: string;
     phone?: string;
  }[];
}>;

Defined in: modules/products/index.ts:1883

Список контактов

Returns contacts linked to a seller warehouse. Only for warehouses with delivery type 3 (DBW - WB courier).

Rate limit: 300 req/min, 200ms interval, burst 20

Parameters

ParameterTypeDescription
warehouseIdnumberID склада продавца

Returns

Promise<{ contacts?: { comment?: string; phone?: string; }[]; }>

Warehouse contacts list

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Sklady-prodavca

Example

typescript
const result = await sdk.products.getWarehousesContact(12345);
console.log(result.contacts); // [{ phone: '+79001234567', comment: 'Main' }]

updateWarehousesContact()

ts
updateWarehousesContact(warehouseId: number, data: StoreContactRequestBody): Promise<void>;

Defined in: modules/products/index.ts:1915

Обновить список контактов

Overwrites the contact list for a seller warehouse (DBW delivery type 3 only). Send ALL contacts including unchanged ones. Max 5 contacts. Send empty array to delete all.

Rate limit: 300 req/min, 200ms interval, burst 20

Parameters

ParameterTypeDescription
warehouseIdnumberID склада продавца
dataStoreContactRequestBodyContact list data (overwrites existing)

Returns

Promise<void>

void on success

Throws

When API key is invalid (401/403)

Throws

When rate limit exceeded (429)

Throws

When request data is invalid (400/422)

Throws

When network request fails or times out

See

https://dev.wildberries.ru/openapi/work-with-products#tag/Sklady-prodavca

Example

typescript
await sdk.products.updateWarehousesContact(12345, {
  contacts: [{ phone: '+79001234567', comment: 'Main contact' }],
});

Made with ❤️ for the Wildberries developer community