报告的结构及内容如有更改,恕不另行通知。

例如,可以添加新列或更改工作表的名称。

营业额报告

方法适用于模式FBY.

如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一

开始生成指定日期的营业额报告。 这是什么报告

您可以使用请求查找生成状态并获取指向已完成报告的链接。 GET v2/reports/info/{reportId}.

报告列说明:

表单Все категории(文件turnover

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

WAREHOUSE_NAME

warehouseName

Склад Маркета

string

MACROREGION_NAME

macroregionName

Кластер

string

CATEGORY

category

Категория

string

SHOP_SKU

shopSku

Ваш SKU

string

MARKET_SKU

marketSku

SKU на Маркете

integer

OFFER_NAME

offerName

Название товара

string

LENGTH

length

Длина, мм

integer

WIDTH

width

Ширина, мм

integer

HEIGHT

height

Высота, мм

integer

VOLUME

volume

Объём, л

number

TURNOVER

turnover

Оборачиваемость

string

MARKET_RECOMMENDATION

marketRecommendation

Рекомендация Маркета

string

AVG_SOLD_VOLUME

avgSoldVolume

Среднесуточный объём проданных товаров, л

number

AVG_SOLD_ITEMS

avgSoldItems

Среднесуточное количество проданных товаров, шт.

number

AVG_SOLD_VOLUME_ON_STOCK

avgSoldVolumeOnStock

Среднесуточный объём товаров на складе, л

number

ITEMS_ON_STOCK

itemsOnStock

Остаток на последний день периода, шт.

integer

AMOUNT

amount

Стоимость платного хранения.*

number

表单Льготное хранение(文件preferential_categories_turnover

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

WAREHOUSE_NAME

warehouseName

Склад Маркета

string

MACROREGION_NAME

macroregionName

Кластер

string

CATEGORY

category

Категория

string

SHOP_SKU

shopSku

Ваш SKU

string

MARKET_SKU

marketSku

SKU на Маркете

integer

OFFER_NAME

offerName

Название товара

string

LENGTH

length

Длина, мм

integer

WIDTH

width

Ширина, мм

integer

HEIGHT

height

Высота, мм

integer

VOLUME

volume

Объём, л

number

TURNOVER

turnover

Оборачиваемость

number

MARKET_RECOMMENDATION

marketRecommendation

Рекомендация Маркета

string

AVG_SOLD_VOLUME

avgSoldVolume

Среднесуточный объём проданных товаров, л

number

AVG_SOLD_ITEMS

avgSoldItems

Среднесуточное количество проданных товаров, шт.

number

AVG_SOLD_VOLUME_ON_STOCK

avgSoldVolumeOnStock

Среднесуточный объём товаров на складе, л

number

ITEMS_ON_STOCK

itemsOnStock

Остаток на последний день периода, шт.

integer

AMOUNT

amount

Стоимость платного хранения.*

number

⚙️ 限制: 每小时100个请求

Request

POST

https://api.partner.market.yandex.ru/v2/reports/goods-turnover/generate

Query parameters

Name

Description

format

Type: ReportFormatType

报告或文档的格式。

ReportFormatType

报告格式:

  • FILE — 电子表格文件(XLSX).
  • CSV — 每个报告表都有一个包含CSV文件的ZIP存档。
  • JSON — 每个报告表都有一个带有JSON文件的ZIP压缩包.

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
    "campaignId": 0,
    "date": "string"
}

Name

Description

campaignId*

Type: integer<int64>

活动ID。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:

  • 运动ID;
  • 标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。

date

Type: string<date>

需要计算营业额的日期。 如果省略该参数,则使用当前日期。

Responses

200 OK

作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。

Body

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

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Enum: OK, ERROR

result

Type: GenerateReportDTO

跟踪生成状态和接收完成的报告或文档所需的ID。

ApiResponseStatusType

响应的类型。 可能的值:

  • OK — 没有错误。
  • ERROR — 处理请求时出错。

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

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