Paging

Parameters

• limit (Default 30, max 100)

• offset (Default 0)

Meta

The meta index is available on all endpoints. On endpoints which contains lists of items you will find 2 indexes of interest:

• paging

  • next (uri to fetch the next batch of data)

  • prev (uri to fetch the previous batch of data)

• items_total (only on certain endpoints)

Example

GET /stores/17/locations

"meta": {
    "paging": {
        "next": null,
        "prev": null
    },
    "items_total": null
}

There is no paging here since the resultset contains fewer then 30 results (28 as of this moment)

GET /stores/54/locations

"meta": {
    "paging": {
        "next": ".../stores/54/locations?limit=30&offset=30",
        "prev": null
    },
    "items_total": null
}

This implies that there is at least 30 results. But the next page could still be empty since items_total is not set, this will be the case on most endpoints.