GetProductSearchPage - Call Reference - eBay Trading Web Services

GetProductSearchPage

Retrieves the attributes a seller can use to form a query when searching for Pre-filled Item Information to use in a listing for a category that is catalog-enabled. This call is applicable for use cases related to listing items with Pre-filled Item Information. Specifically, it retrieves data that you use to construct valid "single-attribute" queries. The attributes describe search criteria (e.g., Author) and sorting criteria (e.g., Publication Year), as appropriate for the category. GetProductSearchPage does not conduct the actual product search. It only returns data about what you can search on. Use the data as input to GetProductSearchResults to conduct the actual search for product information. To retrieve Product Finder search criteria (querying against multiple attributes), use GetProductFinder instead. See the eBay Web Services guide for an overview of Pre-filled Item Information and details about searching for catalog products.

See:
    The Catalog Product (Pre-filled Item) API
    Retrieving Product Search Page Meta-Data
    Searching with a Single-Attribute Search Page

Related calls:

GetCategory2CS - Retrieves mappings between categories and characteristic sets that are available for an eBay site.
GetProductSearchResults - Searches for Pre-filled Item Information within one or more characteristic sets. Use the response from GetProductSearchPage or GetProductFinder to determine the attributes that can be used as criteria for the search. After a user selects a product by its ID, use the ID as input to GetProductSellingPages. This call also supports batch requests (i.e., searching for several products in the same call).

GetProductSearchPage Input

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).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetProductSearchPageRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel nodes here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <AttributeSetID> int </AttributeSetID>
  <!-- ... more AttributeSetID nodes here ... -->
  <AttributeSystemVersion> string </AttributeSystemVersion>
</GetProductSearchPageRequest>

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
DetailLevel	DetailLevelCodeType (repeatable)	Optional	Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
AttributeSetID	int (repeatable)	Optional	A characteristic set ID that is associated with a catalog-enabled category that supports product search pages. You can pass an array of these IDs in the request. Each characteristic set corresponds to a level in the eBay category hierarchy at which all items share common characteristics. Multiple categories can be mapped to the same characteristic set. Each ID is used as a filter to limit the response content to fewer characteristic sets. When IDs are specified, the call only returns search page data for the corresponding characteristic sets. When no IDs are specified, the call returns all the current search page data in the system.
AttributeSystemVersion	string	Optional	A version of the search page definitions for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the search pages for which the attribute meta-data has changed since the specified version. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed.

GetProductSearchPage Output

The box below lists all fields that might be returned in the call 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).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetProductSearchPageResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <AttributeSystemVersion> string </AttributeSystemVersion>
  <ProductSearchPage> ProductSearchPageType 
    <DataElementSet attributeSetID="int"> DataElementSetType 
      <DataElement> string </DataElement>
      <DataElementID> int </DataElementID>
    </DataElementSet>
    <!-- ... more DataElementSet nodes here ... -->
    <SearchCharacteristicsSet> CharacteristicsSetType 
      <AttributeSetID> int </AttributeSetID>
      <Characteristics> CharacteristicType 
        <AttributeID> int </AttributeID>
        <DisplaySequence> string </DisplaySequence>
        <Label visible="boolean"> LabelType 
          <Name> string </Name>
        </Label>
      </Characteristics>
      <!-- ... more Characteristics nodes here ... -->
    </SearchCharacteristicsSet>
    <SearchType> CharacteristicsSearchCodeType </SearchType>
    <SortCharacteristics> CharacteristicType 
      <AttributeID> int </AttributeID>
      <DateFormat> string </DateFormat>
      <DisplaySequence> string </DisplaySequence>
      <DisplayUOM> string </DisplayUOM>
      <Label visible="boolean"> LabelType 
        <Name> string </Name>
      </Label>
      <SortOrder> SortOrderCodeType </SortOrder>
    </SortCharacteristics>
    <!-- ... more SortCharacteristics nodes here ... -->
  </ProductSearchPage>
  <!-- ... more ProductSearchPage nodes here ... -->
</GetProductSearchPageResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific fields]
Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType (repeatable)	Conditionally	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. 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.
Errors.ErrorCode	token	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.
Errors.ErrorParameters	ErrorParameterType (repeatable)	Conditionally	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
AttributeSystemVersion	string	Always	Current version of the product search page data for the site. This value changes each time changes are made to the search page data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input.
ProductSearchPage	ProductSearchPageType (repeatable)	Always	A list of catalog search criteria and sort keys associated with a catalog-enabled category, plus supplemental information to help the seller understand how to make selections. DetailLevel: ReturnAll. See Retrieving Product Search Page Meta-Data.
ProductSearchPage .DataElementSet	DataElementSetType (repeatable)	Always	Contains helpful hints for the user. Usage of this information is optional. DetailLevel: ReturnAll.
ProductSearchPage .DataElementSet [ attribute attributeSetID ]	int	Always	Matches the AttributeSetID associated with a response returned from the same call that returned the data element set. As calls like GetProductSearchResults can perform batch searches, this ID helps you determine which attribute set the data element set is associated with.
ProductSearchPage .DataElementSet.DataElement	string	Always	An HTML snippet that specifies hints for the user, help links, help graphics, and other supplemental information that varies per characteristic set. In GetProductSearchPage, one DataElement value contains a hint (including an empty HTML achor element), one DataElement value may contain a URL to insert into the HTML anchor as the href value, and one DataElement value may contain a URL that eBay uses as a help graphic. If no value is available in the meta-data, a dash ("--") is returned instead. Usage of this information is optional and may require developers to inspect the information to determine how it can be applied in an application. Because this is returned as a string, the HTML markup elements are escaped with character entity references (e.g.,<a href=""><Attributes>...). See the appendices in the eBay Web Services guide for general information about string data types. DetailLevel: ReturnAll.
ProductSearchPage .DataElementSet.DataElementID	int	Always	Identifier for a data element. This is primarily for internal use by eBay. Developers can choose to inspect this information and determine how it can be applied in their applications. DetailLevel: ReturnAll.
ProductSearchPage .SearchCharacteristicsSet	CharacteristicsSetType	Always	A list of attributes that describe the choice of search criteria for the specified characteristic set. The order in which the criteria are returned is not significant and may vary for different requests. See the eBay Web Services guide for details about how to use this data as input to GetProductSearchResults. DetailLevel: ReturnAll.
ProductSearchPage .SearchCharacteristicsSet .AttributeSetID	int	Always	Numeric value that identifies the characteristic set in a language-independent way. Identifies the characteristic set that is mapped to a catalog-enabled category associated with the product. Unique across all eBay sites. DetailLevel: ReturnAll.
ProductSearchPage .SearchCharacteristicsSet .Characteristics	CharacteristicType (repeatable)	Always	A salient aspect or feature of an item. Used to describe an item in a standard way so that buyers can find it more easily. An individual, standardized characteristic that is common to all items within the specified characteristic set. In the context of GetProductSearchPage, each characteristic identifies a single searchable attribute. A searchable attribute is a product aspect or feature that can be used as a criterion in a search for catalog content. For example, "Title" might be a criterion for searching the book catalog for Pre- filled Item Information related to books. See the eBay Web Services guide for more information. DetailLevel: ReturnAll.
ProductSearchPage .SearchCharacteristicsSet .Characteristics.AttributeID	int	Always	Constant value that identifies the characteristic in a language-independent way. Unique within the characteristic set. DetailLevel: ReturnAll.
ProductSearchPage .SearchCharacteristicsSet .Characteristics .DisplaySequence	string	Always	The suggested order in which the characteristic should be presented to the user in a list. Indicates the relative position of the sort key in the list of characteristics. The characteristic with the lowest display sequence is considered the default sort key in calls to GetProductSearchResults. Aside from that, usage of this display sequence information is optional. For example, in an application with a graphical user interface, a characteristic with a display sequence of 2 could be presented before one with a display sequence of 3 in a drop-down list. If multiple sort characteristics are returned for a characteristic set, compare their display sequence values to determine the lowest available value (usually 0) and the overall sequence. DetailLevel: ReturnAll.
ProductSearchPage .SearchCharacteristicsSet .Characteristics.Label	LabelType	Always	Applicable when working with Pre-filled Item Information (Catalogs) functionality. The label to display when presenting the attribute to a user. Not necessarily the same as the attribute's label as defined in the characteristic set (i.e., the label could be overridden by the catalog). DetailLevel: ReturnAll.
ProductSearchPage .SearchCharacteristicsSet .Characteristics.Label [ attribute visible ]	boolean	Always	If true, the label name is visible on the eBay site. If false, the label is not visible. Usage of this information is optional. You are not required to display labels in the same manner as eBay.
ProductSearchPage .SearchCharacteristicsSet .Characteristics.Label.Name	string	Always	The label to display when presenting the attribute to a user (e.g., "Title" or "Manufacturer"). The label is defined for the product, and is therefore not necessarily the same as the label that is defined in the characteristic set returned by another call like GetAttributesCS. For GetProductSearchPage: If the attribute's label is "Keyword", it means you can enter the attribute's ID and a string value in the SearchAttributes node of GetProductSearchResults, and then eBay will search for the string against one or more attributes in the catalog. For example, for strollers, GetProductSearchPage only returns a Keyword attribute instead of separate Brand, Product Type, and Model attributes (for the US site). So, you can use the single Keyword attribute to search against all of those attributes. DetailLevel: ReturnAll.
ProductSearchPage.SearchType	CharacteristicsSearchCodeType	Always	Ignore this field. GetProductSearchPage only retrieves criteria for single-attribute searches. Use GetProductFinder for valid multi-attribute search criteria. Applicable values: • CustomCode (out) Reserved for internal or future use • Multi (out) Not used. (For multi-attribute search criteria, call GetProductFinder instead.) • Single (out) The search criteria can consist of one attribute. DetailLevel: ReturnAll.
ProductSearchPage .SortCharacteristics	CharacteristicType (repeatable)	Always	A product aspect or feature that can be used as a key for sorting catalog search results. This does not necessarily match a searchable attribute. For example, you might be able to search on a product's title but sort the results by the release date or the manufacturer's suggested retail price (MSRP). At least one sort attribute is always returned. Applications should ensure that only one attribute is selected as a sort key from these results (before calling GetProductSearchResults). The default sort key is the one with the lowest DisplaySequence value. The order in which the SortCharacteristics nodes are returned is not significant and may vary for different requests. See the eBay Web Services guide for details about how to use this data as input to GetProductSearchResults. DetailLevel: ReturnAll.
ProductSearchPage .SortCharacteristics .AttributeID	int	Always	Constant value that identifies the characteristic in a language-independent way. Unique within the characteristic set. DetailLevel: ReturnAll.
ProductSearchPage .SortCharacteristics .DateFormat	string	Conditionally	Applicable when working with Pre-filled Item Information (Catalogs) functionality. Returned if the characteristic is a Date data type. Specifies the pattern to use when presenting the date to a user. Possible values: Day/Month/Year, Month/Year, Year Only. For example, the Year Only format would indicate that the date should be a value like 1999. Output only. DetailLevel: ReturnAll.
ProductSearchPage .SortCharacteristics .DisplaySequence	string	Always	The suggested order in which the characteristic should be presented to the user in a list. Indicates the relative position of the sort key in the list of characteristics. The characteristic with the lowest display sequence is considered the default sort key in calls to GetProductSearchResults. Aside from that, usage of this display sequence information is optional. For example, in an application with a graphical user interface, a characteristic with a display sequence of 2 could be presented before one with a display sequence of 3 in a drop-down list. If multiple sort characteristics are returned for a characteristic set, compare their display sequence values to determine the lowest available value (usually 0) and the overall sequence. DetailLevel: ReturnAll.
ProductSearchPage .SortCharacteristics .DisplayUOM	string	Conditionally	Applicable when working with Pre-filled Item Information (Catalogs) functionality. The unit of measure (e.g., Inch) to use when the characteristic is numeric indicates a measurement. Not returned if not applicable. Output only. DetailLevel: ReturnAll.
ProductSearchPage .SortCharacteristics.Label	LabelType	Always	Applicable when working with Pre-filled Item Information (Catalogs) functionality. The label to display when presenting the attribute to a user. Not necessarily the same as the attribute's label as defined in the characteristic set (i.e., the label could be overridden by the catalog). DetailLevel: ReturnAll.
ProductSearchPage .SortCharacteristics.Label [ attribute visible ]	boolean	Always	If true, the label name is visible on the eBay site. If false, the label is not visible. Usage of this information is optional. You are not required to display labels in the same manner as eBay.
ProductSearchPage .SortCharacteristics.Label .Name	string	Always	The label to display when presenting the attribute to a user (e.g., "Title" or "Manufacturer"). The label is defined for the product, and is therefore not necessarily the same as the label that is defined in the characteristic set returned by another call like GetAttributesCS. For GetProductSearchPage: If the attribute's label is "Keyword", it means you can enter the attribute's ID and a string value in the SearchAttributes node of GetProductSearchResults, and then eBay will search for the string against one or more attributes in the catalog. For example, for strollers, GetProductSearchPage only returns a Keyword attribute instead of separate Brand, Product Type, and Model attributes (for the US site). So, you can use the single Keyword attribute to search against all of those attributes. DetailLevel: ReturnAll.
ProductSearchPage .SortCharacteristics.SortOrder	SortOrderCodeType	Conditionally	Applicable when working with Pre-filled Item Information (Catalogs) functionality. Indicates the order in which eBay's search engine will sort the results if you pass this characteristic as a sort attribute in GetProductSearchResults. You cannot change the sort order of a characteristic when you perform a search. (Of course, you can change the sort order when you present results in your own application.) In GetProductSearchPage, if SortOrder is not returned at all, it means the results will be returned in the order in which they are stored on eBay (which can be useful for international sites that use ideographic characters). Output only. Applicable values: • Ascending (in/out) The results will be sorted by the specified attribute in ascending (low to high) order. • CustomCode (in/out) Reserved for internal or future use. • Descending (in/out) The results will be sorted by the specified attribute in descending (high to low) order. DetailLevel: ReturnAll.

GetProductSearchPage Detail Controls

Detail Control: DetailLevel

The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)

none	The field is returned if DetailLevel is not specified on input.
Y	The field is always returned.
(Y)	The field is conditionally returned. See the field description for clarification of conditions.

Output Field	ReturnAll	none
AttributeSystemVersion	Y	Y
ProductSearchPage	Y	-
ProductSearchPage.DataElementSet	Y	-
ProductSearchPage.DataElementSet.DataElement	Y	-
ProductSearchPage.DataElementSet.DataElementID	Y	-
ProductSearchPage.SearchCharacteristicsSet	Y	-
ProductSearchPage.SearchCharacteristicsSet.AttributeSetID	Y	-
ProductSearchPage.SearchCharacteristicsSet.Characteristics	Y	-
ProductSearchPage.SearchCharacteristicsSet.Characteristics .AttributeID	Y	-
ProductSearchPage.SearchCharacteristicsSet.Characteristics .DisplaySequence	Y	-
ProductSearchPage.SearchCharacteristicsSet.Characteristics.Label	Y	-
ProductSearchPage.SearchCharacteristicsSet.Characteristics.Label .Name	Y	-
ProductSearchPage.SearchType	Y	-
ProductSearchPage.SortCharacteristics	Y	-
ProductSearchPage.SortCharacteristics.AttributeID	Y	-
ProductSearchPage.SortCharacteristics.DateFormat	(Y)	-
ProductSearchPage.SortCharacteristics.DisplaySequence	Y	-
ProductSearchPage.SortCharacteristics.DisplayUOM	(Y)	-
ProductSearchPage.SortCharacteristics.Label	Y	-
ProductSearchPage.SortCharacteristics.Label.Name	Y	-
ProductSearchPage.SortCharacteristics.SortOrder	(Y)	-

GetProductSearchPage Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetProductSearchPage.

GetProductSearchPage Change History

Version	Description
499 2007-02-07	DataElements (modified): Deleted previously deprecated objects from the latest schema. This object is still supported with lower request versions. See Deprecated Objects.

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Trading API Call Reference Version 579

eBay Trading API
Call Reference Version 579