有关余额和营业额的信息

方法适用于模式:FBY, FBS, ExpressDBS.

如果您使用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;
  • 标签 查询日志 →块中的下拉列表 显示日志.

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

每页的值数。

Min value: 1
Example: 20

page_token

Type: string

结果页面的ID。

如果省略该参数,则返回第一页。

我们建议传输输出参数的值 nextPageToken,在最后一次请求期间接收。

如果设置 page_token 并且请求有参数 pagepageSize 它们被忽略了。
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
    "stocksWarehouseId": 0,
    "hasStocks": false,
    "withTurnover": false,
    "archived": false,
    "offerIds": [
        "string"
    ]
}

Name

Description

archived

Type: boolean

按存档中的位置过滤。

传下去 true 获取有关存档的其余项目的信息。 如果过滤器未填充或通过 false 响应返回有关未存档的产品的信息。

hasStocks

Type: boolean

只适用于型号 FBY

按产品可用性筛选。 只与 stocksWarehouseId.

传下去 false 获取有关不可用产品的信息。 与值 true 返回有关指定仓库中的货物的数据。

offerIds

Type: string[]

过滤你的 SKU 产品。

返回有关所有转移资金的剩余金额的信息。 SKU,包括档案中的项目。

此列表仅完整返回。

如果你要求提供特定的资料 SKU,不填写:

  • page_token
  • limit
  • archived
  • stocksOnWarehouse


你的 SKU — 系统中的产品ID。

使用规则 SKU:

  • 对于每个产品 SKU 一定有一个。

  • 已经设置 SKU 它不能被释放并重新用于另一个产品。 每个产品都应该收到一个以前从未在目录中使用过的新标识符。

SKU 产品可以在市场上的卖方帐户中更改。 阅读有关如何做到这一点。 在市场对卖家的帮助.

重要

值开头和结尾的空格会自动删除。 例如, " SKU123 ""SKU123" 它们将被视为相同的值。

什么是 SKU 以及如何分配它

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

Min items: 1

Max items: 500

Unique items  

stocksWarehouseId

Type: integer<int64>

仓库ID。

如果指定了该参数,则只返回已转移仓库中的货物。

**对于模型 FBY:**要获取市场仓库列表,请使用方法 GET v2/warehouses.

Min value: 1

withTurnover

Type: boolean

只适用于型号 FBY

是否返回成交信息。

默认值: false. 如果需要信息,则传递值 true.

Default: false

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

响应的类型。 可能的值:

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

Enum: OK, ERROR

result

Type: object

warehouses*

Type: object[]

仓库列表页面。
仓库中剩余货物的信息。

paging

Type: object

nextPageToken

Type: string

下一个结果页面的ID。

prevPageToken

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.

产品销售的平均天数。 提供有关营业额的详细资料 在市场对卖家的帮助.