Wildberries API TypeScript SDK / TariffsModule
Class: TariffsModule
Defined in: modules/tariffs/index.ts:20
Constructors
Constructor
new TariffsModule(client: BaseClient): TariffsModule;Defined in: modules/tariffs/index.ts:21
Parameters
| Parameter | Type |
|---|---|
client | BaseClient |
Returns
TariffsModule
Methods
getTariffsCommission()
getTariffsCommission(options?: {
locale?: string;
}): Promise<
| Commission
| CommissionChina
| CommissionTurkey
| CommissionUzbekistan
| CommissionUAE>;Defined in: modules/tariffs/index.ts:44
Комиссия по категориям товаров
Метод возвращает данные о комиссии WB по родительским категориям товаров согласно модели продаж. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 2 запроса | </div>
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | { locale?: string; } | Query parameters |
options.locale? | string | - |
Returns
Promise< | Commission | CommissionChina | CommissionTurkey | CommissionUzbekistan | CommissionUAE>
Успешно
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
Examples
// Get commission rates (default locale)
const result = await sdk.tariffs.getTariffsCommission();
console.log(result);// Get commission rates with English locale
const result = await sdk.tariffs.getTariffsCommission({ locale: 'en' });
console.log(result);getTariffsBox()
getTariffsBox(date: string): Promise<TariffsBoxResponse>;Defined in: modules/tariffs/index.ts:72
Тарифы для коробов
Для товаров, которые поставляются на склад в коробах, метод возвращает тарифы на остаток: - доставка со склада или пункта приёма до покупателя - доставка от покупателя до пункта приёма - хранение на складе WB <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 60 запросов | 1 секунда | 5 запросов | </div>
Parameters
| Parameter | Type | Description |
|---|---|---|
date | string | Date for tariffs in YYYY-MM-DD format (required) |
Returns
Promise<TariffsBoxResponse>
Успешно
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
Example
const result = await sdk.tariffs.getTariffsBox('2024-01-15');
console.log(result);getTariffsPallet()
getTariffsPallet(date: string): Promise<TariffsPalletResponse>;Defined in: modules/tariffs/index.ts:94
Тарифы для монопаллет
Для товаров, которые поставляются на склад WB на монопаллетах, метод возвращает стоимость: - доставки со склада до покупателя - доставки от покупателя до склада - хранения на складе WB <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 60 запросов | 1 секунда | 5 запросов | </div>
Parameters
| Parameter | Type | Description |
|---|---|---|
date | string | Date for tariffs in YYYY-MM-DD format (required) |
Returns
Promise<TariffsPalletResponse>
Успешно
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
Example
const result = await sdk.tariffs.getTariffsPallet('2024-01-15');
console.log(result);getTariffsReturn()
getTariffsReturn(date: string): Promise<ReturnTariffsResponse>;Defined in: modules/tariffs/index.ts:116
Тарифы на возврат
Метод возвращает тарифы: - на перевозку товаров со склада WB или из пункта приёма до продавца - на обратную перевозку возвратов, которые не забрал продавец <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 60 запросов | 1 секунда | 5 запросов | </div>
Parameters
| Parameter | Type | Description |
|---|---|---|
date | string | Date for tariffs in YYYY-MM-DD format (required) |
Returns
Promise<ReturnTariffsResponse>
Успешно
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
Example
const result = await sdk.tariffs.getTariffsReturn('2024-01-15');
console.log(result);getAcceptanceCoefficients()
getAcceptanceCoefficients(options?: {
warehouseIDs?: string;
}): Promise<ModelsAcceptanceCoefficient[]>;Defined in: modules/tariffs/index.ts:151
Тарифы на поставку
Метод возвращает тарифы на поставку для конкретных складов на ближайшие 14 дней.
Приёмка для поставки доступна только при сочетании:
coefficient—0или1allowUnload—true
Rate limit: 6 requests per minute, 10 second interval, burst 6
Parameters
| Parameter | Type | Description |
|---|---|---|
options? | { warehouseIDs?: string; } | Query parameters |
options.warehouseIDs? | string | Warehouse IDs, comma-separated. Returns all warehouses by default |
Returns
Promise<ModelsAcceptanceCoefficient[]>
Array of acceptance coefficients for the next 14 days
Throws
When API key is invalid (401/403)
Throws
When rate limit exceeded (429)
Throws
When request data is invalid (400)
Throws
When network request fails or times out
Examples
// Get coefficients for all warehouses
const allCoeffs = await sdk.tariffs.getAcceptanceCoefficients();
console.log(allCoeffs);// Get coefficients for specific warehouses
const coeffs = await sdk.tariffs.getAcceptanceCoefficients({ warehouseIDs: '507,117501' });
console.log(coeffs);