Поиск

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

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

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

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

Баланс

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

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

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

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

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

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

Responses

Response samples

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

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

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

Методы получения:

  1. Списка отчётов реализации и детализаций к отчётам по ID и за период

Список отчётов реализации{{ /api/finance/v1/sales-reports/list }}

Описание метода
Метод доступен по Персональному токену, Сервисному токену

Метод возвращает список отчётов релизации по формату таблицы отчётов.

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

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 мин 1 запрос 1 мин 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
dateFrom
required
string

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

  • 2025-06-20
  • 2025-06-20T23:59:59
  • 2025-06-20T00:00:00.12345
  • 2025-06-20T00:00:00
dateTo
required
string

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

  • 2025-06-20
  • 2025-06-20T23:59:59
  • 2025-06-20T00:00:00.12345
  • 2025-06-20T00:00:00
limit
integer <= 1000
Default: 1000

Количество отчётов в ответе

offset
integer
Default: 0

Сколько элементов пропустить. Например, для значения 10 ответ начнётся с 11 элемента

period
string
Default: weekly
Enum: daily weekly

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

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

Responses

Request samples

Content type
application/json
{
  • "dateFrom": "2026-03-17",
  • "dateTo": "2026-03-20",
  • "limit": 211,
  • "offset": 345,
  • "period": "daily"
}

Response samples

Content type
application/json
[
  • {
    }
]

Детализации к отчётам реализации по ID отчётов{{ /api/finance/v1/sales-reports/detailed/{reportId} }}

Описание метода
Метод доступен по Персональному токену, Сервисному токену

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

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

Лимит запросов на один профиль продавца:
Период Лимит Интервал Всплеск
1 мин 1 запрос 1 мин 1 запрос
Authorizations:
HeaderApiKey
path Parameters
reportId
required
integer <int64>

ID отчёта.
Для ежедневных отчётов вместо стандартной десериализации рекомендуем использовать нестандартные библиотеки с поддержкой BigInt

Request Body schema: application/json
required
limit
integer <= 100000
Default: 100000

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

rrdId
integer
Default: 0

ID строки ответа. Необходим для получения отчёта частями.
Начинайте загрузку отчёта с "rrdid":0. В последующих запросах передавайте значение rrdId из последней строки предыдущего ответа.
Повторяйте запрос, пока не получите ответ 204

fields
Array of strings

Список полей, которые вернутся в ответе. Если параметр не указан, возвращаются все поля

Responses

Request samples

Content type
application/json
{
  • "limit": 21100,
  • "rrdId": 0,
  • "fields": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Детализации к отчётам реализации за период{{ /api/finance/v1/sales-reports/detailed }}

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

Метод возвращает детализации к отчётам реализации за указанный период.

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

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 1 мин 1 запрос 1 мин 1 запрос
Сервисный 1 мин 1 запрос 1 мин 1 запрос
Базовый с секретом 1 мин 1 запрос 1 мин 1 запрос
Базовый 24 ч 2 запроса 12 ч 1 запрос
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
dateFrom
required
string

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

  • 2025-06-20
  • 2025-06-20T23:59:59
  • 2025-06-20T00:00:00.12345
  • 2025-06-20T00:00:00
dateTo
required
string

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

  • 2025-06-20
  • 2025-06-20T23:59:59
  • 2025-06-20T00:00:00.12345
  • 2025-06-20T00:00:00
limit
integer <= 100000
Default: 100000

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

rrdId
integer
Default: 0

ID строки ответа. Необходим для получения отчёта частями.
Начинайте загрузку отчёта с "rrdid":0. В последующих запросах передавайте значение rrdId из последней строки предыдущего ответа.
Повторяйте запрос, пока не получите ответ 204

period
string
Default: weekly
Enum: daily weekly

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

  • weekly — еженедельные
  • daily — ежедневные
fields
Array of strings

Список полей, которые вернутся в ответе. Если параметр не указан, возвращаются все поля

Responses

Request samples

Content type
application/json
{
  • "dateFrom": "2026-03-17",
  • "dateTo": "2026-03-20",
  • "limit": 21100,
  • "rrdId": 0,
  • "period": "daily",
  • "fields": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Документы

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

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

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

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

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

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

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

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

Лимит запросов на один профиль продавца:
Тип Период Лимит Интервал Всплеск
Персональный 10 сек 1 запрос 10 сек 5 запросов
Сервисный 10 сек 1 запрос 10 сек 5 запросов
Базовый с секретом 10 сек 1 запрос 10 сек 5 запросов
Базовый 24 ч 1 запрос 24 ч 1 запрос
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 запросов
Сервисный 10 сек 1 запрос 10 сек 5 запросов
Базовый с секретом 10 сек 1 запрос 10 сек 5 запросов
Базовый 24 ч 1 запрос 24 ч 1 запрос
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 запросов
Сервисный 10 сек 1 запрос 10 сек 5 запросов
Базовый с секретом 10 сек 1 запрос 10 сек 5 запросов
Базовый 24 ч 1 запрос 24 ч 1 запрос
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 запросов
Сервисный 5 мин 1 запрос 5 мин 5 запросов
Базовый с секретом 5 мин 1 запрос 5 мин 5 запросов
Базовый 24 ч 1 запрос 24 ч 1 запрос
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": {
    }
}