Pagination
Since the amount of data returned for various endpoints may be substantial, you have the option to control payload size and pagination through two parameters:
- Size: specify an integer value for the number of items of a given entity in a payload. Example - for replenishment, this represents the number of orders
- Cursor: when returning the first page of data, we will append a
Paging
object with aNextCursor
value. You are expected to provide this value as a query parameter to retrieve the next page of data
Note the following:
- The
Size
query parameter is dynamic through all pages of retrieval. Changing this parameter will dynamically generate the requested payload size (if different than previously requestd size) - On the final page of the payload, the value of
NextCursor
will benull
as there are no more pages to show - Max value for
Size
is 500
Updated 10 months ago