Pagination

Whenever you try to retrieve a list (e.g shipping labels list), the pagination property is added to their response by default

We include the following as query parameters to limit our queries.

GET /example_list_url?Page=1&PerPage=1

Query Parameters

NameTypeDescription

PerPage

number

This is the maximum number of records that will be returned after the request. This can be modified by passing a new value into the query parameter. Default is 50

Page

number

This is current page to be returned per request. Default: 1

{
    "status": "success",
    "message": "Retrieved successfully",
    "data": {
        "results": [],
        "pagination": {
            "current": 1,
            "perPage": 1,
            "previous": 0,
            "next": 7,
            "total": 8
        }
    }
}

Last updated