GetProducts - Call Reference - eBay Trading API

GetProducts

Searches for stock information and reviews for certain kinds of products, such as a particular digital camera model.

GetProducts is designed to be useful to applications that support shopping comparison, product reviews, or basic supply and demand data.

GetProducts also supports tracking so that members of the eBay Affiliates Program can get commissions for driving traffic to eBay.

Note: For selling use cases, use GetProductSearchResults and GetProductSellingPages instead.

To use this call, you typically pass in keywords, and GetProducts finds products with matching words in the product title, description, and/or Item Specifics.

For each product of interest, you call GetProducts again to retrieve additional details that would be useful to buyers:

Top reviews of the product by eBay members, including part of the review text, plus links to the full text on the eBay Web site.
Relevant buying guides (shopping advice) written by eBay members and by eBay staff, including part of the guide text, plus links to the full text on the eBay Web site.
Up to 200 matching items on eBay (if any). (To find more matching items, use GetSearchResults.)

Note: As catalog queries can take longer than item queries, GetProducts can be slower than GetSearchResults. Also, due to the way product data is cached, you may get a faster response when you run the same query a second time.

See also the reference documentation for these calls:

GetSearchResults - Retrieves item listings based on keywords you specify. The keywords can include wildcards. The response is in the form of an array whose size and contents you specify, using a variety of input fields. You can filter the item listings returned using such criteria as the listing category, location, whether the item is listed in an ebay Store, and listing type. You can include or exclude specified sellers.
GetCategories - Retrieves the latest eBay category hierarchy for a given eBay site. Information returned for each category includes the category name and the unique ID for the category (unique within the eBay site for which categories are retrieved). A category ID is a required input when you list most items.

GetProducts 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 not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetProductsResponse 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 -->
  <ApproximatePages> int </ApproximatePages>
  <BuyingGuideDetails> BuyingGuideDetailsType 
    <BuyingGuide> BuyingGuideType 
      <CategoryID> string </CategoryID>
      <CreationTime> dateTime </CreationTime>
      <Name> string </Name>
      <Text> string </Text>
      <Title> string </Title>
      <URL> anyURI </URL>
      <UserID> UserIDType (string) </UserID>
    </BuyingGuide>
    <!-- ... more BuyingGuide nodes here ... -->
    <BuyingGuideHub> anyURI </BuyingGuideHub>
  </BuyingGuideDetails>
  <CharacteristicsSetProductHistogram> CharacteristicsSetProductHistogramType 
    <HistogramEntry id="string" name="string"> HistogramEntryType 
      <Count> int </Count>
    </HistogramEntry>
    <!-- ... more HistogramEntry nodes here ... -->
  </CharacteristicsSetProductHistogram>
  <DuplicateItems> boolean </DuplicateItems>
  <HasMore> boolean </HasMore>
  <ItemArray> ItemArrayType 
    <Item> ItemType 
      <BuyItNowPrice> AmountType (double) </BuyItNowPrice>
      <Country> CountryCodeType </Country>
      <Currency> CurrencyCodeType </Currency>
      <GiftIcon> int </GiftIcon>
      <ItemID> ItemIDType (string) </ItemID>
      <ItemSpecifics> NameValueListArrayType 
        <NameValueList> NameValueListType 
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value nodes here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes here ... -->
      </ItemSpecifics>
      <ListingDetails> ListingDetailsType 
        <EndTime> dateTime </EndTime>
        <StartTime> dateTime </StartTime>
        <ViewItemURL> anyURI </ViewItemURL>
        <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
      </ListingDetails>
      <ListingDuration> token </ListingDuration>
      <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
      <!-- ... more ListingEnhancement nodes here ... -->
      <ListingType> ListingTypeCodeType </ListingType>
      <Location> string </Location>
      <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
      <!-- ... more PaymentMethods nodes here ... -->
      <PictureDetails> PictureDetailsType 
        <GalleryType> GalleryTypeCodeType </GalleryType>
        <GalleryURL> anyURI </GalleryURL>
      </PictureDetails>
      <PostalCode> string </PostalCode>
      <PrimaryCategory> CategoryType 
        <CategoryID> string </CategoryID>
      </PrimaryCategory>
      <SearchDetails> SearchDetailsType 
        <BuyItNowEnabled> boolean </BuyItNowEnabled>
        <Picture> boolean </Picture>
        <RecentListing> boolean </RecentListing>
      </SearchDetails>
      <SecondaryCategory> CategoryType 
        <CategoryID> string </CategoryID>
      </SecondaryCategory>
      <Seller> UserType 
        <FeedbackPrivate> boolean </FeedbackPrivate>
        <FeedbackScore> int </FeedbackScore>
        <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
      </Seller>
      <SellingStatus> SellingStatusType 
        <BidCount> int </BidCount>
        <CurrentPrice> AmountType (double) </CurrentPrice>
      </SellingStatus>
      <ShippingDetails> ShippingDetailsType 
        <DefaultShippingCost> AmountType (double) </DefaultShippingCost>
        <ShippingType> ShippingTypeCodeType </ShippingType>
      </ShippingDetails>
      <Storefront> StorefrontType 
        <StoreName> string </StoreName>
        <StoreURL> anyURI </StoreURL>
      </Storefront>
      <SubTitle> string </SubTitle>
      <Title> string </Title>
    </Item>
    <!-- ... more Item nodes here ... -->
  </ItemArray>
  <PageNumber> int </PageNumber>
  <Product> CatalogProductType 
    <AttributeSetID> int </AttributeSetID>
    <DetailsURL> anyURI </DetailsURL>
    <DisplayStockPhotos> boolean </DisplayStockPhotos>
    <ExternalProductID> ExternalProductIDType 
      <AlternateValue> string </AlternateValue>
      <!-- ... more AlternateValue nodes here ... -->
      <Type> ExternalProductCodeType </Type>
      <Value> string </Value>
    </ExternalProductID>
    <ItemCount> int </ItemCount>
    <ItemSpecifics> NameValueListArrayType 
      <NameValueList> NameValueListType 
        <Name> string </Name>
        <Value> string </Value>
        <!-- ... more Value nodes here ... -->
      </NameValueList>
      <!-- ... more NameValueList nodes here ... -->
    </ItemSpecifics>
    <ProductReferenceID> long </ProductReferenceID>
    <ProductState> ProductStateCodeType </ProductState>
    <ReviewCount> int </ReviewCount>
    <ReviewDetails> ReviewDetailsType 
      <AverageRating> float </AverageRating>
      <Review> ReviewType 
        <CreationTime> dateTime </CreationTime>
        <Rating> int </Rating>
        <Text> string </Text>
        <Title> string </Title>
        <URL> anyURI </URL>
        <UserID> UserIDType (string) </UserID>
      </Review>
      <!-- ... more Review nodes here ... -->
    </ReviewDetails>
    <StockPhotoURL> anyURI </StockPhotoURL>
    <Title> string </Title>
  </Product>
  <!-- ... more Product nodes here ... -->
  <TotalProducts> int </TotalProducts>
</GetProductsResponse>

Return Value	Type	Occurrence	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	Conditionally, repeatable: [0..*]	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. See the "Errors by Number" document.
Errors.ErrorParameters	ErrorParameterType	Conditionally, repeatable: [0..*]	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
ApproximatePages	int	Always	The total number of pages that can be returned, given the same query and filters in the request. As GetProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request). Min: 1. Max: 2000.
BuyingGuideDetails	BuyingGuideDetailsType	Conditionally	Contains information for up to 5 buying guides that match the query. Only returned when you set IncludeBuyingGuideDetails to true. Buying guides provide useful information about shopping in a particular domain, like Digital Cameras. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. If no buying guides are associated with the product, this only returns a link to the buying guide hub (the main Guides page).
BuyingGuideDetails.BuyingGuide	BuyingGuideType	Conditionally, repeatable: [0..5]	Information that identifies a buying guide. A buying guide contains content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them.
BuyingGuideDetails.BuyingGuide .CategoryID	string	Conditionally	Identifies the category (if any) that is associated with the buying guide. For GetSearchResults, this can be a category that is higher or lower in the hierarchy than the category specified in the request. For a matching categories search, you can use this information to determine the order that the buying guides are returned in when multiple guides are found. Optionally, you can use this information to determine where to present the buying guide link in your application. Not returned for product finder searches. Max length: 10.
BuyingGuideDetails.BuyingGuide .CreationTime	dateTime	Conditionally	The time and date when the guide was posted.
BuyingGuideDetails.BuyingGuide .Name	string	Conditionally	Display name of the buying guide. GetProducts only returns 20 characters, followed by "..." if the name is longer than 20 characters. For the full title, see BuyingGuide.Title instead. Max length: 23.
BuyingGuideDetails.BuyingGuide .Text	string	Conditionally	The text of the guide. If the guide is longer than 2000 characters, the text is cut off and it ends with "...". See BuyingGuide.URL for a link to the full text of the review.
BuyingGuideDetails.BuyingGuide .Title	string	Conditionally	The title of the buying guide. Max length: 55.
BuyingGuideDetails.BuyingGuide .URL	anyURI	Conditionally	URL for the buying guide. Your application can present this as a link. Use the value of Name as the link's display name.
BuyingGuideDetails.BuyingGuide .UserID	UserIDType (string)	Conditionally	The author's eBay user ID.
BuyingGuideDetails .BuyingGuideHub	anyURI	Conditionally	URL of the buying guide home page for the site being searched. Your application can present this URL as a link. Optionally, you can use a value like "See all buying guides" as the link's display name. GetProducts returns this URL even when no guides are available for the product.
CharacteristicsSetProductHistogram	CharacteristicsSetProductHistogramType	Always	A histogram that lists the number of matching products found and the domains in which they were found. A domain is essentially a set of categories that share certain common features (as determined by eBay). Each domain has its own name and ID.
CharacteristicsSetProductHistogram .HistogramEntry	HistogramEntryType	Conditionally, repeatable: [0..*]	In GetProducts, each histogram entry shows how many matching products were found in each matching domain. A domain is like a high-level category. (A domain is also called an attribute set or a characteristic set.)
CharacteristicsSetProductHistogram .HistogramEntry [ attribute id ]	string	Conditionally	For GetProducts, this is the domain ID (attribute set ID or characteristic set ID).
CharacteristicsSetProductHistogram .HistogramEntry [ attribute name ]	string	Conditionally	For GetProducts, this is the domain name (attribute set name or characteristic set name). A domain is like a high-level category.
CharacteristicsSetProductHistogram .HistogramEntry.Count	int	Conditionally	For GetProducts, the number of products found in the domain (characteristic set or attribute set). If a product is mapped to more than one domain, it will be counted separately for each domain. (For example, if the same product can be found in both Children's Books and Fiction Books, the count for both of these domains will include that product.) Furthermore, when a product is mapped to more than one domain, Product.AttributeSetID only returns the most applicable domain, as determined by eBay.
DuplicateItems	boolean	Conditionally	Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.
HasMore	boolean	Always	If true, more pages of results are available. That is, PageNumber is less than ApproximatePages.
ItemArray	ItemArrayType	Conditionally	A list of items (if any) that match the product identified in ExternalProductID or ProductReferenceID in the request. Only returned when you set IncludeItemArray to true. The items are sorted by end time (ending soonest), and this order is not configurable in the request. Up to 200 items can be returned. All items are returned on the first page (page 1). Not returned when you use QueryKeywords. If ItemCount is greater than 200, use GetSearchResults if you want to retrieve more matching items. Note: GetSearchResults doesn't currently support ProductReferenceID queries. So, you can use ExternalProductID (if present) as input to GetSearchResults. Otherwise, see Product.DetailsURL for a workaround to determine a ProductID value to use with GetSearchResults.
ItemArray.Item	ItemType	Conditionally, repeatable: [0..200]	Contains the data properties that define one item listing. GetSellerEvents and GetSellerList only return items if any are available for the seller within the time window specified in the request. Some optional fields are only returned if the seller defined them for the item. Some fields are only returned under particular conditions specified in the individual field descriptions. For example, a buyer's contact information might only be returned if the member who is making the request (as identified in eBayAuthToken) has a transactional relationship with that buyer. For calls that support detail levels, the set of fields returned is also controlled by the value of DetailLevel in the request. For some calls, other parameters in the request can also control the data returned for each item. For example, GranularityLevel controls the fields to return for each item in the GetSellerList response.
ItemArray.Item.BuyItNowPrice	AmountType (double)	Conditionally	For Chinese auction listings, Buy It Now allows a user to purchase the item at a fixed price and end the auction immediately. Use this field to add Buy It Now and specify the amount a buyer would need to bid to take advantage of the Buy It Now feature. On the main eBay site, not applicable to fixed-price items (ListingType values StoresFixedPrice or FixedPriceItem), AdFormat listings, or Half.com listings. For fixed-price and Half.com listings, see StartPrice instead. See the eBay Web Services Guide for validation rules when revising US eBay Motors listings, including rules for lowering the Buy It Now price of a Motors listing. Once a Chinese auction has bids (and the high bid exceeds the reserve price, if specified), the listing is no longer eligible for Buy It Now (with some exceptions noted below). However, calls like GetItem and GetSearchResults still return the BuyItNowPrice that the seller originally set for the listing. You can use Item.SellingStatus.BidCount to determine whether an auction with Buy It Now has bids or not. With GetSearchResults, you can use the Item.SearchDetails.BuyItNowEnabled flag to determine whether the item can still be purchased using Buy It Now. With GetItem, you can use the Item.ListingDetails.BuyItNowAvailable flag to determine whether the item can still be purchased using Buy It Now. On some sites, the Buy It Now price for a Chinese auction may remain available for certain categories even after a bid is placed. See the "Longer Lasting Buy It Now" link below for more details and the latest list of eBay US categories that support this behavior. The eBay Spain site supports this behavior for all categories. There might be price limits imposed for Buy It Now items, subject to the seller's PayPal account or the payment method used. Such limits cannot be determined via the eBay API and are not covered in eBay's API documentation because they can vary for each user. To remove this value when revising or relisting an item, use DeletedField. See: Longer Lasting Buy It Now Revising US eBay Motors Listings
ItemArray.Item.Country	CountryCodeType	Conditionally	Two-letter ISO 3166 country code. In some calls, used with the Location field to indicate the city and country where the item is located. Also applicable as input to AddItem and related calls when you list items to Half.com (specify US). For English names that correspond to each code (e.g., KY="Cayman Islands"), call GeteBayDetails or see the following ISO site: http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html Applicable values: See Country.
ItemArray.Item.Currency	CurrencyCodeType	Conditionally	Currency associated with the item's price information. 3-letter ISO 4217 currency code that corresponds to the site specified in the item-listing request. Also applicable as input to AddItem and related calls when you list items to Half.com (specify USD). You cannot modify a listing's currency when you revise or relist an item. Applicable values: See Currency. See Field Differences for eBay Sites.
ItemArray.Item.GiftIcon	int	Conditionally	If true, a generic gift icon displays next the listing's title in search and browse pages. GiftIcon must be set to be able to use GiftServices options. Note that one/zero is returned instead of true/false. When the Top-Rated Seller program becomes operational in October 2009, some enhanced listing features will be removed or restricted to certain sellers on some sites. Use GeteBayDetails ListingFeatureDetails for more information. Not applicable to Half.com.
ItemArray.Item.ItemID	ItemIDType (string)	Conditionally	The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value. Also applicable to Half.com. For Half.com, you can specify either ItemID or SellerInventoryID in a ReviseItem request to uniquely identify the listing. In transaction calls (e.g., GetItemTransactions), use a combination of ItemID and TransactionID to uniquely identify a transaction. With multi-quantity listings, a single ItemID can be associated with more than one TransactionID. (For single-quantity listings, the TransactionID is 0.) In GetItemRecommendations, the item ID is required when the value of ListingFlow is ReviseItem or RelistItem, but it is not applicable when the value of ListingFlow is AddItem. In GetSearchResults, the same ItemID may be returned for multiple results if the results are variations from the same mult-variation listing. Note: Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see Common FAQs on eBay Item IDs and other eBay IDs in the Knowledge Base. Max length: 19 (Note: the eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
ItemArray.Item.ItemSpecifics	NameValueListArrayType	Conditionally	A list of attribute or Item Specific name and value pairs that the seller specified for the item. In the AddItem family of calls, use this for specifying custom Item Specifics. Note: If you are including an item condition, many categories may only support condition-based searches if you use AttributeSetArray or LookupAttributeArray. In these cases, you can use AttributeSetArray or LookupAttributeArray for the condition, and ItemSpecifics for the custom Item Specifics. To determine which categories support custom Item Specifics, use GetCategoryFeatures. Note: If you are trying to list with ID-based attributes from GetAttributesCS or GetProductSellingPages, use AttributeSetArray instead. To retrieve recommended Item Specifics, use GetCategorySpecifics or GetItemRecommendations. In GetItemRecommendations, pass in the PrimaryCategory and (optionally) Title to retrieve recommended names and values. With GetItem, this is only returned when you specify IncludeItemSpecifics in the request (and the seller included custom Item Specifics in their listing). For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add Item Specifics. If the listing has bids but ends in more than 12 hours, you cannot change existing Item Specifics, but you can add Item Specifics that were not previously specified. To delete all Item Specifics when you revise or relist, specify Item.ItemSpecifics in DeletedField and don't pass ItemSpecifics in the request. With GetProducts, only the item condition is returned at the item level. Additional attributes that were pre-filled from the catalog are returned in Product.ItemSpecifics. See: Working with Custom Item Specifics (GetProducts) Product.ItemSpecifics
ItemArray.Item.ItemSpecifics .NameValueList	NameValueListType	Conditionally, repeatable: [0..*]	For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations.
ItemArray.Item.ItemSpecifics .NameValueList.Name	string	Conditionally	A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations.
ItemArray.Item.ItemSpecifics .NameValueList.Value	string	Conditionally, repeatable: [0..*]	A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations.
ItemArray.Item.ListingDetails	ListingDetailsType	Conditionally	Various details about a listing, some of which are calculated or derived after the item is listed. These include the start and end time, converted (localized) prices, and certain flags that indicate whether the seller specified fields whose values are not visible to the requesting user. For GetMyeBayBuying, returned as a self-closed element if no listings meet the request criteria. Not applicable to Half.com.
ItemArray.Item.ListingDetails .EndTime	dateTime	Conditionally	Time stamp (in GMT) when the listing is scheduled to end (calculated based on the values of StartTime and ListingDuration) or the actual end time if the item has ended. In GetSearchResults, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times. In GetSearchResults, the same EndTime may be returned for multiple results if the results are variations from the same multi-variation listing.
ItemArray.Item.ListingDetails .StartTime	dateTime	Conditionally	The StartTime value returned by non-search calls such as GetItem is the time stamp (in GMT) for when the item was listed. The StartTime value returned by search calls such as GetSearchResults and GetCategoryListings may vary from the value returned by GetItem. The time value is the same value in the following: The StartTime value returned by GetSearchResults, the StartTime value returned by GetCategoryListings, and the time the item became available for search on the eBay site.
ItemArray.Item.ListingDetails .ViewItemURL	anyURI	Conditionally	The URL of the Web page where a user can view the listing. On the US site, this is called the "View Item" page. If you enabled affiliate tracking in a search-related call (for example, if you used the AffiliateTrackingDetails container in an applicable call), ViewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network). In search results (like the GetSearchResults response), this link to the View Item page is configured to select the applicable variation.
ItemArray.Item.ListingDetails .ViewItemURLForNaturalSearch	anyURI	Conditionally	This URL takes you to the same View Item page as ViewItemURL, but this URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines. The URL includes the item title along with other optimizations. To note, "?" (question mark) optimizes to "_W0QQ", "&" (ampersand) optimizes to "QQ", and "=" (equals sign) optimizes to "Z". If you are an eBAy affiliate, use this URL to promote your affiliate information. Note: This URL may include additional query parameters that don't appear in ViewItemURL and vice versa. You should not modify the query syntax. For example, eBay won't recognize the URL if you change QQ to ?. In search results (like the GetSearchResults response), if the result is a variation from a multi-variation listing, this link to the View Item page is configured to select the applicable variation.
ItemArray.Item.ListingDuration	token	Conditionally	Describes the number of days the seller wants the listing to be active (available for bidding/buying). The duration specifies the seller's initial intent at listing time. The end time for a listing is calculated by adding the duration to the item's start time. If the listing ends early, the value of the listing duration does not change. When a listing's duration is changed, any related fees (e.g., 10-day fee) may be debited or credited (as applicable). The valid choice of values depends on the listing format (see Item.ListingType). For a list of valid values, call GetCategoryFeatures with DetailLevel set to ReturnAll and look for ListingDurations information. When you revise a listing, the duration cannot be reduced if it will result in ending the listing within 24 hours of the current date-time. You are only allowed to increase the duration of the listing if fewer than 2 hours have passed since you initially listed the item and the listing has no bids. You can decrease the value of this field only if the listing has no bids (or no items have sold) and the listing does not end within 12 hours. Required for Half.com (but only specify GTC). See: GetCategoryFeatures Fees per Site Applicable values: See ListingDurationCodeType
ItemArray.Item .ListingEnhancement	ListingEnhancementsCodeType	Conditionally, repeatable: [0..*]	Describes listing upgrades that sellers can select for a fee, such as the BoldTitle upgrade. Also includes feature packs for saving on listing upgrades. See Listing Upgrades in the eBay Web site online help. You cannot remove listing upgrades when you revise a listing. When you relist an item, use DeletedField to remove a listing upgrades. Not applicable to Half.com. Applicable values: • BasicUpgradePackBundle (in/out) No longer applicable to any site. Formerly, a feature pack applicable to the Australia site (site ID 15, abbreviation AU) only. Contained the Gallery and Subtitle features. • BoldTitle (in/out) If specified, the seller wants the title for the item's listing to be in boldface type. Applicable listing fees apply. Does not affect the item subtitle (Item.SubTitle), if any. Not applicable to eBay Motors. • Border (in/out) If specified, the seller wants the item to be displayed with a border that goes around the item in search result pages that return multiple items. The border differentiates the item from other items in the list. Applicable listing fees apply. • CustomCode (in/out) Reserved for internal or future use. • Featured (in/out) Listing is a "Featured Plus" item. The item will display prominently in the Featured Items section of its category list, and it will stand out on search results pages. It will also display in the regular, non- featured item list. Only available to users with a Feedback rating of 10 or greater. • Highlight (in/out) Listing is highlighted in a different color in lists. • HomePageFeatured (in/out) Listing will have a chance to rotate into a special display on eBay's Home page. Your item is very likely to show up on the Home page, although eBay does not guarantee that your item will be highlighted in this way. This is the highest level of visibility on eBay. Not applicable for eBay Motors (SiteId 100). In order to feature the listing on eBay Motors home page, use PictureDetails.GalleryType.Featured instead. See GalleryTypeCodeType for more information. • ProPackBundle (in/out) Listing is using ProPackBundle (a feature pack). Applies only to US and Canadian eBay motor vehicle sellers. Contains the BoldTitle, Border, Featured and Highlight features. • ProPackPlusBundle (in/out) Support for this feature varies by site and category. A ProPackPlusBundle listing is using ProPackPlus bundle (a feature pack), which combines the features of BoldTitle, Border, Highlight, Featured (which is equivalent to a GalleryType value of Featured), and Gallery, for a discounted price. Note that if, for example, in AddItem, if you use ProPackPlusBundle and a GalleryType value of Gallery, then the resulting item will have a GalleryType value of Featured. • ValuePackBundle (in/out) Listing is using ValuePack bundle (a feature pack), which combines the features Gallery, Subtitle, and Listing Designer for a discounted price. Support for this feature varies by site and category. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites (starting on the same production date), whenever ValuePackBundle is selected in a request, the basic Gallery feature included in the Value Pack bundle is now automatically upgraded to the Gallery Plus feature at no extra cost (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus). If ValuePackBundle is selected and no Gallery picture is found, the request is still accepted and the ValuePackBundle fee will still apply. Whenever a listing with ValuePackBundle is created on a site that offers free Gallery, the Gallery Plus upgrade will display on all sites and categories that support ValuePackBundle. Note that if Gallery Showcase is automatically included with Gallery Plus, it will be extended to listings with ValuePackBundle that upgrade Gallery to Gallery Plus (see Item.PictureDetails.GalleryType.Plus for more information on Gallery Plus).
ItemArray.Item.ListingType	ListingTypeCodeType	Conditionally	The format of the listing the seller wants to use, such as Chinese auction or fixed price. Optional for eBay.com listings (defaults to Chinese auction) in AddItem and VerifyAddItem. Do not specify ListingType for eBay.com listings in ReviseItem. (You can't modify the listing type of an active eBay listing. Required for Half.com listings (and the value must be Half) in AddItem, VerifyAddItem, and ReviseItem. If you don't specify Half when revising Half.com listings, ReviseItem won't use the correct logic and you may get strange errors (or unwanted side effects in the listing, even if no errors are returned). Applicable values: • AdType (in/out) Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. • Chinese (in/out) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. • CustomCode (in/out) Reserved for internal or future use. • Dutch Deprecated as of version 611. (in/out) Multiple-quantity online auction format. A Dutch auction has a Quantity greater than 1. Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. Note: As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. Deprecation version: 611. See also Deprecated Objects. • Express Deprecated as of version 561. (in/out) For Germany only: eBay Express format (item is listed only on eBay Express only, not on eBay). You must be an Express Germany seller to use this format. See "Express Format Criteria" in the eBay Web Services guide. As of late April 2008, this value will no longer work, regardless of the API version you are using. Deprecation version: 561. See also Deprecated Objects. • FixedPriceItem (in/out) A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Sellers must meet certain feedback requirements and/or be ID Verified to use this format. See Minimum Feedback Requirements for Various Features in the Trading Web Services guide. Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner. Stores fixed price items will be treated as basic fixed-price items. Permitted durations of 30 days and GTC are now available for store and non-store subscribers (in addition to the existing durations of 3, 5, 7, and 10 days). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. • LeadGeneration (in/out) Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). • Live Deprecated as of version 601. (out) Live auction, on-site auction that can include non-eBay bidders. (Use AddLiveAuctionItem to list live auctions.) Live auctions are listed on the eBay Live Auctions site, in live auction categories. They can also appear on eBay if the seller lists the lot in a secondary category that is an eBay category. Deprecation version: 601. See also Deprecated Objects. • Shopping (out) Reserved for internal or future use. You can ignore Shopping.com items in your results. • StoresFixedPrice (in/out) A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Stores fixed price items will be treated as basic fixed-price items; please see the documentation for FixedPriceItem (that is, for the basic fixed-price item format). Use the GetCategoryFeatures call to determine if a particular site has adopted this method. The release notes will also contain much of this information. (Not all values in ListingTypeCodeType apply to this field.) See: Different Ways of Selling Listing Types (Formats) GetCategoryFeatures Fees per Site
ItemArray.Item.Location	string	Conditionally	Indicates the geographical location of the item (along with Country). When you revise a listing, you can add or change this value only if the listing has no bids (or no items have sold) and it does not end within 12 hours. If you do not specify Location, you must specify Item.PostalCode. If you specify a postal code, but do not specify a location, then the location is given a default value derived from the postal code. For the Classified Ad format for eBay Motors vehicles, the value provided in the Location is used as item location only if the SellerContactDetails.Street and the SellerContactDetails.Street2 are empty. Else, the SellerContactDetails.Street and the SellerContactDetails.Street2 will be used for item location. Also applicable as input to AddItem and related calls when you list items to Half.com. Max length: 45.
ItemArray.Item.PaymentMethods	BuyerPaymentMethodCodeType	Conditionally, repeatable: [0..*]	Identifies the payment method (such as PayPal) that the seller will accept when the buyer pays for the item. Use GetCategoryFeatures to determine the payment methods that are allowed for a category on a site. For example, the response data of GetCategoryFeatures will show that on the US site, most categories only allow electronic payments. Also use GetCategoryFeatures to determine the default payment methods for a site. Do not use GeteBayDetails to determine the payment methods for a site. If you specify multiple PaymentMethods fields, the repeating fields must be contiguous. For example, you can specify PayPalEmailAddress after a list of repeating PaymentMethods fields, but not between them: <PaymentMethods>VisaMC</PaymentMethods> <PaymentMethods>PayPal</PaymentMethods> <PayPalEmailAddress>mypaypalemail@ebay.com</PayPalEmailAddress> In general, if you separate repeating instances of a field, the results will be unpredictable. This rule applies to all repeating fields (maxOccurs="unbounded" or greater than 1) in the schema. See "Overview of the Schema" in the eBay Web Services guide. Note: Required or allowed payment methods vary by site and category. Refer to Payment Method Differences (PaymentMethod) in the eBay Trading API Guide for information to help you determine which payment methods you are required or allowed to specify. Payment methods are not applicable to eBay Real Estate ad format listings, Classified Ad format listings, or Half.com. For ReviseItem and RelistItem only: A listing must have at least one valid payment method. When you revise or relist an item and you specify a payment method that is invalid for the target site, eBay ignores the invalid payment method, applies the other valid changes, and returns a warning to indicate that the invalid payment method was ignored. If multiple payment methods were invalid, the warning indicates that they were all ignored. If you modify the listing so that it includes no valid payment methods, an error is returned. This situation could occur when the seller removes all valid payment methods or when all the payment methods specified for the item are no longer valid on the target site. For GetProducts only: Only PayPal is returned in product search results. Applicable values: • PayPal (in/out) PayPal is accepted as a payment method. This qualifies as a safe payment method. If true in listing requests, Item.PayPalEmailAddress must also be specified. If you don't pass PayPal in the listing request but the seller's eBay preferences are set to accept PayPal on all listings, eBay will add PayPal as a payment method for you in most cases, and we may return a warning. PayPal must be accepted when the seller requires immediate payment (Item.AutoPay) or offers other PayPal-based features, such as a finance offer (Item.FinanceOfferID). PayPal must be accepted for charity listings. PayPal must be accepted for event ticket listings when the venue is in New York state or Illinois, so that eBay can offer buyer protection (per state law). (For some applications, it may be simplest to use errors returned from VerifyAddItem to flag the PayPal requirement for New York and Illinois ticket listings.) PayPal must be accepted for US eBay Motors listings that require a deposit (and it will not be set automatically based on the seller's preferences). Conversely, if PayPal is specified for US eBay Motors listings, deposit attributes must be specified. For additional information about features that depend on PayPal, see the eBay Web Services Guide. (Not all values in BuyerPaymentMethodCodeType apply to this field.) See: Payment Method Differences (PaymentMethod) Listing an Item (SetUserPreferences) SellerPaymentPreferences Overview of the API Schema for rules regarding repeating nodes
ItemArray.Item.PictureDetails	PictureDetailsType	Conditionally	Contains the data for a picture associated with an item. Not applicable to Half.com. Note: PictureDetails replaces the deprecated SiteHostedPicture and VendorHostedPicture in the response with request version 439 or greater. As SiteHostedPicture and VendorHostedPicture are also no longer recommended on input, applications should use PictureDetails in the input as well. If SiteHostedPicture or VendorHostedPicture are passed in with PictureDetails, PictureDetails takes precedence. See Introduction to Pictures in Item Listings.
ItemArray.Item.PictureDetails .GalleryType	GalleryTypeCodeType	Conditionally	Indicates whether listing images are included in the search results (in both Picture Gallery and List Views) and, if so, which image listing enhancements apply to them. Items that have pictures but do not have image listing enhancements display a generic photo image in search results. If the value is Gallery, Plus, or Featured, eBay checks the available image URLs in the following order to determine which URL to use (if more than one of these URLs is available): a) Use the URL in GalleryURL, if it is specified. b) Otherwise, if ProductListingDetails.UseStockPhotoURLAsGallery is true, use the eBay stock photo. c) Otherwise, use the value of the first PictureURL in the array of PictureURL fields, if any. d) Otherwise, if ProductListingDetails.ProductID is specified, use the eBay stock photo for that ProductID (eBay resets UseStockPhotoURLAsGallery to true in this case). e) If eBay is unable to find an image URL for the listing, an error is returned. Note that you can use the Gallery Plus feature whether or not the image is hosted with eBay Picture Services (EPS). Selecting Gallery Plus does not incur a separate Gallery fee. See "Describing Items in a Listing" in the eBay Web Services Guide for additional information about working with pictures and related validation rules. You cannot remove Gallery, Plus, or Featured when revising an item, however you can upgrade to a higher feature. On upgrade, the original feature fee is credited, and the new feature fee is charged. There are a number of categories on some eBay sites that always offer the Gallery feature for free. (The API doesn't flag these categories in any meta-data calls.) In these categories, if you specify a picture and you don't specify GalleryType, eBay may add GalleryType=Gallery to the listing (for free) and return a warning (error code 219243). The Knowledge Base explains an edge case that could result in an unexpected gallery fee if the seller moves the item to a category that doesn't offer the free gallery feature. This fee can also appear when if the seller moves the item from a site that offers free Gallery (across all its categories) to one where free Gallery is not yet available. Whenever you change the primary category, it is a good idea to clearly specify whether the seller is intentionally requesting the gallery option. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), UK (site ID 3), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay will automatically create a Gallery thumbnail for the listing in search results by selecting a picture from one of the image URLs specified in the request (either Item.PictureDetails.PictureURL or Item.PictureDetails.GalleryURL) or from an available stock photo. Thus, a Gallery thumbnail will be created whenever Item.PictureDetails.GalleryType is None or is not specified in the request. A Gallery fee will apply whenever GalleryType specifies the Plus or Featured image enhancements (there will be no Gallery fee whenever GalleryType is Gallery, None or is not specified in the request). eBay will select the image for the thumbnail depending on which of the image URLs above was specified in the request (there are selection rules for four cases). Note that the selected image will not necessarily be the image you have specified in Item.PictureDetails.GalleryURL. Note that a Gallery thumbnail will not be automatically created if PictureURL and GalleryURL are not supplied and UseStockPhotoURLAsGallery and IncludeStockURL are set to false. The most common case occurs when both GalleryURL and PictureURL are specified in the request. eBay will use the image referenced by PictureURL as the Gallery thumbnail. As three other cases exist, please refer to "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide for complete information on how eBay selects an image for the gallery thumbnail on these sites. You cannot remove Gallery or Featured when revising an item, however you can upgrade to a higher feature. On upgrade, the original feature fee is credited, and the new feature fee is charged. (This does not apply to Gallery Plus on sites with free Gallery; see Plus below for more information.) Applicable values: • CustomCode (in/out) Reserved for internal or future use. • Featured (in/out) Listing is highlighted and included at the top of search results. When "Featured" is included in an item listing, the listing also automatically gets the Gallery and Gallery Plus functionality. "Gallery" and "Plus" do not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. For eBay Motors (SiteId 100), this may also feature certain items on the eBay Motors home page. Not applicable to eBay Stores Inventory listings. Note: Gallery Featured is now known as Featured First on several eBay sites, including US (main site, not motors), CA, CAFR, UK, IE, DE, AT, CH, and IT. • Gallery (in/out) Listing image is included in the search results (in both Picture Gallery and List Views). Items that have pictures but do not have the Gallery feature will have a generic photo image shown in search results. Some listing enhancements (for example, "Featured" and "Plus") automatically include the Gallery functionality, so "Gallery" does not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. • None (in/out) Listing image is not included in the search results (in either Picture Gallery or List Views), and no other image listing enhancements apply. Items that have pictures but do not have image listing enhancements display a generic photo image in search results. Mainly useful for RelistItem use cases when you want to remove an existing gallery setting. However, not all image listing enhancements can be removed on revise or relist. Note that specifying None is not necessarily the same as omitting GalleryType from a request. For example, specifying other item properties may cause the listing to be included in the search results Gallery by default if GalleryType is not specified. • Plus (in/out) Listing image has Gallery Plus funtionality. That is, listing includes a Gallery Plus icon that, when moused over or clicked, displays a large (400 px x 400 px) preview image of the item. Clicking the image displays the View Item page for that listing. Listing images that are originally smaller than 400 px x 400 px are centered in the preview frame. Images that are originally larger than 400 px x 400 px are scaled down to 400 px on their longest side (maintaining their original aspect ratio). Note that you can use the Gallery Plus feature whether or not the image is hosted with eBay Picture Services (EPS). One EPS image is included at no cost with the Gallery Plus feature. When "Plus" is included in an item listing, the listing also automatically gets the Gallery functionality at no extra cost. "Gallery" does not need to be specified separately in the listing. Passing "Featured", "Plus", and "Gallery" in the same request will return an error. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites (starting on the same production date), whenever Plus is selected in a request that specifies at least two eBay Picture Services (EPS) hosted images (using ItemType.PictureDetailsType.PictureURL), the Gallery Plus feature now automatically includes a Gallery Showcase of all the listing's images at no extra cost. If Plus is selected and the request includes only one EPS image or any self-hosted images, regular Gallery Plus applies. The Gallery Showcase displays when mousing over or clicking on the listing's Gallery Plus icon in the search results. The Showcase window displays a large (400 px x 400 px) preview image which is usually the first specified PictureURL, as well as up to four (64 px x 64 px) selectable thumbnails for the remaining EPS images (the Showcase window contains pagination controls for observing all EPS images in the request). Clicking on the preview image displays the item's listing page. When using RelistItem or ReviseItem (item has no bids and more than 12 hours before the listing's end), Plus can be unselected in the request. However, the Plus fee will still apply if a previous request selected Plus. There is at most one Plus fee per listing. Not applicable to eBay Stores Inventory listings. See: Introduction to Pictures in Item Listings Using Gallery Features on Sites with Free Gallery for complete details on how eBay selects a gallery thumbnail. KB article: Why am I getting charged a GalleryFee in my RelistItem call...?
ItemArray.Item.PictureDetails .GalleryURL	anyURI	Conditionally	URL for a picture to be used as the Gallery thumbnail. Ignored if GalleryType is None or unspecified. If the value of GalleryType is Gallery or Featured, you can either specify GalleryURL or allow eBay to use another picture that you have included in the listing. Note: As of February 2008, the following sites offer free Gallery: US (site ID 0), Parts & Accessories Category on US Motors (site ID 100), CA (site ID 2), CA (site ID 2), UK (site ID 3), CAFR (site ID 210), FR (site ID 71) and NL (site ID 146). Additionally, ES (site ID 186) and IT (site ID 101) offer free Gallery as of March 2008. On these sites, eBay selects a Gallery thumbnail from image URLs included in the request (i.e. either GalleryURL or the first PictureURL), using selection rules that consider which of these URLs has been specified and whether an eBay stock photo exists for the item. Note that the selected gallery thumbnail may not necessarily be the one you specify using GalleryURL. Also, eBay selects an image regardless of whether you have specified either GalleryType or GalleryURL. A stock photo will not be generated for an item unless UseStockPhotoURLAsGallery and IncludeStockPhotoURL are set to true. Therefore, in this case, an item that does not have a PictureURL will not have a Gallery picture. A Gallery fee will only apply if you have set GalleryType to Plus or Featured (as basic Gallery is free). For more information on eBay's selection rules for the gallery thumbnail on sites with free Gallery, see "Using Gallery Features on Sites with Free Gallery" in the eBay Web Services Guide. (See GalleryType for the rules that determine which URL is used if you do not specify GalleryURL on sites where free Gallery is currently not available.) The image used for the Gallery thumbnail must be in one of the graphics formats JPEG, BMP, TIF, or GIF. See "Describing Items in a Listing" in the eBay Web Services Guide for additional validation rules. For eBay Live Auctions, lots are listed in the gallery for free. To remove GalleryURL when revising or relisting an item, use DeletedField. When you revise an item, you can only remove GalleryURL if the item has at least one PictureURL or a stock photo to use instead. If the item has bids (or items have been sold) or the listing ends within 12 hours, you can add GalleryURL or change its value, but you cannot remove the gallery URL value if it was previously specified. Not applicable to eBay Motors listings. Max length: 1024. See: Introduction to Pictures in Item Listings Using Gallery Features on Sites with Free Gallery for complete details on how eBay selects a gallery thumbnail. (ReviseItem) DeletedField
ItemArray.Item.PostalCode	string	Conditionally	Postal code of the place where the item is located. This value is used for proximity searches. To remove this value when revising or relisting an item, use DeletedField. If you do not specify PostalCode, you must specify Item.Location. If you specify PostalCode, but do not specify Item.Location, then Item.Location is given a default value derived from the postal code. Not applicable to Half.com.
ItemArray.Item.PrimaryCategory	CategoryType	Conditionally	Category ID for the first (or only) category in which the item is listed (or will be listed, if the item is new). A number of listing features have dependencies on the primary category. We have pointed out a few of the notable dependencies below. See the descriptions of the fields you are using to determine whether the feature you're supporting depends on the listing's primary category. For the AddItem family of calls: Use calls like GetCategories and GetCategoryFeatures to determine valid values for the site on which you are listing (see the eBay Web Services Guide for information on working with categories). Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. There are a number of categories on some eBay sites that always add the Gallery feature (for free) when you include a picture in the listing and you don't specify the Gallery feature yourself. See GalleryType for information about fees that could be charged if you change the category in these cases. Not applicable to Half.com. For ReviseItem only: When revising a listing, you can change the primary category only if an item has no bids (or no items have sold) and the listing does not end within 12 hours. If you change the listing category, any Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the new category. See Item.AttributeSetArray. For the eBay US site, we suggest that you avoid including a category ID when you list with an external product ID, such as ISBN. See the KB article listed below for details. You cannot change the meta-categories for vehicles (i.e., you cannot change a truck to a motorcycle), but you can change the leaf category (e.g., change one motorcycle subcategory to another motorcycle subcategory). See the eBay Web Services Guide for additional rules. International sites (such as the eBay Germany site) have similar rules for revising vehicle categories. For GetItemRecommendations only: For GetItemRecommendations, use this value to control the category that is searched for recommendations. Specify the category in which the item will be listed. See Getting Recommendations to Improve a Listing in the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attribute engine. For GetProducts: Use GetCategories if you need to determine the name of the category. See: Categories Specifying eBay Live Auctions Categories Listing US and CA eBay Motors Items (RelistItem) GalleryType KB Article: Listing with ExternalProductID and CategoryID
ItemArray.Item.PrimaryCategory .CategoryID	string	Conditionally	Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For GetPopularKeywords, -1 represents the root category. For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. Max length: 10.
ItemArray.Item.SearchDetails	SearchDetailsType	Conditionally	Container for values that indicate whether a listing uses the Buy It Now feature, whether a listing is no more than one day old, and whether a listing has an image associated with it. Not applicable to Half.com.
ItemArray.Item.SearchDetails .BuyItNowEnabled	boolean	Conditionally	Indicates whether a listing uses the Buy It Now feature. For GetProducts, only returned for listing types that support Buy It Now (like Chinese auctions.)
ItemArray.Item.SearchDetails .Picture	boolean	Conditionally	Indicates whether a listing has an image associated with it.
ItemArray.Item.SearchDetails .RecentListing	boolean	Conditionally	Indicates whether a listing is no more than one day old.
ItemArray.Item .SecondaryCategory	CategoryType	Conditionally	ID for second category in which the item is listed (also see Item.PrimaryCategory). For the AddItem family of calls: Listing an item in a second category is optional. Also see Item.CategoryMappingAllowed and Item.CategoryBasedAttributesPrefill. Not applicable to Half.com. On the eBay UK, Ireland, Germany, Austria, Switzerland, and Italy sites you can list Store Inventory listings in two categories. On the eBay US and other sites, you cannot list Store Inventory listings in two categories. You cannot list US eBay Motors vehicles in two categories. However, you can list Parts & Accessories in two categories. The Final Value Fee is based on the primary category in which the item is listed. Furthermore, you can list the same item in an eBay Motors Parts & Accessories category and in an eligible eBay category, as long as the primary category is associated with the site on which you are listing. That is, the two categories can be a mix of Motors Parts & Accessories and eBay site categories. (Real Estate, Mature Audience (adult), and Business & Industrial categories are not eligible for listing in two categories in this manner.) For example, if you list on Motors, the primary category could be 6750 (eBay Motors > Parts & Accessories > Apparel & Merchandise > Motorcycle > Jackets & Leathers), and the secondary category could be 57988 (eBay > Clothing, Shoes > Accessories > Men's Clothing > Outerwear). If you list on the main eBay site, the primary category could be 57988 and the secondary category could be 6750. To remove this value when relisting an item, use DeletedField. For ReviseItem only: When revising a listing, you can add, remove, or change the secondary category only if the listing has no bids (or no items have sold) and it does not end within 12 hours. If you change the secondary category, any corresponding Item Specifics (attributes) that were previously specified may be dropped from the listing if they aren't valid for the category. See Item.AttributeSetArray. When you revise an item, you can change the secondary category from a Motors Parts & Accessories category to an eBay category or vice versa if the listing has no bids (or no items have sold) and it does not end within 12 hours. For GetItemRecommendations only: For GetItemRecommendations, use this to control the category that will be searched for recommendations. Specify the category in which the item will be listed. See the eBay Web Services guide for differences in validation rules depending on whether you are using the Listing Analyzer engine, Product Pricing engine, or Suggested Attributes engine. See Categories.
ItemArray.Item .SecondaryCategory.CategoryID	string	Conditionally	Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID. For GetPopularKeywords, -1 represents the root category. For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. Max length: 10.
ItemArray.Item.Seller	UserType	Conditionally	Container for information about this listing's seller. Not applicable to Half.com. Returned by GetItemsAwaitingFeedback if Buyer is making the request.
ItemArray.Item.Seller .FeedbackPrivate	boolean	Conditionally	Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on. See Working with Anonymous User Information.
ItemArray.Item.Seller .FeedbackScore	int	Conditionally	The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned. See Working with Anonymous User Information.
ItemArray.Item.Seller .PositiveFeedbackPercent	float	Conditionally	Percent of total feedback that is positive. For example, if the member has 50 feedbacks, where 49 are positive and 1 is neutral or negative, the positive feedback percent could be 98.0. The value uses a max precision of 4 and a scale of 1. If the user has feedback, this value can be returned regardless of whether the member has chosen to make their feedback private. Not returned if the user has no feedback. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request.
ItemArray.Item.SellingStatus	SellingStatusType	Conditionally	Various details about the current status of the listing, such as the current number of bids and the current high bidder. Not applicable to Half.com.
ItemArray.Item.SellingStatus .BidCount	int	Conditionally	Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).
ItemArray.Item.SellingStatus .CurrentPrice	AmountType (double)	Conditionally	For competitive-bid item listings (Chinese auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), or Ad type (AdType) listings this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised using the ReviseItem call. In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.
ItemArray.Item.ShippingDetails	ShippingDetailsType	Conditionally	The shipping-related details for an item or transaction, including flat and calculated shipping costs and shipping insurance costs. New users who list their first items in selected categories on the US site must specify at least one domestic shipping service. This applies to a category if GetCategoryFeatures returns true for Category.ShippingTermsRequired. For multi-quantity Store Inventory Format listings and for multi-quantity Fixed Price listings, a seller can revise all shipping details of the listing (except for sales tax and for shipping type of Freight) for all unsold items. This applies to both domestic and international shipping. Checkout is not affected for those who bought items prior to the seller's shipping changes--the shipping details that were in effect at the time of purchase are used for that buyer at the time of checkout. Shipping details are not applicable to Real Estate listings and Half.com. See: Determining Shipping Costs for a Listing Revising Items for restrictions on changing item properties with ReviseItem
ItemArray.Item.ShippingDetails .DefaultShippingCost	AmountType (double)	Conditionally	The default shipping cost for the item. If the seller specified multiple shipping services, this is the "first" shipping service as specified by the seller when they listed the item. For GetSearchResults: If ShippingType has the value Flat, then the actual shipping cost is shown. If ShippingType has the value Free, then zero is shown. If ShippingType has the value Calculated, then this tag (DefaultShippingCost) is not shown. If ShippingType has the value NotSpecified, then this tag (DefaultShippingCost) is not shown. If ShippingType has the value Freight, then this tag (DefaultShippingCost) is not shown. Not applicable to Half.com.
ItemArray.Item.ShippingDetails .ShippingType	ShippingTypeCodeType	Conditionally	The shipping cost model offered by the seller. This is not returned for various calls since shipping type can be deduced: if a CalculatedShippingRate structure is returned by the call, the shipping type is Calculated. Otherwise, it is one of the other non-Calculated shipping types. Not applicable to Half.com. Applicable values: • Calculated (in/out) Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts. • CalculatedDomesticFlatInternational (in/out) The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. • CustomCode (in/out) Reserved for future use. • Flat (in/out) Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. • FlatDomesticCalculatedInternational (in/out) The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. • Free (out) Free shipping. Returned only by GetSearchResults and GetProducts. This field is output-only so if you want to use AddItem to specify a free Shipping Cost, specify 0 in Item.ShippingDetails.ShippingServiceOptions.ShippingServiceCost. • Freight (out) Freight shipping model: the cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code). Currently, Freight can only be specified on input via eBay Web site, not API. • FreightFlat (in/out) Freight shipping model: freight shipping may be used when flat or calculated shipping cannot be used due to the greater weight of the item. See "Specifying Freight Shipping" in the Shipping chapter for details on freight shipping. • NotSpecified (in/out) The seller did not specify the shipping type.
ItemArray.Item.Storefront	StorefrontType	Conditionally	Contains information related to the item in the context of a seller's eBay Store. Applicable for auction formats, Basic Fixed Price, and Store Inventory format items listed by eBay Stores sellers. Not applicable to Half.com.
ItemArray.Item.Storefront .StoreName	string	Conditionally	The name of the seller's eBay Store. GetProducts returns an empty value for all items at the time of this writing. Max length: 200.
ItemArray.Item.Storefront .StoreURL	anyURI	Conditionally	The URL of the seller's eBay Store page. GetProducts only returned a default URL at the time of this writing.
ItemArray.Item.SubTitle	string	Conditionally	Subtitle to use in addition to the title. Provides more keywords when buyers search in titles and descriptions. You cannot use HTML in the Subtitle. (HTML characters will be interpreted literally as plain text.) If you pass any value, this feature is applied (with applicable fees). Not applicable to listings in US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or to listings in CA eBay Motors passenger vehicle and motorcycle categories. For eBay Motors categories that do not support this field, use Item Specifics (AttributeSetArray) to specify the vehicle subtitle. When you revise a item, you can add, change, or remove the subtitle. Not applicable to Half.com. Max length: 55. See: Removing a Field When Relisting an Item (RelistItem) DeletedField Valid Item Specifics for Listing eBay Motors US Cars & Trucks Specifying a Subtitle for a Motors Vehicle Listing
ItemArray.Item.Title	string	Conditionally	Name of the item as it appears in the listing or search results. Required for most items. Optional if you list in Books, Music, Movies, or Video Games categories and you use Pre-filled Item Information (as the title can be pre-filled based on the catalog product title). That is, optional if you specify Item.ExternalProductID or Item.ProductListingDetails. You cannot use HTML or JavaScript in the Title. (HTML characters will be interpreted literally as plain text.) For AddItem, not applicable to Half.com. For GetOrders, not returned from eBay.com, but a title from the Half.com catalog is returned from Half.com instead. You can add or change the value of this tag only if an item has no bids (or no items have sold) and the listing does not end for 12 hours. In GetItemRecommendations, more keywords in the title usually results in more relevant recommendations. Max length: 55.
PageNumber	int	Always	The number of the page of data returned. If many products are found and multiple pages of results are available, use this in combination with ApproximatePages and HasMore to decide which page to retrieve next. As GetProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request). Min: 1. Max: 2000.
Product	CatalogProductType	Always, repeatable: [1..20]	An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. When you use QueryKeywords in the request, GetProducts returns a maximum of 20 products per page. When you use ExternalProductID or ProductReferenceID in the request, GetProducts usually only returns 1 product. (If more than one product matches the same ExternalProductID, GetProducts will return all of those products. As of the time of this writing, we expect this to be a rare case.)
Product.AttributeSetID	int	Conditionally	Numeric ID for the product's domain (characteristic set). When you use GetProducts by itself, this can be useful when you want to group product results by domain (e.g., all book products together). For a mapping of attribute set IDs to names, see the eBay Web Services guide. Alternatively, use GetCategory2CS to retrieve the mappings periodically (e.g., once a day) and store them locally. (We do not recommend using the product histogram, for this purpose.)
Product.DetailsURL	anyURI	Always	Fully qualified URL for optional information about the product, such as a movie's description or film credits. This information is hosted through the eBay Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link in product search results so that end users can view additional descriptive details about the product. Note: You can use the ProductMementoString parameter in this URL as the ProductID value in GetSearchResults requests. This parameter is a colon-delimited alphanumeric value. For an example of how to use this string, see the GetProducts samples in the eBay Web Services guide.
Product.DisplayStockPhotos	boolean	Always	If true, your application can attempt to display stock photos that are returned. If false, your application should not attempt to display any stock photos that are returned. This recommendation is useful for catalog data related to products like coins, where stock photos are not necessarily applicable or available. An application with a graphical user interface can use this flag to determine when to hide customized stock photo widgets.
Product.ExternalProductID	ExternalProductIDType	Conditionally	An ISBN, UPC, or EAN value that is associated with this eBay catalog product (if any). These values are only returned for products in "media" domains (Books, DVDs and Movies, Music, and Video Games). Products in other domains don't return this value (even if a UPC is available in the Item Specifics.) Please note that as of February 2007, GetProducts may temporarily return two ExternalProductID nodes for ISBN for some sites (one with a 13-digit value and one with a 10-digit value). This is a bug and it will be fixed in an upcoming release. Instead, one ExternalProductID node will be returned with an additional field. Do not code your application to expect multiple ExternalProductID nodes to be returned for ISBN values on an ongoing basis.
Product.ExternalProductID .AlternateValue	string	Conditionally, repeatable: [0..*]	An industry-standard value that provides an alternate identification for the product, if any. Currently, this only returns an alternate ISBN value. If the catalog defines both an ISBN-13 and ISBN-10, then the ISBN-13 is returned in Value and the ISBN-10 is returned in AlternateValue. (That is, the ISBN-13 is considered to be the preferred identifier.) If the catalog only defines one ISBN, it is returned in Value (and AlternateValue is not returned). Please note that some catalogs return ISBN values that are not 10 or 13 characters, and some values contain non-alphanumeric symbols (e.g., $). Max length: 4000.
Product.ExternalProductID.Type	ExternalProductCodeType	Conditionally	The kind of identifier being used. The choices are listed For requests, required if Value is specified. For Half.com listing use cases, only ISBN, UPC, and EAN are supported. GetProducts supports ISBN, UPC, and EAN. Applicable values: • EAN (in/out) ExternalProductID.Value contains an EAN value. Required when you pass an EAN as the external product ID. • ISBN (in/out) ExternalProductID.Value contains an ISBN value. Required when you pass an ISBN as the external product ID. (This value is also applicable to Half.com listings.) • UPC (in/out) ExternalProductID.Value contains a UPC value. Required when you pass a UPC as the external product ID. (This value is also applicable to Half.com listings.) (Not all values in ExternalProductCodeType apply to this field.)
Product.ExternalProductID .Value	string	Conditionally	An industry-standard value that uniquely identifies the product. The valid values are dictated by the Type property. Required if Type is specified. Max length 13 for ISBN (as of February 2007), 13 for EAN, 12 for UPC, and 4000 for ProductID. No max length for ticket keywords (but passing too much data can result in "no match found" errors). For AddItem and related calls: If the primary and secondary categories are both catalog-enabled, the value must apply to the primary category. Event tickets listings support a set of keywords that uniquely identify the listing. The ticket keywords specify the event name (the title shown on the ticket), venue name, and event date and time. See the eBay Web Services guide for more information and validation rules. For convenience, you can pass an eBay product ID as input (not limited to media categories). Required for Half.com listing use cases, and this can only be an ISBN, UPC, or EAN value. For GetSearchResults and GetProducts input only: Only ISBN, EAN, and UPC values are currently supported as input. For GetProducts and GetSellerPayments output only: Also see AlternateValue, which is returned if the catalog defines multiple ISBN values (e.g., one for ISBN-13 and one for ISBN-10). Please note that some catalogs return ISBN values that are not 10 or 13 characters, and some values contain non-alphanumeric symbols (e.g., $). Max length: See description.
Product.ItemCount	int	Always	Total number of listings on the specified eBay site that use stock information from this catalog product. This value can be greater than the number of listings returned in ItemArray. To retrieve more listings, use GetSearchResults. Only returned when you use ExternalProductID or ProductReferenceID and you set IncludeItemArray to true.
Product.ItemSpecifics	NameValueListArrayType	Conditionally	A list of attribute and value pairs that are included in the product's pre-filled Item Specifics. Also see ExternalProductID for ISBN, UPC, or MPN values, if applicable. This is usually returned. (We are not aware of any cases in which this node is not be returned. However, it may be safest to check for the existence of this node.)
Product.ItemSpecifics .NameValueList	NameValueListType	Conditionally, repeatable: [0..*]	For the AddItem family of calls: Contains the name and value(s) for an Item Specific. Only required when the ItemSpecifics container is specified. For the AddFixedPriceItem family of calls: The same NameValueList schema is used for the ItemSpecifics node, the VariationSpecifics node, and the VariationSpecifcsSet node. If the listing has varations, any name that you use in the VariationSpecifics and VariationSpecificsSet nodes can't be used in the ItemSpecifics node. When you list with Item Variations: a) Specify shared Item Specifics (e.g., Brand) in the ItemSpecifics node. b) Specify up to five VariationSpecifics in each Variation node. c) Specify all applicable names with all their supported values in the VariationSpecificSet node. See the Variation sample in the AddFixedPriceItem call reference for examples. For PlaceOffer: Required if the item being purchased includes Item Variations.
Product.ItemSpecifics .NameValueList.Name	string	Conditionally	A name in a name/value pair. For the AddItem and AddFixedPriceItem families of calls: In the Item.ItemSpecifics context, this can be any name that the seller wants to use. However, to help buyers find items more easily, it is a good idea to try to use a recommended name when possible (see GetCategorySpecifics or GetItemRecommendations). You can't specify the same name twice within the same listing. For the AddFixedPriceItem family of calls: In the VariationSpecifics context, this can be any name that the seller wants to use, unless the VariationsEnabled flag is false for the name in the GetCategorySpecifics response. For example, for some categories eBay may recommend that you only use "Brand" as a shared name at the Item level, not in variations. For GetCategorySpecifics and GetItemRecommendations: This is a recommended (popular) name to use for items in the specified category (e.g., "Brand" might be recommended, not "Manufacturer"). For search calls: In the GetSearchResults response, this the name of an attribute (Attribute) that was used in the listing. Specifically: If SearchRequest was used to perform a "Product Finder" search, this contains the name of one attribute (i.e, the name of one ID-based Item Specifics field). If IncludeCondition was true in the request, this returns the condition attribute name (e.g., "Item Condition"). In the GetProducts response, this is an attribute name that is defined for a catalog product. For PlaceOffer: Required if the item being purchased includes Item Variations.
Product.ItemSpecifics .NameValueList.Value	string	Conditionally, repeatable: [0..*]	A value associated with the name. For the AddItem family of calls: If you specify multiple values for Item Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. For the AddFixedPriceItem family of calls: If you specify multiple values for Item Specifics or Variation Specifics, eBay only stores the first one, unless GetCategorySpecifics or GetItemRecommendations indicates that the corresponding name supports multiple values. In VariationSpecificSet, you typically specify multiple Value fields for each name. For example, if Name=Size, you would specify all size values that you wan to offer in the listing. For GetCategorySpecifics and GetItemRecommendations: The most highly recommended values are returned first. For these calls, Value is only returned when recommended values are available. For search calls: In the GetSearchResults response, if SearchRequest was used to perform a "Product Finder" search, this contains the value of one attribute. If IncludeCondition was true in the request, this returns the condition attribute value (e.g., "New"). For PlaceOffer: Required if the item being purchased includes Item Variations.
Product.ProductReferenceID	long	Conditionally	The numeric ID for the eBay catalog product. After selecting a product returned from a keyword query, pass this value in GetProducts to retrieve more information about that product.
Product.ProductState	ProductStateCodeType	Conditionally	Indicates that the product has changed or will soon change (usually due to a migration from one catalog to another catalog). Typically, this field is returned for up to 90 days for a given product. After that, the product either no longer returns this field or the product is no longer returned (depending on the state change). As of mid-2008, this data is primarily applicable to catalogs used by the US, Germany, Austria, and Switzerland sites. Other sites may undergo catalog changes in the future. Applicable values: • CustomCode (out) Reserved for internal or future use. • Delete (out) This product is marked for deletion, and it will not be mapped to another product. You cannot add or relist items that use products marked for deletion. If your application currently uses the product for listing or searching, we recommend that you update your application to use a product that is not scheduled to be merged or deleted. • Merge (out) Some information in this product is scheduled to be merged into another product in the catalog that eBay (or Half.com) is currently using. This product may be removed from the system at any time. If your application currently uses the product for listing or searching, we recommend that you update your application to use a product that is not scheduled to be merged or deleted. • Update (out) This product's details have been updated. If your application currently uses the product for listing or searching, we recommend that you check to make sure the product data still meets your needs. • UpdateMajor (out) This product has changed. This product has been mapped to a newer product in the catalog that eBay (or Half.com) is currently using, and its details have been updated based on the new catalog data. The product reference ID remains the same (but the longer product ID string may have changed). If your application currently uses the product for listing or searching, we recommend that you check to make sure the product data still meets your needs. • UpdateNoDetails (out) This product was previously available in an earlier catalog, but it has not been mapped to a product in the catalog that eBay is currently using. It can still be used to pre-fill listings, but it may contain fewer details than other products. If your application currently uses the product for listing or searching, we recommend that you check to make sure the product data still meets your needs. Not applicable to Half.com.
Product.ReviewCount	int	Always	The total number of reviews that are available for this product on the eBay Web site. This can be greater than the number of reviews returned by GetProducts. See ReviewDetails.Review.URL for information about viewing more reviews. Min: 0.
Product.ReviewDetails	ReviewDetailsType	Conditionally	The product's most helpful reviews, if any. The reviews are sorted by most helpful review (most votes) first. Only returned when you pass in ExternalProductID or ProductReferenceID and you set IncludeReviewDetails to true. Up to 20 of the reviews are returned. If more reviews are available, (that is, if ReviewCount is greater than 20), the user can look at additional reviews on the eBay Web site. See ReviewDetails.Review.URL for information about viewing more reviews.
Product.ReviewDetails .AverageRating	float	Conditionally	The product's average rating (out of 5) based on all reviews. For example, a value like 4.5 would mean the average rating is 4.5 out of 5. (See ReviewCount for the total number of reviews.) Min: 0. Max: 5.
Product.ReviewDetails.Review	ReviewType	Conditionally, repeatable: [0..20]	An eBay member's review of the product.
Product.ReviewDetails.Review .CreationTime	dateTime	Conditionally	The time and date when the reviewer posted the review.
Product.ReviewDetails.Review .Rating	int	Conditionally	The eBay member's rating of the product. Min: 0. Max: 5.
Product.ReviewDetails.Review .Text	string	Conditionally	The text of the review. If the review is longer than 2000 characters, the text is cut off and it ends with "...". See Review.URL for a link to the full text of the review. Max length: 2000. See (GetProducts) Product.ReviewDetails.Review.URL.
Product.ReviewDetails.Review .Title	string	Conditionally	The title of the review. Max length: 55.
Product.ReviewDetails.Review .URL	anyURI	Conditionally	A link to the full review on the eBay Web site. This URL optimized for natural search: "_W0QQ" is like "?" (question mark), "QQ" is like "&" (ampersand), and "Z" is like "=" (equals sign). Note: For a link to all reviews for the product, remove the upvr parameter from this URL. See the eBay Web Services guide for an example.
Product.ReviewDetails.Review .UserID	UserIDType (string)	Conditionally	The reviewer's eBay user ID.
Product.StockPhotoURL	anyURI	Conditionally	Fully qualified URL for a stock image (if any) that is associated with the eBay catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it.
Product.Title	string	Always	The title of the product. Always returned when Product is returned.
TotalProducts	int	Always	The total number of matching products found. (If more than 2000 products are found, the call fails with an error.) Min: 0. Max: 2000.

GetProducts Detail Controls

Detail Control: DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

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

GetProducts Change History

Version	Description
581 2008-09-03	HideDuplicateItems, DuplicateItems (added): When HideDuplicateItems is specified in the request, any duplicate item listings are filtered from the results. DuplicateItems is true in the response when duplicate items were filtered from the search results.
565 2008-05-14	ProductReferenceID (modified): Starting in May 2008, some sites will start migrating some catalogs to a new provider. If you pass in an older product reference ID, eBay will return a corresponding newer product if available. Product.ProductState (added): Identifies a product that has been updated or marked for replacement or deletion.
561 2008-04-16	Item.ListingType.Express (deprecated): Due to the shutdown of UK and Germany eBay Express sites Item.ListingType.Express has been deprecated.
503 2007-03-07	ExternalProductID.AlternateValue (added): When ExternalProductID defines multiple ISBN values (ISBN-13 and ISBN-10), AlternateValue returns the ISBN-10 value.
501 2007-02-21	(added) New call.

This document was generated with a customized version of the apireferencedocs tool.

Call-specific Input Fields
AffiliateTrackingDetails	AffiliateTrackingDetailsType	Optional	See the eBay Partner Network. eBay uses the values in AffiliateTrackingDetails to build a View Item URL string, in order to include that string in the response. When a user clicks through the URL to eBay, you may get a commission (see the URL above). Only applicable when IncludeItemArray is specified (because the View Item URL is only returned in item information, not in product information). See Affiliate Tracking Concepts.
AffiliateTrackingDetails .AffiliateUserID	string	Conditional	Need not be specified. You can define an AffiliateUserID (up to 256 characters) if you want to leverage it to better monitor your marketing efforts. If you are using the eBay Partner Network, and you provide an AffiliateUserID, the tracking URL returned by eBay Partner Network will contain the AffiliateUserID, but it will be referred to as a "customid".
AffiliateTrackingDetails .TrackingID	string	Conditional	The value you specify is obtained from your tracking partner. For eBay Partner Network, the TrackingID is the Campaign ID ("campid") provided by eBay Partner Network. A Campaign ID is a 10-digit, unique number for associating traffic. A Campaign ID is valid across all programs to which you have been accepted.
AffiliateTrackingDetails .TrackingPartnerCode	string	Conditional	Specifies your tracking partner for affiliate commissions. Required if you specify a TrackingID. Depending on your tracking partner, specify one of the following values. Not all partners are valid for all sites. For PlaceOffer, only eBay Partner Network and Mediaplex are valid: 2 = Be Free 3 = Affilinet 4 = TradeDoubler 5 = Mediaplex 6 = DoubleClick 7 = Allyes 8 = BJMT 9 = eBay Partner Network For information about the eBay Partner Network, see eBay Partner Network. See Affiliate Tracking Concepts.
HideDuplicateItems	boolean	Optional	Specifies whether or not to remove duplicate items from search results. When set to true, and there are duplicate items for an item in the search results, the subsequent duplicates will not appear in the results. Item listings are considered duplicates in the following conditions: Items are listed by the same seller Items have exactly the same item title Items have similar listing formats Auctions: Auction Items, Auction BIN items, Multi-Quantity Auctions, and Multi-Quantity Auctions BIN items Fixed Price: Fixed Price, Multi-quantity Fixed Price, Fixed Price with Best Offer, and Store Inventory Format items Classified Ads For Auctions, items must also have the same price and number of bids to be considered duplicates. Filtering of duplicate item listings is not supported on all sites. For GetProducts, this filter only works when IncludeItemArray is set to true. Default: false.
IncludeBuyingGuideDetails	boolean	Optional	If true, the response includes up to 5 buying guides (if any) for the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords. Default: false.
IncludeHistogram	boolean	Optional	If true, the response includes a histogram that lists the number of matching products found and the domains in which they were found. (A domain is like a high-level category.) Including the histogram can affect the call's performance. You may see significantly slower response times when many matching products are found. Default: false.
IncludeItemArray	boolean	Optional	If true, the response includes items (if any) that match the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords. Default: false.
IncludeReviewDetails	boolean	Optional	If true, the response includes up to 20 reviews (if any) for the product specified in ExternalProductID or ProductReferenceID. The reviews are sorted by most helpful (most votes) first. When you include review details, please note that response times may be longer than 60 seconds. Not applicable with QueryKeywords. Default: false.
ProductSearch	ProductSearchType	Required	Contains the fields that form the search query. You can query against keywords, an eBay product reference ID (not to be confused with an eBay product ID), or external product ID (like an ISBN).
ProductSearch .AvailableItemsOnly	boolean	Optional	If true, only retrieve products that have been used to pre-fill active listings on the specified eBay site. If false, retrieve all products that match the query. For GetProducts This is useful when you use QueryKeywords and you only want to find products that have items (that is, where ItemArray is not empty). For GetProductSearchResults: Ths can be useful when you want to find products that other sellers have recently used to pre-fill similar listings. Default: false.
ProductSearch .CharacteristicSetIDs	CharacteristicSetIDsType	Optional	List of one or more IDs that indicate which domain (characteristic set) to search in. If not specified, the search is conducted across all domains (characteristic sets). For GetProducts Only useful when QueryKeywords is specified. If you use this with ProductReferenceID or ExternalProductID, AND logic is applied. In this case, if you specify an ID that doesn't match the product, no matching product will be found. Therefore, we recommend that you only use this with QueryKeywords. For GetProductSearchResults: Only applicable when QueryKeywords is specified. Ignored when SearchAttributes is specified.
ProductSearch .CharacteristicSetIDs.ID	string	Optional, repeatable: [0..*]	Numeric identifier for a domain (characteristic set). For GetProducts (for buying tools), you can use the list of catalog-enabled attribute sets in the documentation (see link below). For GetProductSearchResults (for selling tools), it's best to use GetCategory2CS to determine mappings between categories and characteristic sets that are flagged as CatalogEnabled. See Catalog-Enabled Attribute Sets.
ProductSearch .ExternalProductID	ExternalProductIDType	Conditional	A query that only retrieves items that were listed with stock products that have ISBN or UPC values (such as books, DVDs, CDs, and video game products). Use this query to retrieve basic details about one catalog product (or a very limited number of products). The results can optionally include items, reviews, and/or buying guides that match that product. (Specifically, the items returned are items that sellers listed with the specified product's stock information.) If you have gotten the ISBN or UPC from another Web site or resource, you can use that ID. Otherwise, call GetProducts with QueryKeywords (or ProductReferenceID). Any matching products that include ISBN or UPC values will return those values in Product.ExternalProductID. The request requires either QueryKeywords, ProductReferenceID, or ExternalProductID, but these fields cannot be used together.
ProductSearch .ExternalProductID.Type	ExternalProductCodeType	Conditional	The kind of identifier being used. The choices are listed For requests, required if Value is specified. For Half.com listing use cases, only ISBN, UPC, and EAN are supported. GetProducts supports ISBN, UPC, and EAN. Applicable values: • EAN (in/out) ExternalProductID.Value contains an EAN value. Required when you pass an EAN as the external product ID. • ISBN (in/out) ExternalProductID.Value contains an ISBN value. Required when you pass an ISBN as the external product ID. (This value is also applicable to Half.com listings.) • UPC (in/out) ExternalProductID.Value contains a UPC value. Required when you pass a UPC as the external product ID. (This value is also applicable to Half.com listings.) (Not all values in ExternalProductCodeType apply to this field.)
ProductSearch .ExternalProductID.Value	string	Conditional	An industry-standard value that uniquely identifies the product. The valid values are dictated by the Type property. Required if Type is specified. Max length 13 for ISBN (as of February 2007), 13 for EAN, 12 for UPC, and 4000 for ProductID. No max length for ticket keywords (but passing too much data can result in "no match found" errors). For AddItem and related calls: If the primary and secondary categories are both catalog-enabled, the value must apply to the primary category. Event tickets listings support a set of keywords that uniquely identify the listing. The ticket keywords specify the event name (the title shown on the ticket), venue name, and event date and time. See the eBay Web Services guide for more information and validation rules. For convenience, you can pass an eBay product ID as input (not limited to media categories). Required for Half.com listing use cases, and this can only be an ISBN, UPC, or EAN value. For GetSearchResults and GetProducts input only: Only ISBN, EAN, and UPC values are currently supported as input. For GetProducts and GetSellerPayments output only: Also see AlternateValue, which is returned if the catalog defines multiple ISBN values (e.g., one for ISBN-13 and one for ISBN-10). Please note that some catalogs return ISBN values that are not 10 or 13 characters, and some values contain non-alphanumeric symbols (e.g., $). Max length: See description.
ProductSearch.Pagination	PaginationType	Optional	Pagination instruction that specifies the virtual page of data to return per search request. For GetProducts, this is primarily useful when you use QueryKeywords. When you use ExternalProductID or ProductReferenceID, only one page of data is typically returned. See Step4:Specify Pagination Properties.
ProductSearch.Pagination .EntriesPerPage	int	Optional	Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value in EntriesPerPage, then the lower number is returned. For most calls, the max is 200 and the default is 25. For GetUserDisputes, the value is hard-coded at 200, and any input is ignored. For GetProducts, the maximum is 20 (and higher values are ignored). See the annotations for other individual calls to determine the correct max and default values. For GetOrders, not applicable to eBay.com (but applicable to Half.com for GetOrders). Min: 1. Max: 20.
ProductSearch.Pagination .PageNumber	int	Optional	Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Min: 1. Max: 2000. Default: 1.
ProductSearch .ProductReferenceID	string	Conditional	The global reference ID for an eBay catalog product. Use this query to retrieve basic details about one catalog product. The results can optionally include items, reviews, and/or buying guides that match that product. (Specifically, the items returned are items that sellers listed with the specified product's stock information.) To determine valid reference IDs, call GetProducts with QueryKeywords (or ExternalProductID). Each matching product returns a reference ID in Product.ProductReferenceID. Note: This value is not the same as the ProductID used in AddItem and related calls. A ProductID represents a particular version of a catalog product. (A given version could have an older or newer description, set of Item Specifics, or other details.) A ProductReferenceID is a more generic or global reference to a product (regardless of version), which is useful for buy-side searching. One product reference ID can be associated with multiple product IDs. As of mid-2008, some sites (such as eBay US, Germany, Austria, and Switzerland) are updating, replacing, deleting, or merging some products (as a result of migrating from one catalog data provider to another). If you specify one of these products, the call may return a warning, or it may return an error if the product has been deleted. The request requires either QueryKeywords, ProductReferenceID, or ExternalProductID, but these fields cannot be used together.
ProductSearch.QueryKeywords	string	Conditional	One or more keywords to search for. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for products containing these words. To use AND or OR logic, use eBay's standard search string modifiers. Wildcards (+, -, or ) are also supported. Be careful when using spaces before or after modifiers and wildcards. For GetProducts* When you use a keyword search, eBay searches the product database for matching words in the product title, description, and/or Item Specifics, and it returns a list of matching products (with no items, reviews, or guides). (To retrieve items, reviews, and/or guides for a particular product, use ProductReferenceID instead.) If specified, you must pass in at least 3 alphanumeric characters. Some keyword queries can result in response times of 30 seconds or longer. If more than 2000 matches are found, the call fails with an error. If this kind of error occurs, refine the search by passing in more keywords and/or by using CharacteristicSetIDs to restrict the search to certain domains (such as DVDs). If you are searching for a particular book, DVD, CD, or video game and you already know its ISBN (for a book) or UPC, consider using ExternalProductID instead to retrieve more precise results. The request requires either QueryKeywords, ProductReferenceID, or ExternalProductID, but these fields cannot be used together. For GetProductSearchResults: eBay searches only in the characteristic set specified in CharacteristicSetIDs. Both the product title and Item Specifics are searched. For each ProductSearch, either SearchAttributes or QueryKeywords is required (but do not pass both). Blank searches are not applicable (and result in a warning). If your search is using a Keyword attribute returned by GetProductSearchPage, use SearchAttributes instead. Max length: 350. See Searching with Plain-Text Keywords.
ProductSort	ProductSortCodeType	Optional	Sorts the list of products returned. This is mostly only useful with QueryKeywords. (When you use ExternalProductID or ProductReferenceID, eBay usually only returns one product.) Applicable values: • CustomCode (in) Reserved for values that are not available in the version of the schema you are using. If eBay adds a new value to this code type as of a particular version, we return CustomCode when you specify a lower request version. • ItemCountAsc (in) Sort by the number of active items listed with this product, and return products with the fewest items first. • ItemCountDesc (in) Sort by the number of active items listed with this product, and return products with the most items first. • PopularityAsc (in) Sort by product popularity (as determined by eBay), and return the most popular products first. • PopularityDesc (in) Sort by product popularity (as determined by eBay), and return the least popular products first. • RatingAsc (in) Sort by average rating, and return the lowest rated products first. • RatingDesc (in) Sort by average rating, and return the highest rated products first. • ReviewCountAsc (in) Sort by the number of reviews, and return products with the fewest reviews first. • ReviewCountDesc (in) Sort by the number of reviews, and return products with the most reviews first. • TitleAsc (in) Sort by the product title, and return products in ascending order. For example, with Western character sets, this means alphabetical order (e.g., A to Z), where titles that start with the word "A" appear before titles that start with the word "The". • TitleDesc (in) Sort by the product title, and return products in reverse order (e.g., Z to A).

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.
OutputSelector	string	Optional, repeatable: [0..*]	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
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.

eBay Trading API Call Reference Version 643

eBay Trading API
Call Reference Version 643