--- title: "Documents List" description: "Returns seller documents list" lang: en-US source: https://valeryverkhoturov.github.io/wb-api-client-docs/en/reference/api/finances/get-api-v1-documents-list --- # Documents List ```http GET /api/v1/documents/list ``` **Base URL:** `https://documents-api.wildberries.ru` · **Module:** [`finances`](https://valeryverkhoturov.github.io/wb-api-client-docs/en/reference/api/finances/) · **Section:** Documents · [Specification doc ↗](https://dev.wildberries.ru/en/docs/openapi/documents-and-accounting#tag/documents/operation/getV1DocumentsList) Returns seller documents list [Request limit](https://dev.wildberries.ru/openapi/api-information#tag/introduction/Rate-Limits) per one seller account: | Type | Period | Limit | Interval | Burst | | ---------------- | ------ | --------- | -------- | ---------- | | Personal | 10 s | 1 request | 10 s | 5 requests | | Service | 10 s | 1 request | 10 s | 5 requests | | Base with secret | 10 s | 1 request | 10 s | 5 requests | | Base | 24 h | 1 request | 24 h | 1 request | ## Parameters | Name | In | Type | Req. | Description | | ------------- | ----- | ---------------- | ---- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | | `beginTime` | query | `string` | no | Period start. Only with `endTime` | | `endTime` | query | `string` | no | Period end. Only with `beginTime` | | `sort` | query | `string` | no | Sorting: - `date` — by the document creation date - `category` — by category (only when `locale=ru`) Only with `order` | | `order` | query | `string` | no | Data order: - `desc` — descending - `asc` — ascending Only with `sort` | | `category` | query | `string` | no | [Document category](https://dev.wildberries.ru/openapi/documents-and-accounting#tag/documents/operation/getV1DocumentsCategories) ID from the `name` field | | `serviceName` | query | `string` | no | Unique document ID | | `limit` | query | `integer` | no | The maximum number of response rows | | `offset` | query | `integer` | no | From which row to start outputting data | ## Responses | Code | Description | Schema | | ----- | ----------------- | --------- | | `200` | Success | `GetList` | | `400` | Bad request | `object` | | `401` | Unauthorized | `object` | | `402` | Payment required | `object` | | `403` | Access denied | `object` | | `429` | Too many requests | `object` | **Structure `200`:** - `data` `object` - `documents` `object[]` — Documents categories - `serviceName` `string` — Unique document ID - `name` `string` — Document name - `category` `string` — [Document category](https://dev.wildberries.ru/openapi/documents-and-accounting#tag/documents/operation/getV1DocumentsCategories) name from the response field `title` - `extensions` `string[]` — Document formats - `creationTime` `string` — Date and time of document creation - `viewed` `boolean` — Whether the document has been downloaded from the personal account **Structure `400`:** - `title` `string` — Error title - `status` `number` — HTTP status code - `detail` `string` — Error details - `requestId` `string` — Unique request ID - `origin` `string` — WB internal service ID **Structure `401`:** - `title` `string` — Error title - `detail` `string` — Error details - `code` `string` — Internal error code - `requestId` `string` — Unique request ID - `origin` `string` — WB internal service ID - `status` `number` — HTTP status code - `statusText` `string` — Text of the HTTP status code - `timestamp` `string` — Request date and time **Structure `402`:** - `title` `string` — Error title - `detail` `string` — Error details. The error is only returned to services from the [Solutions for business Catalog](https://dev.wildberries.ru/business-solutions) **Structure `403`:** - `title` `string` — Error title - `detail` `string` — Error details - `code` `string` — Internal error code - `requestId` `string` — Request ID - `origin` `string` — WB internal service ID - `status` `number` — HTTP status code - `statusText` `string` — Text of the HTTP status code - `timestamp` `string` — Request date and time **Structure `429`:** - `title` `string` — Error title - `detail` `string` — Error details - `code` `string` — Internal error code - `requestId` `string` — Unique request ID - `origin` `string` — WB internal service ID - `status` `number` — HTTP status code - `statusText` `string` — Text of the HTTP status code - `timestamp` `string` — Request date and time ## Call examples Arguments are shown as parameter names — substitute your own values. Languages whose client does not expose this operation are omitted. **Python** ```python from wb_api_client.finances import Configuration, ApiClient from wb_api_client.finances.api import FinancesApi cfg = Configuration(access_token="") 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** ```ts import { Configuration, FinancesApi, } from "@valeryverkhoturov/wb-api-client/finances"; const cfg = new Configuration({}); cfg.setAccessToken(""); const api = new FinancesApi(cfg); const { data } = await api.getV1DocumentsList(locale, beginTime, endTime, sort, order, category, serviceName, limit, offset); console.log(data); ``` **Go** ```go import ( "context" "fmt" wbfinances "github.com/ValeryVerkhoturov/wb-api-client-go/finances" ) cfg := wbfinances.NewConfiguration() cfg.SetAccessToken("") client := wbfinances.NewAPIClient(cfg) result, _, err := client.FinancesAPI.GetV1DocumentsList(context.Background()).Execute() if err != nil { panic(err) } fmt.Printf("%+v\n", result) ``` **Java** ```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("")); FinancesApi api = new FinancesApi(client); System.out.println(api.getV1DocumentsList(locale, beginTime, endTime, sort, order, category, serviceName, limit, offset)); ``` **PHP** ```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('')); $api = new FinancesApi(new Client(), $config); print_r($api->getV1DocumentsList()); ``` **OneScript** ```bsl #Использовать "wb-api-client" Настройки = Новый Конфигурация(); Настройки.УстановитьТокен(""); Клиент = Новый FinancesApi(Настройки); Сообщить(Клиент.GetV1DocumentsList().Тело); ``` **C#** ```csharp using ValeryVerkhoturov.WbApiClient.Finances.Api; using ValeryVerkhoturov.WbApiClient.Finances.Client; var config = new Configuration(); config.AccessTokenSecret = new SecretString(""); var api = new FinancesApi(config); Console.WriteLine(api.GetV1DocumentsList()); ``` **Rust** ```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(""); let result = finances_api::get_v1_documents_list(&cfg, locale, begin_time, end_time, sort, order, category, service_name, limit, offset).await; println!("{:#?}", result); } ```