跳转到内容

分页

使用基于游标的分页遍历 BoxHero API 中的长列表。

列表端点每次返回一页结果,并使用基于游标的分页。

参数说明
cursor页面的起始位置。传入上一次响应中的 cursor 字段。首次调用时省略。
limit每页大小。允许的范围和默认值列在各端点中,例如获取商品列表。

每一页都包含结果以及获取下一页所需的字段:

{
"items": [...],
"count": 100,
"limit": 100,
"cursor": 1234567,
"has_more": true
}
字段说明
count本页的结果数量
limit本页使用的每页大小
cursor将此值作为 cursor 查询参数传入即可获取下一页。没有更多页面时为 null。
has_more如果本页之后还有更多结果,则为 true
  1. 不带 cursor 调用列表端点。
  2. 只要 has_more 为 true,就将 cursor 设置为上一次响应中的 cursor,再次调用。
  3. 当 has_more 为 false 时停止。
Terminal window
curl "https://rest.boxhero-app.com/v1/items?cursor=1234567" \
-H "Authorization: Bearer $BOXHERO_API_TOKEN"

首次调用时使用的筛选条件,在后续每次调用中都要保持不变。

每种资源都定义了自己的排序方式。大多数列表端点按 id 升序返回结果。获取库存记录列表会先返回最新的库存记录(按库存记录时间排序,时间相同时按 id 排序)。