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

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

仓库余额报告

方法适用于模式：FBY, FBS, Express 和 DBS.

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

开始生成库存余额报告。 这是什么报告

将返回哪些信息:

  • 对于模型 FBY 如果指定 campaignId, — 关于市场仓库里的剩菜。
  • 对于其他型号，如果指定 campaignId, — 关于商店相应仓库的剩菜。
  • 对于其他型号，如果指定 businessId, — 关于橱柜里所有商店仓库的剩菜，除了 FBY. 使用过滤器 campaignIds 以指定特定的商店。

⚠️ 不要在同一时间传送 campaignId 和 businessId.

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

报告列说明：

表单Остатки на складе（文件stocks_on_warehouses）

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

SHOP_SKU

shopSku

SSKU

string

ARTICLE

article

Ваш SKU

string

MARKET_SKU

marketSku

SKU на Яндексе

integer

PRODUCT_NAME

productName

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

string

VALID

valid

Годный

integer

RESERVED

reserved

Резерв

integer

AVAILABLE_FOR_ORDER

availableForOrder

Доступно для заказа

integer

QUARANTINE

quarantine

Карантин

integer

UTILIZATION

utilization

Передан на утилизацию

integer

DEFECT

defect

Брак

integer

EXPIRED

expired

Просрочен

integer

LENGTH

length

Длина, см

integer

WIDTH

width

Ширина, см

integer

HEIGHT

height

Высота, см

integer

WEIGHT

weight

Вес, кг

number

WAREHOUSE

warehouse

Склад

string

SELLING_STATUS

sellingStatus

Статус продаж

string

RECOMMENDATIONS

recommendations

Рекомендации

string

TURNOVER

turnover

Оборачиваемость за \d{2}.\d{2}.\d{2}-\d{2}.\d{2}.\d

string

报告列说明：

表单Список товаров（文件mass_shared_stocks）

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

ERRORS

errors

Критичные ошибки

string

WARNINGS

warnings

Некритичные ошибки

string

SHOP_SKU

shopSku

Ваш SKU *

string

PRODUCT_NAME

productName

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

string

COUNT

count

Доступное количество товара *

integer

报告列说明：

表单Остатки на складах（文件stocks_business）

CSV中的列名

JSON中的列名

XLSX中的列名

值类型

ERRORS

errors

Критичные ошибки

string

SHOP_SKU

shopSku

Ваш SKU *

string

PRODUCT_NAME

productName

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

string

PLACEMENT_TYPE

placementType

Модель работы

string

WAREHOUSE_AND_SHOP

warehouseAndShop

Склад *

string

COUNT

count

Доступно для заказа *

integer

RESERVE

reserve

Резерв

integer

PRICE

price

Цена

string

STATUS

status

Статус

string

COMMENT

comment

Примечание

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

Request

POST

https://api.partner.market.yandex.ru/v2/reports/stocks-on-warehouses/generate

Query parameters

Name

Description

format

Type: string

报告或文档的格式。
报告格式:

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

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
    "campaignId": 0,
    "businessId": 0,
    "warehouseIds": [
        0
    ],
    "reportDate": "string",
    "categoryIds": [
        0
    ],
    "hasStocks": false,
    "campaignIds": [
        0
    ]
}

Name

Description

businessId

Type: integer<int64>

只适用于型号 DBS, FBS 和 Express

应为其生成报告的机柜的ID（除 FBY-商店）。

不要与 campaignId.

campaignId

Type: integer<int64>

对于模型 DBS, FBS 和 Express 此参数将很快变得不可用。

要接收有关商店库存余额的信息，请发送 businessId 和所需商店的ID在 campaignIds.

活动ID。

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

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

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

不要与 businessId.

campaignIds

Type: integer[]

按存储筛选机柜报告（模型除外 FBY).

与...... businessId.
您需要获取信息的商店的广告系列列表。

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

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

⚠️ 请勿使用商店Id，这些Id列在商店名称旁边的市场上的卖家帐户和某些报告中。

Min items: 1

Unique items  

categoryIds

Type: integer[]

市场上按类别筛选（型号除外 FBY).

Min value (exclusive): 0

Min items: 1

Unique items  

hasStocks

Type: boolean

根据剩菜的存在进行过滤（模型除外 FBY).

reportDate

Type: string<date>

按日期筛选（对于模型 FBY). 该报告将包括以下数据： 前一个 下午好。.

日期格式: YYYY-MM-DD.

warehouseIds

Type: integer[]

按仓库Id筛选（仅限型号 FBY). 要查找ID，请使用请求 GET v2/warehouses.

Min items: 1

Unique items  

Responses

200 OK

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

Body

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

Name

Description

status*

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

result
Type: object

estimatedGenerationTime*

Type: integer<int64>

预计生成时间以毫秒为单位。

reportId*

Type: string

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

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

400 Bad Request

请求包含不正确的数据。 有关错误的更多信息

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

403 Forbidden

授权数据不正确或禁止访问资源。 有关错误的更多信息

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

420 Method Failure

已超出资源访问限制。 有关错误的更多信息

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

500 Internal Server Error

市场的内部错误。 有关错误的更多信息

Body

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

Name

Description

errors

Type: object[]

错误列表。
一般错误格式。

Min items: 1

status

Type: string

响应的类型。 可能的值:

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

Enum: OK, ERROR

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

上一篇
营业额报告(FBY)
下一篇
产品回顾报告