PaginationOutput
This type contains information about the pagination of a response payload. The entries (data records) returned by the request are grouped into pages, which are limited in size according to the number of entries per page as specified by the limit field.
Types that use PaginationOutput:
Calls that use PaginationOutput:
/post-order/v2/cancellation/search GET, /post-order/v2/casemanagement/search GET, /post-order/v2/inquiry/search GET, /post-order/v2/return/search GET
Fields
The maximum number of entries to return per request. This value is set through the limit query parameter in the request (or the default value is used if this query parameter is omitted).
The value of the totalEntries field divided by the value of this field determines the value of the totalPages field.
The value of the totalEntries field divided by the value of this field determines the value of the totalPages field.
See the Field Index to learn which calls use limit.
The offset value indicates the number of entries to skip in the results set before returning the first entry in the paginated response. The offset query parameter is paired with the limit query parameter to control the number of entries returned in the response, and which entries appear on that page of data. For example, if you supply an offset of
The offset value defaults to
0 and a limit of 10, the first page of the response contains the first 10 entries from the results set. If the offset was set to 10 and the limit was set to 20, the first page of the results set would contain entries 11-30. The offset value defaults to
0 if the offset query parameter is omitted from the request.
See the Field Index to learn which calls use offset.
The total number of entries that match the current input criteria of the request. This value divided by the value of the limit field determines the value of the totalPages field.
See the Field Index to learn which calls use totalEntries.
The total number of pages of entries that match the current input criteria of the request.
This value is determined by dividing the value of the totalEntries field by the value of the limit field. If totalPages is more than
This value is determined by dividing the value of the totalEntries field by the value of the limit field. If totalPages is more than
1, subsequent calls must be used to view subsequent pages in the results set.
See the Field Index to learn which calls use totalPages.