findProductsByCompatibility

Note: This call is deprecated, and will be decommissioned on March 31st, 2025.

Use this call to find the products in a specific category. You can refine search results using optional catalog property name-value pair filters, application property name-value pair filters, and/or a keyword query. If you specify keywords without specifying a category, you can search for products across all compatibility-enabled categories on a site.

Property Filters

Property filters restrict the search results to products that exactly match specific catalog property name-value pairs. You must specify a category to use property filters. Use getProductSearchNames and getProductSearchValues to retrieve searchable property names and values for the given category.

For example, to retrieve all products in a parts category that are front brake discs manufactured by Brembo, you would call getProductSearchNames to identify searchable properties for the category, such as "Supplier Name" and "Type." Next, you would call getProductSearchValues to get the values associated with a property.

Note: We recommend you retrieve and maintain the product search metadata locally. Use getProductSearchValuesBulk to retrieve all applicable property values for up to 10 property names. You can use getProductSearchDataVersion to check for updates to the metadata.

The following filter will limit the search results to Brembo brake parts for the front of a vehicle:

<propertyFilter>
   <propertyName>Supplier Name</propertyName>
   <value>
      <text>
         <value>Brembo</value>
      </text>
   </value>
</propertyFilter>
<propertyFilter>
   <propertyName>Type</propertyName>
   <value>
      <text>
         <value>Front Brake Pads/Shoes, Rotors, Drums</value>
      </text>
   </value>
</propertyFilter>

Application Property Filters

Application property filters restrict the search results by parts compatibility. For example, on the eBay US Motors site, you can restrict the results to contain only products that are compatible with a Honda Accord. You must specify a category to use application property filters. Use getCompatibilitySearchNames and getCompatibilitySearchValues to retrieve searchable compatibility property names and values for the given category.

For example, to retrieve all products in a parts category that are compatible with a Honda Accord, you would call getCompatibilitySearchNames to identify searchable compatibility properties for the category, such as "Year," "Make," and "Model." Next, you would call getCompatibilitySearchValues to get the values associated with a compatibility property.

Note: We recommend you retrieve and maintain the product search metadata locally. Use getCompatibilitySearchValuesBulk to retrieve all applicable compatibility property values for up to 10 property names. You can use getCompatibilitySearchDataVersion to check for updates to the metadata.

The following filter will limit the search results to parts that fit a Honda Accord:

<applicationPropertyFilter>
   <propertyFilter>
      <propertyName>Make</propertyName>
      <value>
         <text>
            <value>Honda</value>
         </text>
      </value>
   </propertyFilter>
   <propertyFilter>
      <propertyName>Model</propertyName>
      <value>
         <text>
            <value>Accord</value>
         </text>
      </value>
   </propertyFilter>
</applicationPropertyFilter>

Note: Parts Compatibility is supported in limited Parts & Accessories categories for the eBay US Motors (site ID 100) and eBay Germany (site ID 77) sites only.

Input

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"?>
<findProductsByCompatibilityRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Input Fields -->
  <productByCompatibilitySearch> ProductByCompatibilityRequest
    <applicationPropertyFilter> CompatibilityPropertyFilter
      <propertyFilter> PropertyValue
        <propertyName> string </propertyName>
        <value> Value
          <number> NumericValue
            <unitOfMeasurement> token </unitOfMeasurement>
            <value> string </value>
          </number>
          <text> StringValue
            <value> string </value>
          </text>
          <URL> URIValue
            <value> anyURI </value>
          </URL>
        </value>
        <!-- ... more value nodes allowed here ... -->
      </propertyFilter>
      <!-- ... more propertyFilter nodes allowed here ... -->
    </applicationPropertyFilter>
    <productSearch> ProductRequest
      <categoryId> string </categoryId>
      <dataset> token </dataset>
      <!-- ... more dataset values allowed here ... -->
      <datasetPropertyName> string </datasetPropertyName>
      <!-- ... more datasetPropertyName values allowed here ... -->
      <invocationId> string </invocationId>
      <keywords> string </keywords>
      <paginationInput> PaginationInput
        <entriesPerPage> int </entriesPerPage>
        <pageNumber> int </pageNumber>
      </paginationInput>
      <productStatusFilter> ProductStatus
        <excludeForeBayReviews> boolean </excludeForeBayReviews>
        <excludeForeBaySelling> boolean </excludeForeBaySelling>
        <excludeForHalfSelling> boolean </excludeForHalfSelling>
      </productStatusFilter>
      <propertyFilter> PropertyValue
        <propertyName> string </propertyName>
        <value> Value
          <number> NumericValue
            <unitOfMeasurement> token </unitOfMeasurement>
            <value> string </value>
          </number>
          <text> StringValue
            <value> string </value>
          </text>
          <URL> URIValue
            <value> anyURI </value>
          </URL>
        </value>
        <!-- ... more value nodes allowed here ... -->
      </propertyFilter>
      <!-- ... more propertyFilter nodes allowed here ... -->
      <sortOrder> SortOrder
        <order> OrderType </order>
        <propertyName> string </propertyName>
      </sortOrder>
    </productSearch>
  </productByCompatibilitySearch>
  <!-- ... more productByCompatibilitySearch nodes allowed here ... -->
</findProductsByCompatibilityRequest>

Argument	Type	Occurrence	Meaning

productByCompatibilitySearch	ProductByCompatibilityRequest	Optional, repeatable: [0..*]	Container for an individual product search query.
productByCompatibilitySearch .applicationPropertyFilter	CompatibilityPropertyFilter	Optional	This will contain the property name-value pairs of the application. For example, an application property filter can consist of name-value pairs that describe a particular make and model of a car.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter	PropertyValue	Optional, repeatable: [0..*]	Filter consisting of name-value pairs that describe compatibilities for a product.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter.propertyName	string	Optional	This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter.value	Value	Optional, repeatable: [0..*]	A value for the property.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter.value.number	NumericValue	Optional	For numeric value type.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter.value.number .unitOfMeasurement	token	Optional	Unit of measure for a numeric value. Allowed values: bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10^-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter.value.number .value	string	Optional	A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter.value.text	StringValue	Optional	For string value type.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter.value.text .value	string	Optional	A string value.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter.value.URL	URIValue	Optional	For URL value type.
productByCompatibilitySearch .applicationPropertyFilter .propertyFilter.value.URL .value	anyURI	Optional	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS). Max length: 400.
productByCompatibilitySearch .productSearch	ProductRequest	Optional	User can findproducts for one catalog at a time or batch up to 10 catalogs.
productByCompatibilitySearch .productSearch.categoryId	string	Conditional	Specifies the category from which you want to retrieve product details. When categoryId is used with findProducts, the category must be catalog- enabled, or it will contain no product data, and the request will fail. When categoryId is used with findProductsByCompatibility, the category must be compatibility-enabled. A category must be catalog-enabled to be compatibility-enabled. Your request must contain categoryId and/or keywords. Max length: 10. See: GetCategory2CS for information to identify catalog-enabled categories. GetCategoryFeatures for information to identify compatibility-enabled categories.
productByCompatibilitySearch .productSearch.dataset	token	Optional, repeatable: [0..*]	This will define what are properties that will be returned for this catelog-enabled category. Dataset values: DisplayableProductDetails Properies for use in a user interface to describe products. DisplayableSearchResults Properties for use in results for product searches. Searchable Properties for use in searches. Sortable Properties that are suitable for sorting. User can either enter dataset name or enter individual property names (datasetPropertyName) from the dataset. Only one should be preset at a time. Default: Searchable.
productByCompatibilitySearch .productSearch .datasetPropertyName	string	Optional, repeatable: [0..*]	Individual property name from the dataset. You can either enter dataset name or enter individual property names from the dataset. Only one should be preset at a time.
productByCompatibilitySearch .productSearch.invocationId	string	Required	A unique identifer for a given product request. Use invocationId to prevent the submission of duplicate data. In the event of a partial failure, the invocation ID can also be used to identify a product request that did not succeed. If the same invocationId is passed in more than once in the same request, then an error will be returned. The identifier must be a number .
productByCompatibilitySearch .productSearch.keywords	string	Conditional	Use keywords to refine your product search query. Products whose catalog searchable property values contain these keywords will be returned. Returned products must match both the specified keywords and the name- value pairs constraint. Keyword searches are not case sensitive. Keywords are used for exact word matching only, wildcards or search string modifiers are not supported. Your request must contain categoryId and/or keywords. Max length: 350. The maximum length for a single word is 98.
productByCompatibilitySearch .productSearch.paginationInput	PaginationInput	Optional	Controls the pagination of the result set. Child elements specify the maximum number of products to return per call and the page of data to return. Controls the number of products returned in the response, but does not specify the amount of data to return for each product. Note: No more than 10,000 products 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 (20).
productByCompatibilitySearch .productSearch.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. Max: 100. Default: 100.
productByCompatibilitySearch .productSearch.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. Max: 100. Default: 1.
productByCompatibilitySearch .productSearch .productStatusFilter	ProductStatus	Optional	Specifies whether or not to filter out the products which are disabled for selling, product reviews, or use on half.com.
productByCompatibilitySearch .productSearch .productStatusFilter .excludeForeBayReviews	boolean	Optional	Product cannot be used in product review flows. Default: false.
productByCompatibilitySearch .productSearch .productStatusFilter .excludeForeBaySelling	boolean	Optional	Product cannot be used in selling flows on eBay. Default: false.
productByCompatibilitySearch .productSearch .productStatusFilter .excludeForHalfSelling	boolean	Optional	Product cannot be used in selling flows on half.com. Default: false.
productByCompatibilitySearch .productSearch.propertyFilter	PropertyValue	Optional, repeatable: [0..*]	One or more name-value pairs that describe the product.
productByCompatibilitySearch .productSearch.propertyFilter .propertyName	string	Optional	This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
productByCompatibilitySearch .productSearch.propertyFilter .value	Value	Optional, repeatable: [0..*]	A value for the property.
productByCompatibilitySearch .productSearch.propertyFilter .value.number	NumericValue	Optional	For numeric value type.
productByCompatibilitySearch .productSearch.propertyFilter .value.number .unitOfMeasurement	token	Optional	Unit of measure for a numeric value. Allowed values: bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10^-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed.
productByCompatibilitySearch .productSearch.propertyFilter .value.number.value	string	Optional	A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values.
productByCompatibilitySearch .productSearch.propertyFilter .value.text	StringValue	Optional	For string value type.
productByCompatibilitySearch .productSearch.propertyFilter .value.text.value	string	Optional	A string value.
productByCompatibilitySearch .productSearch.propertyFilter .value.URL	URIValue	Optional	For URL value type.
productByCompatibilitySearch .productSearch.propertyFilter .value.URL.value	anyURI	Optional	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS). Max length: 400.
productByCompatibilitySearch .productSearch.sortOrder	SortOrder	Optional	Sort Order for the result set. Any of the searchable property can be used to specify the sort order. If no sort order is specified then default sort order(popularity descending) will be applied.
productByCompatibilitySearch .productSearch.sortOrder.order	OrderType	Optional	Order of the sort, either Ascending or Descending. Default: Descending. Applicable values: Ascending The results will be sorted by the specified attribute in ascending (low to high) order. Descending The results will be sorted by the specified attribute in descending (high to low) order.
productByCompatibilitySearch .productSearch.sortOrder .propertyName	string	Optional	Output can be sorted by one or more property names. You can look these values up using the getProductSearchNames call in the Product Metadata API. Max length: 100.

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"?>
<findProductsByCompatibilityResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Output Fields -->
  <productSearchResult> ProductResponse
    <invocationId> string </invocationId>
    <paginationOutput> PaginationOutput
      <entriesPerPage> int </entriesPerPage>
      <pageNumber> int </pageNumber>
      <totalEntries> int </totalEntries>
      <totalPages> int </totalPages>
    </paginationOutput>
    <products> Product
      <compatibilityCount> int </compatibilityCount>
      <notes> Notes
        <noteDetails> PropertyValue
          <propertyName> string </propertyName>
          <value> Value
            <number> NumericValue
              <unitOfMeasurement> token </unitOfMeasurement>
              <value> string </value>
            </number>
            <text> StringValue
              <value> string </value>
            </text>
            <URL> URIValue
              <value> anyURI </value>
            </URL>
          </value>
          <!-- ... more value nodes allowed here ... -->
        </noteDetails>
        <!-- ... more noteDetails nodes allowed here ... -->
      </notes>
      <productDetails> PropertyValue
        <propertyName> string </propertyName>
        <value> Value
          <number> NumericValue
            <unitOfMeasurement> token </unitOfMeasurement>
            <value> string </value>
          </number>
          <text> StringValue
            <value> string </value>
          </text>
          <URL> URIValue
            <value> anyURI </value>
          </URL>
        </value>
        <!-- ... more value nodes allowed here ... -->
      </productDetails>
      <!-- ... more productDetails nodes allowed here ... -->
      <productIdentifier> ProductIdentifier
        <EAN> string </EAN>
        <ePID> string </ePID>
        <ISBN> string </ISBN>
        <productId> string </productId>
        <UPC> string </UPC>
      </productIdentifier>
      <productStatus> ProductStatus
        <excludeForeBayReviews> boolean </excludeForeBayReviews>
        <excludeForeBaySelling> boolean </excludeForeBaySelling>
        <excludeForHalfSelling> boolean </excludeForHalfSelling>
      </productStatus>
      <stockPhotoURL> StockPhotoURL
        <standard> URIValue
          <value> anyURI </value>
        </standard>
        <thumbnail> URIValue
          <value> anyURI </value>
        </thumbnail>
      </stockPhotoURL>
      <type> string </type>
    </products>
    <!-- ... more products nodes allowed here ... -->
  </productSearchResult>
  <!-- ... more productSearchResult nodes allowed here ... -->
  <!-- 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>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</findProductsByCompatibilityResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

productSearchResult	ProductResponse	Conditionally, repeatable: [0..*]	Container for the products that matched the search criteria. The data for each product is returned in individual containers, if any matches were found.
productSearchResult .invocationId	string	Conditionally	A unique identifer for a given product response, corresponding to a specific product request.
productSearchResult .paginationOutput	PaginationOutput	Conditionally	Indicates the pagination of the result set. Child elements indicate the maximum number of productSearchResult nodes returned per response and which page of data has been returned.
productSearchResult .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.
productSearchResult .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 entries matching the search criteria divided by the value specified for entriesPerPage in the request. The response for a request contains one "page" of data. This returned value indicates the page number of 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.
productSearchResult .paginationOutput.totalEntries	int	Conditionally	The total number of entries 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 entries that match the search criteria.
productSearchResult .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 entries that match the search criteria.
productSearchResult.products	Product	Conditionally, repeatable: [0..*]	Container for multiple products.
productSearchResult.products .compatibilityCount	int	Conditionally	Coming soon. The quantity of compatibilities that have been specified for the product. When returned, indicates that the product is Parts Compatibility eanbled.
productSearchResult.products .notes	Notes	Conditionally	Optional notes that provide additional information about the product, such as the placement of the part or accessory on a vehicle or the type of vehicle a part fits.
productSearchResult.products .notes.noteDetails	PropertyValue	Conditionally, repeatable: [0..*]	Additional comments about the product in the form of name-value pairs.
productSearchResult.products .notes.noteDetails .propertyName	string	Conditionally	This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
productSearchResult.products .notes.noteDetails.value	Value	Conditionally, repeatable: [0..*]	A value for the property.
productSearchResult.products .notes.noteDetails.value .number	NumericValue	Conditionally	For numeric value type.
productSearchResult.products .notes.noteDetails.value .number.unitOfMeasurement	token	Conditionally	Unit of measure for a numeric value. Allowed values: bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10^-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed.
productSearchResult.products .notes.noteDetails.value .number.value	string	Conditionally	A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values.
productSearchResult.products .notes.noteDetails.value.text	StringValue	Conditionally	For string value type.
productSearchResult.products .notes.noteDetails.value.text .value	string	Conditionally	A string value.
productSearchResult.products .notes.noteDetails.value.URL	URIValue	Conditionally	For URL value type.
productSearchResult.products .notes.noteDetails.value.URL .value	anyURI	Conditionally	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS). Max length: 400.
productSearchResult.products .productDetails	PropertyValue	Conditionally, repeatable: [0..*]	Details about the product in the form of name-value pairs.
productSearchResult.products .productDetails.propertyName	string	Conditionally	This is the canonical name of the property. Used to identify a property within a catalog that this category belongs to.
productSearchResult.products .productDetails.value	Value	Conditionally, repeatable: [0..*]	A value for the property.
productSearchResult.products .productDetails.value.number	NumericValue	Conditionally	For numeric value type.
productSearchResult.products .productDetails.value.number .unitOfMeasurement	token	Conditionally	Unit of measure for a numeric value. Allowed values: bps Bits per second. A unit of data transmission. kbps Kilobits per second. A unit of data transmission. bit Binary digit. A unit of information storage. byte An ordered collection of bits. A unit of information storage equal to 8 bits in most contexts. kb Kilobit. A unit of information storage equal to 1024 bits. MB Megabyte. A unit of information storage equal to one million bytes. mW Megawatt. A unit of power equal to one million watts. W Watt. The base SI unit of power. Hz Hertz. A unit of frequency equal to one cycle per second. kHz Kilohertz. A unit of frequency equal to 1,000 cycles per second. m Meter. The base unit of distance. mm Megameter. A unit of distance equal to one million meters. rph Revolutions per hour. A unit of frequency. hr Hour. A unit of time equal to 3,600 seconds. min Minute. A unit of time equal to 60 seconds. ms Microsecond. A unit of time equal to one millionth of a second. ns Nanosecond. A unit of time equal to 10^-9 seconds. sec Seconds. The base unit of time. g Grams. A unit of mass equal to one one-thousandth of the SI base unit, the kilogram. lbs Pounds. The base Imperial unit of mass. The allowed units of measure do not apply to all numeric values. For example, when specifying the number of doors, unitOfMeasurement is not needed.
productSearchResult.products .productDetails.value.number .value	string	Conditionally	A numeric value. For example, physical dimensions of a product, such as height or weight, are specified as nummeric values.
productSearchResult.products .productDetails.value.text	StringValue	Conditionally	For string value type.
productSearchResult.products .productDetails.value.text .value	string	Conditionally	A string value.
productSearchResult.products .productDetails.value.URL	URIValue	Conditionally	For URL value type.
productSearchResult.products .productDetails.value.URL .value	anyURI	Conditionally	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS). Max length: 400.
productSearchResult.products .productIdentifier	ProductIdentifier	Conditionally	The eBay produdt ID (ePID) or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned.
productSearchResult.products .productIdentifier.EAN	string	Conditionally	European Article Number (EAN) value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. Max length: 13.
productSearchResult.products .productIdentifier.ePID	string	Conditionally	eBay Product ID. eBay's global reference ID for a catalog product. On the eBay Web site, this is known as the "ePID". A reference ID is a fixed reference to a product (regardless of version). One reference ID can be associated with multiple ProductID values. The value should start with "EPID", for example "EPID30971438" (without quotes). You can find reference IDs for products by using GetProducts (or FindProducts in the Shopping API). You can also find the ePID on eBay's Web site. If the primary and secondary categories are both catalog-enabled, this ID should correspond to the primary category (not the secondary category). Max length: 38.
productSearchResult.products .productIdentifier.ISBN	string	Conditionally	ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. Max length: 13.
productSearchResult.products .productIdentifier.productId	string	Conditionally	eBay's unique identifier for a specific version of a product. This is the long alphanumeric ID that is returned from GetProductSearchResults and related calls. See the Trading API Guide for information about finding this type of product ID. (For the shorter ePID value that is displayed on the eBay Web site, see ProductReferenceID instead.) Max length: 4000.
productSearchResult.products .productIdentifier.UPC	string	Conditionally	eBay Product ID. Max length: 12.
productSearchResult.products .productStatus	ProductStatus	Conditionally	Indicates whether or not a product is disabled for selling, product reviews, or use on Half.com.
productSearchResult.products .productStatus .excludeForeBayReviews	boolean	Conditionally	Product cannot be used in product review flows.
productSearchResult.products .productStatus .excludeForeBaySelling	boolean	Conditionally	Product cannot be used in selling flows on eBay.
productSearchResult.products .productStatus .excludeForHalfSelling	boolean	Conditionally	Product cannot be used in selling flows on half.com.
productSearchResult.products .stockPhotoURL	StockPhotoURL	Conditionally	Thumbnail and standard stockphoto URLs.
productSearchResult.products .stockPhotoURL.standard	URIValue	Conditionally	Fully qualified URL for a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product.
productSearchResult.products .stockPhotoURL.standard.value	anyURI	Conditionally	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS). Max length: 400.
productSearchResult.products .stockPhotoURL.thumbnail	URIValue	Conditionally	Fully qualified URL for the thumbnail of a stock image (if any) that is associated with a catalog product. The URL is for the image eBay usually displays in product search results (usually 40px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product.
productSearchResult.products .stockPhotoURL.thumbnail.value	anyURI	Conditionally	As part of request, this will be the URL to download media file. As part of response, this will be the URL where the media file is stored on eBay Picture Services (EPS). Max length: 400.
productSearchResult.products .type	string	Conditionally	Indicates if a product is the top or main product in a family (Head) or a variant of the head product (Member). If a product is not part of a product family, it is also the Head. Sometimes several versions (or editions) of a product may be available. All versions of the same product are considered to be part of the same product family. Some product families may contain only one product; others may contain many products. Allowed values: Head The product is the the head of the product family. Member The product is a variant of the head product.

Standard Output Fields

ack	AckValue	Always	Indicates whether or not errors or warnings were generated during the processing of the request. Applicable values: Failure The request was processed successfully, but something occurred that may affect your application or the user. PartialFailure The request that triggered the error was processed successfully but with some warnings. Success The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. Warning The request that triggered the error was processed successfully but with some warnings. 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: MarketplaceCatalog The error is specific to the Marketplace Catalog subdomain. MarketplaceCommon The error is common to all Marketplace services.
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.

Samples

Code samples not yet added for this call's documentation.

Change History

Change Date	Description
1.1.0 11/3/2009	(added) New call.