报告的结构及内容如有更改,恕不另行通知。
例如,可以添加新列或更改工作表的名称。
价格报告
方法适用于所有模式.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
开始生成"价格"报告。
将返回哪些信息:
- 如果通过
businessId— 以相同的内阁价格; - 如果[商店价格包括在内](*onlyDefaultPrice-false) 并指定
campaignId— 根据相应商店的价格。
您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.
报告列说明:
表单Список товаров(文件business_prices)
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
ERRORS |
errors |
Критичные ошибки |
string |
|
WARNINGS |
warnings |
Некритичные ошибки |
string |
|
OFFER_ID |
offerId |
Ваш SKU |
string |
|
OFFER_NAME |
offerName |
Название товара |
string |
|
BASIC_PRICE |
basicPrice |
Цена |
integer |
|
BASIC_DISCOUNT_BASE |
basicDiscountBase |
Зачёркнутая цена |
integer |
|
CURRENCY |
currency |
Валюта |
string |
|
MINIMUM_FOR_BESTSELLER |
minimumForBestseller |
Минимум для акции |
integer |
|
COST_PRICE |
costPrice |
Себестоимость |
integer |
|
ADDITIONAL_EXPENSES |
additionalExpenses |
Дополнительные расходы |
integer |
|
ON_DISPLAY |
onDisplay |
На витрине |
string |
|
PRICE_GREEN_THRESHOLD |
priceGreenThreshold |
Порог для выгодной цены |
integer |
|
PRICE_RED_THRESHOLD |
priceRedThreshold |
Порог для умеренно привлекательной цены |
integer |
|
MINIMUM_PRICE_ON_MARKETPLACES |
minimumPriceOnMarketplaces |
Минимальная на рынке |
integer |
|
MARKETPLACE_WITH_BEST_PRICE_WITHOUT_MARKET |
marketplaceWithBestPriceWithoutMarket |
Площадка с лучшей ценой (без учёта Маркета) |
string |
|
PRICE_VALUE_OUTSIDE_MARKET |
priceValueOutsideMarket |
Цена на этой площадке |
integer |
|
SHOP_WITH_BEST_PRICE_ON_MARKET |
shopWithBestPriceOnMarket |
Магазин с лучшей ценой на Маркете |
string |
|
PRICE_VALUE_ON_MARKET |
priceValueOnMarket |
Цена в этом магазине |
integer |
报告列说明:
表单Список товаров(文件shop_prices)
|
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
|
ERRORS |
errors |
Критичные ошибки |
string |
|
WARNINGS |
warnings |
Некритичные ошибки |
string |
|
OFFER_ID |
offerId |
Ваш SKU |
string |
|
OFFER_NAME |
offerName |
Название товара |
string |
|
SHOP_PRICE |
shopPrice |
Цена в магазине |
integer |
|
SHOP_DISCOUNT_BASE |
shopDiscountBase |
Зачёркнутая цена в магазине |
integer |
|
CURRENCY |
currency |
Валюта |
string |
|
VAT |
vat |
НДС |
string |
|
HIDE_FROM_DISPLAY |
hideFromDisplay |
Скрыть с витрины |
string |
|
BASIC_PRICE |
basicPrice |
Цена |
integer |
|
BASIC_DISCOUNT_BASE |
basicDiscountBase |
Зачёркнутая цена |
integer |
|
ON_DISPLAY |
onDisplay |
На витрине |
string |
|
PRICE_GREEN_THRESHOLD |
priceGreenThreshold |
Порог для выгодной цены |
integer |
|
PRICE_RED_THRESHOLD |
priceRedThreshold |
Порог для умеренно привлекательной цены |
integer |
|
MINIMUM_PRICE_ON_MARKETPLACES |
minimumPriceOnMarketplaces |
Минимальная на рынке |
integer |
|
MARKETPLACE_WITH_BEST_PRICE_WITHOUT_MARKET |
marketplaceWithBestPriceWithoutMarket |
Площадка с лучшей ценой (без учёта Маркета) |
string |
|
PRICE_VALUE_OUTSIDE_MARKET |
priceValueOutsideMarket |
Цена на этой площадке |
integer |
|
SHOP_WITH_BEST_PRICE_ON_MARKET |
shopWithBestPriceOnMarket |
Магазин с лучшей ценой на Маркете |
string |
|
PRICE_VALUE_ON_MARKET |
priceValueOnMarket |
Цена в этом магазине |
integer |
| ⚙️ 限制: 每小时100个请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/goods-prices/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,
"categoryIds": [
0
],
"campaignId": 0
}
|
Name |
Description |
|
businessId |
Type: integer<int64> 内阁ID。 在大多数情况下需要。 如果指定,则省略 |
|
campaignId |
Type: integer<int64> 活动ID。 只有在橱柜中有独特价格的商店并且您希望收到他们的报告时才发送它。 在这种情况下,发送 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。 |
|
categoryIds |
Type: integer<int32>[] 在市场上按类别过滤。 Min value (exclusive): Min 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.
[*onlyDefaultPrice-false]:在方法 POST v2/businesses/{businessId}/settings 参数返回 只有价格 与值 错误.