报告的结构及内容如有更改,恕不另行通知。
例如,可以添加新列或更改工作表的名称。
仓库余额报告
方法适用于模式:FBY, FBS, Express 和 DBS.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
- offers-and-cards-management — 商品和卡片管理
- all-methods — 全面管理账户
开始生成库存余额报告。 这是什么报告
将返回哪些信息:
- 对于模型 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 报告或文档的格式。 报告格式:
Default: Enum: |
Body
application/json
{
"campaignId": 1,
"businessId": 1,
"warehouseIds": [
0
],
"reportDate": "2025-01-01",
"categoryIds": [
0
],
"hasStocks": true,
"campaignIds": [
1
]
}
|
Name |
Description |
|
businessId |
Type: integer 内阁ID。 要找到答案,请使用请求 GET v2/campaigns. Min value: |
|
campaignId |
Type: integer 广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它。 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要把它与:
Min value: |
|
campaignIds |
Type: integer[] | null 按存储筛选机柜报告(模型除外 FBY). 与...... Min items: Unique items: Example
|
|
categoryIds |
Type: integer[] | null 市场上按类别筛选(型号除外 FBY). Min items: Unique items: Example
|
|
hasStocks |
Type: boolean 根据剩菜的存在进行过滤(模型除外 FBY). |
|
reportDate |
Type: string<date> 按日期筛选(对于模型 FBY). 该报告将包括以下数据: 前一个 下午好。. 日期格式: Example: |
|
warehouseIds |
Type: integer[] | null 按仓库Id筛选(仅限型号 FBY). 要查找ID,请使用请求 GET v2/warehouses. Min items: Unique items: Example
|
Responses
200 OK
作为响应,您会收到一个标识符,该标识符允许您查找生成状态并下载完成的报告。
Body
application/json
{
"status": "OK",
"result": {
"reportId": "example",
"estimatedGenerationTime": 0
}
}
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
result
Type: object
estimatedGenerationTime
Type: integer
预计生成时间以毫秒为单位。
reportId
Type: string
跟踪生成状态和接收完成的报告或文档所需的ID。
Example:
example跟踪生成状态和接收完成的报告或文档所需的ID。
Example
{ "reportId": "example", "estimatedGenerationTime": 0 }Example
{ "result": { "reportId": "example", "estimatedGenerationTime": 0 } }
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
500 Internal Server Error
Yandex中的内部错误。 市场。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "example",
"message": "example"
}
]
}
Type: object
All of 1 type
-
Type: object
All of 2 types
-
Type: object
status
Type: string
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
Enum:
OK,ERROR服务器响应的标准包装器。
Example
{ "status": "OK" } -
Type: object
errors
Type: object[]
code
Type: string
的错误代码。
Example:
examplemessage
Type: string
错误的描述。
Example:
example错误列表。
Min items:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
服务器错误的标准包装器。
Example
{ "status": "OK", "errors": [ { "code": "example", "message": "example" } ] } -
No longer supported, please use an alternative and newer version.