Search
API docs by Redocly

Documents and Accounting (finances)

Managing seller's documents and financial reports

Documents and Accounting

Managing seller's documents and financial reports

Financial Reports

To access the methods, use a token for the Statistics category

Realization sales report{{ /api/v5/supplier/reportDetailByPeriod }}

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

Details to the weekly realization report. The report contains data since 29 January 2024.

If there is no data for the specified period, the method will return [].

You can save the report in Google Sheets
Maximum of 1 request per minute per one seller's account
Authorizations:
HeaderApiKey
query Parameters
dateFrom
required
string <RFC3339>

Starting date of the report.
Date format: RFC3339. You may send date or date with time. Time could be specified in seconds or milliseconds.
The time stands in Moscow time zone (UTC+3).
Examples:

  • 2019-06-20
  • 2019-06-20T23:59:59
  • 2019-06-20T00:00:00.12345
  • 2017-03-25T00:00:00

limit
integer
Default: 100000

The maximum number of report rows returned by the method. Cannot be more than 100000.

dateTo
required
string <date>

Report end date

rrdid
integer

The unique ID of the report line. Required to receive the report in parts.
Report loading must start with rrdid = 0 and on subsequent API calls, pass the rrd_id value in the request from the row line received as a result of the previous call.
Thus, to load a single report, you may need to call the API until the number of rows returned is zero.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Documents

To access the methods, use a token for the Documents category

Documents categories{{ /api/v1/documents/categories }}

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

Returns documents categories.

Maximum of 1 request per 10 seconds per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "en"
Example: locale=ru

title field language:

  • ru — Russian
  • en — English
  • zh — Chinese

Responses

Response samples

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

Documents list{{ /api/v1/documents/list }}

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

Returns seller's documents list.

Maximum of 1 request per 10 seconds per one seller's account
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "en"
Example: locale=ru

category field language:

  • ru — Russian
  • en — English
  • zh — Chinese
beginTime
number <ГГГГ-MM-ДД>
Example: beginTime=2024-07-09

Period start. Only with endTime

endTime
number <ГГГГ-MM-ДД>
Example: endTime=2024-07-15

Period end. Only with beginTime

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

Sorting:

  • date — by the document creation date
  • category — by category (only when locale=ru)

Only with order

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

Data order:

  • desc — from the latest date to the earliest, from the first to the last letter of the alphabet by category names
  • asc — from the earliest date to the latest, from the last to the first letter of the alphabet by category names

Only with sort

category
string
Example: category=redeem-notification

Document category ID from the name field

serviceName
string
Example: serviceName=redeem-notification-44841941

Unique document ID

Responses

Response samples

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

Get document{{ /api/v1/documents/download }}

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

Returns one document.

Maximum of 1 request per 10 seconds per one seller's account
Authorizations:
HeaderApiKey
query Parameters
serviceName
required
string
Example: serviceName=redeem-notification-44841941

Unique document ID

extension
required
string
Example: extension=zip

Document format

Responses

Response samples

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

Get documents{{ /api/v1/documents/download/all }}

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

Returns more than one document. You can get an unlimited number of documents.

Maximum of 1 request per 5 minutes per one seller's account
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": {
    }
}