This type contains the specifications for the collection of orders that match the search or filter criteria of a getOrders call. The collection is grouped into a result set, and based on the query parameters that are set (including the limit and offset parameters), the result set may included multiple pages, but only one page of the result set can be viewed at a time.
Types that use OrderSearchPagedCollection
Not used by any types.
Call that uses OrderSearchPagedCollection
Note: If this is the last or only page of the result set, the page may contain fewer orders than the limit value. To determine the number of pages in a result set, divide the total value (total number of orders matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was
120(120 total orders) and the limit value was
50(show 50 orders per page), the total number of pages in the result set is three, so the seller would have to make three separate getOrders calls to view all orders matching the input criteria. Default:
This field is only returned if there is a next page of results to view based on the current input criteria.
Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of
By default, orders are returned according to creation date (oldest to newest), but the order will vary according to any filter that is set in request.
This field is only returned if there is a previous page of results to view based on the current input criteria.
Note: If no orders are found, this field is returned with a value of