Skip to content

Wildberries API TypeScript SDK / TariffsModule

Class: TariffsModule

Defined in: modules/tariffs/index.ts:20

Constructors

Constructor

ts
new TariffsModule(client: BaseClient): TariffsModule;

Defined in: modules/tariffs/index.ts:21

Parameters

ParameterType
clientBaseClient

Returns

TariffsModule

Methods

getTariffsCommission()

ts
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

ParameterTypeDescription
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

ts
// Get commission rates (default locale)
const result = await sdk.tariffs.getTariffsCommission();
console.log(result);
ts
// Get commission rates with English locale
const result = await sdk.tariffs.getTariffsCommission({ locale: 'en' });
console.log(result);

getTariffsBox()

ts
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

ParameterTypeDescription
datestringDate 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

ts
const result = await sdk.tariffs.getTariffsBox('2024-01-15');
console.log(result);

getTariffsPallet()

ts
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

ParameterTypeDescription
datestringDate 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

ts
const result = await sdk.tariffs.getTariffsPallet('2024-01-15');
console.log(result);

getTariffsReturn()

ts
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

ParameterTypeDescription
datestringDate 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

ts
const result = await sdk.tariffs.getTariffsReturn('2024-01-15');
console.log(result);

getAcceptanceCoefficients()

ts
getAcceptanceCoefficients(options?: {
  warehouseIDs?: string;
}): Promise<ModelsAcceptanceCoefficient[]>;

Defined in: modules/tariffs/index.ts:151

Тарифы на поставку

Метод возвращает тарифы на поставку для конкретных складов на ближайшие 14 дней.

Приёмка для поставки доступна только при сочетании:

  • coefficient0 или 1
  • allowUnloadtrue

Rate limit: 6 requests per minute, 10 second interval, burst 6

Parameters

ParameterTypeDescription
options?{ warehouseIDs?: string; }Query parameters
options.warehouseIDs?stringWarehouse 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

ts
// Get coefficients for all warehouses
const allCoeffs = await sdk.tariffs.getAcceptanceCoefficients();
console.log(allCoeffs);
ts
// Get coefficients for specific warehouses
const coeffs = await sdk.tariffs.getAcceptanceCoefficients({ warehouseIDs: '507,117501' });
console.log(coeffs);

Made with ❤️ for the Wildberries developer community