getProductSearchValues

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

Use this call to find the values for the specified property name. Property values can be used with their respective property names to find products with the findProducts call in the Product API. You must specify a category and a property name. First use getProductSearchNames to retrieve the property names for the given category.

If the category is catalog-enabled, the response can be retrieved as either a flat list or a structured dependency tree. If the category is not compatibility-enabled, the property values are returned as a list of values for each property.

For example, if you want to get a list of all available aspect ratios for Bridgestone tires with a width of 225, your request would include the following parameters:

• categoryId: for the tires category
• propertyName: set to "Aspect Ratio" to retrieve available values
• propertyFilter: one for brand and one for tire width

   ...
   <categoryId>170578</categoryId>
   <propertyName>Aspect Ratio</propertyName>
   <propertyFilter>
      <propertyName>Brand</propertyName>
      <value>
         <text>
            <value>Bridgestone</value>
         </text>
      </value>
   </propertyFilter>
   <propertyFilter>
      <propertyName>Section Width</propertyName>
      <value>
         <text>
            <value>225</value>
         </text>
      </value>
   </propertyFilter>
   ...

The response contains a list of all available aspect ratios for Bridgestone tires which have a tire width of 225.

See also the reference documentation for these calls:

• getProductSearchDataVersion - Get the metadata version for the specified category.
• getProductSearchNames - Returns all properties available for a given catalog enabled category.
• getProductSearchValuesBulk - Retrieves property values for multiple fields (up to 10).

See also the reference documentation for this call (in the Product API Reference):

• findProducts - Finds products for a given category and search criteria.

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"?>
<getProductSearchValuesRequest xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Input Fields -->
  <propertyName> string </propertyName>
  <!-- Standard Input Fields -->
  <categoryId> string </categoryId>
  <listFormatOnly> boolean </listFormatOnly>
  <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>
  <!-- ... more sortOrder nodes allowed here ... -->
</getProductSearchValuesRequest>

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"?>
<getProductSearchValuesResponse xmlns="http://www.ebay.com/marketplace/marketplacecatalog/v1/services">
  <!-- Call-specific Output Fields -->
  <metadataVersion> string </metadataVersion>
  <propertyValues> 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 ... -->
  </propertyValues>
  <!-- ... more propertyValues nodes allowed here ... -->
  <propertyValuesTree> PropertyNameValue
    <childPropertyNameValue> PropertyNameValue
      <childPropertyNameValue> PropertyNameValue
        <childPropertyNameValue> PropertyNameValue </childPropertyNameValue>
          <!-- >>> childPropertyNameValue can be nested within itself an unlimited number of times >>> -->
        <!-- ... more childPropertyNameValue nodes allowed here ... -->
        <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>
      </childPropertyNameValue>
      <!-- ... more childPropertyNameValue nodes allowed here ... -->
      <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>
    </childPropertyNameValue>
    <!-- ... more childPropertyNameValue nodes allowed here ... -->
    <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>
  </propertyValuesTree>
  <treeFormat> boolean </treeFormat>
  <!-- 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>
</getProductSearchValuesResponse>

Samples

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

Change History