有关余额和营业额的信息
方法适用于模式:FBY, FBS, Express 和 DBS.
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回产品余额(所有型号)和[营业额]数据(*turnover) 产品(用于模型 FBY).
默认情况下,不会返回营业额数据。
要让他们在响应中,请发送 true 在战场上 withTurnover.
**对于模型 FBY:**有关余额的信息可能会从几个市场仓库返回,这些仓库会有不同的 warehouseId. 要获取市场仓库列表,请使用该方法 GET v2/warehouses.
参数的限制 limit
不要传递大于200的值。
| ⚙️ 限制: 每分钟100,000件产品 |
|---|
[//]:<>(营业额:产品销售的平均天数。 有关营业额的更多信息,请参阅市场对卖家的帮助。 https://yandex.ru/support/marketplace/analytics/turnover.html.)
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/offers/stocks
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。
Min value: |
Query parameters
|
Name |
Description |
|
limit |
Type: integer<int32> 每页的值数。
Min value: |
|
page_token |
Type: string 结果页面的ID。 如果省略该参数,则返回第一页。 我们建议传输输出参数的值 如果设置 |
Body
application/json
{
"stocksWarehouseId": 0,
"hasStocks": false,
"withTurnover": false,
"archived": false,
"offerIds": [
"string"
]
}
|
Name |
Description |
|
archived |
Type: boolean 按存档中的位置过滤。 传下去 |
|
hasStocks |
Type: boolean 只适用于型号 FBY 按产品可用性筛选。 只与 传下去 |
|
offerIds |
Type: string[] 过滤你的 SKU 产品。 返回有关所有转移资金的剩余金额的信息。 SKU,包括档案中的项目。 此列表仅完整返回。 如果您要求提供有关特定信息的信息 SKU,不填写:
使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: Min items: Max items: Unique items |
|
stocksWarehouseId |
Type: integer<int64> 仓库ID。 如果指定了该参数,则只返回已转移仓库中的货物。 **对于模型 FBY:**要获取市场仓库列表,请使用方法 GET v2/warehouses. Min value: |
|
withTurnover |
Type: boolean 只适用于型号 FBY 是否返回成交信息。 默认值: Default: |
Responses
200 OK
仓库中的货物残余。
Body
application/json
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"warehouses": [
{
"warehouseId": 0,
"offers": [
{
"offerId": "string",
"turnoverSummary": {
"turnover": "LOW",
"turnoverDays": 0
},
"stocks": [
{
"type": "FIT",
"count": 0
}
],
"updatedAt": "2022-12-29T18:02:01Z"
}
]
}
]
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
|
result |
Type: GetWarehouseStocksDTO 仓库列表,其中包含有关每个仓库余额的信息。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
GetWarehouseStocksDTO
仓库列表,其中包含有关每个仓库余额的信息。
|
Name |
Description |
|
warehouses* |
Type: WarehouseOffersDTO[] 仓库列表页面。 |
|
paging |
Type: ScrollingPagerDTO 有关结果页的信息。 |
WarehouseOffersDTO
仓库中剩余货物的信息。
|
Name |
Description |
|
offers* |
Type: WarehouseOfferDTO[] 有关余额的信息。 |
|
warehouseId* |
Type: integer<int64> 仓库ID。 |
ScrollingPagerDTO
有关结果页的信息。
|
Name |
Description |
|
nextPageToken |
Type: string 下一个结果页面的ID。 |
|
prevPageToken |
Type: string 上一个结果页面的ID。 |
WarehouseOfferDTO
剩余商品的信息。
|
Name |
Description |
|
offerId* |
Type: string 你的 SKU — 系统中的产品ID。 使用规则 SKU:
SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助. Min length: Max length: Pattern: |
|
stocks* |
Type: WarehouseStockDTO[] 有关余额的信息。 |
|
turnoverSummary |
Type: TurnoverDTO Информация об оборачиваемости. |
|
updatedAt |
Type: string<date-time> 余额信息上次更新的日期和时间。 日期和时间格式: ISO 8601 具有相对于 UTC. 例如, |
WarehouseStockDTO
剩余商品的信息。
|
Name |
Description |
|
count* |
Type: integer<int64> 剩菜的价值。 |
|
type* |
Type: WarehouseStockType Тип остатков. Enum: |
TurnoverDTO
品的营业额的信息。
阅读更多有关货物储存及周转的资料 燕基科斯.对卖家的市场帮助.
|
Name |
Description |
|
turnover* |
Type: TurnoverType Оценка оборачиваемости. Enum: |
|
turnoverDays |
Type: number<double> 值以天为单位。 |
WarehouseStockType
仓库中剩余货物的类型:
-
AVAILABLE(对应于市场上卖方办公室"库存余额"报告中的"可供订购"类型) — 可供出售的物品。 -
DEFECT(对应于"婚姻"类型) — 有缺陷的产品。 -
EXPIRED(对应于"逾期"类型) — 过期的产品。 -
FIT(对应于"适合"类型) — 可供出售或已被保留的物品。 -
FREEZE— 为订单保留的产品。 -
QUARANTINE(对应于"隔离"类型) — 暂时不可出售的物料(例如,物料正在从一个仓库移动到另一个仓库)。 -
UTILIZATION— 将被处置的产品。
|
Type |
Description |
|
Enum: |
TurnoverType
营业额的评估。
| 枚举 | 营业额范围 | 评论 |
|---|---|---|
LOW |
turnoverDays ≥ 120 |
|
ALMOST_LOW |
100 ≤ turnoverDays < 120 |
|
HIGH |
45 ≤ turnoverDays < 100 |
|
VERY_HIGH |
0 ≤ turnoverDays < 45 |
|
NO_SALES |
— | 没有销售。 |
FREE_STORE |
任何值。 | 没有必要支付此类货物的存储费用。 |
|
Type |
Description |
|
Enum: |
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.
产品销售的平均天数。 提供有关营业额的详细资料 在市场对卖家的帮助.