Поиск
API docs by Redocly

Документы и бухгалтерия (finances)

Узнать больше о документах и бухгалтерии можно в справочном центре

Просмотр баланса, финансовых отчётов и документов продавца.

Документы и бухгалтерия

Узнать больше о документах и бухгалтерии можно в справочном центре

Просмотр баланса, финансовых отчётов и документов продавца.

Баланс

Для доступа к методам используйте токен для категории Финансы
Узнать больше о балансе продавца можно в справочном центре

Чтобы получить текущий баланс, воспользуйтесь методом загрузки.

Получить баланс продавца{{ /api/v1/account/balance }}

Описание метода

Метод возвращает данные виджета баланса на главной странице портала продавцов.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey

Responses

Response samples

Content type
application/json
{
  • "currency": "RUB",
  • "current": 10196.21,
  • "for_withdraw": 6395.8
}

Финансовые отчёты

Для доступа к методам используйте токен для категории Статистика
Узнать больше о финансовых отчётах можно в справочном центре

Чтобы получить отчёт о продажах по реализации, воспользуйтесь методом загрузки.

Отчёт о продажах по реализации{{ /api/v5/supplier/reportDetailByPeriod }}

Описание метода

Метод возвращает детализации к отчётам реализации.

Данные доступны с 29 января 2024 года.

Вы можете выгрузить данные в Google Таблицы
Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
1 минута 1 запрос 1 минута 1 запрос
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Начальная дата отчёта.
Дата в формате RFC3339. Можно передать дату или дату со временем. Время можно указывать с точностью до секунд или миллисекунд.
Время передаётся в часовом поясе Москва (UTC+3).
Примеры:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00
dateTo
required
string <date>

Конечная дата отчёта

limit
integer <= 100000
Default: 100000

Количество строк в ответе

rrdid
integer
Default: 0

Уникальный ID строки отчёта. Необходим для получения отчёта частями.
Загрузку отчёта нужно начинать с rrdid = 0 и при последующих вызовах API передавать в запросе значение rrd_id из последней строки, полученной в результате предыдущего вызова.
Таким образом, для загрузки одного отчёта может понадобиться вызывать API до тех пор, пока в ответе не будет отдан пустой массив [].

period
string
Default: "weekly"
Enum: "weekly" "daily"

Периодичность отчёта:

  • weekly — еженедельный
  • daily — ежедневный

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Документы

Для доступа к методам используйте токен для категории Документы

С помощью этих методов вы можете получить документы продавца различных категорий: акты, бухгалтерские отчёты, оферты, письма, списки товаров, УКД, УПД, уведомления и так далее.

Для работы с документами получите списки:

  1. Категорий документов
  2. Документов продавца, доступных для загрузки

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

Категории документов{{ /api/v1/documents/categories }}

Описание метода

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 1 запрос 10 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "en"
Example: locale=ru

Язык поля title:

  • ru — русский
  • en — английский
  • zh — китайский

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Список документов{{ /api/v1/documents/list }}

Описание метода

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 1 запрос 10 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "en"
Example: locale=ru

Язык поля category:

  • ru — русский
  • en — английский
  • zh — китайский
beginTime
string <date>
Example: beginTime=2024-07-09

Начало периода. Только вместе с endTime

endTime
string <date>
Example: endTime=2024-07-15

Конец периода. Только вместе с beginTime

sort
string
Default: "date"
Enum: "date" "category"
Example: sort=category

Сортировка:

  • date — по дате создания документа
  • category — по категории (только при locale=ru)

Только вместе с order

order
string
Default: "desc"
Enum: "desc" "asc"
Example: order=asc

Сортировка:

  • desc — по убыванию
  • asc — по возрастанию

Только вместе с sort

category
string
Example: category=redeem-notification
serviceName
string
Example: serviceName=redeem-notification-44841941

Уникальный ID документа

limit
integer <= 50
Default: 50
Example: limit=10

Максимальное количество строк ответа

offset
integer
Default: 0
Example: offset=90

После какой строки выдавать данные

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить документ{{ /api/v1/documents/download }}

Описание метода

Метод загружает один документ из списка документов продавца.

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
10 секунд 1 запрос 10 секунд 5 запросов
Authorizations:
HeaderApiKey
query Parameters
serviceName
required
string
Example: serviceName=redeem-notification-44841941

Уникальный ID документа

extension
required
string
Example: extension=zip

Формат документа

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Получить документы{{ /api/v1/documents/download/all }}

Описание метода

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

Лимит запросов на один аккаунт продавца:
Период Лимит Интервал Всплеск
5 минут 1 запрос 5 минут 5 запросов
Authorizations:
HeaderApiKey
Request Body schema: application/json
Array of objects [ 1 .. 50 ] items

Responses

Request samples

Content type
application/json
{
  • "params": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}