Список документов

GET /api/v1/documents/list

База: https://documents-api.wildberries.ru · Модуль: finances · Раздел: Документы · Документация спецификации ↗

Метод возвращает список документов продавца. Вы можете получить один или несколько документов из полученного списка.

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

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

Параметры

Имя	Где	Тип	Обяз.	Описание
beginTime	query	string	нет	Начало периода. Только вместе с endTime
endTime	query	string	нет	Конец периода. Только вместе с beginTime
sort	query	string	нет	Сортировка: - date — по дате создания документа - category — по категории (только при locale=ru) Только вместе с order
order	query	string	нет	Сортировка: - desc — по убыванию - asc — по возрастанию Только вместе с sort
category	query	string	нет	ID категории документов из поля name
serviceName	query	string	нет	Уникальный ID документа
limit	query	integer<int64>	нет	Максимальное количество строк ответа
offset	query	integer<int64>	нет	После какой строки выдавать данные

Ответы

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

Структура 200:

• data object
  • documents object[] — Категории документов
    • serviceName string — Уникальный ID документа
    • name string — Название документа
    • category string — Название категории документов из поля ответа title
    • extensions string[] — Форматы документа
    • creationTime string — Дата и время создания документа
    • viewed boolean — Выгружен ли документ в личном кабинете

Структура 400:

• title string — Заголовок ошибки
• status number — HTTP статус-код
• 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 — Детали ошибки
• code string — Внутренний код ошибки
• requestId string — ID запроса
• origin string — ID внутреннего сервиса WB
• status number — HTTP статус-код
• statusText string — Расшифровка HTTP статус-кода
• timestamp string — Дата и время запроса

Структура 429:

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

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

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

Python

from wb_api_client.finances import Configuration, ApiClient
from wb_api_client.finances.api import FinancesApi

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

result = api.get_v1_documents_list(locale=..., begin_time=..., end_time=..., sort=..., order=..., category=..., service_name=..., limit=..., offset=...)
print(result)

TypeScript

import {
  Configuration,
  FinancesApi,
} from "@valeryverkhoturov/wb-api-client/finances";

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

const { data } = await api.getV1DocumentsList(locale, beginTime, endTime, sort, order, category, serviceName, limit, offset);
console.log(data);

Go

import (
	"context"
	"fmt"

	wbfinances "github.com/ValeryVerkhoturov/wb-api-client-go/finances"
)

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

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

Java

import io.github.valeryverkhoturov.wbapi.finances.ApiClient;
import io.github.valeryverkhoturov.wbapi.finances.SecretString;
import io.github.valeryverkhoturov.wbapi.finances.api.FinancesApi;

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

System.out.println(api.getV1DocumentsList(locale, beginTime, endTime, sort, order, category, serviceName, limit, offset));

PHP

use ValeryVerkhoturov\WbApiClient\Finances\Configuration;
use ValeryVerkhoturov\WbApiClient\Finances\SecretString;
use ValeryVerkhoturov\WbApiClient\Finances\Api\FinancesApi;
use GuzzleHttp\Client;

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

print_r($api->getV1DocumentsList());

OneScript

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

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

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

C#

using ValeryVerkhoturov.WbApiClient.Finances.Api;
using ValeryVerkhoturov.WbApiClient.Finances.Client;

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

Console.WriteLine(api.GetV1DocumentsList());

Rust

use wb_api_client::finances::apis::{configuration::Configuration, finances_api};

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

    let result = finances_api::get_v1_documents_list(&cfg, locale, begin_time, end_time, sort, order, category, service_name, limit, offset).await;
    println!("{:#?}", result);
}