GetSellerList is called to retrieve a group of items listed by a specified seller.

  • Items for the eBay seller tied to the user token are returned.
  • All calls require at least one date-range filter be specified.
  • Specify a GranularityLevel to control the response data. If omitted, the default value fine is applied.
  • Pagination values must be included. Refer to Paginate results for additional information.

GetSellerList returns a list of items in the ItemArray. The array comprises one ItemArray.Item object for each item listed by the specified seller that also satisfies any input filtering criteria. The application parses the ItemArray and examines each ItemArray.Item to inspects its properties.

The response includes indicators of how many items are returned and whether there are additional items that could be returned (i.e., additional items that satisfy the criteria but require additional calls to be retrieved). The result set also contains the page number for the data returned, the number of items being returned per page, and the total number of pages of items meeting the selection criteria.

Filter results by date

The number of items that could be returned for a given seller is potentially large. To reduce the number of items returned, date-based filter inputs can be used to filter results based on:

  • When the items started
  • When the items ended
  • When the items were last modified

Applications use this type of filtering to limit the items to just those of interest in the context of a given operation. For example, if the context calls for retrieving only those items that end on a particular day, the application should not filter for all the items ending within a given month.

Date-based filters work in pairs, delineating a date range described by the earliest date of interest (i.e., oldest,) and a the latest date of interest (i.e., most recent). For example, to retrieve the items that end on a particular day:

  • The earliest date in the range might be one second after midnight on the morning of interest; items that ended prior to that time would not be of interest.
  • The latest date in the range might be midnight on that day; items that ended after that time would not be of interest.

When one filter input is used, the other matching filter element must also be used (the application must always specify both the oldest date and the most recent date for a filtering date range). For example, if EndTimeFrom is specified (because the filtering date range is based on the end date) then EndTimeTo must also be specified. At least one date-range filter must be specified. Multiple date-range filters may be used per call. For instance, a single call can return the items ending within a date range (one filter) plus those that started in a specified date range (a second filter).

Paginate results

One way to reduce the number of items returned in any single call is by configuring Pagination. Pagination breaks the total data set down into smaller chunks that might be easier for the application to use.

Note: If zero items would be returned, an Invalid page number error will NOT be returned.

For example, if 100 items for a seller satisfy the selection criteria for a call, the application could issue:

  • One single call to retrieve all 100 items, or
  • Ten calls that each retrieves 10 items (i.e.,ten pages of ten items each).

Pagination is configured by:

The first call returns page 1 of a seller's items. Data in the call's result set indicate if there are additional ItemArray.Item objects to retrieve and, if so, how many remain. The application uses this information to determine whether additional calls are required and, based on the Pagination.EntriesPerPage value, how many additional calls are required to retrieve all items.

If additional calls are needed, each subsequent call specifies an incrementally larger page number to retrieve each succeeding page of items.

Sort results

Items returned by GetSellerList can be sorted by their ItemArray.Item.ListingDetails.EndTime values.