findCompletedItems

Note: This call is deprecated as of October 15, 2020, and access is restricted. All calls in the Finding API will be decommissioned on February 5, 2025.

An alternative to findCompletedItems call is the Marketplace Insights API, but please note that this API is also restricted and requires eBay Business approval for access. Please contact the Developer Technical Support team if you are interested in getting access to the Marketplace Insights API.

This call searches for items whose listings are completed and are no longer available for sale by category (using categoryId), by keywords (using keywords), or a combination of the two. Keyword queries search the title and subtitle of the item; they do not search descriptions.

Note: eBay supports multiple-variation listings, which are listings that contain multiple variations of the same product, such as a shirt that comes in multiple colors and sizes. Each variation can be considered its own purchasable line item. When a specific variation of a multiple-variation listing has been sold, the findCompletedItems call will return this variation (or line item) as completed even if the multiple-variation listing is still active.

Usage Details

The findCompletedItems response contains details about items matching your search criteria. By default, eBay returns a specific set of data in the response to your call. Control findCompletedItems result sets using the following methods:

Searching for items available on a specific eBay site
The GLOBAL-ID URL parameter (or X-EBAY-SOA-GLOBAL-ID HTTP header) specifies the eBay site to use for searches.
Filtering results with item filters
You can control your results by specifying item filters (itemFilter) for a variety of properties, including the item condition, number of bids, price range, listing type, and more.
Refining results with aspect filters
Aspect filters (aspectFilter) let you use standard item characteristics, such as Style or Color, to refine your search results.
Including additional data in the response
Specify one or more outputSelector fields to retrieve more than the default set of response data. For example, you can retrieve seller information for each item, or an aspect histogram.

Sorting results
Use sortOrder to specify the order in which returned items are sorted, such as by price or by listing end time.

Note: The default sortOrder for findCompletedItems results is the most recent end date (End Date: recent first). Unlike the rest of the Finding API calls, BestMatch is not supported as the default sort order for findCompletedItems.

Paginating the results
Use paginationInput to divide the items matching the search criteria into subsets, or "pages," of data.

For findCompletedItems, you can expect the response times for this call to be longer than other types of Finding Service requests. The call must search through historical databases rather than performing a quick lookup on currently listed items. There is a 5,000 limit on the number of findCompletedItems calls an application can make in a single day (even if the application has completed an app check).

Be aware that it is possible to use this call in such a way as to violate the terms and conditions of your API License Agreement. Ensure that you do not store the results retrieved from this call or use the results for market research purposes.

For details on these response control mechanisms, refer to findItemsByKeywords.

Note: Starting October 2014, domains will be deprecated.
This call will continue to accept requests containing references to domains (such as domainFilter) and will continue to return references to domains (such as domainDisplayName).
The behavior will differ, as follows, depending on the fields specified in the request/response.

The input field domainFilter will be ignored. Use categoryId for equivalent behavior.
In the response for <outputSelector>aspectHistogram</outputSelector>:
- The aspectHistogramContainer field will show the aspects in the category.
- The domainDisplayName field will show the category name.
- The domainName field will show the category name.
Everywhere else, "domain" should be considered as analogous to "category".

If you are an eBay affiliate, you can specify your affiliate information using the fields in the affiliate container. By specifying your affiliate information, you can earn commissions on user activity generated from your site. Affiliate data is embedded in the viewItemURL URLs returned in your search results.

Note: For listings that return item.discountPriceInfo.pricingTreatment set to MAP (Minimum Advertised Price), you are legally required to follow the rules for displaying the price of the item to potential buyers. You are bound by the terms of the API License Agreement to follow these rules. Refer to the API License Agreement for consequences of non-compliance.

Input

Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

<?xml version="1.0" encoding="utf-8"?>
<findCompletedItemsResponse xmlns="http://www.ebay.com/marketplace/search/v1/services">
  <!-- (No call-specific Output fields) -->

  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage
    <error> ErrorData
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter values allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <paginationOutput> PaginationOutput
    <entriesPerPage> int </entriesPerPage>
    <pageNumber> int </pageNumber>
    <totalEntries> int </totalEntries>
    <totalPages> int </totalPages>
  </paginationOutput>
  <searchResult count="int"> SearchResult
    <item> SearchItem
      <attribute> ItemAttribute </attribute>
      <!-- ... more attribute nodes allowed here ... -->
      <autoPay> boolean </autoPay>
      <charityId> string </charityId>
      <condition> Condition
        <conditionDisplayName> string </conditionDisplayName>
        <conditionId> int </conditionId>
      </condition>
      <country> token </country>
      <discountPriceInfo> DiscountPriceInfo </discountPriceInfo>
      <distance unit="string"> Distance (double) </distance>
      <eBayPlusEnabled> boolean </eBayPlusEnabled>
      <eekStatus> string </eekStatus>
      <!-- ... more eekStatus values allowed here ... -->
      <galleryInfoContainer> GalleryInfoContainer
        <galleryURL gallerySize="GallerySizeEnum"> GalleryURL (anyURI) </galleryURL>
        <!-- ... more galleryURL values allowed here ... -->
      </galleryInfoContainer>
      <galleryPlusPictureURL> anyURI </galleryPlusPictureURL>
      <!-- ... more galleryPlusPictureURL values allowed here ... -->
      <galleryURL> anyURI </galleryURL>
      <globalId> token </globalId>
      <itemId> string </itemId>
      <listingInfo> ListingInfo
        <bestOfferEnabled> boolean </bestOfferEnabled>
        <buyItNowAvailable> boolean </buyItNowAvailable>
        <buyItNowPrice currencyId="string"> Amount (double) </buyItNowPrice>
        <convertedBuyItNowPrice currencyId="string"> Amount (double) </convertedBuyItNowPrice>
        <endTime> dateTime </endTime>
        <gift> boolean </gift>
        <listingType> token </listingType>
        <startTime> dateTime </startTime>
      </listingInfo>
      <location> string </location>
      <paymentMethod> token </paymentMethod>
      <!-- ... more paymentMethod values allowed here ... -->
      <pictureURLLarge> anyURI </pictureURLLarge>
      <pictureURLSuperSize> anyURI </pictureURLSuperSize>
      <postalCode> string </postalCode>
      <primaryCategory> Category
        <categoryId> string </categoryId>
        <categoryName> string </categoryName>
      </primaryCategory>
      <productId> ProductId (string) </productId>
      <secondaryCategory> Category
        <categoryId> string </categoryId>
        <categoryName> string </categoryName>
      </secondaryCategory>
      <sellerInfo> SellerInfo
        <feedbackRatingStar> token </feedbackRatingStar>
        <feedbackScore> long </feedbackScore>
        <positiveFeedbackPercent> double </positiveFeedbackPercent>
        <sellerUserName> string </sellerUserName>
        <topRatedSeller> boolean </topRatedSeller>
      </sellerInfo>
      <sellingStatus> SellingStatus
        <bidCount> int </bidCount>
        <convertedCurrentPrice currencyId="string"> Amount (double) </convertedCurrentPrice>
        <currentPrice currencyId="string"> Amount (double) </currentPrice>
        <sellingState> token </sellingState>
        <timeLeft> duration </timeLeft>
      </sellingStatus>
      <shippingInfo> ShippingInfo
        <shippingServiceCost currencyId="string"> Amount (double) </shippingServiceCost>
        <shippingType> token </shippingType>
        <shipToLocations> string </shipToLocations>
        <!-- ... more shipToLocations values allowed here ... -->
      </shippingInfo>
      <storeInfo> Storefront
        <storeName> string </storeName>
        <storeURL> anyURI </storeURL>
      </storeInfo>
      <subtitle> string </subtitle>
      <title> string </title>
      <topRatedListing> boolean </topRatedListing>
      <unitPrice> UnitPriceInfo </unitPrice>
      <viewItemURL> anyURI </viewItemURL>
    </item>
    <!-- ... more item nodes allowed here ... -->
  </searchResult>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</findCompletedItemsResponse>

Return Value	Type	Occurrence	Meaning

(No call-specific fields)

Standard Output Fields

ack	AckValue	Always	Indicates whether or not errors or warnings were generated during the processing of the request. Applicable values: Failure eBay encountered a fatal error during the processing of the request, causing the request to fail. When a serious application-level error occurs, the error is returned instead of the business data. PartialFailure eBay successfully processed the request, but one or more non-fatal errors occurred during the processing. For best results, requests should return without warning messages. Inspect the message details and resolve any problems before resubmitting the request. Success eBay successfully processed the request and the business data is returned in the response. Note that it is possible for a response to return Success, but still not contain the expected data in the result. Warning The request was successfully processed, but eBay encountered a non-fatal error during the processing. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request. Code so that your app gracefully handles any future changes to this list.
errorMessage	ErrorMessage	Conditionally	Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	Details about a single error.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: Application An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay. Request An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay. System Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay side, an application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. Code so that your app gracefully handles any future changes to this list.
errorMessage.error.domain	string	Conditionally	Name of the domain in which the error occurred. domain values: Marketplace A business or validation error occurred in the service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework.
errorMessage.error.errorId	long	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
errorMessage.error.exceptionId	token	Conditionally	Unique identifier for an exception associated with an error.
errorMessage.error.message	string	Conditionally	A detailed description of the condition that caused in the error.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.parameter [ attribute name ]	string	Conditionally	Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
errorMessage.error.severity	ErrorSeverity	Conditionally	Indicates whether the reported problem is fatal (an error) or is less- severe (a warning). Review the error message details for information on the cause. If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, re-send the request to eBay. If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form. If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem. Applicable values: Error eBay encountered a fatal error during the processing of the request, causing the request to fail. When eBay encounters an error, it returns error data instead of the requested business data. Inspect the error details and resolve the problem before resubmitting the request. Warning The request was successfully processed, but eBay encountered a non-fatal error during the processing that could affect the data returned. For example, eBay might have changed the value of an input field. In this case, eBay returns a successful response, but it also returns a warning. For best results, requests should return without warnings. Inspect the warning details and resolve the problem before resubmitting the request. Code so that your app gracefully handles any future changes to this list.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain in which the error occurred. subdomain values: Finding The error is specific to the Finding service. MarketplaceCommon The error is common to all Marketplace services.
paginationOutput	PaginationOutput	Conditionally	Indicates the pagination of the result set. Child elements indicate the page number that is returned, the maximum number of item listings to return per page, total number of pages that can be returned, and the total number of listings that match the search criteria.
paginationOutput .entriesPerPage	int	Conditionally	The maximum number of items that can be returned in the response. This number is always equal to the value input for paginationInput.entriesPerPage. The end of the result set has been reached if the number specified for entriesPerPage is greater than the number of items found on the specified pageNumber. In this case, there will be fewer items returned than the number specified in entriesPerPage. This can be determined by comparing the entriesPerPage value with the value returned in the count attribute for the searchResult field. Min: 1. Max: 100.
paginationOutput.pageNumber	int	Conditionally	The subset of item data returned in the current response. Search results are divided into sets, or "pages," of item data. The number of pages is equal to the total number of items matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of item data. This returned value indicates the page number of item data returned (a subset of the complete result set). If this field contains 1, the response contains the first page of item data (the default). If the value returned in totalEntries is less than the value for entriesPerPage, pageNumber returns 1 and the response contains the entire result set. The value of pageNumber is normally equal to the value input for paginationInput.pageNumber. However, if the number input for pageNumber is greater than the total possible pages of output, eBay returns the last page of item data in the result set, and the value for pageNumber is set to the respective (last) page number. Min: 0. Max: 100.
paginationOutput.totalEntries	int	Conditionally	The total number of items found that match the search criteria in your request. Depending on the input value for entriesPerPage, the response might include only a portion (a page) of the entire result set. A value of "0" is returned if eBay does not find any items that match the search criteria. Min: 0.
paginationOutput.totalPages	int	Conditionally	The total number of pages of data that could be returned by repeated search requests. Note that if you modify the value of inputPagination.entriesPerPage in a request, the value output for totalPages will change. A value of "0" is returned if eBay does not find any items that match the search criteria. Min: 0.
searchResult	SearchResult	Always	Container for the item listings that matched the search criteria. The data for each item is returned in individual containers, if any matches were found.
searchResult [ attribute count ]	int	Always	Container for the item listings that matched the search criteria. The data for each item is returned in individual containers, if any matches were found.
searchResult.item	SearchItem	Always, repeatable: [1..*]	Container for the data of a single item that matches the search criteria.
searchResult.item.attribute	ItemAttribute	Conditionally, repeatable: [0..*]	item attribute
searchResult.item.autoPay	boolean	Always	If true, the seller requires immediate payment for the item. If false (or not specified), immediate payment is not requested. Immediate payment does not apply to classified listings nor to auction listings that end with a winning bidder. Note: The value of the autoPay flag indicates the seller's stated preference only. It does not indicate whether the listing is still a candidate for purchase via immediate payment. For example, if a listing receives bids and no longer qualifies for immediate payment, the value of the autoPay flag does not change.
searchResult.item.charityId	string	Conditionally	A unique identification number assigned by eBay to a registered non-profit charity organization. See GetCharities in the Trading API for information to retrieve details on a specific charity.
searchResult.item.condition	Condition	Conditionally	This container shows the name and unique ID of the item's condition. This container will generally get returned unless the item is in an eBay category that does not require an item condition. Supported item conditions vary by category.
searchResult.item.condition .conditionDisplayName	string	Conditionally	The human-readable label for the item condition. Display names are localized for the site on which they're listed (not necessarily the site on which they're viewed). In item results, this is only returned when the seller specified the item's condition using a structured format eBay recognizes. When conditionId is also present: Most categories use the same display name for the same condition ID. Some categories may override the display name based on buyer expectations for items in the category. For example, condition ID 1000 could be called "New" in one category and "New with tags" in another. If an item is listed in two categories, the primary category controls the display name. Behind the scenes, eBay's search engine uses the ID (not the display name) to determine whether items are new, used, or refurbished. So, if you need to normalize the conditions across categories (such as to group items by condition), it may be easier to use the ID and then show the varying display names for reference. In condition histograms: If you search against a specific category and some items match based on their secondary category, the histogram only shows the display name if the secondary category supports the condition. (Condition IDs and names are dependent on the primary category.) However, the histogram shows the condition ID and item counts. This should only occur in a very small percent of results. As a workaround, you can fill in the missing name based on the "Item Condition IDs and Names" (link below) or based on the condition from an applicable item in the results. For example, suppose a seller lists a concert T-shirt in a clothing category with the condition "New without tags" (1500), and also in a music accessories secondary category (where "New without tags" isn't a recognized condition). If you specify the music accessories category in your request, the condition ID (1500) is shown in the histogram, but not the display name. However, the display name is shown within the items. Max length: 50. See Item Condition IDs and Names for a list of display names and the typical meaning of each condition.
searchResult.item.condition .conditionId	int	Conditionally	The numeric ID (e.g., 1000) for the item condition. In item results, this is only returned when the seller listed the item with a condition ID. Some categories don't support or require condition IDs (e.g., most Antiques categories don't). If you Condition as a itemFilter, the response returns items with the correctly matching condition(s), even if conditionId is not returned. See Item Condition IDs and Names for a list of display names and the typical meaning of each condition.
searchResult.item.country	token	Conditionally	Two-letter ISO 3166 country code to indicate the country where the item is located (e.g., "US" for the United States or "GB" for the United Kingdom). See English country names and code elements for country names and corresponding ISO 3166 codes.
searchResult.item .discountPriceInfo	DiscountPriceInfo	Conditionally	The format type of the listing, such as online auction, fixed price, or advertisement.
searchResult.item.distance	Distance (double)	Conditionally	The distance that the item is from the buyer, calculated using buyerPostalCode. The unit for distance varies by site, and is either miles or kilometers. If the country whose site you are searching uses kilometers to measure distance (for example, India/EBAY-IN), the unit is kilometers. If the site is either the US or UK, the distance unit is miles. This value is only returned for distance-based searches. You must specify a buyerPostalCode and either sort by Distance, or use a combination of the MaxDistance LocalSearch itemFilters.
searchResult.item.distance [ attribute unit ]	string	Conditionally	The distance that the item is from the buyer, calculated using buyerPostalCode. The unit for distance varies by site, and is either miles or kilometers. If the country whose site you are searching uses kilometers to measure distance (for example, India/EBAY-IN), the unit is kilometers. If the site is either the US or UK, the distance unit is miles. This value is only returned for distance-based searches. You must specify a buyerPostalCode and either sort by Distance, or use a combination of the MaxDistance LocalSearch itemFilters.
searchResult.item .eBayPlusEnabled	boolean	Conditionally	Indicates whether the item is ebayPlus item. This field is returned for the following sites only: DE (EBAY-DE), AU (EBAY-AU)
searchResult.item.eekStatus	string	Conditionally, repeatable: [0..*]	eek status of the item
searchResult.item .galleryInfoContainer	GalleryInfoContainer	Conditionally	Contains three URLs for item thumbnail images in standard sizes. Not returned if the item has no images. That is, if the item was not listed using a product identifier and the seller has not uploaded images, the container will not be returned, even when the outputSelector is set to GalleryInfo.
searchResult.item .galleryInfoContainer .galleryURL	GalleryURL (anyURI)	Always, repeatable: [1..3]	URL for a single item image thumbnail of a specific size.
searchResult.item .galleryInfoContainer .galleryURL [ attribute gallerySize ]	GallerySizeEnum	Conditionally	URL for a single item image thumbnail of a specific size. For a list of possible enumeration values, see GallerySizeEnum.
searchResult.item .galleryPlusPictureURL	anyURI	Conditionally, repeatable: [0..*]	URL for the Gallery Plus image. The size of Gallery Plus images (up to 500 pixels on the longest side) is bigger than the size of standard gallery images. In site search results, you can view the Gallery Plus image by hovering over or clicking the Enlarge link or magifying glass icon. This field is only returned when the seller has opted for the Gallery Plus option for the given item.
searchResult.item.galleryURL	anyURI	Conditionally	URL for the Gallery thumbnail image. Returned only if the seller uploaded images for the item or the item was listed using a product identifier.
searchResult.item.globalId	token	Always	The identifier for the site on which the item is listed. Returns a Global ID, which is a unique identifier that specifies the combination of the site, language, and territory. In other eBay APIs (such as the Shopping API), this value is know as the site ID. See Global ID Values for a list of possible enumeration values and how they map to eBay sites.
searchResult.item.itemId	string	Always	The ID that uniquely identifies the item listing. eBay generates this ID when an item is listed. ID values are unique across all eBay sites. Max length: 19 (normally, item IDs are 9 to 12 digits in length) .
searchResult.item.listingInfo	ListingInfo	Conditionally	The format type of the listing, such as online auction, fixed price, or advertisement.
searchResult.item.listingInfo .bestOfferEnabled	boolean	Conditionally	Shows whether or not the seller will accept a best offer for the associated item. Best Offer allows a buyer to make a lower-priced binding offer on a fixed price item. Buyers cannot see how many offers have been made (only the seller can see this information). To make a best offer on a listing, use the eBay Web site.
searchResult.item.listingInfo .buyItNowAvailable	boolean	Conditionally	Applies only to auction listings that were listed with a Buy It Now price. Buy It Now lets a user purchase the item at a fixed price, effectively ending the auction. On most sites, the Buy It Now option is removed (and this value returns false) once a valid bid is made on the associated item (a valid bid could be a bid above the reserve price). buyItNowAvailable will return "false" if the listing type is anything but "AuctionWithBIN". Please ignore buyItNowAvailable for fixed-price listings.
searchResult.item.listingInfo .buyItNowPrice	Amount (double)	Conditionally	The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed. You can use this field to determine if the item was originally listed with Buy It Now, even if the Buy It Now option is no longer available for the item. For Basic Fixed-Price (FixedPrice), Store Inventory (StoreInventory), Ad Format (AdFormat), and Classified Ad (Classified) listings, currentPrice is the current fixed price. Only returned if an item was listed with Buy It Now.
searchResult.item.listingInfo .buyItNowPrice [ attribute currencyId ]	string	Always	The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed. You can use this field to determine if the item was originally listed with Buy It Now, even if the Buy It Now option is no longer available for the item. For Basic Fixed-Price (FixedPrice), Store Inventory (StoreInventory), Ad Format (AdFormat), and Classified Ad (Classified) listings, currentPrice is the current fixed price. Only returned if an item was listed with Buy It Now.
searchResult.item.listingInfo .convertedBuyItNowPrice	Amount (double)	Conditionally	The listing's Buy It Now Price (if any), converted into the currency of the site to which you sent your search request. For active items, refresh this value every 24 hours to pick up changes in conversion rates (if this value has been converted). Price fields are returned as doubles, not necessarily in the traditional monetary format of the site's country. For example, a US Dollar value might be returned as 3.880001 instead of 3.88. Only returned if an item was listed with Buy It Now.
searchResult.item.listingInfo .convertedBuyItNowPrice [ attribute currencyId ]	string	Always	The listing's Buy It Now Price (if any), converted into the currency of the site to which you sent your search request. For active items, refresh this value every 24 hours to pick up changes in conversion rates (if this value has been converted). Price fields are returned as doubles, not necessarily in the traditional monetary format of the site's country. For example, a US Dollar value might be returned as 3.880001 instead of 3.88. Only returned if an item was listed with Buy It Now.
searchResult.item.listingInfo .endTime	dateTime	Conditionally	Time stamp specifying when the listing is scheduled to end, or the actual end time if the item listing has ended. This value is returned in GMT, the ISO 8601 date and time format (YYYY-MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. Note: For items that are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. This difference in time is intended to facilitate the renewal of these items' end times (which occurs every 30 days).
searchResult.item.listingInfo .gift	boolean	Conditionally	If true, a generic gift icon displays next the listing's title in search and browse pages.
searchResult.item.listingInfo .listingType	token	Conditionally	The format of the listing, such as online auction, fixed price, or advertisement. listingType values: AdFormat Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay and eBay Feedback is not available for ad format listings. Auction Competitive-bid online auction format. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no valid bids have been placed. Online auctions are listed on eBay.com; they can also be listed in a seller's eBay Store if the seller is a Store owner. AuctionWithBIN Same as Auction format, but Buy It Now is enabled. AuctionWithBIN changes to Auction if a valid bid has been placed on the item. Valid bids include bids that are equal to or above any specified reserve price. Classified Classified Ads connect buyers and sellers, who then complete the sale outside of eBay. This format does not enable buyers and sellers to transact online through eBay and eBay Feedback is not available for these listing types. FixedPrice A fixed-price listing. Auction-style bidding is not allowed. On some sites, this auction format is also known as "Buy It Now Only" (not to be confused with the Buy It Now option available with competitive- bidding auctions). Fixed-price listings appear on eBay.com; they can also be listed in a seller's eBay Store if the seller is a Store owner.
searchResult.item.listingInfo .startTime	dateTime	Conditionally	Time stamp that eBay recorded as the moment the listing was made available. This value is returned in GMT, the ISO 8601 date and time format (YYYY-MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone. Note that it is possible for startTime to be different from the value returned by GetSingleItem.
searchResult.item.location	string	Conditionally	Physical location of the item, as specified by the seller. This gives a general indication from where the item will be shipped (or delivered).
searchResult.item .paymentMethod	token	Conditionally, repeatable: [0..*]	Identifies the payment method (or methods) available to the buyer to purchase the item. See BuyerPaymentMethodCodeType in the Shopping API for a complete list of possible paymentMethod response values.
searchResult.item .pictureURLLarge	anyURI	Conditionally	URL for item's picture url with size 400x400
searchResult.item .pictureURLSuperSize	anyURI	Conditionally	URL for item's picture url with size 800x800
searchResult.item.postalCode	string	Conditionally	The postal code where the listed item is located. This field is returned only if a postal code has been specified by the seller. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned via the API. eBay proximity and local search behavior can use the combination of buyerPostalCode and postalCode values.
searchResult.item .primaryCategory	Category	Always	Details about the first (or only) category in which the item is listed. Note that items can be listed in more than a single category.
searchResult.item .primaryCategory.categoryId	string	Always	The unique ID of a category on the specified eBay site. Max length: 10.
searchResult.item .primaryCategory.categoryName	string	Always	Display name of a category as it appears on the eBay Web site. Max length: 30.
searchResult.item.productId	ProductId (string)	Conditionally	Unique identifier for the eBay catalog product with which the item was listed. An eBay catalog product consists of pre-filled Item Specifics, additional descriptive information, plus a stock photo (if available). These product details are used to pre-fill item information, which is used to describe the item and can also help surface the item in searches. eBay supports the following types of product ID types: ISBN, UPC, EAN, and ReferenceID (ePID, also known as an eBay Product Reference ID). ReferenceID values are returned when available. A UPC, ISBN, or EAN product identifier will be returned only when a ReferenceID is not available. This productId value can be used as input with findItemsByProduct to retrieve items that were listed with the specified eBay catalog product. This field is only returned when a product was used to list the item.
searchResult.item .secondaryCategory	Category	Conditionally	Details about the second category in which the item is listed. This element is not returned if the seller did not specify a secondary category.
searchResult.item .secondaryCategory.categoryId	string	Conditionally	The unique ID of a category on the specified eBay site. Max length: 10.
searchResult.item .secondaryCategory .categoryName	string	Conditionally	Display name of a category as it appears on the eBay Web site. Max length: 30.
searchResult.item.sellerInfo	SellerInfo	Conditionally	Information about the item's seller. Only returned if SellerInfo is specified in the outputSelector field in the request.
searchResult.item.sellerInfo .feedbackRatingStar	token	Conditionally	Visual indicator of user's feedback score. feedbackRatingStar values: None No graphic displayed, feedback score 0-9. Yellow Yellow Star, feedback score 10-49. Blue Blue Star, feedback score 50-99. Turquoise Turquoise Star, feedback score 100-499. Purple Purple Star, feedback score 500-999. Red Red Star, feedback score 1,000-4,999. Green Green Star, feedback score 5,000-9,999. YellowShooting Yellow Shooting Star, feedback score 10,000-24,999. TurquoiseShooting Turquoise Shooting Star, feedback score 25,000-49,999. PurpleShooting Purple Shooting Star, feedback score 50,000-99,999. RedShooting Red Shooting Star, feedback score 100,000-499,000 and above. GreenShooting Green Shooting Star, feedback score 500,000-999,000 and above. SilverShooting Silver Shooting Star, feedback score 1,000,000 or more.
searchResult.item.sellerInfo .feedbackScore	long	Conditionally	The aggregate feedback score of the seller. A seller's feedback score is their net positive feedback minus their net negative feedback. Feedback scores are a quantitative expression of the desirability of dealing with a seller in a transaction.
searchResult.item.sellerInfo .positiveFeedbackPercent	double	Conditionally	The percentage value of a user's positive feedback (their positive feedbackScore divided by their total positive plus negative feedback).
searchResult.item.sellerInfo .sellerUserName	string	Conditionally	The seller's eBay user name; a unique value.
searchResult.item.sellerInfo .topRatedSeller	boolean	Conditionally	Indicates whether the seller of the item is top-rated. A top-rated seller: Consistently receives highest buyers' ratings Ships items quickly Has earned a track record of excellent service eBay regularly reviews the performance of these sellers to confirm they continue to meet the program's requirements. This field is returned for the following sites only: US (EBAY-US), Motors (EBAY-MOTOR), DE (EBAY-DE), AT (EBAY-AT), and CH (EBAY-CH). See Top-rated Sellers page.
searchResult.item .sellingStatus	SellingStatus	Conditionally	Specifies the item's selling status with regards to eBay's processing workflow.
searchResult.item .sellingStatus.bidCount	int	Conditionally	The number of bids that have been placed on the item. Min: 0.
searchResult.item .sellingStatus .convertedCurrentPrice	Amount (double)	Conditionally	The listing's current price converted to the currency of the site specified in the find request (globalId).
searchResult.item .sellingStatus .convertedCurrentPrice [ attribute currencyId ]	string	Always	The listing's current price converted to the currency of the site specified in the find request (globalId).
searchResult.item .sellingStatus.currentPrice	Amount (double)	Conditionally	The current price of the item given in the currency of the site on which the item is listed. That is, currentPrice is returned in the original listing currency. For competitive-bid item listings, currentPrice is the current minimum bid price if the listing has no bids, or the current high bid if the listing has bids. A Buy It Now price has no effect on currentPrice. For Basic Fixed-Price (FixedPrice), Store Inventory (StoreInventory), Ad Format (AdFormat), and Classified Ad (Classified) listings, currentPrice is the current fixed price.
searchResult.item .sellingStatus.currentPrice [ attribute currencyId ]	string	Always	The current price of the item given in the currency of the site on which the item is listed. That is, currentPrice is returned in the original listing currency. For competitive-bid item listings, currentPrice is the current minimum bid price if the listing has no bids, or the current high bid if the listing has bids. A Buy It Now price has no effect on currentPrice. For Basic Fixed-Price (FixedPrice), Store Inventory (StoreInventory), Ad Format (AdFormat), and Classified Ad (Classified) listings, currentPrice is the current fixed price.
searchResult.item .sellingStatus.sellingState	token	Conditionally	Specifies the listing's status in eBay's processing workflow. If an item's EndTime is in the past, but there are no details about the buyer or high bidder (and the user is not anonymous), you can use sellingState information to determine whether eBay has finished processing the listing. sellingState values: Active The listing is still live. It is also possible that the auction has recently ended, but eBay has not completed the final processing (e.g., the high bidder is still being determined). Canceled The listing has been canceled by either the seller or eBay. Ended The listing has ended and eBay has completed the processing of the sale (if any). EndedWithSales The listing has been ended with sales. EndedWithoutSales The listing has been ended without sales.
searchResult.item .sellingStatus.timeLeft	duration	Conditionally	Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). For listings that have ended, the time left is PT0S (zero seconds). See the "duration" type for information about this time format.
searchResult.item.shippingInfo	ShippingInfo	Conditionally	Container for data about a listing's shipping details.
searchResult.item.shippingInfo .shippingServiceCost	Amount (double)	Conditionally	The basic shipping cost of the item. This reflects the domestic shipping cost or the international shipping costs, depending on which applies (that is, whether the bidder/buyer is in the same country as the listing site of the item).
searchResult.item.shippingInfo .shippingServiceCost [ attribute currencyId ]	string	Always	The basic shipping cost of the item. This reflects the domestic shipping cost or the international shipping costs, depending on which applies (that is, whether the bidder/buyer is in the same country as the listing site of the item).
searchResult.item.shippingInfo .shippingType	token	Conditionally	The shipping method that was used for determining the cost of shipping. For example: flat rate, calculated, or free. The seller specifies the available shipping services when they list the item. shippingType values: Calculated The calculated shipping model: The posted cost of shipping is based on the buyer-selected shipping service, chosen by the buyer from the different shipping services offered by the seller. The shipping costs are calculated by eBay and the shipping carrier, based on the buyer's address. Any packaging and handling costs established by the seller are automatically rolled into the total. CalculatedDomesticFlatInternational The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. Flat The flat-rate shipping model: The seller establishes the cost of shipping and any shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. FlatDomesticCalculatedInternational The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. Free Free is used when the seller has declared that shipping is free for the buyer. FreePickup No shipping available, the buyer must pick up the item from the seller. Freight The freight shipping model: the cost of shipping is determined by a third party, FreightQuote.com, based on the buyer's address (postal code). FreightFlat The flat rate shipping model: the seller establishes the cost of freight shipping and freight insurance, regardless of what any buyer-selected shipping service might charge the seller. NotSpecified The seller did not specify the shipping type.
searchResult.item.shippingInfo .shipToLocations	string	Conditionally, repeatable: [0..*]	An international location or region to which the seller is willing to ship the item. Only returned when the seller has specifically identified locations where she is willing to ship the given item. specified. See shipToLocations for a complete list of shipping locations.
searchResult.item.storeInfo	Storefront	Conditionally	Information about the eBay store in which the item is listed. Only returned if the item is listed in a store and StoreInfo is specified in the outputSelector field in the request.
searchResult.item.storeInfo .storeName	string	Conditionally	The name of the seller's eBay Store. Max length: 200.
searchResult.item.storeInfo .storeURL	anyURI	Conditionally	The URL of the seller's eBay Store page.
searchResult.item.subtitle	string	Conditionally	Subtitle of the item. Only returned if the seller included a subtitle for the listing.
searchResult.item.title	string	Conditionally	Name of the item as it appears in the listing title, or in search and browse results.
searchResult.item .topRatedListing	boolean	Conditionally	Indicates whether the item is Top Rated Plus item. A top rated plus item: is listed by experienced sellers with highest buyer ratings;/li> Sellers commit to shipping your items in a business day with tracking provided and offer at least a 14-day, money-back return policy;/li> This field is returned for the following sites only: US (EBAY-US) See Top Rated Plus item page.
searchResult.item.unitPrice	UnitPriceInfo	Conditionally	Unit price information of the item
searchResult.item.viewItemURL	anyURI	Conditionally	The URL to view this specific listing on eBay. The returned URL is optimized to support natural search. That is, the URL is designed to make items on eBay easier to find via popular internet search engines. The URL includes the item title along with other optimizations. If you enabled affiliate tracking in the call, viewItemURL contains a string that includes affiliate tracking information. Note: eBay URLs returned in fields, such as viewItemURL, are subject to syntax and other changes without notice. To avoid problems in your application when eBay alters the URL format, we advise you to avoid parsing eBay URLs programmatically. We strive to ensure that other fields in the response contain all the information that is encoded in the URL, and more. See eBay Partner Network for more information.
timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone.
version	string	Always	The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues. Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site.

Detail Controls

DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Samples

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Retrieves a set of items that successfully ended with a sale, based on keywords and category

Description

A seller wants to list a used GPS on eBay and wants to determine the best price to list the item for. The seller wants to find only similar items that have sold recently and have similar shipping and handling procedures.

Input

To determine the right selling price for the GPS, the seller searches for items with the following request parameters:

GPS category (categoryId = 156955)
Specific keywords (keywords = Garmin nuvi 1300 Automotive GPS Receiver)
Only items that are used, as indicated by an item condition ID of 3000 (itemFilter.name = Condition, itemFilter.value = 3000)
Only items that actually sold (itemFilter.name = SoldItemsOnly, itemFilter.value = true)
Only items that offer free shipping (itemFilter.name = FreeShippingOnly, itemFitler.value = true)
Results sorted by price (sortOrder = PricePlusShippingLowest), because the seller wants to see pricing and handling charges that are similar to what he/she would charge

URL format. See also the non-wrapped version of this URL. For results in a format other than XML, 
specify a different value for responseencoding.

https://svcs.ebay.com/services/search/FindingService/v1?
   OPERATION-NAME=findCompletedItems&
   SERVICE-VERSION=1.7.0&
   SECURITY-APPNAME=YourAppID&
   RESPONSE-DATA-FORMAT=XML&
   REST-PAYLOAD&
   keywords=Garmin+nuvi+1300+Automotive+GPS+Receiver&
   categoryId=156955&
   itemFilter(0).name=Condition&
   itemFilter(0).value=3000&
   itemFilter(1).name=FreeShippingOnly&
   itemFilter(1).value=true&
   itemFilter(2).name=SoldItemsOnly&
   itemFilter(2).value=true&
   sortOrder=PricePlusShippingLowest&
   paginationInput.entriesPerPage=2

Here is the same input in XML format. Note that this does not include standard values.

XML format. Also available is the JSON equivalent.

<?xml version="1.0" encoding="UTF-8"?>
<findCompletedItemsRequest xmlns="http://www.ebay.com/marketplace/search/v1/services">
   <keywords>Garmin nuvi 1300 Automotive GPS Receiver</keywords>
   <categoryId>156955</categoryId>
   <itemFilter>
      <name>Condition</name>
      <value>3000</value>
   </itemFilter>
   <itemFilter>
      <name>FreeShippingOnly</name>
      <value>true</value>
   </itemFilter>
   <itemFilter>
      <name>SoldItemsOnly</name>
      <value>true</value>
   </itemFilter>
   <sortOrder>PricePlusShippingLowest</sortOrder>
   <paginationInput>
      <entriesPerPage>2</entriesPerPage>
      <pageNumber>1</pageNumber>
   </paginationInput>
</findCompletedItemsRequest>

Output

The response contains matching items that meet the criteria for category, keywords, sortOrder, only sold items, free shipping, with two responses displayed per page.

XML format. Also available is the JSON equivalent.

<findCompletedItemsResponse xmlns="http://www.ebay.com/marketplace/search/v1/services">
   <ack>Success</ack>
   <version>1.11.0</version>
   <timestamp>2015-12-17T22:55:44.894Z</timestamp>
   <searchResult count="2">
      <item>
         <itemId>2**********3</itemId>
         <title>Garmin nuvi 1300 Automotive GPS Receiver HAS PIN PLEASE READ</title>
         <globalId>EBAY-US</globalId>
         <primaryCategory>
            <categoryId>156955</categoryId>
            <categoryName>GPS Systems</categoryName>
         </primaryCategory>
         <galleryURL>https://thumbs2.ebaystatic.com/pict/2**************0_1.jpg</galleryURL>
         <viewItemURL>https://www.ebay.com/itm/Garmin-nuvi-1300-Automotive-GPS-Receiver-HAS-PIN-PLEASE-READ-/2**********3?pt=GPS_Devices</viewItemURL>
         <productId type="ReferenceID">72068366</productId>
         <paymentMethod>PayPal</paymentMethod>
         <autoPay>false</autoPay>
         <postalCode>56***</postalCode>
         <location>Saint Cloud,MN,USA</location>
         <country>US</country>
         <shippingInfo>
            <shippingServiceCost currencyId="USD">0.0</shippingServiceCost>
            <shippingType>Free</shippingType>
            <expeditedShipping>true</expeditedShipping>
            <oneDayShippingAvailable>false</oneDayShippingAvailable>
            <handlingTime>3</handlingTime>
            <shipToLocations>US</shipToLocations>
         </shippingInfo>
         <sellingStatus>
            <currentPrice currencyId="USD">25.0</currentPrice>
            <convertedCurrentPrice currencyId="USD">25.0</convertedCurrentPrice>
            <bidCount>1</bidCount>
            <sellingState>EndedWithSales</sellingState>
         </sellingStatus>
         <listingInfo>
            <bestOfferEnabled>false</bestOfferEnabled>
            <buyItNowAvailable>false</buyItNowAvailable>
            <startTime>2015-12-08T17:02:40.000Z</startTime>
            <endTime>2015-12-08T19:17:28.000Z</endTime>
            <listingType>Auction</listingType>
            <gift>false</gift>
         </listingInfo>
         <returnsAccepted>false</returnsAccepted>
         <condition>
            <conditionId>3000</conditionId>
            <conditionDisplayName>Used</conditionDisplayName>
         </condition>
         <isMultiVariationListing>false</isMultiVariationListing>
      </item>
      <item>
         <itemId>2**********1</itemId>
         <title>Garmin nuvi 1300 Automotive GPS Receiver</title>
         <globalId>EBAY-US</globalId>
         <primaryCategory>
            <categoryId>156955</categoryId>
            <categoryName>GPS Systems</categoryName>
         </primaryCategory>
         <galleryURL>https://thumbs4.ebaystatic.com/pict/2**************0_1.jpg</galleryURL>
         <viewItemURL>https://www.ebay.com/itm/Garmin-nuvi-1300-Automotive-GPS-Receiver-/2**********1?pt=GPS_Devices</viewItemURL>
         <productId type="ReferenceID">72068366</productId>
         <paymentMethod>PayPal</paymentMethod>
         <autoPay>false</autoPay>
         <postalCode>98***</postalCode>
         <location>Snoqualmie,WA,USA</location>
         <country>US</country>
         <shippingInfo>
            <shippingServiceCost currencyId="USD">0.0</shippingServiceCost>
            <shippingType>Free</shippingType>
            <expeditedShipping>true</expeditedShipping>
            <oneDayShippingAvailable>false</oneDayShippingAvailable>
            <handlingTime>2</handlingTime>
            <shipToLocations>US</shipToLocations>
         </shippingInfo>
         <sellingStatus>
            <currentPrice currencyId="USD">44.0</currentPrice>
            <convertedCurrentPrice currencyId="USD">44.0</convertedCurrentPrice>
            <bidCount>1</bidCount>
            <sellingState>EndedWithSales</sellingState>
         </sellingStatus>
         <listingInfo>
            <bestOfferEnabled>false</bestOfferEnabled>
            <buyItNowAvailable>false</buyItNowAvailable>
            <startTime>2015-12-11T21:25:47.000Z</startTime>
            <endTime>2015-12-11T22:45:55.000Z</endTime>
            <listingType>Auction</listingType>
            <gift>false</gift>
         </listingInfo>
         <returnsAccepted>false</returnsAccepted>
         <condition>
            <conditionId>3000</conditionId>
            <conditionDisplayName>Used</conditionDisplayName>
         </condition>
         <isMultiVariationListing>false</isMultiVariationListing>
      </item>
   </searchResult>
   <paginationOutput>
      <pageNumber>1</pageNumber>
      <entriesPerPage>2</entriesPerPage>
      <totalPages>28</totalPages>
      <totalEntries>55</totalEntries>
   </paginationOutput>
</findCompletedItemsResponse>

Change History

Change Date	Description
1.13.0 10/21/2014	domainFilter (deprecated): The domainFilter field has been deprecated. You should use categoryID instead. Calls using domainFilter will not fail, but the field will be ignored. eekStatus (added): Indicates the energy efficiency rating of the item. Note This is currently applicable only for the DE-Germany site.
1.12.0 05/16/2012	topRatedListing (doc change): In the call reference documentation, topRatedListing had appeared erroneously under searchResult.item.sellerInfo. It now appears in its correct location under searchResult.item, with an updated description. unitPrice (doc change): In the call reference documentation, unitPrice had appeared erroneously under searchResult.item.sellerInfo. It now appears in its correct location under searchResult.item, with an updated description. shippingInfo (doc change): Three shippingInfo fields (expeditedShipping, handlingTime and oneDayShippingAvailable) are returned only for items listed on the eBay US site. This was not previously made clear in the field descriptions.
1.11.0 06/08/2011	(added) New call.

affiliate	Affiliate	Optional	Container for affiliate details. eBay uses the specified affiliate information to build a View Item URL and Product URL string with correctly formatted affiliate tracking information, which it returns in the response. You can publish these URLs, and if a user clicks them to access eBay, the respective affiliate might get a commission, depending on the user's actions. See: eBay Partner Network site for information about affiliate commissions findItemsByKeywords Call Sample: Specifying affiliate information
affiliate.customId	string	Optional	You can define an affiliate customId if you want an ID to monitor your marketing efforts. Chose an ID up to up to 256 characters in length. If you are using the eBay Partner Network, and you provide a customId, the tracking URL returned by the eBay Partner Network will contain your customId value.
affiliate.geoTargeting	boolean	Optional	The lgeo parameter will be used for geo-targeting feature that is already implemented on the affiliate tracking side
affiliate.networkId	string	Optional	Specifies your tracking partner for affiliate commissions. Affiliates earn money from eBay for driving traffic to eBay. This field is required if you specify a tracking ID. Depending on your tracking partner, specify one of the following values. Not all partners are valid for all sites. For PlaceOffer, only the eBay Partner Network and Mediaplex are valid: 2 = Be Free 3 = Affilinet 4 = TradeDoubler 5 = Mediaplex 6 = DoubleClick 7 = Allyes 8 = BJMT 9 = eBay Partner Network See eBay Partner Network site for information about commissions.
affiliate.trackingId	string	Optional	Specify the affiliate value obtained from your tracking partner. For the eBay Partner Network, the tracking ID is the provided Campaign ID ("campid"). A Campaign ID is a unique 10-digit number used for associating traffic and is valid across all programs to which you have been accepted. Another example of this value is the Affiliate ID given to you by TradeDoubler.
buyerPostalCode	string	Optional	The postal code of the buyer. This is used as the basis for proximity searches as well as local searches. A proximity search requires buyerPostalCode and a MaxDistance item filter. A local search requires buyerPostalCode and item filters for MaxDistance and LocalSearch. Note: To get the accurate shipping cost for items listed using a rate table, you must include buyerPostalCode in the request. See findItemsByKeywords Call Sample: Proximity Search for an example of how to restrict searches by distance.
paginationInput	PaginationInput	Optional	Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and the page of data to return. Controls the number of listings returned in the response, but does not specify the details to return for each listing. Note: No more than 10,000 items can be retrieved for a given search, regardless of how many matches are found. This limit is enforced by the maximum page number allowed (100) and the maximum entries per page allowed (100).
paginationInput.entriesPerPage	int	Optional	Specifies the maximum number of entries to return in a single call. If the number of entries found on the specified pageNumber is less than the value specified here, the number of items returned will be less than the value of entriesPerPage. This indicates the end of the result set. If entriesPerPage is set to a number greater than 100, the default value, 100, will be used. Min: 1. Max: 100. Default: 100.
paginationInput.pageNumber	int	Optional	Specifies which subset of data (or "page") to return in the call response. The number of data pages is determined by the total number of items matching the request search criteria (returned in paginationOutput.totalEntries) divided by the number of entries to display in each response (entriesPerPage). You can return up to the first 100 pages of the result set by issuing multiple requests and specifying, in sequence, the pages to return. Min: 1. Max: 100. Default: 1.
sortOrder	SortOrderType	Optional	Sort the returned items according to a single specified sort order. Default: BestMatch. Applicable values: See sortOrder.