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

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 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

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"
}

Type: object

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

401 Unauthorized

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

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

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

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json
{
  "status": "OK"
}

Type: object

pathParams: []
searchParams:
  - description: The format of the report or document.
    name: format
    in: query
    required: false
    schema:
      description: >
        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.
      type: string
      enum:
        - FILE
        - CSV
        - JSON
      default: FILE
headers: []
body: |-
  {
    "businessId": 1,
    "dateFrom": "2025-08-22",
    "dateTo": "2025-09-22",
    "categoryIds": [
      0
    ],
    "offerIds": [
      "example"
    ]
  }
schema:
  description: |
    The data required to generate the report.
  type: object
  required:
    - businessId
    - dateFrom
    - dateTo
  properties:
    businessId:
      description: "Cabinet ID. To find out, use the request [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [What is a cabinet and a store on the Market?](https://yandex.ru/support/marketplace/account/introduction.html)\n"
      type: integer
      format: int64
      minimum: 1
    dateFrom:
      type: string
      format: date
      description: |
        The beginning of the period, inclusive.

        Date format: `YYYY-MM-DD`.
      example: '2025-08-22'
    dateTo:
      type: string
      format: date
      description: |
        End of the period, inclusive.

        Date format: `YYYY-MM-DD`.
      example: '2025-09-22'
    categoryIds:
      description: Category IDs.
      type: array
      uniqueItems: true
      minItems: 1
      maxItems: 1000
      nullable: true
      items:
        type: integer
        format: int32
        minimum: 0
        exclusiveMinimum: true
    offerIds:
      description: Product IDs.
      type: array
      uniqueItems: true
      minItems: 1
      maxItems: 1000
      nullable: true
      items:
        description: "Your SKU —\_the product ID in your system.\n\nUsage rules SKU:\n\n* For each product SKU there must be one.\n\n* Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.\n\nSKU 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](https://yandex.ru/support2/marketplace/ru/assortment/operations/edit-sku).\n\n{% note warning %}\n\nSpaces at the beginning and end of the value are automatically deleted. For example, `\"  SKU123  \"` and `\"SKU123\"` they will be treated as identical values.\n\n{% endnote %}\n\n[What is SKU and how to assign it](https://yandex.ru/support/marketplace/assortment/add/index.html#fields)\n"
        type: string
        pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
        x-transform: trim
        minLength: 1
        maxLength: 255
bodyType: application/json
method: post
security:
  - type: apiKey
    name: 'Api-Key'
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/reports/sales-geography/generate
host: https://api.partner.market.yandex.ru

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