PaginationType

Contains data for controlling pagination in API requests. Pagination of returned data is required for some calls and not needed in or not supported for some calls. See the documentation for individual calls to determine whether pagination is supported, required, or desirable.

Types that use PaginationType:

GetAccountRequestType, GetBestOffersRequestType, GetFeedbackRequestType, GetItemsAwaitingFeedbackRequestType, GetItemTransactionsRequestType, GetMemberMessagesRequestType, GetMyMessagesRequestType, GetOrdersRequestType, GetSellerListRequestType, GetSellerTransactionsRequestType, GetSellingManagerInventoryRequestType, GetSellingManagerSoldListingsRequestType, GetUserDisputesRequestType, GetVeROReportStatusRequestType, ItemListCustomizationType

Calls that use PaginationType:

GetAccount, GetBestOffers, GetFeedback, GetItemsAwaitingFeedback, GetItemTransactions, GetMemberMessages, GetMyeBayBuying, GetMyeBaySelling, GetMyMessages, GetOrders, GetSellerList, GetSellerTransactions, GetSellingManagerInventory, GetSellingManagerSoldListings, GetUserDisputes, GetVeROReportStatus

Fields

EntriesPerPage ( int ) [0..1]

This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set.

The maximum and default values are not the same for all calls. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page.

See the Field Index to learn which calls use EntriesPerPage.

PageNumber ( int ) [0..1]

Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for the individual calls to determine the correct default value.

See the Field Index to learn which calls use PageNumber.