API docs by Redocly

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

Управление документами продавца

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

Управление документами продавца

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

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

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

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

Возвращает детализацию к еженедельному отчёту реализации. Доступны данные, начиная с 29 января 2024 года.

Если нет данных за указанный период, метод вернет []

Вы можете сохранить статистику в Google Таблицах
Максимум 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

limit
integer
Default: 100000

Максимальное количество строк отчета, возвращаемых методом. Не может быть более 100000.

dateTo
required
string <date>

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

rrdid
integer

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Документы

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

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

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

Возвращает категории документов.

Максимум 1 запрос в 10 секунд на один аккаунт продавца
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 }}

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

Возвращает список документов продавца.

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

Язык поля category:

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

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

endTime
number <ГГГГ-MM-ДД>
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 документа

Responses

Response samples

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

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

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

Возвращает один документ.

Максимум 1 запрос в 10 секунд на один аккаунт продавца
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 }}

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

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

Максимум 1 запрос в 5 минут на один аккаунт продавца
Authorizations:
HeaderApiKey
Request Body schema: application/json
Array of objects

Responses

Request samples

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

Response samples

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