Перейти к содержанию

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

GET /api/v1/warehouse_remains

Метод создаёт задание на генерацию отчёта об остатках на складах WB.

Параметры groupBy и filter (группировки и фильтры) можно задать в любой комбинации — аналогично версии в личном кабинете.

Лимит запросов на один аккаунт продавца:

Тип Период Лимит Интервал Всплеск
Персональный 1 мин 1 запрос 1 мин 5 запросов
Сервисный 1 мин 1 запрос 1 мин 5 запросов
Базовый с секретом 1 мин 1 запрос 1 мин 5 запросов
Базовый 1 ч 4 запроса 15 мин 1 запрос

Параметры

Имя Расположение Тип Обязательный Описание
locale query string нет Язык полей ответа subjectName и warehouseName: - ru — русский - en — английский - zh — китайский. Значения warehouseName на английском
groupByBrand query boolean нет Разбивка по брендам
groupBySubject query boolean нет Разбивка по предметам
groupBySa query boolean нет Разбивка по артикулам продавца
groupByNm query boolean нет Разбивка по артикулам WB. Если groupByNm=true, в ответе будет поле volume
groupByBarcode query boolean нет Разбивка по баркодам
groupBySize query boolean нет Разбивка по размерам
filterPics query integer нет Фильтр по фото: - -1 — без фото - 0 — не применять фильтр - 1 — с фото
filterVolume query integer нет Фильтр по объёму: - -1 — без габаритов - 0 — не применять фильтр - 3 — свыше трёх литров

Ответ: CreateTaskResponse

Примеры вызова

import os
from wildberries_sdk import reports

token = os.getenv("WB_API_TOKEN")
api = reports.DefaultApi(
    reports.ApiClient(reports.Configuration(api_key={"HeaderApiKey": token}))
)
result = api.api_v1_warehouse_remains_get()
print(result)

import { Configuration, DefaultApi } from 'wildberries-sdk';

const api = new DefaultApi(new Configuration({ apiKey: process.env.WB_API_TOKEN }));
const result = await api.apiV1WarehouseRemainsGet();
console.log(result);

cfg := reports.NewConfiguration()
cfg.AddDefaultHeader("Authorization", os.Getenv("WB_API_TOKEN"))
client := reports.NewAPIClient(cfg)
result, _, err := client.DefaultApi.ApiV1WarehouseRemainsGet(context.Background()).Execute()

<?php
$config = Wildberries\Sdk\Reports\Configuration::getDefaultConfiguration()
    ->setApiKey('Authorization', getenv('WB_API_TOKEN'));
$api = new Wildberries\Sdk\Reports\Api\DefaultApi(new GuzzleHttp\Client(), $config);
$result = $api->apiV1WarehouseRemainsGet();

use wildberries_sdk_reports::apis::{configuration::Configuration, configuration::ApiKey, default_api};

let mut config = Configuration::new();
config.api_key = Some(ApiKey { prefix: None, key: std::env::var("WB_API_TOKEN").unwrap() });
let result = default_api::api_v1_warehouse_remains_get(&config).await?;