跳转到主要内容
GET
/
listings
/
availability
Bulk availability check
curl --request GET \
  --url https://csboard.com/v1/listings/availability \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "available": {
      "itm_8841201": 1,
      "itm_8841340": 3
    },
    "unavailable_ids": [
      "itm_8841999"
    ]
  }
}
在下批量订单之前，请确认您打算购买的商品仍然可用。通过逗号分隔的 ids 参数最多传入 100 个商品 id；响应将告诉您每个 id 当前可用的数量，以及哪些 id 已不再可用。 需要身份验证。 请将密钥作为 Authorization: Bearer csb_pub_... 发送。

​
查询参数

​
ids
string
必填
以逗号分隔的商品 id，例如 itm_8841201,itm_8841340。必填。 每次请求最多 100 个 id。

​
响应字段

​
data
object
必填

​
示例请求

curl "https://csboard.com/v1/listings/availability?ids=itm_8841201,itm_8841340,itm_8841999" \
  -H "Authorization: Bearer csb_pub_..."

​
示例响应

{
  "data": {
    "available": {
      "itm_8841201": 1,
      "itm_8841340": 3
    },
    "unavailable_ids": ["itm_8841999"]
  }
}

​
错误代码

HTTP 状态码代码含义
401missing_api_key / invalid_api_keyAPI 密钥缺失或无效。
422invalid_request未提供 ids，或提供了超过 100 个 id。
429rate_limit_exceeded请求过多。请按照 Retry-After 响应头中的秒数退避。
可用性是一个时间点快照。报告为可用的 id 仍可能在您的购买执行前售罄——请始终发送 max_price_usd，并在购买调用中处理 item_unavailable。

授权

​
Authorization
string
header
必填

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile.

查询参数

​
ids
string
必填

Comma-separated listing ids. Required. Maximum 100 ids per request.

响应

Availability map for the requested ids.

​
data
object
必填