Pagination

 

Pagination is the process of dividing content into discrete pages. The benefit of pagination is that it allows for faster response times to requests against large datasets like Customers, Products and Invoices, thus providing a more responsive and flexible API for your mission-critical applications.

DEAR Inventory API currently uses pagination on the following endpoints:

• Customers

• Suppliers

• Products

• ProductFamilies

• ProductAvailability

• Sales

 

All remaining API endpoints do not support pagination.

 

 

Requesting a page

 

Pages are requested by adding page parameter to URL: https://inventory.dearsystems.com/dearapi/{endpoint}?page={pagenumber}, where {endpoint} and {pagenumber} are placeholders.


For example, if you wanted to retrieve the 3rd page of 100 records from the Products endpoint we would write https://inventory.dearsystems.com/dearapi/Products?page=3.



Page size

 

The default page size is 100 records, but is configurable by adding the desired page size in the URL querystring, https://inventory.dearsystems.com/dearapi/{endpoint}?page={pagenumber}&limit={pagesize}.

The minimum page size is 1 and the maximum page size is 1000 records.

If you want to retrieve the 5th page of 200 ProductAvailability records (ie. 1001st to 1500th record) then you would use this URL: https://inventory.dearsystems.com/dearapi/ProductAvailability?page=5&limit=200.

 

 

Pagination info

 

In the endpoints that support Pagination additional parameter Total is returned with every API call response to provide information regarding how many records there are overall. Below is an example of this structure in JSON for Products endpoint.

{ "Products":[{...}], "Total":41}