有关余额和营业额的信息

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

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

返回产品余额(所有型号)和[营业额]数据(*turnover) 产品(用于模型 FBY).

默认情况下,不会返回营业额数据。

要让他们在响应中,请发送 true 在战场上 withTurnover.

**对于模型 FBY:**有关余额的信息可能会从几个市场仓库返回,这些仓库会有不同的 warehouseId. 要获取市场仓库列表,请使用该方法 GET v2/warehouses.

**对于模型 FBS:**响应可能不仅包括合作伙伴仓库,还包括市场的退货仓库。 如果退款是在卖方指定的退货点收到的,并且很长一段时间没有收到,这是可能的。

参数的限制 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

广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。

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

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

⚠️ 不要把它与:

  • 商店的标识符,显示在商家的个人帐户中。
  • 广告活动。

Min value: 1

Query parameters

Name

Description

limit

Type: integer

每页的值数。

Min value: 1

page_token

Type: string

结果页面的ID。

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

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

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

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
  "stocksWarehouseId": 1,
  "hasStocks": true,
  "withTurnover": false,
  "archived": true,
  "offerIds": [
    "example"
  ]
}

Name

Description

archived

Type: boolean

按存档中的位置过滤。

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

hasStocks

Type: boolean

只适用于型号 FBY

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

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

offerIds

Type: string[] | null

过滤你的 SKU 产品。

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

此列表仅完整返回。

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

  • page_token
  • limit
  • archived
  • stocksOnWarehouse

Min items: 1

Max items: 500

Unique items: true

Example
[
  "example"
]

stocksWarehouseId

Type: integer

仓库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": "example",
      "prevPageToken": "example"
    },
    "warehouses": [
      {
        "warehouseId": 0,
        "offers": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    响应的类型。 可能的值:

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

    Enum: OK, ERROR

    服务器响应的标准包装器。

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    result

    Type: object

    warehouses

    Type: object[]

    offers

    Type: object[]

    offerId

    Type: string

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

    使用规则 SKU:

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

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

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

    重要

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

    什么是 SKU 以及如何分配它

    Min length: 1

    Max length: 255

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

    Example: example

    stocks

    Type: object[]

    count

    Type: integer

    剩菜的价值。

    type

    Type: string

    仓库中剩余货物的类型:

    • AVAILABLE (对应于市场上卖方办公室"库存余额"报告中的"可供订购"类型) — 可供出售的物品。

    • DEFECT (对应于"婚姻"类型) — 有缺陷的产品。

    • EXPIRED (对应于"逾期"类型) — 过期的产品。

    • FIT (对应于"适合"类型) — 可供出售或已被保留的物品。

    • FREEZE — 为订单保留的产品。

    • QUARANTINE (对应于"隔离"类型) — 暂时不可出售的物料(例如,物料正在从一个仓库移动到另一个仓库)。

    • UTILIZATION — 将被处置的产品。

    Enum: FIT, FREEZE, AVAILABLE, QUARANTINE, UTILIZATION, DEFECT, EXPIRED

    有关余额的信息。

    Example
    [
      {
        "type": "FIT",
        "count": 0
      }
    ]
    

    turnoverSummary

    Type: object

    turnover

    Type: string

    营业额的评估。

    |枚举|营业额范围|评论| |-|-|-| |LOW|turnoverDays ≥ 120|| |ALMOST_LOW|100 ≤ turnoverDays < 120|| |HIGH|45 ≤ turnoverDays < 100|| |VERY_HIGH|0 ≤ turnoverDays < 45|| |NO_SALES|—|没有销售。| |FREE_STORE|任何值。|没有必要支付此类货物的存储费用。|

    Enum: LOW, ALMOST_LOW, HIGH, VERY_HIGH, NO_SALES, FREE_STORE

    turnoverDays

    Type: number

    值以天为单位。

    品的营业额的信息。

    阅读更多有关货物储存及周转的资料 燕基科斯.对卖家的市场帮助.

    Example
    {
      "turnover": "LOW",
      "turnoverDays": 0.5
    }
    

    updatedAt

    Type: string<date-time>

    余额信息上次更新的日期和时间。

    日期和时间格式: ISO 8601 具有相对于 UTC. 例如, 2023-11-21T00:42:42+03:00.

    Example: 2025-01-01T00:00:00Z

    有关余额的信息。

    Example
    [
      {
        "offerId": "example",
        "turnoverSummary": {
          "turnover": "LOW",
          "turnoverDays": 0.5
        },
        "stocks": [
          {
            "type": "FIT",
            "count": 0
          }
        ],
        "updatedAt": "2025-01-01T00:00:00Z"
      }
    ]
    

    warehouseId

    Type: integer

    仓库ID。

    **对于模型 FBY:**返回市场仓库的ID。

    **对于模型 FBS:**可以退回合作伙伴仓库和市场退货仓库的标识符。

    仓库列表页面。

    **对于模型 FBY:**可能包含多个市场仓库。

    **对于模型 FBS:**可以同时包含合作伙伴仓库和市场退货仓库。

    Example
    [
      {
        "warehouseId": 0,
        "offers": [
          {
            "offerId": "example",
            "turnoverSummary": {
              "turnover": "LOW",
              "turnoverDays": 0.5
            },
            "stocks": [
              {}
            ],
            "updatedAt": "2025-01-01T00:00:00Z"
          }
        ]
      }
    ]
    

    paging

    Type: object

    All of 2 types
    • Type: object

      nextPageToken

      Type: string

      下一个结果页面的ID。

      Example: example

      下一页的ID。

      Example
      {
        "nextPageToken": "example"
      }
      
    • Type: object

      prevPageToken

      Type: string

      上一个结果页面的ID。

      Example: example

      Example
      {
        "prevPageToken": "example"
      }
      

    有关结果页的信息。

    Example
    {
      "nextPageToken": "example",
      "prevPageToken": "example"
    }
    

    仓库列表,其中包含有关每个仓库余额的信息。

    Example
    {
      "paging": {
        "nextPageToken": "example",
        "prevPageToken": "example"
      },
      "warehouses": [
        {
          "warehouseId": 0,
          "offers": [
            {
              "offerId": "example",
              "turnoverSummary": {},
              "stocks": [
                null
              ],
              "updatedAt": "2025-01-01T00:00:00Z"
            }
          ]
        }
      ]
    }
    
    Example
    {
      "result": {
        "paging": {
          "nextPageToken": "example",
          "prevPageToken": "example"
        },
        "warehouses": [
          {
            "warehouseId": 0,
            "offers": [
              {}
            ]
          }
        ]
      }
    }
    

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

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "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.

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