getProductSearchNames

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

Use this call to find all the properties available for a given catalog-enabled category. Then you can use these properties, along with their respective values, as input for find and get calls to retrieve products. Use the returned propertyName values as input for getProductSearchValues or getProductSearchValues to retrieve the corresponding property values.

Use dataset to restrict the properties returned in the response. The dataset value specifies the type of compatibility properties you want back. For example, if you specify Searchable, your compatibility details will contain properties that can be used to search for products, such as Make and Model. Some compatibility properties, such as FitmentComments, are not intended for product searches.

For example, if the input category is a parts category, the properties would be (according to the dependency graph):

• DisplayName
• Supplier Name
• Type
• Part number

If the input is category is tires, the properties would be (according to the dependency graph):

• DisplayName
• Brand
• Model
• Tire Size
• Load Index
• Speed Rating
• Tire Type
• P Metric

See also the reference documentation for these calls:

• getProductSearchDataVersion - Get the metadata version for the specified category.
• getProductSearchValues - Retrieves all available values and their dependencies for a given product property or a group of properties (of the product catalog).
• getProductSearchValuesBulk - Retrieves property values for multiple fields (up to 10).

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"?>
<getProductSearchNamesRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Input Fields -->
  <categoryId> string </categoryId>
  <dataset> token </dataset>
  <!-- ... more dataset values allowed here ... -->
</getProductSearchNamesRequest>

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"?>
<getProductSearchNamesResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Output Fields -->
  <categoryId> string </categoryId>
  <properties> Properties
    <dataset> token </dataset>
    <metadataVersion> string </metadataVersion>
    <propertyName> Property
      <propertyDisplayName> string </propertyDisplayName>
      <propertyName> string </propertyName>
      <propertyNameMetadata> PropertyNameMetadata
        <displaySequence> int </displaySequence>
      </propertyNameMetadata>
    </propertyName>
    <!-- ... more propertyName nodes allowed here ... -->
  </properties>
  <!-- ... more properties 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>
</getProductSearchNamesResponse>

Samples

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

Change History