The structure and content of the reports are subject to change without prior notice.

For example, a new column may be added or the name of the sheet may change.

Sales Geography Report

Info

Console

The method is available for models: FBY, FBS, Express and DBS.

If you are using an API Key token, one of the accesses in the list is required to call the method

finance-and-accounting — View financial data and reports
all-methods — Full account management

Starts the generation of a report on the geography of sales. What kind of report is this

You can find out the generation status and get a link to the finished report using a request. GET v2/reports/info/{reportId}.

Explanation of the report columns:

Sheet География продаж (file sales_geography)

CSV column name	JSON column name	XLSX column name	Value type
OFFER_ID	offerId	Информация о товарах/Ваш SKU	string
OFFER_NAME	offerName	Информация о товарах/Название товара	string
CATEGORY	category	Информация о товарах/Категория	string
EXPENSES_ON_DELIVERY_IN_RUSSIA	expensesOnDeliveryInRussia	Доля локальных продаж и ваши расходы/Расходы на доставку по России	number
LOCAL_SALES	localSales	Доля локальных продаж и ваши расходы/Локальных продаж	integer
DELIVERED_ITEMS	deliveredItems	Доля локальных продаж и ваши расходы/Товаров доставлено	integer
CLUSTER_MOSCOW	clusterMoscow	Сколько товаров доставлено в конкретные кластеры/Москва	integer
CLUSTER_ROSTOV_ON_DON	clusterRostovOnDon	Сколько товаров доставлено в конкретные кластеры/Ростов-на-Дону	integer
CLUSTER_EKATERINBURG	clusterEkaterinburg	Сколько товаров доставлено в конкретные кластеры/Екатеринбург	integer
CLUSTER_SAINT_PETERSBURG	clusterSaintPetersburg	Сколько товаров доставлено в конкретные кластеры/Санкт-Петербург	integer
CLUSTER_SAMARA	clusterSamara	Сколько товаров доставлено в конкретные кластеры/Самара	integer

⚙️ Limit: 100 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/reports/sales-geography/generate

Query parameters

Name

Description

format

Type: string

The format of the report or document. Report format:

FILE — the spreadsheet file (XLSX).
CSV — A ZIP archive with CSV files for each report sheet.
JSON — A ZIP archive with JSON files for each report sheet.

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json

{
  "businessId": 1,
  "dateFrom": "2025-08-22",
  "dateTo": "2025-09-22",
  "categoryIds": [
    0
  ],
  "offerIds": [
    "example"
  ]
}

Name	Description
businessId	Type: integer Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market? Min value: `1`
dateFrom	Type: string<date> The beginning of the period, inclusive. Date format: `YYYY-MM-DD`. Example: `2025-08-22`
dateTo	Type: string<date> End of the period, inclusive. Date format: `YYYY-MM-DD`. Example: `2025-09-22`
categoryIds	Type: integer[] \| null Category IDs. Min items: `1` Max items: `1000` Unique items: `true` Example `[ 0 ]`
offerIds	Type: string[] \| null Product IDs. Min items: `1` Max items: `1000` Unique items: `true` Example `[ "example" ]`

Responses

200 OK

An identifier is sent in response, which allows you to find out the generation status and download the finished report.

Body

application/json

{
  "status": "OK",
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

Type: object

All of 2 types

Type: object
status

Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

estimatedGenerationTime

Type: integer

Expected generation time in milliseconds.

reportId

Type: string

The ID that will be needed to track the generation status and receive the finished report or document.

Example: example

The ID that will be needed to track the generation status and receive the finished report or document.

Example

{
  "reportId": "example",
  "estimatedGenerationTime": 0
}

Example

{
  "result": {
    "reportId": "example",
    "estimatedGenerationTime": 0
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Was the article helpful?

Sales Analytics Report

Report on key indicators