ページネーション

カーソルベースのページネーションで、BoxHero API の長いリストを順に取得します。

リスト系のエンドポイントは結果を 1 ページずつ返し、カーソルベースのページネーションを使用します。

クエリパラメーター

パラメーター	説明
`cursor`	ページの開始位置です。前回のレスポンスの `cursor` フィールドを渡します。最初の呼び出しでは省略します。
`limit`	ページサイズです。許容範囲とデフォルト値は各エンドポイントに記載されています（例: 商品一覧の取得）。

各ページには、結果と次のページを取得するために必要なフィールドが含まれます。

{
  "items": [...],
  "count": 100,
  "limit": 100,
  "cursor": 1234567,
  "has_more": true
}

フィールド	説明
`count`	このページの結果の件数
`limit`	このページに使用されたページサイズ
`cursor`	次のページを取得するには、この値を `cursor` クエリパラメーターとして渡します。これ以上ページがない場合は `null` です。
`has_more`	このページの後にさらに結果がある場合は `true`

curl "https://rest.boxhero-app.com/v1/items?cursor=1234567" \
  -H "Authorization: Bearer $BOXHERO_API_TOKEN"

最初の呼び出しで使用したフィルターは、以降のすべての呼び出しでも同じものを指定してください。

並び順はリソースごとに定義されています。ほとんどのリスト系のエンドポイントは、id の昇順で結果を返します。履歴一覧の取得は、新しい履歴から順に返します（履歴の日時順で、同じ場合は id 順）。