报告的结构及内容如有更改,恕不另行通知。
例如,可以添加新列或更改工作表的名称。
销售地理报告
方法适用于所有模式.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
- finance-and-accounting — 查看财务信息和报告
- all-methods — 全面管理账户
开始生成有关销售地理的报告。 这是什么报告
您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/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/v2/reports/sales-geography/generate
Query parameters
|
Name |
Description |
|
format |
Type: ReportFormatType 报告或文档的格式。 |
ReportFormatType
报告格式:
FILE— 电子表格文件(XLSX).CSV— 每个报告表都有一个包含CSV文件的ZIP存档。JSON— 每个报告表都有一个带有JSON文件的ZIP压缩包.
|
Type |
Description |
|
Default: Enum: |
Body
application/json
{
"businessId": 0,
"dateFrom": "string",
"dateTo": "string",
"categoryIds": [
0
],
"offerIds": [
"string"
]
}
|
Name |
Description |
|
businessId* |
Type: integer<int64> 内阁ID。 |
|
dateFrom* |
Type: string<date> 期的开始,包括在内。 |
|
dateTo* |
Type: string<date> 期结束,包括在内。 |
|
categoryIds |
Type: integer<int32>[] 类别Id。 Min value (exclusive): Min items: Max items: Unique items |
|
offerIds |
Type: string[] 产品Id。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: Min items: Max items: Unique items |
Responses
200 OK
作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
|
result |
Type: GenerateReportDTO 跟踪生成状态和接收完成的报告或文档所需的ID。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
GenerateReportDTO
跟踪生成状态和接收完成的报告或文档所需的ID。
|
Name |
Description |
|
estimatedGenerationTime* |
Type: integer<int64> 以毫秒为单位的预期生成时间。 |
|
reportId* |
Type: string 跟踪生成状态和接收完成的报告或文档所需的ID。 |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
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: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.