Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
complexType "ns:NameRecommendationType"
Namespace:
urn:ebay:apis:eBLBaseComponents
Content:
complex, 7 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 7 elements, elem. wildcard
Used:
at 2 locations
Component Diagram
XML Representation Summary
<...>
   
Content: 
ns:Name?, ns:RelevanceIndicator?, ns:ValidationRules?, ns:ValueRecommendation*, ns:HelpURL?, ns:Source?, ns:HelpText?, {any}*
</...>
All Direct / Indirect Based Elements (2):
ns:NameRecommendation (defined in ns:RecommendationsType complexType),
ns:NameRecommendation (in ns:ProductIdentifiers)
Known Usage Locations
Annotation
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.
XML Source (w/o annotations (8); see within schema source)
<xs:complexType name="NameRecommendationType">
<xs:sequence>
<xs:element minOccurs="0" name="Name" type="xs:string"/>
<xs:element minOccurs="0" name="RelevanceIndicator" type="ns:RelevanceIndicatorType"/>
<xs:element minOccurs="0" name="ValidationRules" type="ns:RecommendationValidationRulesType"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="ValueRecommendation" type="ns:ValueRecommendationType"/>
<xs:element minOccurs="0" name="HelpURL" type="xs:anyURI"/>
<xs:element minOccurs="0" name="Source" type="ns:ItemSpecificSourceCodeType"/>
<xs:element minOccurs="0" name="HelpText" type="xs:string"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 8/8)
ns:HelpText
Type:
xs:string, predefined, simple content
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.
XML Representation Summary
<ns:HelpText>
   
Content: 
{ xs:string }
</ns:HelpText>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="HelpText" type="xs:string"/>
ns:HelpURL
Type:
xs:anyURI, predefined, simple content
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.
XML Representation Summary
<ns:HelpURL>
   
Content: 
{ xs:anyURI }
</ns:HelpURL>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="HelpURL" type="xs:anyURI"/>
ns:Name
Type:
xs:string, predefined, simple content
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.
XML Representation Summary
<ns:Name>
   
Content: 
{ xs:string }
</ns:Name>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Name" type="xs:string"/>
ns:RelevanceIndicator
Type:
ns:RelevanceIndicatorType, complex content
This container is returned for an item specific if eBay has data on how many searches have been performed for listings in the category using that item specific.

Note: This container is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields that you want access to 'Buyer Demand Data' in GetCategorySpecifics.
Component Diagram
XML Representation Summary
<ns:RelevanceIndicator>
   
Content: 
ns:SearchCount?, {any}*
</ns:RelevanceIndicator>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="RelevanceIndicator" type="ns:RelevanceIndicatorType"/>
ns:Source
Type:
ns:ItemSpecificSourceCodeType, simple content
This field is not currently returned in GetCategorySpecifics for any Item Specific.
XML Representation Summary
<ns:Source>
   
Content: 
{ enumeration of xs:token }
</ns:Source>
Simple Content
Enumeration:
"ItemSpecific"
 - 
This enumeration value indicates that the corresponding Item Specific was specified by the seller in Add/Revise/Relist call or flow. In an Add/Revise/Relist API call, Item Specifics for a listing are specified through the ItemSpecifics.NameValueList or VariationSpecifics.NameValueList (for a variation in a multiple-variation listing) containers.
"Attribute"
 - 
This value is no longer applicable and should not be returned.
"Product"
 - 
This enumeration value indicates that the corresponding Item Specific was derived from a product in the eBay Catalog, and was automatically picked up by the listing when the seller created, revised, or relisted an item referencing and matching an eBay catalog product through the use of an ePID or GTIN value in the ProductListingDetails container.
"CustomCode"
 - 
Reserved for future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Source" type="ns:ItemSpecificSourceCodeType"/>
ns:ValidationRules
Type:
ns:RecommendationValidationRulesType, complex content
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.
Component Diagram
XML Representation Summary
<ns:ValidationRules>
   
Content: 
ns:ValueType?, ns:MinValues?, ns:MaxValues?, ns:SelectionMode?, ns:AspectUsage?, ns:MaxValueLength?, ns:ProductRequired?, ns:UsageConstraint?, ns:Confidence?, ns:Relationship*, ns:VariationPicture?, ns:VariationSpecifics?, ns:ValueFormat?, {any}*
</ns:ValidationRules>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ValidationRules" type="ns:RecommendationValidationRulesType"/>
ns:ValueRecommendation
Type:
ns:ValueRecommendationType, complex content
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.
Component Diagram
XML Representation Summary
<ns:ValueRecommendation>
   
Content: 
ns:Value?, ns:ValidationRules?, {any}*
</ns:ValueRecommendation>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="ValueRecommendation" type="ns:ValueRecommendationType"/>
{any element from any namespace}
XML Source (see within schema source)
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
Overview 
Namespace 
WSDL 
Schema 
 Component 
Index 
PREV C-TYPE   NEXT C-TYPE
FRAMES   NO FRAMES NS-Bindings
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API
WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.