Pagination

Trong các API lấy về danh sách tài nguyên của Goship thông thường sẽ bao gồm dữ liệu phân trang. Dựa vào dữ liệu phân trang, bạn có thể tùy biến thông tin dữ liệu trả về của API để phù hợp với hệ thống của bạn.

Mẫu response

{
    "data": {...},
    "meta": {
        "pagination": {
            "count": 25,
            "current_page": 1,
            "per_page": 25,
            "total": 44,
            "total_pages": 2,
            "links": {
                "next": "http://sandbox.goship.io/api/v2/shipments?page=2",
                "previous": null
            }
        }
    }
}

Các API phân trang

Các API bị ảnh hưởng bởi phân trang bao gồm:

  • Districts: Api danh sách quận huyện
  • Shipments: Api danh sách vận đơn
  • Invoices: Api danh sách phiếu thanh toán COD
  • Transactions: Api danh sách lịch sử giao dịch
  • Customers: Api danh sách người nhận hàng (khách hàng của shop)

Sử dụng tham số phân trang

Có 2 tham số chính trên url để tùy biến dữ liệu 1 API là sizepage. Bạn có thể sử dụng dữ liệu này để kiểm soát số lượng bản ghi được trả ra và điều hướng tới các trang khác nhau của API.

Edit this page on GitHub Updated at Tue, May 31, 2022