eBay Finding APIVersion 1.13.0
** This call is deprecated. **
See also the reference documentation for this call:
| Output Detail Controls Samples Change History |
See also Samples.
The box below lists all fields that could be included in the call request. 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"?> <findItemsByImageRequest xmlns="https://www.ebay.com/marketplace/search/v1/services"> <!-- Call-specific Input Fields --> <aspectFilter> AspectFilter <aspectName> string </aspectName> <aspectValueName> string </aspectValueName> <!-- ... more aspectValueName values allowed here ... --> </aspectFilter> <!-- ... more aspectFilter nodes allowed here ... --> <categoryId> string </categoryId> <!-- ... more categoryId values allowed here ... --> <domainFilter> DomainFilter <domainName> string </domainName> <!-- ... more domainName values allowed here ... --> </domainFilter> <!-- ... more domainFilter nodes allowed here ... --> <itemFilter> ItemFilter <name> ItemFilterType </name> <paramName> token </paramName> <paramValue> string </paramValue> <value> string </value> <!-- ... more value values allowed here ... --> </itemFilter> <!-- ... more itemFilter nodes allowed here ... --> <itemId> string </itemId> <outputSelector> OutputSelectorType </outputSelector> <!-- ... more outputSelector values allowed here ... --> <!-- Standard Input Fields --> <affiliate> Affiliate <customId> string </customId> <geoTargeting> boolean </geoTargeting> <networkId> string </networkId> <trackingId> string </trackingId> </affiliate> <buyerPostalCode> string </buyerPostalCode> <paginationInput> PaginationInput <entriesPerPage> int </entriesPerPage> <pageNumber> int </pageNumber> </paginationInput> </findItemsByImageRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Call-specific Input Fields [Jump to standard fields] |
| aspectFilter | AspectFilter | Optional,
repeatable: [0..*] |
Aspect filters refine (limit) the number of items returned by a find request. Obtain input values for the aspectFilter fields from an aspectHistogramContainer returned in the response of a previous query. By issuing a series of find queries, you can continually refine the items returned in your responses. Do this by repeating a query using the aspect values returned in one response as the input values to your next query. For example, the aspectHistogramContainer in a response on Men's Shoes could contain an aspect of Size, along with "aspect values" for the different sizes currently available in Men's Shoes. By populating aspectFilter fields with the values returned in an aspectHistogramContainer, you can refine the item results returned by your new query. See:
|
| aspectFilter.aspectName | string | Optional | Name of a standard item characteristic associated with a given domain. For example, "Optical Zoom" or "Megapixels" are aspects for the Digital Cameras domain. The current aspect names associated with a specific domain can be found in the aspect histogram. Aspect histograms can be retrieved for a given keyword query or category. The aspect histogram contains information about aspects from the domain that is most relevant to your search (or category). |
| aspectFilter.aspectValueName | string | Optional,
repeatable: [1..*] |
A value name for a given aspect. For example, "Point & Shoot" is a value name for the "Product Type" aspect in the "Digital Cameras" domain. |
| categoryId | string | Optional,
repeatable: [0..*] |
Specifies the leaf category from which you want to retrieve item listings with similar images. If no category is specified, search results can come from any Clothing, Shoes & Accessories leaf category. This field can be repeated (up to 3 times) to include multiple categories. Image similarity searches are only supported in Clothing, Shoes & Accessories leaf categories on the eBay US, UK, and Germany sites. If a specified category ID doesn't match an existing category for the site, eBay returns an invalid-category error message. To determine valid leaf categories, use the Trading API GetCategories call. Max length: 10. |
| domainFilter | DomainFilter | Optional,
repeatable: [0..*] |
Restricts results to items listed within the specified domain. Domains are a buy-side grouping of items. such as shoes or digital cameras. A domain can span multiple eBay categories. |
| domainFilter.domainName | string | Optional,
repeatable: [1..*] |
Specify the name of the domain to which you want to restrict search results. Only items listed within the specified domain will be returned in the search results. Domain names can be retrieved from an aspect histogram. |
| itemFilter | ItemFilter | Optional,
repeatable: [0..*] |
Reduce the number of items returned by a find request using item filters. Use itemFilter to specify name/value pairs. You can include multiple item filters in a single request. |
| itemFilter.name | ItemFilterType | Optional |
Specify the name of the item filter you want to use. The filter type specified in the itemFilter.name field must have a corresponding value. You can apply multiple itemFilter
name/value pairs in a single request. See ItemFilterType for more information on the available filters and the values supported/associated with each filter type.
Applicable values: See name. See:
|
| itemFilter.paramName | token | Optional |
In addition to filter Name/Value pairs, some itemFilters use an additional parameter Name/Value pair. Specifically, filters that use currency values (MaxPrice and MinPrice) make use of addition parameters. When you use these itemFilters, set paramName to Currency and provide the currency ID in paramValue. For example, if you use the MaxPrice itemFilter, you will need to specify a parameter Name of Currency with a parameter Value that specifies the type of currency desired. Note that for MaxPrice and MinPrice itemFilters, the default value for paramName is Currency. |
| itemFilter.paramValue | string | Optional |
The currency value associated with the respective itemFilter parameter Name. Usually paramName is set to Currency and paramValue is set to the currency type in which the monetary transaction occurs. Note: For MaxPrice and MinPrice itemFilters, the default value for paramValue is USD. See currencyId Values for a list of possible currency enumeration values. |
| itemFilter.value | string | Optional,
repeatable: [1..*] |
The value associated with the respective item filter name. Allowed values and datatypes vary for a given filter name.
See ItemFilterType for information about the allowed values, usage rules, and dependencies. |
| itemId | string | Required |
Specifies the item that the customer wants to use for retrieving more listings with similar images. The item must active and it must be listed in a Clothing, Shoes & Accessories category (parent category ID 11450 on the eBay US site). Max length: 19 (normally, item IDs are 9 to 12 digits in length) . |
| outputSelector | OutputSelectorType | Optional,
repeatable: [0..*] |
Defines what data to return, in addition to the default set of data, in a response. If you don't specify this field, eBay returns a default set of item fields. Use the outputSelector to include more information in the response. The additional data is grouped into discrete nodes. You can specify multiple nodes by including this field multiple times, as needed, in the request. If you specify this field, the additional fields returned can affect the call's response time (performance), including in the case with feedback data. Applicable values: See outputSelector. See Detail Controls. |
| Standard Input Fields |
| 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:
|
| 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 | Conditional |
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. This is also required for any country that supports local shipping regions in order for the correct shipping cost to be determined. 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. |
| Input Detail Controls Samples Change History |
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"?> <findItemsByImageResponse xmlns="https://www.ebay.com/marketplace/search/v1/services"> <!-- Call-specific Output Fields --> <aspectHistogramContainer> AspectHistogramContainer <aspect name="string"> Aspect <valueHistogram valueName="string"> AspectValueHistogram <count> long </count> </valueHistogram> <!-- ... more valueHistogram nodes allowed here ... --> </aspect> <!-- ... more aspect nodes allowed here ... --> <domainDisplayName> token </domainDisplayName> <domainName> string </domainName> </aspectHistogramContainer> <categoryHistogramContainer> CategoryHistogramContainer <categoryHistogram> CategoryHistogram (Category) <categoryId> string </categoryId> <categoryName> string </categoryName> <childCategoryHistogram> CategoryHistogram (Category) <categoryId> string </categoryId> <categoryName> string </categoryName> <childCategoryHistogram> CategoryHistogram (Category) <categoryId> string </categoryId> <categoryName> string </categoryName> <childCategoryHistogram> CategoryHistogram (Category) </childCategoryHistogram> <!-- >>> childCategoryHistogram can be nested within itself an unlimited number of times >>> --> <!-- ... more childCategoryHistogram values allowed here ... --> <count> long </count> </childCategoryHistogram> <!-- ... more childCategoryHistogram values allowed here ... --> <count> long </count> </childCategoryHistogram> <!-- ... more childCategoryHistogram values allowed here ... --> <count> long </count> </categoryHistogram> <!-- ... more categoryHistogram values allowed here ... --> </categoryHistogramContainer> <conditionHistogramContainer> ConditionHistogramContainer </conditionHistogramContainer> <!-- 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> <itemSearchURL> anyURI </itemSearchURL> <paginationOutput> PaginationOutput <entriesPerPage> int </entriesPerPage> <pageNumber> int </pageNumber> <totalEntries> int </totalEntries> <totalPages> int </totalPages> </paginationOutput> <searchResult count="int"> SearchResult <item> SearchItem <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> <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 ... --> <postalCode> string </postalCode> <primaryCategory> Category <categoryId> string </categoryId> <categoryName> string </categoryName> </primaryCategory> <productId> ProductId (string) </productId> <returnsAccepted> boolean </returnsAccepted> <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 <expeditedShipping> boolean </expeditedShipping> <handlingTime> int </handlingTime> <oneDayShippingAvailable> boolean </oneDayShippingAvailable> <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> <viewItemURL> anyURI </viewItemURL> </item> <!-- ... more item nodes allowed here ... --> </searchResult> <timestamp> dateTime </timestamp> <version> string </version> </findItemsByImageResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Call-specific Output Fields [Jump to standard fields] |
| aspectHistogramContainer | AspectHistogramContainer | Conditionally |
Response container for aspect histograms.
outputSelector: AspectHistogram |
|
aspectHistogramContainer .aspect |
Aspect | Conditionally,
repeatable: [1..*] |
A characteristic of an item in a domain. For example, "Optical Zoom", "Brand", and "Megapixels" could be aspects of the Digital Cameras domain. Aspects are well-known, standardized characteristics of a domain, and they vary from domain to domain (the aspects of "Men's Shoes" are different from those of "Digital Cameras"). A search request on the eBay site will often display aspects and their respective aspect values on the left-had side of a query response. Aspects are extracted from item listing properties (such as item titles and subtitles), and represent the characteristics of active items. Values returned in the Aspect container can be used as inputs to the aspectFilter fields in a query to distill the items returned by the query. eBay generates aspects dynamically from the items currently listed; aspects provide a view into what is currently available on eBay. Because of this, aspect values returned one day cannot be guaranteed to be valid the next day. The following graphic shows how eBay might return a set of aspects for the Digital Cameras domain. In this graphic, "Product Type", "Brand", and "Megapixels" are aspects, and "Point & Shoot", "Canon", and "12.0 to 12.9 MP" are aspect values. Histogram values (item counts) are shown for each aspect value. 
outputSelector: AspectHistogram |
| aspectHistogramContainer .aspect [ attribute name ] |
string | Conditionally |
A characteristic of an item in a domain. For example, "Optical Zoom", "Brand", and "Megapixels" could be aspects of the Digital Cameras domain. Aspects are well-known, standardized characteristics of a domain, and they vary from domain to domain (the aspects of "Men's Shoes" are different from those of "Digital Cameras"). A search request on the eBay site will often display aspects and their respective aspect values on the left-had side of a query response. Aspects are extracted from item listing properties (such as item titles and subtitles), and represent the characteristics of active items. Values returned in the Aspect container can be used as inputs to the aspectFilter fields in a query to distill the items returned by the query. eBay generates aspects dynamically from the items currently listed; aspects provide a view into what is currently available on eBay. Because of this, aspect values returned one day cannot be guaranteed to be valid the next day. The following graphic shows how eBay might return a set of aspects for the Digital Cameras domain. In this graphic, "Product Type", "Brand", and "Megapixels" are aspects, and "Point & Shoot", "Canon", and "12.0 to 12.9 MP" are aspect values. Histogram values (item counts) are shown for each aspect value.
|
|
aspectHistogramContainer .aspect.valueHistogram |
AspectValueHistogram | Conditionally,
repeatable: [0..*] |
Container that returns the name of the respective aspect value and the histogram (the number of available items) that share that item characteristic. This value is not returned if there are no matching aspects for the associated domain. outputSelector: AspectHistogram |
| aspectHistogramContainer .aspect.valueHistogram [ attribute valueName ] |
string | Conditionally |
Container that returns the name of the respective aspect value and the histogram (the number of available items) that share that item characteristic. This value is not returned if there are no matching aspects for the associated domain. |
|
aspectHistogramContainer .aspect.valueHistogram.count |
long | Conditionally |
Number of items that share the characteristic the respective aspect value.
outputSelector: AspectHistogram |
|
aspectHistogramContainer .domainDisplayName |
token | Conditionally |
A buy-side group of items, for example "Shoes." Domains are extracted from item listing properties, such as the title, descriptions, and so on.
outputSelector: AspectHistogram |
|
aspectHistogramContainer .domainName |
string | Conditionally |
A buy-side group of items that share aspects, but not necessarily an eBay category. For example "Women's Dresses" or "Digital Cameras" could be domains. You can use a domainName to label a set of aspects that you display. Domains are extracted from item listing properties (such as item titles and subtitles). outputSelector: AspectHistogram |
| categoryHistogramContainer | CategoryHistogramContainer | Conditionally |
Response container for category histograms. Only returned when one or more category histograms are returned. A category histogram is not returned if there are no matching items or if the search is restricted to a single leaf category. Note: The category IDs returned for items in search results are for the leaf categories in which the items are listed. If you use these category IDs as input, the response will not return a category histogram. Note: When searching the eBay Motors site, category histograms may not be available for some parent categories. In these cases, aspect histograms should be used to refine search results. This behavior is consistent with eBay Motors site search behavior. outputSelector: CategoryHistogram |
|
categoryHistogramContainer .categoryHistogram |
CategoryHistogram (Category) | Conditionally,
repeatable: [0..*] |
Statistical (item count) information on the categories that contain items that match the search criteria or specified category or categories. A category histogram contains information for up to 10 child categories. Search result total entries may not necessarily match the sum of category histogram item counts. For search calls, the item count shows the distribution of matching items across each of the returned categories. A category histogram is not returned if there are no matching items or if the search is restricted to a single leaf category. For getHistograms, the category histogram contains the total item count for the specified category and item counts for the child categories containing the most item listings. A category histogram is not returned if the specified category is a leaf category. For categories associated with specific items, review the individual item containers returned in the search result. outputSelector: CategoryHistogram |
|
categoryHistogramContainer .categoryHistogram.categoryId |
string | Conditionally |
The unique ID of a category on the specified eBay site. Max length: 10. outputSelector: CategoryHistogram |
|
categoryHistogramContainer .categoryHistogram .categoryName |
string | Conditionally |
Display name of a category as it appears on the eBay Web site. Max length: 30. outputSelector: CategoryHistogram |
|
categoryHistogramContainer .categoryHistogram .childCategoryHistogram |
CategoryHistogram (Category) | Conditionally,
repeatable: [0..10] |
Container for histogram information pertaining to a child of the category specified in the request. Histograms return data on up to 10 children. Histograms are only a single level deep. That is, a given category histogram contains only immediate children.
outputSelector: CategoryHistogram |
|
categoryHistogramContainer .categoryHistogram .childCategoryHistogram .categoryId |
string | Conditionally |
The unique ID of a category on the specified eBay site. Max length: 10. outputSelector: CategoryHistogram |
|
categoryHistogramContainer .categoryHistogram .childCategoryHistogram .categoryName |
string | Conditionally |
Display name of a category as it appears on the eBay Web site. Max length: 30. outputSelector: CategoryHistogram |
|
categoryHistogramContainer .categoryHistogram .childCategoryHistogram .childCategoryHistogram |
CategoryHistogram (Category) | Conditionally,
repeatable: [0..10] |
Container for histogram information pertaining to a child of the category specified in the request. Histograms return data on up to 10 children. Histograms are only a single level deep. That is, a given category histogram contains only immediate children.
Recursion: Whatever the depth of data returned, the deepest level does not include childCategoryHistogram. outputSelector: CategoryHistogram |
|
categoryHistogramContainer .categoryHistogram .childCategoryHistogram.count |
long | Conditionally |
The total number of items in the associated category that match the search criteria.
outputSelector: CategoryHistogram |
|
categoryHistogramContainer .categoryHistogram.count |
long | Conditionally |
The total number of items in the associated category that match the search criteria.
outputSelector: CategoryHistogram |
| conditionHistogramContainer | ConditionHistogramContainer | Conditionally |
| Standard Output Fields |
| ack | AckValue | Always |
Indicates whether or not errors or warnings were generated during the processing of the request.
Applicable values: Code so that your app gracefully handles any future changes to this list. outputSelector: none (not controlled by outputSelector) |
| errorMessage | ErrorMessage | Conditionally |
Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value is Success.
outputSelector: none (not controlled by outputSelector) |
| errorMessage.error | ErrorData | Conditionally,
repeatable: [0..*] |
Details about a single error.
outputSelector: none (not controlled by outputSelector) |
| errorMessage.error.category | ErrorCategory | Conditionally |
There are three categories of errors: request errors, application errors, and system errors.
Applicable values: Code so that your app gracefully handles any future changes to this list. outputSelector: none (not controlled by outputSelector) |
| errorMessage.error.domain | string | Conditionally |
Name of the domain in which the error occurred.
outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) |
| errorMessage.error.exceptionId | token | Conditionally |
Unique identifier for an exception associated with an error.
outputSelector: none (not controlled by outputSelector) |
| errorMessage.error.message | string | Conditionally |
A detailed description of the condition that caused in the error.
outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) |
| 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: Code so that your app gracefully handles any future changes to this list. outputSelector: none (not controlled by outputSelector) |
| errorMessage.error.subdomain | string | Conditionally |
Name of the subdomain in which the error occurred.
outputSelector: none (not controlled by outputSelector) |
| itemSearchURL | anyURI | Always |
A URL to view the search results on the eBay web site. The search results on the web site will use the same pagination as the API search results. 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. outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) |
|
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. outputSelector: none (not controlled by outputSelector) |
| 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. outputSelector: none (not controlled by outputSelector) |
| 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. outputSelector: none (not controlled by outputSelector) |
| paginationOutput.totalPages | int | Conditionally |
The total number of pages of data that could be returned by repeated search requests. Note: 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. outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) |
| 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. Buyers must have a PayPal account to purchase items that require immediate payment. A seller can choose to require immediate payment for Fixed Price and Buy It Now listings, including eBay Stores Inventory listings. If a Buy It Now item ends as an auction (that is, if the Buy It Now option is removed due to bids being placed on the listing), the immediate payment requirement does not apply. 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. Only applicable to items listed on PayPal-enabled sites and in categories that support immediate payment. outputSelector: none (not controlled by outputSelector) |
| searchResult.item.charityId | string | Conditionally |
A unique identification number assigned by eBay to a registered non-profit charity organization.
outputSelector: none (not controlled by outputSelector) See GetCharities in the Trading API for information to retrieve details on a specific charity. |
| searchResult.item.condition | Condition | Conditionally |
Contains information about the item's condition. Only returned when the seller listed the item with an item condition. Different categories can support different condition choices. If a listing is in two categories, the seller uses condition details that are supported in the primary category. Thus, even if two nearly identical items are found in the same category search, they could support different condition details if they have different primary categories. For example, suppose Seller A lists a concert T-shirt in clothing, and also in music accessories as the secondary category. Seller B lists an identical shirt in music accessories only. If you search against the music accessories category, you will find both items, but seller A's shirt may have condition details that are slightly different from seller B's shirt, because the listings have different primary categories. outputSelector: none (not controlled by outputSelector) |
|
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 (e.g., conditionId or an older item specifics format). 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. Histograms may support display names in these cases later in 2011. 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. outputSelector: none (not controlled by outputSelector) 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). Also, until spring 2011, some GTC listings may define the item condition in item specifics instead, so no ID is returned. If you specify Condition in itemFilter, the response returns items with the correctly matching condition(s), even if conditionId is not returned. For example, if you specify a value of "New" or "1000" in the item filter, the response only returns new items. Min: 1000. Max: 7000. outputSelector: none (not controlled by outputSelector) 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).
outputSelector: none (not controlled by outputSelector) 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.
outputSelector: none (not controlled by outputSelector) |
| 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. outputSelector: none (not controlled by outputSelector) |
| 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 .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.
outputSelector: GalleryInfo |
|
searchResult.item .galleryInfoContainer .galleryURL |
GalleryURL (anyURI) | Always,
repeatable: [1..3] |
URL for a single item image thumbnail of a specific size.
outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) 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) . outputSelector: none (not controlled by outputSelector) |
| searchResult.item.listingInfo | ListingInfo | Conditionally |
The format type of the listing, such as online auction, fixed price, or advertisement.
outputSelector: none (not controlled by outputSelector) |
|
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.
outputSelector: none (not controlled by outputSelector) |
|
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. outputSelector: none (not controlled by outputSelector) |
|
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. outputSelector: none (not controlled by outputSelector) |
| 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. outputSelector: none (not controlled by outputSelector) |
| 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). outputSelector: none (not controlled by outputSelector) |
|
searchResult.item.listingInfo .gift |
boolean | Conditionally |
If true, a generic gift icon displays next the listing's title in search and browse pages.
outputSelector: none (not controlled by outputSelector) |
|
searchResult.item.listingInfo .listingType |
token | Conditionally |
The format of the listing, such as online auction, fixed price, or advertisement.
outputSelector: none (not controlled by outputSelector) |
|
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: It is possible for startTime to be different from the value returned by GetSingleItem. outputSelector: none (not controlled by outputSelector) |
| 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).
outputSelector: none (not controlled by outputSelector) |
|
searchResult.item .paymentMethod |
token | Conditionally,
repeatable: [0..*] |
Identifies the payment method (or methods) the seller will accept for the item (such as PayPal). Note: If the seller accepts only PayPal, the buyer can still pay with a credit card. PayPal supports major credit cards. Payment methods are not applicable to eBay Real Estate advertisement listings or other Classified Ad listing formats. outputSelector: none (not controlled by outputSelector) See BuyerPaymentMethodCodeType in the Shopping API for a complete list of possible paymentMethod response values. |
| 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. eBay proximity and local search behavior can use the combination of buyerPostalCode and postalCode values.
outputSelector: none (not controlled by outputSelector) |
|
searchResult.item .primaryCategory |
Category | Always |
Details about the first (or only) category in which the item is listed. Note: Items can be listed in more than a single category. outputSelector: none (not controlled by outputSelector) |
|
searchResult.item .primaryCategory.categoryId |
string | Always |
The unique ID of a category on the specified eBay site. Max length: 10. outputSelector: none (not controlled by outputSelector) |
|
searchResult.item .primaryCategory.categoryName |
string | Always |
Display name of a category as it appears on the eBay Web site. Max length: 30. outputSelector: none (not controlled by outputSelector) |
| 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. outputSelector: none (not controlled by outputSelector) |
|
searchResult.item .returnsAccepted |
boolean | Conditionally |
This is set to true if the seller accepts return of the item.
outputSelector: none (not controlled by outputSelector) |
|
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.
outputSelector: none (not controlled by outputSelector) |
|
searchResult.item .secondaryCategory.categoryId |
string | Conditionally |
The unique ID of a category on the specified eBay site. Max length: 10. outputSelector: none (not controlled by outputSelector) |
|
searchResult.item .secondaryCategory .categoryName |
string | Conditionally |
Display name of a category as it appears on the eBay Web site. Max length: 30. outputSelector: none (not controlled by outputSelector) |
| searchResult.item.sellerInfo | SellerInfo | Conditionally |
Information about the item's seller. Only returned if SellerInfo is specified in the outputSelector field in the request.
outputSelector: SellerInfo |
|
searchResult.item.sellerInfo .feedbackRatingStar |
token | Conditionally |
Visual indicator of user's feedback score.
outputSelector: SellerInfo |
|
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.
outputSelector: SellerInfo |
|
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).
outputSelector: SellerInfo |
|
searchResult.item.sellerInfo .sellerUserName |
string | Conditionally |
The seller's eBay user name; a unique value.
outputSelector: SellerInfo |
|
searchResult.item.sellerInfo .topRatedSeller |
boolean | Conditionally |
Indicates whether the seller of the item is top-rated. A top-rated seller:
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). outputSelector: SellerInfo |
|
searchResult.item .sellingStatus |
SellingStatus | Conditionally |
Specifies the item's selling status with regards to eBay's processing workflow.
outputSelector: none (not controlled by outputSelector) |
|
searchResult.item .sellingStatus.bidCount |
int | Conditionally |
The number of bids that have been placed on the item. Min: 0. outputSelector: none (not controlled by outputSelector) |
|
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).
outputSelector: none (not controlled by outputSelector) |
| 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. outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) |
|
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.
outputSelector: none (not controlled by outputSelector) |
| searchResult.item.shippingInfo | ShippingInfo | Conditionally |
Container for data about a listing's shipping details.
outputSelector: none (not controlled by outputSelector) |
|
searchResult.item.shippingInfo .expeditedShipping |
boolean | Conditionally |
This is returned set to true if expedited shipping is available for the item.
outputSelector: none (not controlled by outputSelector) |
|
searchResult.item.shippingInfo .handlingTime |
int | Conditionally |
The number of days it will take the seller to ship this item.
outputSelector: none (not controlled by outputSelector) |
|
searchResult.item.shippingInfo .oneDayShippingAvailable |
boolean | Conditionally |
This is returned set to true if one-day shipping is available for the item.
outputSelector: none (not controlled by outputSelector) |
|
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).
outputSelector: none (not controlled by outputSelector) |
| 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.
outputSelector: none (not controlled by outputSelector) |
|
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.
outputSelector: none (not controlled by outputSelector) 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.
outputSelector: StoreInfo |
|
searchResult.item.storeInfo .storeName |
string | Conditionally |
The name of the seller's eBay Store. Max length: 200. outputSelector: StoreInfo |
|
searchResult.item.storeInfo .storeURL |
anyURI | Conditionally |
The URL of the seller's eBay Store page.
outputSelector: StoreInfo |
| searchResult.item.subtitle | string | Conditionally |
Subtitle of the item. Only returned if the seller included a subtitle for the listing.
outputSelector: none (not controlled by outputSelector) |
| searchResult.item.title | string | Conditionally |
Name of the item as it appears in the listing title, or in search and browse results.
outputSelector: none (not controlled by outputSelector) |
| 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. outputSelector: none (not controlled by outputSelector) 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.
outputSelector: none (not controlled by outputSelector) |
| 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. outputSelector: none (not controlled by outputSelector) |
| Input Output Samples Change History |
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
The outputSelector input field gives you control over which call-specific output fields may be returned from your queries. outputSelector accepts a set of preset values, each of which permits the return of a different set of fields. (All standard output fields are returned regardless of outputSelector.)
The table below details the fields that each outputSelector value controls. In addition, the table includes a none column that shows the fields that are not controlled by outputSelector settings. Note that some fields are returned only when certain conditions are met; see the associated field documentation for a clarification of these conditions.
| Y | The field is always returned. |
| (Y) | The field is conditionally returned. See the field documentation for clarification of conditions. |
| Input Output Detail Controls Change History |
New to making API calls? Please see Making a Call.
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.
Available samples:
Retrieves a set of items based on image similarity with the item you provide.
Description
You've found a dress on eBay that looks close to what want. The image of the dress shows the right color and style, but you want to see more like it to view what variations are available.
Input
The itemId specifies the listing with the image you want to use for matching. The outputSelector is set to GalleryInfo to get an array of different sized thumbnail images for each item in the response.
The Clothing, Shoes & Accessories categories contain many listings with Item Variations for aspects, such as size or color. The HideDuplicateItems itemFilter prevents duplicate items in the search results due to Item Variations.
Note: URL samples have been wrapped for readability. To run the samples, undo the line wrapping and insert your own SECURITY-APPNAME.
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=findItemsByImage&
SERVICE-VERSION=1.12.0&
SECURITY-APPNAME=YourAppId&
RESPONSE-DATA-FORMAT=XML&
REST-PAYLOAD&
itemId=170965157637&
itemFilter.name=HideDuplicateItems&
itemFilter.value=true
Here is the same input in XML format. Note that this does not include standard values.
XML format. Also available is the JSON equivalent. <findItemsByImageRequest xmlns="https://www.ebay.com/marketplace/search/v1/services"> <itemId>170965157637</itemId> <outputSelector>GalleryInfo</outputSelector> <itemFilter> <name>HideDuplicateItems</name> <value>true</value> </itemFilter> </findItemsByImageRequest>
Output
You may want to use a specific size of the image thumbnails in galleryInfoContainer for each item to create a grid of images to browse, You can include additional content, such as title and convertedCurrentPrice to help with comparisions.
XML format. Also available is the JSON equivalent. <findItemsByImageResponse xmlns="https://www.ebay.com/marketplace/search/v1/services"> <ack>Success</ack> <version>1.12.0</version> <timestamp>2016-01-02T22:50:23.862Z</timestamp> <searchResult count="100"> <item> <itemId>170965157637</itemId> <title>Dazzled Geometric Prints Sexy Halter Neck Womens Sleeveless Mini Dress Cocktail</title> <globalId>EBAY-US</globalId> <primaryCategory> <categoryId>63861</categoryId> <categoryName>Dresses</categoryName> </primaryCategory> <galleryURL>https://thumbs2.ebaystatic.com/m/mWPl7F0twgLw16MM1-CBiuw/140.jpg</galleryURL> <galleryInfoContainer> <galleryURL gallerySize="Large">https://thumbs2.ebaystatic.com/m/mWPl7F0twgLw16MM1-CBiuw/140.jpg</galleryURL> <galleryURL gallerySize="Medium">https://thumbs2.ebaystatic.com/m/mWPl7F0twgLw16MM1-CBiuw/96.jpg</galleryURL> <galleryURL gallerySize="Small">https://thumbs2.ebaystatic.com/m/mWPl7F0twgLw16MM1-CBiuw/80.jpg</galleryURL> </galleryInfoContainer> <viewItemURL>https://www.ebay.com/itm/Dazzled-Geometric-Prints-Sexy-Halter-Neck-Womens-Sleeveless-Mini-Dress-Cocktail-/170965157637?pt=US_CSA_WC_Dresses</viewItemURL> <paymentMethod>PayPal</paymentMethod> <autoPay>false</autoPay> <location>China</location> <country>CN</country> <shippingInfo> <shippingType>Flat</shippingType> <shipToLocations>Worldwide</shipToLocations> <expeditedShipping>false</expeditedShipping> <oneDayShippingAvailable>false</oneDayShippingAvailable> <handlingTime>1</handlingTime> </shippingInfo> <sellingStatus> <currentPrice currencyId="USD">11.99</currentPrice> <convertedCurrentPrice currencyId="USD">11.99</convertedCurrentPrice> <bidCount>0</bidCount> <sellingState>Active</sellingState> <timeLeft>P0DT2H23M12S</timeLeft> </sellingStatus> <listingInfo> <bestOfferEnabled>false</bestOfferEnabled> <buyItNowAvailable>false</buyItNowAvailable> <startTime>2015-12-27T01:13:35.000Z</startTime> <endTime>2016-01-03T01:13:35.000Z</endTime> <listingType>Auction</listingType> <gift>false</gift> </listingInfo> <returnsAccepted>true</returnsAccepted> <condition> <conditionId>1000</conditionId> <conditionDisplayName>New with tags</conditionDisplayName> </condition> <isMultiVariationListing>false</isMultiVariationListing> <topRatedListing>true</topRatedListing> </item> <item> <itemId>170889904791</itemId> <title>Womens Striped Spaghetti Straps Halter V-neck Geometric Figure Sexy Mini Dress</title> <globalId>EBAY-US</globalId> <primaryCategory> <categoryId>63861</categoryId> <categoryName>Dresses</categoryName> </primaryCategory> <galleryURL>https://thumbs4.ebaystatic.com/pict/1708899047914040_2.jpg</galleryURL> <galleryInfoContainer> <galleryURL gallerySize="Large">https://thumbs4.ebaystatic.com/pict/1708899047914040_2.jpg</galleryURL> <galleryURL gallerySize="Medium">https://thumbs4.ebaystatic.com/pict/170889904791_2.jpg</galleryURL> <galleryURL gallerySize="Small">https://thumbs4.ebaystatic.com/pict/1708899047918080_2.jpg</galleryURL> </galleryInfoContainer> <viewItemURL>https://www.ebay.com/itm/Womens-Striped-Spaghetti-Straps-Halter-V-neck-Geometric-Figure-Sexy-Mini-Dress-/170889904791?pt=US_CSA_WC_Dresses&var=</viewItemURL> <paymentMethod>PayPal</paymentMethod> <autoPay>false</autoPay> <location>China</location> <country>CN</country> <shippingInfo> <shippingType>Free</shippingType> <shipToLocations>Worldwide</shipToLocations> <expeditedShipping>false</expeditedShipping> <oneDayShippingAvailable>false</oneDayShippingAvailable> <handlingTime>1</handlingTime> </shippingInfo> <sellingStatus> <currentPrice currencyId="USD">14.99</currentPrice> <convertedCurrentPrice currencyId="USD">14.99</convertedCurrentPrice> <sellingState>Active</sellingState> <timeLeft>P27DT10H9M33S</timeLeft> </sellingStatus> <listingInfo> <bestOfferEnabled>false</bestOfferEnabled> <buyItNowAvailable>false</buyItNowAvailable> <startTime>2016-01-03T08:54:56.000Z</startTime> <endTime>2016-01-30T08:59:56.000Z</endTime> <listingType>FixedPrice</listingType> <gift>false</gift> </listingInfo> <returnsAccepted>true</returnsAccepted> <condition> <conditionId>1000</conditionId> <conditionDisplayName>New with tags</conditionDisplayName> </condition> <isMultiVariationListing>true</isMultiVariationListing> <topRatedListing>true</topRatedListing> </item> <!-- ... more item nodes here ... --> </searchResult> <paginationOutput> <totalPages>45</totalPages> <totalEntries>4419</totalEntries> <pageNumber>1</pageNumber> <entriesPerPage>100</entriesPerPage> </paginationOutput> <itemSearchURL>https://www.ebay.com/sch/i.html?itemid=170965157637&_id=170965157637&_ipg=100&_os=GI%7CD&_pgn=1&_sop=40</itemSearchURL> </findItemsByImageResponse>
Retrieves a set of items from a specific category based on image similarity with the item you provide.
Description
You've found the perfect dress, and now you want to find matching accessories to complete the outfit. You can restrict the response to items from a specific category within Clothing, Shoes & Accessories. This lets you match items of different types, such as a dress and a scarf, based on image similarity.
Input
The itemId specifies the listing with the image you want to use for matching. The categoryId specifies the category in which items in the response must be listed (Women's Accessories, category ID 4251, in this case). The outputSelector is set to GalleryInfo to get an array of different sized thumbnail images for each item in the response.
Note: URL samples have been wrapped for readability. To run the samples, undo the line wrapping and insert your own SECURITY-APPNAME.
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=findItemsByImage&
SERVICE-VERSION=1.12.0&
SECURITY-APPNAME=YourAppId&
RESPONSE-DATA-FORMAT=XML&
REST-PAYLOAD&
itemId=170965157637&
categoryId=4251
Here is the same input in XML format. Note that this does not include standard values.
XML format. Also available is the JSON equivalent. <findItemsByImageRequest xmlns="https://www.ebay.com/marketplace/search/v1/services"> <itemId>170965157637</itemId> <categoryId>4251</categoryId> <outputSelector>GalleryInfo</outputSelector> </findItemsByImageRequest>
Output
You may want to use a specific size of the image thumbnails in galleryInfoContainer for each item to create a grid of images to browse, You can include additional content, such as title and convertedCurrentPrice to help with comparisions.
XML format. Also available is the JSON equivalent. <findItemsByImageResponse xmlns="https://www.ebay.com/marketplace/search/v1/services"> <ack>Success</ack> <version>1.12.0</version> <timestamp>2016-01-02T22:50:28.596Z</timestamp> <searchResult count="100"> <item> <itemId>170790211430</itemId> <title>Ladies Sexy Hot Sleeveless Mini Short Leopard Tight-fitting Dress</title> <globalId>EBAY-US</globalId> <primaryCategory> <categoryId>1063</categoryId> <categoryName>Other</categoryName> </primaryCategory> <galleryURL>https://thumbs3.ebaystatic.com/m/mxTd_iOXjWJiIvhrxFnzO0w/140.jpg</galleryURL> <galleryInfoContainer> <galleryURL gallerySize="Large">https://thumbs3.ebaystatic.com/m/mxTd_iOXjWJiIvhrxFnzO0w/140.jpg</galleryURL> <galleryURL gallerySize="Medium">https://thumbs3.ebaystatic.com/m/mxTd_iOXjWJiIvhrxFnzO0w/96.jpg</galleryURL> <galleryURL gallerySize="Small">https://thumbs3.ebaystatic.com/m/mxTd_iOXjWJiIvhrxFnzO0w/80.jpg</galleryURL> </galleryInfoContainer> <viewItemURL>https://www.ebay.com/itm/Ladies-Sexy-Hot-Sleeveless-Mini-Short-Leopard-Tight-fitting-Dress-/170790211430?pt=US_Women_s_Accessories</viewItemURL> <paymentMethod>PayPal</paymentMethod> <autoPay>false</autoPay> <location>Hong Kong</location> <country>HK</country> <shippingInfo> <shippingType>Free</shippingType> <shipToLocations>Worldwide</shipToLocations> <expeditedShipping>false</expeditedShipping> <oneDayShippingAvailable>false</oneDayShippingAvailable> <handlingTime>1</handlingTime> </shippingInfo> <sellingStatus> <currentPrice currencyId="USD">7.19</currentPrice> <convertedCurrentPrice currencyId="USD">7.19</convertedCurrentPrice> <sellingState>Active</sellingState> <timeLeft>P16DT6H45M43S</timeLeft> </sellingStatus> <listingInfo> <bestOfferEnabled>false</bestOfferEnabled> <buyItNowAvailable>false</buyItNowAvailable> <startTime>2015-12-24T05:31:11.000Z</startTime> <endTime>2016-01-19T05:36:11.000Z</endTime> <listingType>FixedPrice</listingType> <gift>false</gift> </listingInfo> <returnsAccepted>true</returnsAccepted> <condition> <conditionId>1500</conditionId> <conditionDisplayName>New without tags</conditionDisplayName> </condition> <isMultiVariationListing>false</isMultiVariationListing> <topRatedListing>false</topRatedListing> </item> <item> <itemId>260958396351</itemId> <title>Leopard Prints Two tone New Women's Fashion Silky Scarf Wraps 67"*29"</title> <globalId>EBAY-US</globalId> <primaryCategory> <categoryId>45238</categoryId> <categoryName>Scarves & Wraps</categoryName> </primaryCategory> <galleryURL>https://thumbs4.ebaystatic.com/m/mEbWs3PCMDsIDZNUzbPNV3w/140.jpg</galleryURL> <galleryInfoContainer> <galleryURL gallerySize="Large">https://thumbs4.ebaystatic.com/m/mEbWs3PCMDsIDZNUzbPNV3w/140.jpg</galleryURL> <galleryURL gallerySize="Medium">https://thumbs4.ebaystatic.com/m/mEbWs3PCMDsIDZNUzbPNV3w/96.jpg</galleryURL> <galleryURL gallerySize="Small">https://thumbs4.ebaystatic.com/m/mEbWs3PCMDsIDZNUzbPNV3w/80.jpg</galleryURL> </galleryInfoContainer> <viewItemURL>https://www.ebay.com/itm/Leopard-Prints-Two-tone-New-Womens-Fashion-Silky-Scarf-Wraps-67-29-/260958396351?pt=US_Scarves_Wraps</viewItemURL> <paymentMethod>PayPal</paymentMethod> <autoPay>false</autoPay> <location>China</location> <country>CN</country> <shippingInfo> <shippingServiceCost currencyId="USD">0.0</shippingServiceCost> <shippingType>Free</shippingType> <shipToLocations>Worldwide</shipToLocations> <expeditedShipping>false</expeditedShipping> <oneDayShippingAvailable>false</oneDayShippingAvailable> <handlingTime>2</handlingTime> </shippingInfo> <sellingStatus> <currentPrice currencyId="USD">7.99</currentPrice> <convertedCurrentPrice currencyId="USD">7.99</convertedCurrentPrice> <sellingState>Active</sellingState> <timeLeft>P8DT5H52M3S</timeLeft> </sellingStatus> <listingInfo> <bestOfferEnabled>false</bestOfferEnabled> <buyItNowAvailable>false</buyItNowAvailable> <startTime>2015-12-26T04:37:31.000Z</startTime> <endTime>2016-01-11T04:42:31.000Z</endTime> <gift>false</gift> </listingInfo> <returnsAccepted>true</returnsAccepted> <condition> <conditionId>1500</conditionId> <conditionDisplayName>New without tags</conditionDisplayName> </condition> <isMultiVariationListing>false</isMultiVariationListing> <topRatedListing>false</topRatedListing> </item> <!-- ... more item nodes here ... --> </searchResult> <paginationOutput> <totalPages>100</totalPages> <totalEntries>10000</totalEntries> <pageNumber>1</pageNumber> <entriesPerPage>100</entriesPerPage> </paginationOutput> <itemSearchURL>https://www.ebay.com/sch/4251/i.html?itemid=170965157637&_ddo=1&_id=170965157637&_ipg=100&_os=GI%7CD&_pgn=1&_sop=40</itemSearchURL> </findItemsByImageResponse>
| Input Output Detail Controls Samples |
| Change Date | Description |
|---|---|
| 1.13.0 10/21/2014 |
|
| 1.12.0 05/16/2012 |
|
| 1.11.0 06/08/2011 |
|
Copyright © 2013–2018 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.