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

POST /api/v2/nm-report/downloads

База: https://seller-analytics-api.wildberries.ru · Модуль: analytics · Раздел: Аналитика продавца CSV · Документация спецификации ↗

Метод создаёт задание на генерацию отчёта с расширенной аналитикой продавца.

Вы можете создать CSV-версии отчётов по воронке продаж или параметрам поиска с группировкой по: * артикулам WB * предметам, брендам и ярлыкам В отчётах по воронке продаж можно группировать данные по дням, неделям или месяцам.

Также можете создать CSV-версии отчётов по текстам поисковых запросов и остаткам.

Каждый новый отчёт должен иметь уникальный ID.

Не используйте одинаковые ID для разных отчётов — это может привести к ошибкам при генерации

Набор параметров запроса в объекте params зависит от типа отчёта. Чтобы получить описание параметров, выберите тип отчёта в раскрывающемся списке в описании параметра reportType.

Параметры includeSubstitutedSKUs и includeSearchTexts не могут одновременно иметь значение false.

Если не удалось получить отчёт, можно создать повторное задание на генерацию. Также можно получить список и проверить статусы отчётов.

Данные отчётов обновляются 1 раз в 2 часа.

Отчёты по остаткам — типы STOCK_HISTORY_REPORT_CSV и STOCK_HISTORY_DAILY_CSV — можно создать без подписки Джем

Лимит запросов на один профиль продавца:

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

Тело запроса

application/json — схема object, необязательно

• один из вариантов: SalesFunnelItemReq, SalesFunnelGroupReq, SearchReportGroupReq, SearchReportItemReq, SearchReportTextReq, InventoryMetricsReportReq, InventoryHistoryReportReq

Ответы

Код	Описание	Схема
200	Успешно	NmReportCreateReportResponse
400	Неправильный запрос	PostV2NmReportDownloadsResponse400
401	Не авторизован	object
402	Требуется платёж	object
403	Доступ запрещён	ErrorObject
429	Слишком много запросов	object

Структура 200:

• data string — Уведомление, что началась генерация отчёта

Структура 400:

• title string — Заголовок ошибки
• detail string — Детали ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB

Структура 401:

• title string — Заголовок ошибки
• detail string — Детали ошибки
• code string — Внутренний код ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB
• status number — HTTP статус-код
• statusText string — Расшифровка HTTP статус-кода
• timestamp string — Дата и время запроса

Структура 402:

• title string — Заголовок ошибки
• detail string — Детали ошибки. Ошибка возвращается только сервисам из Каталога решений для бизнеса

Структура 403:

• title string — Заголовок ошибки
• detail string — Детали ошибки
• requestId string — Уникальный ID запроса
• origin string — ID внутреннего сервиса WB

Структура 429:

• один из вариантов: response429Download, response429DownloadDaily

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

Аргументы показаны именами параметров — подставьте свои значения. Языки, в клиенте которых этой операции нет, не показаны.

Python

from wb_api_client.analytics import Configuration, ApiClient
from wb_api_client.analytics.api import AnalyticsApi

cfg = Configuration(access_token="<ваш JWT WB>")
api = AnalyticsApi(ApiClient(cfg))

result = api.post_v2_nm_report_downloads(post_v2_nm_report_downloads_request=...)
print(result)

TypeScript

import {
  Configuration,
  AnalyticsApi,
} from "@valeryverkhoturov/wb-api-client/analytics";

const cfg = new Configuration({});
cfg.setAccessToken("<ваш JWT WB>");
const api = new AnalyticsApi(cfg);

const { data } = await api.postV2NmReportDownloads(postV2NmReportDownloadsRequest);
console.log(data);

Go

import (
	"context"
	"fmt"

	wbanalytics "github.com/ValeryVerkhoturov/wb-api-client-go/analytics"
)

cfg := wbanalytics.NewConfiguration()
cfg.SetAccessToken("<ваш JWT WB>")
client := wbanalytics.NewAPIClient(cfg)

result, _, err := client.AnalyticsAPI.PostV2NmReportDownloads(context.Background()).Execute()
if err != nil {
    panic(err)
}
fmt.Printf("%+v\n", result)

Java

import io.github.valeryverkhoturov.wbapi.analytics.ApiClient;
import io.github.valeryverkhoturov.wbapi.analytics.SecretString;
import io.github.valeryverkhoturov.wbapi.analytics.api.AnalyticsApi;

ApiClient client = new ApiClient();
client.setAccessToken(new SecretString("<ваш JWT WB>"));
AnalyticsApi api = new AnalyticsApi(client);

System.out.println(api.postV2NmReportDownloads(postV2NmReportDownloadsRequest));

PHP

use ValeryVerkhoturov\WbApiClient\Analytics\Configuration;
use ValeryVerkhoturov\WbApiClient\Analytics\SecretString;
use ValeryVerkhoturov\WbApiClient\Analytics\Api\AnalyticsApi;
use GuzzleHttp\Client;

$config = (new Configuration())
    ->setAccessTokenSecret(new SecretString('<ваш JWT WB>'));
$api = new AnalyticsApi(new Client(), $config);

print_r($api->postV2NmReportDownloads());

OneScript

#Использовать "wb-api-client"

Настройки = Новый Конфигурация();
Настройки.УстановитьТокен("<ваш JWT WB>");
Клиент = Новый AnalyticsApi(Настройки);

Сообщить(Клиент.PostV2NmReportDownloads(Тело).Тело);

C#

using ValeryVerkhoturov.WbApiClient.Analytics.Api;
using ValeryVerkhoturov.WbApiClient.Analytics.Client;

var config = new Configuration();
config.AccessTokenSecret = new SecretString("<ваш JWT WB>");
var api = new AnalyticsApi(config);

Console.WriteLine(api.PostV2NmReportDownloads());

Rust

use wb_api_client::analytics::apis::{configuration::Configuration, analytics_api};

#[tokio::main]
async fn main() {
    let mut cfg = Configuration::new();
    cfg.set_access_token("<ваш JWT WB>");

    let result = analytics_api::post_v2_nm_report_downloads(&cfg, post_v2_nm_report_downloads_request).await;
    println!("{:#?}", result);
}