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 be changed.

Sales Geography Report

The method is available for all models.

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

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 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/reports/sales-geography/generate

Query parameters

Name

Description

format

Type: ReportFormatType

The format of the report or document.

ReportFormatType

Report format:

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

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
    "businessId": 0,
    "dateFrom": "string",
    "dateTo": "string",
    "categoryIds": [
        0
    ],
    "offerIds": [
        "string"
    ]
}

Name

Description

businessId*

Type: integer<int64>

Cabinet ID.

dateFrom*

Type: string<date>

The beginning of the period, inclusive.

dateTo*

Type: string<date>

End of the period, inclusive.

categoryIds

Type: integer<int64>[]

Category IDs.

Min items: 1

Max items: 1000

Unique items  

offerIds

Type: string[]

Product IDs.
Your SKU is the product identifier in your system.

SKU Usage Rules:

  • Each product must have its own SKU.

  • An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

What is a SKU and how to assign it

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

Min items: 1

Max items: 1000

Unique items  

Responses

200 OK

In response, you receive an identifier that allows you to find out the generation status and download the finished report.

Body

application/json
{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

result

Type: GenerateReportDTO

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

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

GenerateReportDTO

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

Name

Description

estimatedGenerationTime*

Type: integer<int64>

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.

ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

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": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

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

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

  • OK — there are no mistakes.
  • ERROR — an error occurred while processing the request.

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.