GetCategoryListingsRequestType
Note: This API call is being deprecated and will not be available after July 1, 2010. The functionality provided by this call will be supported in the new Finding API. If you're building new search applications, we recommend you start with the Finding API.
Returns items in a specified category. A number of inputs are provided for filtering the item listings returned using such criteria as location, whether the item is listed in an ebay Store, the listing type, and including or excluding specified sellers.

If you are not using the BestMatch search option, the API search results may not match the search results returned by the eBay website.

It is recommended that you consider using FindItemsAdvanced (in the Shopping API) instead of GetCategoryListings because FindItemsAdvanced is easier to use and faster. See Shopping API for more information.
Fields
AdFormat ( boolean )
CategoryID ( string )
Currency ( CurrencyCodeType )
FreeShipping ( boolean )
Group ( GroupType )
HideDuplicateItems ( boolean )
IncludeCondition ( boolean )
IncludeFeedback ( boolean )
IncludeGetItFastItems ( boolean )
ItemTypeFilter ( ItemTypeFilterCodeType )
LocalSearchPostalCode ( string )
MaxRelatedSearchKeywords ( int )
MotorsGermanySearchable ( boolean )
OrderBy ( CategoryListingsOrderCodeType )
Pagination ( PaginationType )
PaymentMethod ( PaymentMethodSearchCodeType )
ProximitySearch ( ProximitySearchType )
SearchLocation ( SearchLocationType )
SearchType ( CategoryListingsSearchCodeType )

AdFormat ( boolean ) [0..1]
Restricts listings to return only items that have the Ad Format feature. If true, the values of ItemTypeFilter and StoreSearchFilter are ignored (if they are specified). That is, "AND" logic is not applied.
See the Field Index to learn which calls use AdFormat.

CategoryID ( string ) [0..1]
Specifies the category for which to retrieve item listings.
See the Field Index to learn which calls use CategoryID.

Currency ( see CurrencyCodeType for possible values ) [0..1]
A currency value. Limits the result set to just those items listed using a specified currency. Not applicable to US eBay Motors searches.
See the Field Index to learn which calls use Currency.

FreeShipping ( boolean ) [0..1]
If true, only items with free shipping for the user's location are returned. The user's location is determined from the site ID specified in the request. If false, no filtering is done via this attribute. A listing is not considered a free shipping listing if it requires insurance or requires pick up or requires a shipping surcharge.
See the Field Index to learn which calls use FreeShipping.

Group ( GroupType ) [0..1]
You can group Best Match search results by category. To group by category, put the BestMatchCategoryGroup value in the OrderBy field. When you use the BestMatchCategoryGroup value, you can include group parameters in your call. Note that there will be significanty fewer results returned with a BestMatchCategoryGroup sort because the results account for Best Matches in lower-level (leaf) as well as higher-level categories. There is not a direct correlation between the number of results returned in a regular sort or the number of results returned with a BestMatch sort, and the results that are returned by the BestMatchCategoryGroup sort. You should not receive more than 2 pages of results with this type of sort. See also the new GroupCategoryID element in ItemType.
See the Field Index to learn which calls use Group.

HideDuplicateItems ( boolean ) [0..1]
Specifies whether or not to remove duplicate items from search results. When set to true, and there are duplicate items for an item in the search results, the subsequent duplicates will not appear in the results. Item listings are considered duplicates in the following conditions:
  • Items are listed by the same seller
  • Items have exactly the same item title
  • Items have similar listing formats
    • Auctions: Auction Items, Auction BIN items, Multi-Quantity Auctions, and Multi-Quantity Auctions BIN items
    • Fixed Price: Fixed Price, Multi-quantity Fixed Price, Fixed Price with Best Offer, and Store Inventory Format items
    • Classified Ads

For Auctions, items must also have the same price and number of bids to be considered duplicates.
Filtering of duplicate item listings is not supported on all sites.
See the Field Index to learn which calls use HideDuplicateItems.

IncludeCondition ( boolean ) [0..1]
If true, each item in the result set can also include the item condition (whether the item is new or used). The item's condition is returned in Item.AttributeSetArray. An item only includes condition attribute if the item's seller filled in the Item Condition in the Item Specifics section of the listing. (That is, the condition is not returned if the seller only put the word "New" in the listing's title.)
See the Field Index to learn which calls use IncludeCondition.

IncludeFeedback ( boolean ) [0..1]
If true, each item in the result set also includes information about the seller's feedback.
See the Field Index to learn which calls use IncludeFeedback.

IncludeGetItFastItems ( boolean ) [0..1]
When passed with a value of true, limits the results to Get It Fast listings.
See the Field Index to learn which calls use IncludeGetItFastItems.

ItemTypeFilter ( see ItemTypeFilterCodeType for possible values ) [0..1]
Filters items based on the ListingType set for the items. If ItemTypeFilter is not specified (or if the AllItemTypes value of ItemTypeFilter is specified), all listing types can be returned unless another relevant filter is specified.
See the Field Index to learn which calls use ItemTypeFilter.

LocalSearchPostalCode ( string ) [0..1]
Include local items in returning results near this postal code. This postal code is the basis for local search.
See the Field Index to learn which calls use LocalSearchPostalCode.

MaxRelatedSearchKeywords ( int ) [0..1]
The maximum number of related keywords to be retrieved. Use this field if you want the results to include recommended keywords (that is, keywords matching the category ID) in a RelatedSearchKeywordArray container. A value of 0 (the default) means no related search information is processed.
See the Field Index to learn which calls use MaxRelatedSearchKeywords.

MotorsGermanySearchable ( boolean ) [0..1]
Filters the response based on each item's eligibility to appear on the mobile.de site. If false, excludes eligible items from search results. If true, queries for eligible items only. If not specified, the search results are not affected. Only applicable for items listed on the eBay Germany site (site ID 77) in subcategories of mobile.de search-enabled categories.
See the Field Index to learn which calls use MotorsGermanySearchable.

OrderBy ( see CategoryListingsOrderCodeType for possible values ) [0..1]
Specifies the order in which the item listings returned will be sorted. Store Inventory listings are usually returned after other listing types, regardless of the sort order.
See the Field Index to learn which calls use OrderBy.

Pagination ( PaginationType ) [0..1]
Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return.
See the Field Index to learn which calls use Pagination.

PaymentMethod ( see PaymentMethodSearchCodeType for possible values ) [0..1]
Specifies items that accept a specific payment method or methods.
See the Field Index to learn which calls use PaymentMethod.

ProximitySearch ( ProximitySearchType ) [0..1]
Limits the result set to just those items that meet proximity search criteria: postal code and max distance.
See the Field Index to learn which calls use ProximitySearch.

SearchLocation ( SearchLocationType ) [0..1]
Limits the result set to just those items that meet location criteria: listed in a specified eBay site, location where the seller has the item, location from which the user is searching, and/or items listed with a specified currency.
See the Field Index to learn which calls use SearchLocation.

SearchType ( see CategoryListingsSearchCodeType for possible values ) [0..1]
Specifies whether to limit the item listings to just those that are category featured or super featured or all items.
See the Field Index to learn which calls use SearchType.

This document was generated with a customized version of the apireferencedocs tool.

© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.