Search
API docs by Redocly

Documents and Accounting (finances)

View seller balance, financial reports, and documents.

Documents and Accounting

View seller balance, financial reports, and documents.

Balance

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

To view your current balance, use the seller balance method.

Get Seller Balance{{ /api/v1/account/balance }}

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

Balance widget data on the main page of the sellers portal.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 1 request
Service 1 min 1 request 1 min 1 request
Base with secret 1 min 1 request 1 min 1 request
Base 24 h 1 request 24 h 1 request
Authorizations:
HeaderApiKey

Responses

Response samples

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

Financial Reports

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

Methods for getting:

  1. Sales reports list and details for the reports by IDs and period
You can save the report in Google Sheets

Sales Reports List{{ /api/finance/v1/sales-reports/list }}

Описание метода
Method is available by Personal token, Service token

The method returns sales reports list in the report table format.

The list contains data since January 29, 2024.

Request limit per one seller account:
Period Limit Interval Burst
1 min 1 request 1 min 1 request
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
dateFrom
required
string

Report start date.
Date in the RFC3339 format. 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:

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

Report end date.
Date in the RFC3339 format. 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:

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

Number of reports in the response

offset
integer
Default: 0

How many results to skip. For example, with value 10, the response will start with the 11 element

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

Report periodicity:

  • 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
[
  • {
    }
]

Details for the Sales Reports by Report ID{{ /api/finance/v1/sales-reports/detailed/{reportId} }}

Описание метода
Method is available by Personal token, Service token

The method returns details for the sales reports by report IDs.

The data is available since January 29, 2024.

Request limit per one seller account:
Period Limit Interval Burst
1 min 1 request 1 min 1 request
Authorizations:
HeaderApiKey
path Parameters
reportId
required
integer <int64>

Report ID.
For daily reports, we recommend using non-standard libraries with BigInt support, instead of standard deserialization

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

Number of rows in the response

rrdId
integer
Default: 0

Response row ID. Required to get the report in parts.
Start report uploading with "rrdid":0. In subsequent requests, specify the rrdId value from the last row of the previous response.
Repeat the request until you get 204 response

fields
Array of strings

List of fields that will be returned in response. If the parameter is not specified, all fields are returned

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Details for the Sales Reports by Period{{ /api/finance/v1/sales-reports/detailed }}

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

The method returns details for the sales reports by specified period.

The data is available since January 29, 2024.

You can save the report in Google Sheets
Request limit per one seller account:
Type Period Limit Interval Burst
Personal 1 min 1 request 1 min 1 request
Service 1 min 1 request 1 min 1 request
Base with secret 1 min 1 request 1 min 1 request
Base 24 h 2 requests 12 h 1 request
Authorizations:
HeaderApiKey
Request Body schema: application/json
required
dateFrom
required
string

Report start date.
Date in the RFC3339 format. 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:

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

Report end date.
Date in the RFC3339 format. 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:

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

Number of rows in the response

rrdId
integer
Default: 0

Response row ID. Required to get the report in parts.
Start report uploading with "rrdid":0. In subsequent requests, specify the rrdId value from the last row of the previous response.
Repeat the request until you get 204 response

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

Report periodicity:

  • weekly
  • daily
fields
Array of strings

List of fields that will be returned in response. If the parameter is not specified, all fields are returned

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
[
  • {
    }
]

Documents

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

Using these methods, you can get seller documents of various categories: acts, accounting reports, offers, letters, product lists, CCDs (Correction Calculation Documents), UPDs (Universal Transfer Documents), notifications, and so on.

To work with documents, first get the lists:

  1. Of document categories
  2. Of seller documents available for download

Then you can download a single document or multiple documents from the list.

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

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

Returns documents categories

Request limit 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
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 documents list

Request limit 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
Authorizations:
HeaderApiKey
query Parameters
locale
string
Default: "en"
Example: locale=ru

category field language:

  • ru — Russian
  • en — English
  • zh — Chinese
beginTime
string <date>
Example: beginTime=2024-07-09

Period start. Only with endTime

endTime
string <date>
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 — descending
  • asc — ascending

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

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

The maximum number of response rows

offset
integer
Default: 0
Example: offset=90

From which row to start outputting data

Responses

Response samples

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

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

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

Returns one document

Request limit 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
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.

Request limit per one seller account:
Type Period Limit Interval Burst
Personal 5 min 1 request 5 min 5 requests
Service 5 min 1 request 5 min 5 requests
Base with secret 5 min 1 request 5 min 5 requests
Base 24 h 1 request 24 h 1 request
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": {
    }
}