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

GET /api/v1/documents/list

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

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

Тип	Период	Лимит	Интервал	Всплеск
Персональный	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	нет	Максимальное количество строк ответа
offset	query	integer	нет	После какой строки выдавать данные

Ответ: GetList

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

PythonNode.jsGoPHPRust

import os
from wildberries_sdk import finances

token = os.getenv("WB_API_TOKEN")
api = finances.DefaultApi(
    finances.ApiClient(finances.Configuration(api_key={"HeaderApiKey": token}))
)
result = api.api_v1_documents_list_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.apiV1DocumentsListGet();
console.log(result);

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

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

use wildberries_sdk_finances::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_documents_list_get(&config).await?;