Структура и содержание отчетов могут изменяться без предварительного уведомления

Например, может добавиться новая колонка или поменяться название листа.

Отчет по географии продаж

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Запускает генерацию отчета по географии продаж. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.

Пояснение к колонкам отчета:

Лист География продаж (файл sales_geography)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

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
⚙️ Лимит: 100 запросов в час

Request

POST

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

Query parameters

Name

Description

format

Type: ReportFormatType

Формат отчета или документа.

ReportFormatType

Формат отчета:

  • FILE — файл с электронной таблицей (XLSX).
  • CSV — ZIP-архив с CSV-файлами на каждый лист отчета.
  • JSON — ZIP-архив с JSON-файлами на каждый лист отчета.

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>

Идентификатор кабинета.

dateFrom*

Type: string<date>

Начало периода, включительно.

dateTo*

Type: string<date>

Конец периода, включительно.

categoryIds

Type: integer<int64>[]

Идентификаторы категорий.

Min items: 1

Max items: 1000

Unique items  

offerIds

Type: string[]

Идентификаторы товаров.
Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Что такое SKU и как его назначать

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

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.

Body

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

Name

Description

result

Type: GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

Name

Description

estimatedGenerationTime*

Type: integer<int64>

Ожидаемая продолжительность генерации в миллисекундах.

reportId*

Type: string

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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

Предыдущая
Отчет по бусту продаж
Следующая
Отчет по движению товаров (FBY)