Component 
SUMMARY: XML REP | DERIVED | USE
DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD
eBay Trading API

complexType "ns:RecommendationValidationRulesType"
Namespace:
Content:
complex, 13 elements, elem. wildcard
Defined:
globally in Schema in ebaySvc.wsdl; see XML source
Includes:
definitions of 13 elements, elem. wildcard
Used:
Component Diagram
XML Representation Summary
<...>
   
Content: 
</...>
All Direct / Indirect Based Elements (2):
Known Usage Locations
Annotation
This type is used by the ValidationRules containers that are returned for each Item Specific in the GetCategorySpecifics response. The ValidationRules container consists of some rules and limits for the recommended Item Specific name and the corresponding values for that Item Specific. These rules and limits will apply when the Item Specific is subsequently used in an Add/Revise/Relist call.
XML Source (w/o annotations (14); see within schema source)
<xs:complexType name="RecommendationValidationRulesType">
<xs:sequence>
<xs:element minOccurs="0" name="ValueType" type="ns:ValueTypeCodeType"/>
<xs:element minOccurs="0" name="MinValues" type="xs:int"/>
<xs:element minOccurs="0" name="MaxValues" type="xs:int"/>
<xs:element minOccurs="0" name="SelectionMode" type="ns:SelectionModeCodeType"/>
<xs:element minOccurs="0" name="AspectUsage" type="ns:AspectUsageCodeType"/>
<xs:element minOccurs="0" name="MaxValueLength" type="xs:int"/>
<xs:element minOccurs="0" name="ProductRequired" type="ns:ProductRequiredCodeType"/>
<xs:element minOccurs="0" name="UsageConstraint" type="ns:UsageConstraintCodeType"/>
<xs:element minOccurs="0" name="Confidence" type="xs:int"/>
<xs:element maxOccurs="unbounded" minOccurs="0" name="Relationship" type="ns:NameValueRelationshipType"/>
<xs:element minOccurs="0" name="VariationPicture" type="ns:VariationPictureRuleCodeType"/>
<xs:element minOccurs="0" name="VariationSpecifics" type="ns:VariationSpecificsRuleCodeType"/>
<xs:element minOccurs="0" name="ValueFormat" type="ns:ValueFormatCodeType"/>
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>
</xs:sequence>
</xs:complexType>
Content Element Detail (all declarations defined in this component; 14/14)
ns:AspectUsage
Type:
ns:AspectUsageCodeType, simple content
The value returned in this field will indicate if the item specific value is a product aspect (relevant to catalog products in the category) or an item/instance aspect, which is an aspect whose value will vary based on a particular instance of the product.

Note: Currently, the AspectUsage field will only be returned for some item/instance aspects (and not product aspects). Examples of common instance aspects that are shared by many eBay categories include 'Custom Bundle', 'Bundle Description', 'Modified Item', 'Modification Description', and 'California Prop 65 Warning'. Many instance aspect values are allowed more characters than the standard 65 max character threshold, and sellers can look at the corresponding MaxValueLength field to get the maximum number of characters allowed for that particular instance aspect value.
XML Representation Summary
<ns:AspectUsage>
   
Content: 
{ enumeration of xs:string }
</ns:AspectUsage>
Simple Content
Enumeration:
"Product"
 - 
This enumeration value indicates that the Item Specific in the corresponding NameRecommendation.Name field is defined/derived from an eBay catalog product. 'Product' Item Specifics are also referred to as Product Aspects in Web flows and other APIs. Generally, catalog product-based Item Specifics should not be modified if the seller created/revise/relisted the item based on an eBay catalog product.
"Instance"
 - 
This enumeration value indicates that the Item Specific in the corresponding NameRecommendation.Name field is an 'instance aspect', which is an Item Specific whose value will vary based on a particular instance of the product. When creating a listing, the seller should pass in the name-value pair for this Item Specific through the Item.ItemSpecifics.NameValueList container of an AddItem call.
"CustomCode"
 - 
Reserved for future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="AspectUsage" type="ns:AspectUsageCodeType"/>

ns:Confidence
Type:
xs:int, predefined, simple content
Indicates eBay's confidence that this is the right name or value, given the data you specified your request. The confidence is based on historical items in the same category, with similar titles (if specified).

This field is only returned when IncludeConfidence is included in the request and set to true. This field is not returned when SelectionMode is set to Prefilled.
XML Representation Summary
<ns:Confidence>
   
Content: 
{ xs:int }
</ns:Confidence>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="Confidence" type="xs:int"/>

ns:MaxValueLength
Type:
xs:int, predefined, simple content
This integer value will state the maximum length of the instance aspect's value. The seller must make sure not to exceed this value when setting instance aspects on a listing. This field is only returned for instance aspects (AspectUsage=Instance). The standard maximum length for an item specific value is 65 characters.
XML Representation Summary
<ns:MaxValueLength>
   
Content: 
{ xs:int }
</ns:MaxValueLength>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="MaxValueLength" type="xs:int"/>

ns:MaxValues
Type:
xs:int, predefined, simple content
Maximum number of values that you can specify for this Item Specific in listing requests (like AddItem) in the specified category.

Most Item Specifics can only have one value. When this is greater than 1, your application can present the value recommendations (if any) as a multi-select list to the seller. (See SelectionMode to determine whether the seller needs to choose from eBay's recommendations or not.)
XML Representation Summary
<ns:MaxValues>
   
Content: 
{ xs:int }
</ns:MaxValues>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="MaxValues" type="xs:int"/>

ns:MinValues
Type:
xs:int, predefined, simple content
Minimum number of values that you can specify for this Item Specific in listing requests. Not returned if zero (0).

If this field is returned, it indicates that the Item Specific is required in listing requests in the corresponding category. If the Relationship field is also present, it means this Item Specific is required when you specify its parent value in listing requests.
XML Representation Summary
<ns:MinValues>
   
Content: 
{ xs:int }
</ns:MinValues>
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="MinValues" type="xs:int"/>

ns:ProductRequired
Type:
The enumeration value returned in this field will indicate whether or not the corresponding product brand requires listings within that category to be associated with an eBay catalog product. To create a listing that is associated with an eBay catalog product, the seller uses the ProductListingDetails container of the AddItem call. To find a matching product in the eBay catalog, the seller can use the new eBay Catalog API or FindProducts call of the eBay Shopping API.

This field is only returned for the 'Brand' NameRecommendation container, and only if that particular product brand within that Product-Based Shopping Experience-enabled category requires a catalog product.

Note: Due to the rollback of the Product-Based Shopping Experience mandate for all eBay categories (and brands within those categories), the ValidationRules.ProductRequired field will not get returned for any brands within any eBay category. Due to this fact, the ProductRequired field is currently not applicable.
XML Representation Summary
<ns:ProductRequired>
   
Content: 
{ enumeration of xs:token }
</ns:ProductRequired>
Simple Content
Enumeration:
"Disabled"
 - 
If this enumeration value is returned for a product brand within a category, the eBay seller is not expected to use an eBay catalog product when creating or revising their listing in this category for this product brand.
"Enabled"
 - 
If this enumeration value is returned for a product brand within a category, the eBay seller should use an eBay catalog product when creating or revising their listing in this category for this product brand. Using an eBay catalog product for the specific category/brand to create/revise the listing is not a hard mandate, but it is necessary if the seller would like the listing to appear in product-based listing search results.
"CustomCode"
 - 
Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ProductRequired" type="ns:ProductRequiredCodeType"/>

ns:Relationship
Type:
Indicates the Item Specific's logical dependency on another Item Specific, if any.

For example, in a clothing category, Size Type could be recommended as a parent of Size, because Size=XL would mean something different to buyers when Size Type=Juniors or Size Type=Regular.

Or in the US (in the future), a list of cities can vary depending on the state, so State could be recommended as a parent of City.

Currently, categories only recommend a maximum of one parent for an Item Specific. For example, Size=XL could have a Size Type=Juniors parent in a Juniors clothing category. In the future, some categories may recommend multiple parents. For example, City=Mountain View could have parents like State=California, State=New York, and State=North Carolina.

If an Item Specific has value dependencies (i.e., if it has value recommendations that contain Relationship), then all of its value recommendations are returned (regardless of the number you specified in MaxValuesPerName).
Component Diagram
XML Representation Summary
<ns:Relationship>
   
Content: 
</ns:Relationship>
XML Source (w/o annotations (1); see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="Relationship" type="ns:NameValueRelationshipType"/>

ns:SelectionMode
Type:
ns:SelectionModeCodeType, simple content
The enumeration value returned in this field indicates whether a seller can specify their own custom values for an Item Specific, or if they need to use a value (or values) that eBay has defined.
XML Representation Summary
<ns:SelectionMode>
   
Content: 
{ enumeration of xs:string }
</ns:SelectionMode>
Simple Content
Enumeration:
"Automatic"
 - 
Automatic criteria. Reserved for future use.
"Manual"
 - 
Manual criteria. Reserved for future use.
"Prefilled"
 - 
Indicates that the Item Specifics defined for an eBay catalog product will get pre-filled for a listing if the seller successfully matches their item to a product in eBay's catalog. To match an item to an eBay catalog product when adding or revising a listing, the seller provides either an Add/Revise/Relist eBay Product ID (ePID), or a Global Trade Identification Number such as a UPC, an EAN, anISBN), or a Brand/MPN pair.
"SelectionOnly"
 - 
If this value is returned, it is recommended that the seller only use one of the recommended values for the corresponding Item Specific. In other words, the seller should use the exact string provided in one of the corresponding ValueRecommendation.Value fields when creating, revising, or relisting an item and using that particular Item Specific.
"FreeText"
 - 
Indicates that the seller is allowed to specify their own value(s) for the corresponding Item Specific when creating, revising, or relisting an item and using that particular Item Specific.
"CustomCode"
 - 
Reserved for future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="SelectionMode" type="ns:SelectionModeCodeType"/>

ns:UsageConstraint
Type:
This field is returned for each item specific that is returned in the response. The enumeration value returned will indicate whether the item specific is required, recommended, or optional.

Note: Previously, returned item specifics were only 'marked' as required or optional. With the introduction of this new field, eBay is able to specify to sellers which item specifics are highly recommended, although not required. The item specifics that are recommended can possibly improve search results and/or sales conversion if the seller includes them in the listing.
XML Representation Summary
<ns:UsageConstraint>
   
Content: 
{ enumeration of xs:token }
</ns:UsageConstraint>
Simple Content
Enumeration:
"Optional"
 - 
This enumeration value indicates that the corresponding item specific is completely optional for a listing in the category, but the seller should still include it if the item specific is relevant to the product and its value is known.
"Recommended"
 - 
This enumeration value indicates that the corresponding item specific is typical and recommended for a listing in the category, but not fully required. The seller should include this item specific if its value is known because including it may improve search results and sale conversion.
"Required"
 - 
This enumeration value indicates that the corresponding item specific is required for a listing in the category. The seller must include this item specific or the listing may be blocked.
"CustomCode"
 - 
Reserved for internal or future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="UsageConstraint" type="ns:UsageConstraintCodeType"/>

ns:ValueFormat
Type:
ns:ValueFormatCodeType, simple content
The format of the data type (e.g., date format) that eBay expects the item specific's value to adhere to in listing requests. A data type identified by the ValueType field may have different representations, and ValueFormat specifies the precise format that is required.
XML Representation Summary
<ns:ValueFormat>
   
Content: 
{ enumeration of xs:token }
</ns:ValueFormat>
Simple Content
Enumeration:
"FullDate"
 - 
This enumeration value indicates that a full date is used, including the month, day, and year in the following format: 'YYYYMMDD'
"PartialDate"
 - 
This enumeration value indicates that a partial date is used, including the month and year in the following format: 'YYYYMM'
"Year"
 - 
This enumeration value indicates that only the year is returned in the following format: 'YYYY'
"CustomCode"
 - 
Reserved for future or internal use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ValueFormat" type="ns:ValueFormatCodeType"/>

ns:ValueType
Type:
ns:ValueTypeCodeType, simple content
The data type (e.g., date) that eBay expects the value to adhere to in listing requests. Only returned if the data type is not Text. In some cases, more details about the data type are returned in the ValueFormat field.

As buyers may search on the value you specify in AddItem, the ISBN, UPC, or EAN should match the value that was specified by the publisher or manufacturer.

Note: The Numeric enumeration value is returned for whole integers (no decimal point), and the Decimal enumeration value is returned for numbers with decimals.
XML Representation Summary
<ns:ValueType>
   
Content: 
{ enumeration of xs:token }
</ns:ValueType>
Simple Content
Enumeration:
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="ValueType" type="ns:ValueTypeCodeType"/>

ns:VariationPicture
Type:
Indicates whether the name (e.g., Color) can (or must) be used to classify the variation pictures.
XML Representation Summary
<ns:VariationPicture>
   
Content: 
{ enumeration of xs:token }
</ns:VariationPicture>
Simple Content
Enumeration:
"Required"
 - 
This value indicates that the corresponding Item Specific name must be used in the Variations.Pictures.VariationSpecificName field if the seller is providing picture URLs through the Variations.Pictures.VariationSpecificPictureSet container in a 'FixedPriceItem' call when creating, revising, or relisting an item.
"Enabled"
 - 
This value indicates that the corresponding Item Specific name can be used in the Variations.Pictures.VariationSpecificName field if the seller is providing picture URLs through the Variations.Pictures.VariationSpecificPictureSet container in a 'FixedPriceItem' call when creating, revising, or relisting an item. Unlike the 'Required' value, 'Enabled' indicates that corresponding Item Specific name is just one option, and they may be other options to use as a VariationSpecificName value.
"Disabled"
 - 
This value indicates that the corresponding Item Specific name cannot be used in the Variations.Pictures.VariationSpecificName field if the seller is providing picture URLs through the Variations.Pictures.VariationSpecificPictureSet container in a 'FixedPriceItem' call when creating, revising, or relisting an item. The seller will have to find an Item Specific that is either 'Enabled' or 'Required' to use as a VariationSpecificName value.
"CustomCode"
 - 
Reserved for future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="VariationPicture" type="ns:VariationPictureRuleCodeType"/>

ns:VariationSpecifics
Type:
Indicates whether the recommended name/value pair can be used in an Item.Variations container in a fixed-price listing call. For example, a given category could disable a name like Brand in variation specifics (if Brand is only allowed in the item specifics at the Item level). The same category could enable a name like Size for variation specifics (in addition to recommending it for item specifics). If not returned, then the name/value can be used for both variation specifics and item specifics.
XML Representation Summary
<ns:VariationSpecifics>
   
Content: 
{ enumeration of xs:token }
</ns:VariationSpecifics>
Simple Content
Enumeration:
"Enabled"
 - 
This value indicates that the corresponding Item Specific can be specified at the variation level. In the AddFixedPriceItem call, variation-specific name-value pairs are specified under the Variation.VariationSpecifics.NameValueList container.
"Disabled"
 - 
This value indicates that the corresponding Item Specific cannot be specified at the variation level. If an Item Specific cannot be used at the variation level, it usually indicates that the particular Item Specific should only be specified at the listing-level, as it is a product aspect that should be shared by all variations in the multiple-variation listing.
"CustomCode"
 - 
Reserved for future use.
XML Source (w/o annotations (1); see within schema source)
<xs:element minOccurs="0" name="VariationSpecifics" type="ns:VariationSpecificsRuleCodeType"/>

{any element from any namespace}
XML Source (see within schema source)
<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

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