Paginasi

Telusuri daftar panjang di BoxHero API dengan paginasi berbasis kursor.

Endpoint daftar mengembalikan hasil satu halaman per permintaan dan menggunakan paginasi berbasis kursor.

Parameter kueri

Parameter	Deskripsi
`cursor`	Titik awal halaman. Kirim field `cursor` dari respons sebelumnya. Hilangkan pada panggilan pertama.
`limit`	Ukuran halaman. Rentang yang diizinkan dan nilai bawaannya tercantum di setiap endpoint, misalnya Daftar barang.

Respons

Setiap halaman berisi hasil beserta field yang Anda perlukan untuk mengambil halaman berikutnya:

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

Field	Deskripsi
`count`	Jumlah hasil di halaman ini
`limit`	Ukuran halaman yang digunakan untuk halaman ini
`cursor`	Kirim nilai ini sebagai parameter kueri `cursor` untuk mendapatkan halaman berikutnya. `null` jika tidak ada halaman lagi.
`has_more`	`true` jika masih ada hasil setelah halaman ini

Mengambil semua halaman

Panggil endpoint daftar tanpa cursor.
Selama has_more bernilai true, panggil lagi dengan cursor diisi cursor dari respons terakhir.
Berhenti jika has_more bernilai false.

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

Gunakan filter yang sama seperti pada panggilan pertama di setiap panggilan berikutnya.

Urutan

Setiap resource menentukan urutannya sendiri. Sebagian besar endpoint daftar mengembalikan hasil berdasarkan id, dari kecil ke besar. Daftar transaksi mengembalikan transaksi terbaru terlebih dahulu (berdasarkan waktu transaksi, dengan id sebagai penentu jika waktunya sama).