Wildberries API TypeScript SDK / ReportsModule

Class: ReportsModule

Constructors

Constructor

new ReportsModule(client: BaseClient): ReportsModule;

Defined in: modules/reports/index.ts:11

Parameters

Parameter	Type
`client`	`BaseClient`

Returns

ReportsModule

Methods

getSupplierIncomes()

getSupplierIncomes(options?: {
  dateFrom: string;
}): Promise<IncomesItem[]>;

Defined in: modules/reports/index.ts:28

Поставки

Метод возвращает количество поставок товаров для хранения на складах WB.<br>Данные обновляются раз в 30 минут. <br><br> Для одного ответа в системе установлено условное ограничение 100000 строк. Поэтому, чтобы получить все поставки, может потребоваться более, чем один запрос. Во втором и далее запросе в параметре dateFrom используйте полное значение поля lastChangeDate из последней строки ответа на предыдущий запрос.<br> Если в ответе отдаётся пустой массив [], все поставки уже выгружены. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-

Returns

Promise<IncomesItem[]>

Успешно

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.general.getSupplierIncomes({});
console.log(result);

getSupplierStocks()

getSupplierStocks(options?: {
  dateFrom: string;
}): Promise<StocksItem[]>;

Defined in: modules/reports/index.ts:47

Склады

Метод возвращает количество остатков товаров на складах WB.<br>Данные обновляются раз в 30 минут. <br><br> Для одного ответа в системе установлено условное ограничение 60000 строк. Поэтому, чтобы получить все остатки, может потребоваться более, чем один запрос. Во втором и далее запросе в параметре dateFrom используйте полное значение поля lastChangeDate из последней строки ответа на предыдущий запрос.<br> Если в ответе отдаётся пустой массив [], все остатки уже выгружены. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-

Returns

Promise<StocksItem[]>

Успешно

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.general.getSupplierStocks({});
console.log(result);

getSupplierOrders()

getSupplierOrders(options?: {
  dateFrom: string;
  flag?: number;
}): Promise<OrdersItem[]>;

Defined in: modules/reports/index.ts:66

Заказы

Метод возвращает информацию обо всех заказах.<br>Данные обновляются раз в 30 минут.<br><br> 1 строка = 1 заказ = 1 cборочное задание = 1 единица товара.<br>Для определения заказа рекомендуем использовать поле srid.<br><br> Информация о заказе хранится 90 дней с момента оформления.<br><br> Для одного ответа на запрос с flag=0 или без flag в системе установлено условное ограничение 80000 строк. Поэтому, чтобы получить все заказы, может потребоваться более, чем один запрос. Во втором и далее запросе в параметре dateFrom используйте полное значение поля lastChangeDate из последней строки ответа на предыдущий запрос.<br> Если в ответе отдаётся пустой массив [], все заказы уже выгружены. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `flag?`: `number`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.flag?`	`number`	-

Returns

Promise<OrdersItem[]>

Успешно

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.general.getSupplierOrders({});
console.log(result);

getSupplierSales()

getSupplierSales(options?: {
  dateFrom: string;
  flag?: number;
}): Promise<SalesItem[]>;

Defined in: modules/reports/index.ts:85

Продажи

Метод возвращает информацию о продажах и возвратах.<br>Данные обновляются раз в 30 минут.<br><br> 1 строка = 1 заказ = 1 cборочное задание = 1 единица товара.<br>Для определения заказа рекомендуем использовать поле srid.<br><br> Информация о заказе хранится 90 дней с момента оформления.<br><br> Для одного ответа на запрос с flag=0 или без flag в системе установлено условное ограничение 80000 строк. Поэтому, чтобы получить все продажи и возвраты, может потребоваться более, чем один запрос. Во втором и далее запросе в параметре dateFrom используйте полное значение поля lastChangeDate из последней строки ответа на предыдущий запрос.<br> Если в ответе отдаётся пустой массив [], все продажи и возвраты уже выгружены. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `flag?`: `number`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.flag?`	`number`	-

Returns

Promise<SalesItem[]>

Успешно

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.general.getSupplierSales({});
console.log(result);

createAnalyticsExciseReport()

createAnalyticsExciseReport(options?: {
  dateFrom: string;
  dateTo: string;
}, data?: ExciseReportRequest): Promise<ExciseReportResponse>;

Defined in: modules/reports/index.ts:105

Получить отчёт

Метод возвращает отчёт с операциями по товарам с обязательной маркировкой.<br><br> Данный отчёт можно сохранить в формате таблиц. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 5 часов | 10 запросов | 30 минут | 10 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-
`data?`	`ExciseReportRequest`	Request body data

Returns

Promise<ExciseReportResponse>

Успешно

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.general.createAnalyticsExciseReport({}, {});
console.log(result);

warehouseRemains()

warehouseRemains(options?: {
  locale?: string;
  groupByBrand?: boolean;
  groupBySubject?: boolean;
  groupBySa?: boolean;
  groupByNm?: boolean;
  groupByBarcode?: boolean;
  groupBySize?: boolean;
  filterPics?: number;
  filterVolume?: number;
}): Promise<CreateTaskResponse>;

Defined in: modules/reports/index.ts:124

Создать отчёт

Метод создаёт задание на генерацию отчёта об остатках на складах WB.<br><br> Параметры groupBy и filter (группировки и фильтры) можно задать в любой комбинации — аналогично версии в личном кабинете. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `locale?`: `string`; `groupByBrand?`: `boolean`; `groupBySubject?`: `boolean`; `groupBySa?`: `boolean`; `groupByNm?`: `boolean`; `groupByBarcode?`: `boolean`; `groupBySize?`: `boolean`; `filterPics?`: `number`; `filterVolume?`: `number`; }	Query parameters
`options.locale?`	`string`	-
`options.groupByBrand?`	`boolean`	-
`options.groupBySubject?`	`boolean`	-
`options.groupBySa?`	`boolean`	-
`options.groupByNm?`	`boolean`	-
`options.groupByBarcode?`	`boolean`	-
`options.groupBySize?`	`boolean`	-
`options.filterPics?`	`number`	-
`options.filterVolume?`	`number`	-

Returns

Promise<CreateTaskResponse>

Успешно

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.general.warehouseRemains({});
console.log(result);

getTasksStatu()

getTasksStatu(task_id: string): Promise<GetTasksResponse>;

Defined in: modules/reports/index.ts:143

Проверить статус

Метод возвращает статус задания на генерацию отчёта об остатках на складах WB. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 5 секунд | 1 запрос | 5 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`task_id`	`string`	ID задания на генерацию

Returns

Promise<GetTasksResponse>

Успешно

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.general.getTasksStatu('task_id-value');
console.log(result);

getTasksDownload()

getTasksDownload(task_id: string): Promise<{
  brand?: string;
  subjectName?: string;
  vendorCode?: string;
  nmId?: number;
  barcode?: string;
  techSize?: string;
  volume?: number;
  warehouses?: {
     warehouseName?: string;
     quantity?: number;
  }[];
}[]>;

Defined in: modules/reports/index.ts:162

Получить отчёт

Метод возвращает отчёт об остатках на складах WB по ID задания на генерацию. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Parameters

Parameter	Type	Description
`task_id`	`string`	ID задания на генерацию

Returns

Promise<{ brand?: string; subjectName?: string; vendorCode?: string; nmId?: number; barcode?: string; techSize?: string; volume?: number; warehouses?: { warehouseName?: string; quantity?: number; }[]; }[]>

Успешно

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.general.getTasksDownload('task_id-value');
console.log(result);

getAnalyticsWarehouseMeasurements()

getAnalyticsWarehouseMeasurements(options?: {
  dateFrom?: string;
  dateTo: string;
  tab: "penalty" | "measurement";
  limit: number;
  offset?: number;
}): Promise<
  | Penalty
| Measurement>;

Defined in: modules/reports/index.ts:181

Занижение габаритов упаковки

Метод возвращает отчёты об удержаниях за занижение габаритов упаковки и замерах склада <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 5 запросов | 12 секунд | 1 запрос | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom?`: `string`; `dateTo`: `string`; `tab`: `"penalty"` \| `"measurement"`; `limit`: `number`; `offset?`: `number`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-
`options.tab?`	`"penalty"` \| `"measurement"`	-
`options.limit?`	`number`	-
`options.offset?`	`number`	-

Returns

Promise< | Penalty | Measurement>

Успешно

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.general.getAnalyticsWarehouseMeasurements({});
console.log(result);

getAnalyticsAntifraudDetails()

getAnalyticsAntifraudDetails(options?: {
  date?: string;
}): Promise<unknown>;

Defined in: modules/reports/index.ts:200

Самовыкупы

Метод возвращает отчёт об удержаниях за самовыкупы. Отчёт формируется каждую неделю по средам, до 7:00 по московскому времени, и содержит данные за одну неделю.<br><br> Удержание за самовыкуп — 30% от стоимости товаров.<br>Минимальная сумма всех удержаний — 100 000 ₽, если за неделю в ПВЗ привезли ваших товаров больше, чем на сумму 100 000 ₽.<br><br> Данные доступны с августа 2023. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 100 минут | 10 запросов | 10 минут | 10 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `date?`: `string`; }	Query parameters
`options.date?`	`string`	-

Returns

Promise<unknown>

Response 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

Example

const result = await sdk.general.getAnalyticsAntifraudDetails({});
console.log(result);

getAnalyticsIncorrectAttachments()

getAnalyticsIncorrectAttachments(options?: {
  dateFrom: string;
  dateTo: string;
}): Promise<unknown>;

Defined in: modules/reports/index.ts:219

Подмена товара

Метод возвращает отчёт об удержаниях за отправку ошибочных товаров, пустых коробок или коробок без товара, но с посторонними предметами. В таких случаях удерживается 100% от стоимости заказа.<br><br> Можно получить отчёт максимум за 31 день. Данные доступны с июня 2023. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 10 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-

Returns

Promise<unknown>

Response 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

Example

const result = await sdk.general.getAnalyticsIncorrectAttachments({});
console.log(result);

getAnalyticsGoodsLabeling()

getAnalyticsGoodsLabeling(options?: {
  dateFrom: string;
  dateTo: string;
}): Promise<unknown>;

Defined in: modules/reports/index.ts:238

Маркировка товара

Метод возвращает отчёт о штрафах за отсутствие обязательной маркировки товаров.<br> В отчёте представлены фотографии товаров, на которых маркировка отсутствует либо не считывается.<br><br> Можно получить данные максимум за 31 день. Данные доступны с марта 2024. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 10 минут | 10 запросов | 1 минута | 10 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-

Returns

Promise<unknown>

Response 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

Example

const result = await sdk.general.getAnalyticsGoodsLabeling({});
console.log(result);

getAnalyticsCharacteristicsChange()

getAnalyticsCharacteristicsChange(options?: {
  dateFrom: string;
  dateTo: string;
}): Promise<unknown>;

Defined in: modules/reports/index.ts:257

Смена характеристик

Метод возвращает отчёт об удержаниях за смену характеристик товара. Если товары после приёмки не соответствуют заявленным цветам и размерам, и на складе их перемаркировали с правильными характеристиками, по таким товарам назначается штраф.<br><br> Можно получить отчёт максимум за 31 день. Данные доступны с 28 декабря 2021. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 10 минут | 10 запросов | 1 минута | 10 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-

Returns

Promise<unknown>

Response 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

Example

const result = await sdk.general.getAnalyticsCharacteristicsChange({});
console.log(result);

acceptanceReport()

acceptanceReport(options?: {
  dateFrom: string;
  dateTo: string;
}): Promise<CreateTaskResponse>;

Defined in: modules/reports/index.ts:276

Создать отчёт

Метод создаёт задание на генерацию отчёта о платной приёмке.<br><br> Можно получить отчёт максимум за 31 день. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-

Returns

Promise<CreateTaskResponse>

Успешно

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.general.acceptanceReport({});
console.log(result);

getTasksStatu2()

getTasksStatu2(task_id: string): Promise<GetTasksResponse>;

Defined in: modules/reports/index.ts:295

Проверить статус

Метод возвращает статус задания на генерацию отчёта о платной приёмке. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 5 секунд | 1 запрос | 5 секунд | 1 запрос | </div>

Parameters

Parameter	Type	Description
`task_id`	`string`	ID задания на генерацию

Returns

Promise<GetTasksResponse>

Успешно

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.general.getTasksStatu('task_id-value');
console.log(result);

getTasksDownload2()

getTasksDownload2(task_id: string): Promise<{
  count?: number;
  giCreateDate?: string;
  incomeId?: number;
  nmID?: number;
  shkCreateDate?: string;
  subjectName?: string;
  total?: number;
}[]>;

Defined in: modules/reports/index.ts:314

Получить отчёт

Метод возвращает отчёт о платной приёмке по ID задания на генерацию. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Parameters

Parameter	Type	Description
`task_id`	`string`	ID задания на генерацию

Returns

Promise<{ count?: number; giCreateDate?: string; incomeId?: number; nmID?: number; shkCreateDate?: string; subjectName?: string; total?: number; }[]>

Успешно

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.general.getTasksDownload('task_id-value');
console.log(result);

paidStorage()

paidStorage(options?: {
  dateFrom: string;
  dateTo: string;
}): Promise<CreateTaskResponse>;

Defined in: modules/reports/index.ts:333

Создать отчёт

Метод создаёт задание на генерацию отчёта о платном хранении.<br><br> Можно получить отчёт максимум за 8 дней. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-

Returns

Promise<CreateTaskResponse>

Успешно

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.general.paidStorage({});
console.log(result);

getTasksStatu3()

getTasksStatu3(task_id: string): Promise<GetTasksResponse>;

Defined in: modules/reports/index.ts:352

Проверить статус

Метод возвращает статус задания на генерацию отчёта о платном хранении. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 5 секунд | 1 запрос | 5 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`task_id`	`string`	ID задания на генерацию

Returns

Promise<GetTasksResponse>

Успешно

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.general.getTasksStatu('task_id-value');
console.log(result);

getTasksDownload3()

getTasksDownload3(task_id: string): Promise<ResponsePaidStorage>;

Defined in: modules/reports/index.ts:371

Получить отчёт

Метод возвращает отчёт о платном хранении по ID задания на генерацию. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 1 запрос | </div>

Parameters

Parameter	Type	Description
`task_id`	`string`	ID задания на генерацию

Returns

Promise<ResponsePaidStorage>

Успешно

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.general.getTasksDownload('task_id-value');
console.log(result);

getAnalyticsRegionSale()

getAnalyticsRegionSale(options?: {
  dateFrom: string;
  dateTo: string;
}): Promise<unknown>;

Defined in: modules/reports/index.ts:390

Получить отчёт

Метод возвращает отчёт с данными продаж, сгруппированных по регионам стран.<br><br> Можно получить отчёт максимум за 31 день. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 10 секунд | 1 запрос | 10 секунд | 5 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-

Returns

Promise<unknown>

Response 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

Example

const result = await sdk.general.getAnalyticsRegionSale({});
console.log(result);

getBrandShareBrands()

getBrandShareBrands(): Promise<unknown>;

Defined in: modules/reports/index.ts:408

Бренды продавца

Метод возвращает список брендов продавца для отчёта о доле бренда в продажах. <br><br> Можно получить только бренды, которые: - Продавались за последние 90 дней. - Есть на складе WB. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 10 запросов | </div>

Returns

Promise<unknown>

Response 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

Example

const result = await sdk.general.getBrandShareBrands();
console.log(result);

getBrandShareParentSubjects()

getBrandShareParentSubjects(options?: {
  locale?: string;
  brand: string;
  dateFrom: string;
  dateTo: string;
}): Promise<unknown>;

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

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

Метод возвращает родительские категории бренда продавца для отчёта о доле бренда в продажах.<br><br> Можно получить отчёт максимум за 365 дней. Данные доступны с 1 ноября 2022. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 5 секунд | 1 запрос | 5 секунд | 20 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `locale?`: `string`; `brand`: `string`; `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.locale?`	`string`	-
`options.brand?`	`string`	-
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-

Returns

Promise<unknown>

Response 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

Example

const result = await sdk.general.getBrandShareParentSubjects({});
console.log(result);

getAnalyticsBrandShare()

getAnalyticsBrandShare(options?: {
  parentId: number;
  brand: string;
  dateFrom: string;
  dateTo: string;
}): Promise<unknown>;

Defined in: modules/reports/index.ts:446

Получить отчёт

Метод возвращает отчёт о доле бренда продавца в продажах. <br><br> Можно получить отчёт максимум за 365 дней. Данные доступны с 1 ноября 2022. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 5 секунд | 1 запрос | 5 секунд | 20 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `parentId`: `number`; `brand`: `string`; `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.parentId?`	`number`	-
`options.brand?`	`string`	-
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-

Returns

Promise<unknown>

Response 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

Example

const result = await sdk.general.getAnalyticsBrandShare({});
console.log(result);

getBannedProductsBlocked()

getBannedProductsBlocked(options?: {
  sort: "brand" | "nmId" | "title" | "vendorCode" | "reason";
  order: "desc" | "asc";
}): Promise<{
  report?: {
     brand?: string;
     nmId?: number;
     title?: string;
     vendorCode?: string;
     reason?: string;
  }[];
}>;

Defined in: modules/reports/index.ts:465

Заблокированные карточки

Метод возвращает список заблокированных карточек товаров продавца с причинами блокировки. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 10 секунд | 1 запрос | 10 секунд | 6 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `sort`: `"brand"` \| `"nmId"` \| `"title"` \| `"vendorCode"` \| `"reason"`; `order`: `"desc"` \| `"asc"`; }	Query parameters
`options.sort?`	`"brand"` \| `"nmId"` \| `"title"` \| `"vendorCode"` \| `"reason"`	-
`options.order?`	`"desc"` \| `"asc"`	-

Returns

Promise<{ report?: { brand?: string; nmId?: number; title?: string; vendorCode?: string; reason?: string; }[]; }>

Успешно

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.general.getBannedProductsBlocked({});
console.log(result);

getBannedProductsShadowed()

getBannedProductsShadowed(options?: {
  sort: "brand" | "nmId" | "title" | "vendorCode" | "nmRating";
  order: "desc" | "asc";
}): Promise<{
  report?: {
     brand?: string;
     nmId?: number;
     title?: string;
     vendorCode?: string;
     nmRating?: number;
  }[];
}>;

Defined in: modules/reports/index.ts:484

Скрытые из каталога

Метод возвращает список товаров продавца, скрытых из каталога. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 10 секунд | 1 запрос | 10 секунд | 6 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `sort`: `"brand"` \| `"nmId"` \| `"title"` \| `"vendorCode"` \| `"nmRating"`; `order`: `"desc"` \| `"asc"`; }	Query parameters
`options.sort?`	`"brand"` \| `"nmId"` \| `"title"` \| `"vendorCode"` \| `"nmRating"`	-
`options.order?`	`"desc"` \| `"asc"`	-

Returns

Promise<{ report?: { brand?: string; nmId?: number; title?: string; vendorCode?: string; nmRating?: number; }[]; }>

Успешно

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.general.getBannedProductsShadowed({});
console.log(result);

getAnalyticsGoodsReturn()

getAnalyticsGoodsReturn(options?: {
  dateFrom: string;
  dateTo: string;
}): Promise<{
  report?: {
     barcode?: string;
     brand?: string;
     completedDt?: string;
     dstOfficeAddress?: string;
     dstOfficeId?: number;
     expiredDt?: string;
     isStatusActive?: 0 | 1;
     nmId?: number;
     orderDt?: string;
     orderId?: number;
     readyToReturnDt?: string;
     reason?: string;
     returnType?: string;
     shkId?: number;
     srid?: string;
     status?: string;
     stickerId?: string;
     subjectName?: string;
     techSize?: string;
  }[];
}>;

Defined in: modules/reports/index.ts:503

Получить отчёт

Метод возвращает отчёт о возвратах товаров продавцу. <br><br> Можно получить отчёт максимум за 31 день. <div class="description_limit"> <a href="/openapi/api-information#tag/Vvedenie/Limity-zaprosov">Лимит запросов</a> на один аккаунт продавца: | Период | Лимит | Интервал | Всплеск | | --- | --- | --- | --- | | 1 минута | 1 запрос | 1 минута | 10 запросов | </div>

Parameters

Parameter	Type	Description
`options?`	{ `dateFrom`: `string`; `dateTo`: `string`; }	Query parameters
`options.dateFrom?`	`string`	-
`options.dateTo?`	`string`	-

Returns

Promise<{ report?: { barcode?: string; brand?: string; completedDt?: string; dstOfficeAddress?: string; dstOfficeId?: number; expiredDt?: string; isStatusActive?: 0 | 1; nmId?: number; orderDt?: string; orderId?: number; readyToReturnDt?: string; reason?: string; returnType?: string; shkId?: number; srid?: string; status?: string; stickerId?: string; subjectName?: string; techSize?: string; }[]; }>

Успешно

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.general.getAnalyticsGoodsReturn({});
console.log(result);

Class: ReportsModule ​

Constructors ​

Constructor ​

Parameters ​

Returns ​

Methods ​

getSupplierIncomes() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getSupplierStocks() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getSupplierOrders() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getSupplierSales() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

createAnalyticsExciseReport() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

warehouseRemains() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getTasksStatu() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getTasksDownload() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getAnalyticsWarehouseMeasurements() ​

Parameters ​

Returns ​

Throws ​

Throws ​

Throws ​

Throws ​

Example ​

getAnalyticsAntifraudDetails() ​

Parameters ​

Class: ReportsModule

Constructors

Constructor

Parameters

Returns

Methods

getSupplierIncomes()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getSupplierStocks()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getSupplierOrders()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getSupplierSales()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

createAnalyticsExciseReport()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

warehouseRemains()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getTasksStatu()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getTasksDownload()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getAnalyticsWarehouseMeasurements()

Parameters

Returns

Throws

Throws

Throws

Throws

Example

getAnalyticsAntifraudDetails()

Parameters