การแบ่งหน้า

ไล่ดูรายการยาวใน BoxHero API ด้วยการแบ่งหน้าแบบ cursor

endpoint ที่แสดงรายการจะส่งคืนผลลัพธ์ทีละหน้าและใช้การแบ่งหน้าแบบ cursor

พารามิเตอร์ของคิวรี

พารามิเตอร์	คำอธิบาย
`cursor`	จุดเริ่มต้นของหน้า ส่งฟิลด์ `cursor` จากการตอบกลับก่อนหน้า ไม่ต้องใส่ในการเรียกครั้งแรก
`limit`	ขนาดหน้า ช่วงที่อนุญาตและค่าเริ่มต้นระบุไว้ในแต่ละ endpoint เช่น แสดงรายการสินค้า

การตอบกลับ

แต่ละหน้าจะมีผลลัพธ์พร้อมฟิลด์ที่ใช้ดึงหน้าถัดไป:

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

ฟิลด์	คำอธิบาย
`count`	จำนวนผลลัพธ์ในหน้านี้
`limit`	ขนาดหน้าที่ใช้สำหรับหน้านี้
`cursor`	ส่งค่านี้เป็นพารามิเตอร์คิวรี `cursor` เพื่อรับหน้าถัดไป เป็น `null` เมื่อไม่มีหน้าเพิ่มเติม
`has_more`	เป็น `true` หากมีผลลัพธ์เพิ่มเติมหลังหน้านี้

การดึงข้อมูลทุกหน้า

เรียก endpoint ที่แสดงรายการโดยไม่ใส่ cursor
ขณะที่ has_more เป็น true ให้เรียกอีกครั้งโดยตั้ง cursor เป็น cursor จากการตอบกลับล่าสุด
หยุดเมื่อ has_more เป็น false

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

ใช้ตัวกรองที่ใช้ในการเรียกครั้งแรกให้เหมือนเดิมในทุกการเรียกถัดไป

การเรียงลำดับ

แต่ละทรัพยากรกำหนดลำดับของตัวเอง endpoint ที่แสดงรายการส่วนใหญ่จะส่งคืนผลลัพธ์ตาม id จากน้อยไปมาก แสดงรายการธุรกรรม จะส่งคืนธุรกรรมล่าสุดก่อน (ตามเวลาธุรกรรม โดยใช้ id ตัดสินเมื่อเวลาเท่ากัน)