eBay Trading APIVersion 1099

NameRecommendationType

This type is used by the NameRecommendation container that is returned in GetCategorySpecifics. A NameRecommendation container is returned for every mandatory and recommended Item Specific for a category, and provides the recommended/most popular values for the Item Specific, as well as details, instructions, and constraint information for each Item Specific name-value pairs.

Type that uses NameRecommendationType:

Call that uses NameRecommendationType:

Fields



HelpText ( string ) [0..1]
The text in this field may provide some context on the content of the help page linked to in the HelpURL field. This field is only returned if the HelpURL field is returned, and is available.
See the Field Index to learn which calls use HelpText.

HelpURL ( anyURI ) [0..1]
This field contains a URL to a relevant eBay help page that may provide more information about a particular Item Specific. This field is only returned if a relevant eBay help page is available. If this field is returned, the HelpText field may also be returned and provide some context on the content of the help page.
See the Field Index to learn which calls use HelpURL.

Name ( string ) [0..1]
This string field is the name of the mandatory or recommended Item Specific or Product Identifier type (e.g. Brand/MPN). The seller should use the actual string in this field when creating, revising, or relisting an item with this Item Specific. The number of Item Specifics that are returned can be controlled with the MaxNames field in the call request.

This field is always returned with each NameRecommendation container.
See the Field Index to learn which calls use Name.

Not used by any call.

This field is not currently returned in GetCategorySpecifics for any Item Specific.
See the Field Index to learn which calls use Source.

This container provides details, instructions, and constraint information for each Item Specific name-value pairs. The fields that are returned under the ValidationRules container will vary per Item Specific.

Three key fields to look for are MinValues, MaxValues, and VariationSpecifics. If the MinValues appears for an Item Specific (usually with a value of '1'), it indicates that the Item Specific is required for the category. For many Item Specifics, the MaxValues field is returned with a value of '1', but the value will be higher for Item Specifics that support more than one value. The VariationSpecifics field is only returned (with a value of 'Disabled') when a seller is not allowed to pass in that Item Specific at the variation level in a multiple-variation listing.

This field is always returned with each NameRecommendation container.
See the Field Index to learn which calls use ValidationRules.

ValueRecommendation ( ValueRecommendationType ) [0..*]
Each ValueRecommendation container shows a common/recommended/popular value for the corresponding Item Specific. Values are not returned for every Item Specific, including some instance aspects (such as 'Bundle Description') where the text that is passed in for the Item Specific value may vary widely per seller, or if eBay does not have recommended values available for the Item Specific. The number of values that are returned for each Item Specific can be controlled with the MaxValuesPerName field in the call request.

Note: For unique product identifying aspects, such as MPN, UPC, ISBN, or EAN, instead of an actual value being returned, boilerplate text is used, such as 'Does Not Apply'. If an MPN or GTIN is required, but the seller does not have the identifier, he/she can pass in the boilerplate text as an alternative to the actual identifier.

In addition to the recommended value(s) for an Item Specific, a ValueRecommendation.ValidationRules container will be returned if the IncludeConfidence filter is included in the call request and set to true. The return 'Confidence' value is a percentage value that indicates how confident eBay is that the recommended value is a valid value for the corresponding Item Specific. The ValueRecommendation.ValidationRules container may also get returned for the 'Brand' Item Specific if the particular product brand in that listing category requires an association with an eBay catalog product.
See the Field Index to learn which calls use ValueRecommendation.