Структура и содержание отчетов могут изменяться без предварительного уведомления
Например, может добавиться новая колонка или поменяться название листа.
仓库结余报告
如果您使用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 |
报告列说明:
表单报告(文件mass_shared_stocks)
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
ERRORS |
errors |
log-message |
string |
WARNINGS |
warnings |
info-message |
string |
SHOP_SKU |
shopSku |
id |
string |
PRODUCT_NAME |
productName |
name |
string |
COUNT |
count |
count |
integer |
报告列说明:
表单报告(文件stocks_business)
CSV中的列名 |
JSON中的列名 |
XLSX中的列名 |
值类型 |
ERRORS |
errors |
log-message |
string |
SHOP_SKU |
shopSku |
id |
string |
PRODUCT_NAME |
productName |
name |
string |
PLACEMENT_TYPE |
placementType |
placement_type |
string |
WAREHOUSE_AND_SHOP |
warehouseAndShop |
warehouse_and_shop |
string |
COUNT |
count |
count |
integer |
RESERVE |
reserve |
reserve |
integer |
PRICE |
price |
price |
string |
STATUS |
status |
status |
string |
COMMENT |
comment |
comment |
string |
**⚙️ 限制:**每小时100个请求 |
---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/stocks-on-warehouses/generate
Query parameters
Name |
Description |
format |
Type: ReportFormatType 报告或文档的格式。 |
ReportFormatType
报告格式:
FILE
-电子表格文件(XLSX).CSV
-ZIP存档与CSV文件的每个报告表。JSON
-ZIP存档与JSON文件的每个报告表。
Type |
Description |
Default: Enum: |
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 还有快车 应为其生成报告的机柜的ID(除 FBY-商店)。 不要与 |
campaignId |
Type: integer<int64> 对于模型 DBS, FBS 而Express参数很快就会变得不可用。 要接收有关商店库存余额的信息,请发送 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
,不要发送商店ID,而不是,这是在卖方的帐户在市场上的商店名称旁边和一些报告。 不要与 |
campaignIds |
Type: integer<int64>[] 按存储筛选机柜报告(模型除外 FBY). 与...... 您可以使用查询找到它们。 GET v2/campaigns 或者在市场上的卖家办公室找到它-点击您的企业名称并转到页面:
请勿使用商店Id,这些Id列在商店名称旁边的市场上的卖家帐户和某些报告中。 Min items: Unique items |
categoryIds |
Type: integer<int32>[] 市场上按类别筛选(型号除外 FBY). Min value (exclusive): Min items: Unique items |
hasStocks |
Type: boolean 根据剩菜的存在进行过滤(模型除外 FBY). |
reportDate |
Type: string<date> 按日期筛选(对于模型 FBY). 该报告将包括以下数据: 前一个 下午好。. |
warehouseIds |
Type: integer<int64>[] 按仓库Id筛选(仅限型号 FBY). 要查找ID,请使用请求 GET v2/warehouses. 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
Yandex中的内部错误。 市场。 有关错误的更多信息
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.