GetSearchResults

Note: This API call is being deprecated and will not be available after July 1, 2010. The functionality provided by this call will be supported in the new Finding API. If you're building new search applications, we recommend you start with the Finding API.
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.

The call returns those item listings where the keywords appear in the title, subtitle, and (optionally) the description. Some input fields (e.g., Query) are primary search criteria that let you specify data to match in listings. For example, you can search for all listings that include the word "Toy" in the title.

Some fields (e.g., ItemTypeFilter) are secondary search criteria that let you further refine data to match in listings. For example, you can search for all toys that are listed as auctions. In general, the effect of secondary search fields is cumulative (using "AND" logic) unless otherwise specified. Some fields (e.g., TotalOnly) control what is actually returned in the result set. For example, you can search for all toys that are listed as Chinese auctions, but just retrieve the total count (not the listings themselves).

Some fields (e.g., IncludeCondition) affect the data to retrieve for each listing in the result set. For example, for each toy returned in the result, you can also choose to see the toy's new or used condition.

Some fields (e.g., Order) control the way the listings are organized in the response. For example, you can retrieve all the toy listings in chronological order, with the newest one first. Use the DetailLevel ItemReturnCategories to return the primary category and, if applicable, the secondary category.

Use a DetailLevel value of ItemReturnAttributes (or ReturnAll) to return summary Item Specifics (only returned for categories that support summary Item Specifics in search results).

If you are not using the BestMatch search option, the API search results may not match the search results returned by the eBay website.

Not applicable to Half.com.

See:
    Searching for Items by Using a Query
    Introduction to Pictures in Item Listings
    GetSearchResults
    Search Type Differences



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetSearchResults
GetSearchResults Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

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

The XML prototype 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"?>
<GetSearchResultsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel nodes here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector nodes here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <AdFormat> boolean </AdFormat>
  <AffiliateTrackingDetails> AffiliateTrackingDetailsType 
    <AffiliateUserID> string </AffiliateUserID>
    <TrackingID> string </TrackingID>
    <TrackingPartnerCode> string </TrackingPartnerCode>
  </AffiliateTrackingDetails>
  <BidRange> BidRangeType 
    <MaximumBidCount> int </MaximumBidCount>
    <MinimumBidCount> int </MinimumBidCount>
  </BidRange>
  <Categories> RequestCategoriesType 
    <CategoriesOnly> boolean </CategoriesOnly>
    <DemandData> boolean </DemandData>
    <Levels> int </Levels>
    <MaxCategories> int </MaxCategories>
    <MaxSubcategories> int </MaxSubcategories>
  </Categories>
  <CategoryID> string </CategoryID>
  <CharityID> int </CharityID>
  <EndTimeFrom> dateTime </EndTimeFrom>
  <EndTimeTo> dateTime </EndTimeTo>
  <ExpandSearch> boolean </ExpandSearch>
  <ExternalProductID> ExternalProductIDType 
    <Type> ExternalProductCodeType </Type>
    <Value> string </Value>
  </ExternalProductID>
  <FreeShipping> boolean </FreeShipping>
  <GranularityLevel> GranularityLevelCodeType </GranularityLevel>
  <Group> GroupType 
    <MaxEntriesPerGroup> int </MaxEntriesPerGroup>
    <MaxGroups> int </MaxGroups>
  </Group>
  <HideDuplicateItems> boolean </HideDuplicateItems>
  <IncludeCondition> boolean </IncludeCondition>
  <IncludeFeedback> boolean </IncludeFeedback>
  <IncludeGetItFastItems> boolean </IncludeGetItFastItems>
  <ItemCondition> ItemConditionCodeType </ItemCondition>
  <ItemTypeFilter> ItemTypeFilterCodeType </ItemTypeFilter>
  <LocalSearchPostalCode> string </LocalSearchPostalCode>
  <Lot> boolean </Lot>
  <MaxRelatedSearchKeywords> int </MaxRelatedSearchKeywords>
  <ModTimeFrom> dateTime </ModTimeFrom>
  <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
  <Order> SearchSortOrderCodeType </Order>
  <Pagination> PaginationType 
    <EntriesPerPage> int </EntriesPerPage>
    <PageNumber> int </PageNumber>
  </Pagination>
  <PaymentMethod> PaymentMethodSearchCodeType </PaymentMethod>
  <PriceRangeFilter> PriceRangeFilterType 
    <MaxPrice> AmountType (double) </MaxPrice>
    <MinPrice> AmountType (double) </MinPrice>
  </PriceRangeFilter>
  <ProductID> string </ProductID>
  <ProximitySearch> ProximitySearchType 
    <MaxDistance> int </MaxDistance>
    <PostalCode> string </PostalCode>
  </ProximitySearch>
  <Quantity> int </Quantity>
  <QuantityOperator> QuantityOperatorCodeType </QuantityOperator>
  <Query> string </Query>
  <SearchFlags> SearchFlagsCodeType </SearchFlags>
  <!-- ... more SearchFlags nodes here ... -->
  <SearchLocationFilter> SearchLocationFilterType 
    <CountryCode> CountryCodeType </CountryCode>
    <Currency> CurrencyCodeType </Currency>
    <ItemLocation> ItemLocationCodeType </ItemLocation>
    <SearchLocation> SearchLocationType 
      <RegionID> string </RegionID>
      <SiteLocation> SiteLocationType 
        <SiteID> SiteIDFilterCodeType </SiteID>
      </SiteLocation>
    </SearchLocation>
  </SearchLocationFilter>
  <SearchRequest> SearchRequestType 
    <ProductFinderID> int </ProductFinderID>
    <SearchAttributes> SearchAttributesType 
      <AttributeID> int </AttributeID>
      <DateSpecifier> DateSpecifierCodeType </DateSpecifier>
      <RangeSpecifier> RangeCodeType </RangeSpecifier>
      <ValueList> ValType 
        <ValueID> int </ValueID>
        <ValueLiteral> string </ValueLiteral>
      </ValueList>
      <!-- ... more ValueList nodes here ... -->
    </SearchAttributes>
    <!-- ... more SearchAttributes nodes here ... -->
  </SearchRequest>
  <SearchType> SearchTypeCodeType </SearchType>
  <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
  <StoreSearchFilter> SearchStoreFilterType 
    <StoreName> string </StoreName>
    <StoreSearch> StoreSearchCodeType </StoreSearch>
  </StoreSearchFilter>
  <TicketFinder> TicketDetailsType 
    <CityName> string </CityName>
    <EventDate> DateType 
      <Day> int </Day>
      <Month> int </Month>
      <Year> int </Year>
    </EventDate>
    <EventType> TicketEventTypeCodeType </EventType>
    <StateOrProvince> string </StateOrProvince>
    <TicketQuantity> int </TicketQuantity>
  </TicketFinder>
  <TotalOnly> boolean </TotalOnly>
  <UserIdFilter> UserIdFilterType 
    <ExcludeSellers> UserIDType (string) </ExcludeSellers>
    <IncludeSellers> UserIDType (string) </IncludeSellers>
  </UserIdFilter>
</GetSearchResultsRequest>
Argument Type Occurrence Meaning
Standard Input Fields   [Jump to call-specific fields]
DetailLevel DetailLevelCodeType Optional,
repeatable: [0..*]		 Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.

The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.)

Note that DetailLevel is required input for GetMyMessages.

With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.

Applicable values:

•   ItemReturnAttributes

(in) For GetItem, returns Item Specifics and Pre-filled Item Information, if any. For GetSearchResults, only returns Item Specifics (if any) that are applicable to search results, and only under certain conditions. See the description of Item.AttributeSetArray for details about the effects for applicable calls. Also see the description of Item.ProductListingDetails for GetItem.

•   ItemReturnCategories

(in) For the GetSearchResults call, returns the primary category and, if applicable, the secondary category

•   ReturnAll

(in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance.


(Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).
ID--- country
----- -----
de_AT Austria
de_CH Switzerland
de_DE Germany
en_AU Australia
en_CA Canada
en_GB United Kingdom
en_SG Singapore
en_US United States
es_ES Spain
fr_BE Belgium (French)
fr_CA Canada (French)
fr_FR France
it_IT Italy
nl_BE Belgium (Dutch)
nl_NL Netherlands
zh_CN China
en_IN India
en_IE Ireland
zh_HK Hong Kong

See Tags for the Identification of Languages.
MessageID string Optional In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.

Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
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.
Call-specific Input Fields
AdFormat boolean Optional Restricts listings to return only items that have the Ad Format feature. If true, the values of ItemTypeFilter and StoreSearchFilter are ignored (if they are specified). That is, "AND" logic is not applied.
AffiliateTrackingDetails AffiliateTrackingDetailsType Optional Container for affiliate tags. If you use affiliate tags, it is possible to get affiliate commissions based on calls made by your application. (See the eBay Partner Network for information about commissions.) Affiliate tags enable the tracking of user activity. You can use child tags of AffiliateTrackingDetails if you want call output to include a string that includes affiliate tracking 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.
BidRange BidRangeType Optional Limits the results to items with a minimum or maximum number of bids. You also can specify a bid range by specifying both a minimum and maximum number of bids in one call.
BidRange.MaximumBidCount int Optional Limits the results to items with a maximum number of bids.
BidRange.MinimumBidCount int Optional Limits the results to items with a minimum number of bids.
Categories RequestCategoriesType Optional Retrieves statistical (histogram) information about categories that contain items that match the query. Can also cause the result to include information about buying guides that are associated with the matching categories. Does not control the set of listings to return or the details to return for each listing.

See Searching for Matching Categories.
Categories.CategoriesOnly boolean Optional Filter to retrieve matching categories but not matching items or buying guides. If true, only matching categories are returned (with no item or buying guide details). If false or not present, matching items and matching categories are both returned, along with buying guide details (if any). If TotalOnly and Categories.CategoriesOnly are both specified in the request and their values are inconsistent with each other, TotalOnly overrides Categories.CategoriesOnly. That is, if TotalOnly is true and Categories.CategoriesOnly is false, the results include matching categories but no item data or buying guides. If TotalOnly is false and Categories.CategoriesOnly is true, the results include matching categories, item data, and buying guides.
Categories.DemandData boolean Optional If you specify that DemandData is true, then the categories returned will be sorted based on Best Match. The most relevant categories will be returned first.
Categories.Levels int Optional Filter to control the deepest matching category level to return. If you specify 0, no category data is returned. If you specify a negative number, the results are unpredictable.
Min: 1. Default: 2.
Categories.MaxCategories int Optional Maximum quantity of matching categories to return at the first level of the category hierarchy (CategoryLevel 1).
Default: 3.
Categories.MaxSubcategories int Optional Maximum quantity of matching subcategories to return at each lower level of the hierarchy.
Default: 3.
CategoryID string Conditional Limits the result set to items in the specified category. If no category ID is specified, all categories are searched by default.

Note: CategoryID does not control whether you will see the item's categories in the response. Set the value of DetailLevel to ItemReturnCategories to retrieve each item's primary category and secondary category (if any) in the response.

If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. Here are a few ways to determine valid categories:
- Use the Categories input field to retrieve matching categories, and then submit the request again with one of those categories.
- Find items in all categories but set DetailLevel to ItemReturnCategories, determine the primary (or secondary) category ID for a similar item in the results, and then submit the request again with that category ID.
- Use another call like GetCategories or GetSuggestedCategories to find a valid category ID.

You must pass ProductID, Query, ExternalProductID, or CategoryID in the request. CategoryID can be used in combination with Query. It is not allowed with ExternalProductID or ProductID. If you pass CategoryID without Query, it must specify a leaf category ID. That is, it cannot be a meta-category ID (e.g., 267 for "Books").
Max length: 10.

See Searching by Category ID.
CharityID int Optional Restricts listings to return only items that support the specified nonprofit charity organization. Retrieve CharityID values with GetCharities.
EndTimeFrom dateTime Conditional Limits the results to items ending within a time range. EndTimeFrom specifies the beginning of the time range. Specify a time in the future. If you specify a time in the past, the current time is used. If specified, EndTimeTo must also be specified (with a value equal to or later than EndTimeFrom). Specify the time in GMT. Cannot be used with the ModTimeFrom filter.
EndTimeTo dateTime Conditional Limits the results to items ending within a time range. EndTimeTo specifies the end of the time range. If specified, EndTimeFrom must also be specified (with a value equal to or earlier than EndTimeTo). Specify the time in GMT. Cannot be used with the ModTimeFrom filter.
ExpandSearch boolean Optional Expands search results when a small result set is returned. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, then if you specify true for this tag, the search results are expanded. Specifically, the search returns items (if there are matches) in one or more of the following containers: InternationalExpansionArray (for items available from international sellers), FilterRemovedExpansionArray (items that would be returned if filters such as PriceRangeFilter are removed), StoreExpansionArray (for items listed in the Store Inventory Format), and AllCategoriesExpansionArray (for items available if category filters are removed). Maximum number of items returned in each expansion container is 6 to 10.
ExternalProductID ExternalProductIDType Conditional An exclusive query to only retrieve items that were listed with the specified ISBN or UPC. Only applicable for items that were listed with Pre-filled Item Information in media categories (Books, Music, DVDs and Movies, and Video Games). You must pass ProductID, Query, ExternalProductID, or CategoryID in the request. If you use ExternalProductID, do not use Query, ProductID, or CategoryID.
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.)
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.
FreeShipping boolean Optional If true, only items with free shipping for the user's location are returned. The user's location is determined from the site ID specified in the request. If false, no filtering is done via this attribute. A listing is not considered a free shipping listing if it requires insurance or requires pick up or requires a shipping surcharge.
Default: false.
GranularityLevel GranularityLevelCodeType Optional Optional tag that currently accepts only one value for this call: Coarse. Other values return an error. If you specify Coarse, the call returns the fields shown in the GranularityLevel table plus any tags resulting from the detail level you specify. Controls the fields to return for each listing (not the set of listings that match the query).

Applicable values:

•   Coarse

(in) For each record in the response, retrieves less data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified.

•   CustomCode

(in)

•   Fine

(in) For each record in the response, retrieves more data than Medium. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified.

•   Medium

(in) For each record in the response, retrieves more data than Coarse and less data than Fine. See the eBay Web Services guide for a list of the output fields that are returned when this level is specified.
Group GroupType Optional You can group Best Match search results by category by specifying BestMatchCategoryGroup in the Order field. When you specify BestMatchCategoryGroup in the Order field, you can also specify Group.MaxEntriesPerGroup and/or Group.MaxGroups. When you specify BestMatchCategoryGroup in the Order field, there will be fewer results returned because Best Matches in lower-level (leaf) categories and higher-level categories are taken into account. There is not a direct correlation between the number of items returned in a regular sort (or in a BestMatch sort) and the number of items that are returned when you specify BestMatchCategoryGroup in the Order field. When you specify BestMatchCategoryGroup in the Order field, not more than 2 pages of results are returned. See also the GroupCategoryID element in ItemType.
Group.MaxEntriesPerGroup int Optional Use a positive whole number to specify the maximum number of entries per group that you want to include in the search result.
Group.MaxGroups int Optional Use a positive whole number to specify the maximum number of groups that you want to include in the search result.
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.
Default: false.
IncludeCondition boolean Optional If true, each item in the result set can also include the item condition (e.g., New or Used) in the ItemSpecific property of the response. An item only includes the condition in the response if the seller filled in the Item Condition in the Item Specifics section of the listing. (That is, the condition is not returned if the seller only put the word "New" in the listing's title.)

Controls the details to return for each listing (not the set of listings that match the query).

To control whether to retrieve only new or used items, see ItemCondition (or SearchRequest).
IncludeFeedback boolean Optional If true, each item in the result set also includes information about the seller's feedback. Controls the details to return for each listing (not the set of listings that match the query).
For GetSearchResults, if set to true will also return the seller's User ID.
IncludeGetItFastItems boolean Optional When passed with a value of true, limits the results to Get It Fast listings.
ItemCondition ItemConditionCodeType Optional Limits the results to new or used items, plus items that have no condition specified.

Matches the new or used condition that the seller specified in the Item Specifics section of the listing. (That is, this won't specifically match on items where the seller only put the word "New" in the listing's title.)

Only applicable to sites and categories that support a sitewide (global) item condition. For example, the US site does not currently support this. See GetCategory2CS. To search for the item condition on the US site, use a product finder instead (see SearchRequest).

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   New

(in/out) The seller specified the Item Condition as New, or did not specify a condition. (Excludes items that the seller listed as Used.)

•   Used

(in/out) The seller specified the Item Condition as Used, or did not specify a condition. (Excludes items that the seller listed as New.)


See:
    Specifying an Item's Condition
    (GetSearchResults) SearchRequest
    (GetSearchResults) IncludeCondition

ItemTypeFilter ItemTypeFilterCodeType Optional Filters items based on the ListingType set for the items. If ItemTypeFilter is not specified (or if the AllItemTypes value of ItemTypeFilter is specified), all listing types can be returned unless another relevant filter is specified.
Default: AllItems.

Applicable values:

•   AllFixedPriceItemTypes

(in) Retrieves fixed-price items. Whether StoresFixedPrice items are retrieved does not depend on the site default. The StoresFixedPrice items are retrieved after the basic fixed price items. Items are retrieved whether or not ListingType is set to StoresFixedPrice. Does not retrieve items for which ListingType is AdType. Does not retrieve auction items for which BuyItNowEnabled is false.

•   AllItems

(in) It is recommended that you use AllItemTypes instead of AllItems. Return all listing types (the default for GetSearchResults). Whether StoresFixedPrice items are retrieved depends on the site default.

•   AllItemTypes

(in) Retrieve listings whether or not ListingType is set to StoresFixedPrice; include auction items.

•   AuctionItemsOnly

(in) Retrieve only listings eligible for competitive bidding at auction. That is, only retrieve listings for which ListingType is Chinese (single-item auction), regardless of the BuyItNowEnabled value. Items with any of the following listing types are not retrieved: StoresFixedPrice, FixedPriceItem, and AdType.

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.

•   ClassifiedItemsOnly

(in) Only retrieve Classified Ad format listings.

•   CustomCode

(in) Reserved for internal or future use.

•   ExcludeStoreInventory

(in) Exclude listings that have ListingType set to StoresFixedPrice.

•   FixedPricedItem

(in) Retrieves only listings that can be purchased at a fixed price. That is, only retrieves listings for which ListingType is StoresFixedPrice or FixedPriceItem. Whether StoresFixedPrice items are retrieved depends on the site default. If StoresFixedPrice items are retrieved, they are returned after the other retrieved items. Also retrieves competitive-bid auction listings for which BuyItNowEnabled is true. Does not retrieve listings for which ListingType is AdType, and does not retrieve auction listings for which BuyItNowEnabled is false.

•   FixedPriceExcludeStoreInventory

(in) Exclude listings that have ListingType set to StoresFixedPrice. Exclude listings that have ListingType set to AdType. Exclude auction listings in which BuyItNowEnabled is false.

•   StoreInventoryOnly

(in) Only retrieve listings for which ListingType is StoresFixedPrice.


See Searching By Listing Type.
LocalSearchPostalCode string Optional Include local items in returning results near this postal code. This postal code is the basis for local search.
Lot boolean Optional Limits the results to only those listings for which Item.LotSize is 2 or greater.
MaxRelatedSearchKeywords int Optional The maximum number of related keywords to be retrieved. Use this field if you want the search results to include recommended keywords (that is, keywords matching one or more of the original keywords) in a RelatedSearchKeywordArray container. A value of 0 (the default) means no related search information is processed.
Min: 0. Max: 100.
ModTimeFrom dateTime Optional Limits the results to active items whose status has changed since the specified time. Specify a time in the past. Time must be in GMT. Cannot be used with the EndTime filters.
MotorsGermanySearchable boolean Optional Limits the results based on each item's eligibility to appear on the mobile.de site. If false, excludes eligible items from search results. If true, queries for eligible items only. If not specified, the search results are not affected. Only applicable for items listed on the eBay Germany site (site ID 77) in subcategories of mobile.de search-enabled categories.
Order SearchSortOrderCodeType Optional Specifies the order in which listings are returned in a result set. Listings may be sorted by end time, start time, and in other ways listed in the SearchSortOrderCodeType. Controls the way the listings are organized in the response (not the details to return for each listing). For most sites, the default sort order is by items ending soonest. Store Inventory listings are usually returned after other listing types, regardless of the sort order.
Default: BestMatchSort.

Applicable values:

•   BestMatchCategoryGroup

(in) Groups BestMatch results. BestMatch results are based on community buying activity and other relevance-based factors. You can also set the number of groups to be returned and you can set the number of items to be returned in each group. If you specify BestMatchCategoryGroup, and you want to specify a value for Pagination.EntriesPerPage, the Pagination.EntriesPerPage value can be 50 or less.

•   BestMatchSort

(in) Sorts items by Best Match, which is based on community buying activity and other relevance-based factors.

•   CustomCode

(in) Reserved for internal or future use.

•   PricePlusShippingAsc

(in) This value is part of the Price Plus Shipping Sort feature, to be enabled by the end of Sept. 2007 for the following sites: US (site ID 0), Germany (77), Canada (2), and Australia (15). The Price Plus Shipping Sort feature causes item sorting to consider shipping costs. Specify PricePlusShippingAsc to sort items by lowest cost first, as follows: Lowest-total-cost (for items where shipping was properly specified), then freight-shipping items, then items for which shipping was not specified (sorted by price).

•   PricePlusShippingDesc

(in) This value is part of the Price Plus Shipping Sort feature, to be enabled by the end of Sept. 2007 for the following sites: US (site ID 0), Germany (77), Canada (2), and Australia (15). The Price Plus Shipping Sort feature causes item sorting to consider shipping costs. Specify PricePlusShippingDesc to sort items by highest cost first, as follows: highest-total-cost (for items where shipping was properly specified), then freight-shipping items, then items for which shipping was not specified (sorted by price).

•   SortByBidCountAsc

(in) Sorts items based on the number of bids, fewest bids first.

•   SortByBidCountDesc

(in) Sorts items based on the number of bids, most bids first.

•   SortByCountryAsc

(in) Sorts items in ascending order by the country in which the items are located.

•   SortByCountryDesc

(in) Sorts items in descending order by the country in which the items are located.

•   SortByCurrentBid

(in) Sorts items by current price (lowest bid first). Note that if an item was listed in a different currency from the site's currency, that item is sorted is based on its ConvertedCurrentPrice value.

•   SortByCurrentBidAsc

(in) Due to the new Price Plus Shipping Sort feature, SortByCurrentBidAsc is no longer functional. The Price Plus Shipping Sort feature causes item sorting to consider shipping costs. For more information, please see the PricePlusShippingAsc value. Formerly, SortByCurrentBidAsc sorted items by the current bid price in ascending order (lowest bid first). (If an item was listed in a different currency from the site currency, the item was sorted based on its ConvertedCurrentPrice value.)

•   SortByCurrentBidDesc

(in) Sorts items by the current bid price in descending order (highest bid first). Note that if an item was listed in a different currency from the site's currency, the item is sorted based on its ConvertedCurrentPrice value.

•   SortByDistanceAsc

(in) Sorts items based on distance from the buyer, with the nearest items returned first.

•   SortByEndDate

(in) Sorts items by the end date (items ending soonest). This is the default for most sites, except where noted for other values.

•   SortByEscrowAsc

(in) Sorts items in ascending order based on whether Escrow is applicable (applicable followed by inapplicable).

•   SortByEscrowDesc

(in) Sorts items in descending order based on whether Escrow is applicable (inapplicable followed by applicable).

•   SortByListingDate

(in) Sorts items by the listing date in descending order.

•   SortByPayPalAsc

(in) This input value for sorting is no longer functional. Formerly, this input value sorted items in ascending order based on whether PayPal was accepted (accepted followed by unaccepted).

•   SortByPayPalDesc

(in) This input value for sorting is no longer functional. Formerly, this input value sorted items in descending order based on whether PayPal was accepted (unaccepted followed by accepted).

•   SortByStartDate

(in) Sorts items by the start date (most recently listed first).
Pagination PaginationType Optional Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. Controls the way the listings are organized in the response (not the details to return for each listing).

See Paginating Search Results.
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: 400.
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. Default: 1.
PaymentMethod PaymentMethodSearchCodeType Optional Limits the results to items that accept a specific payment method or methods.

Applicable values:

•   CustomCode

(in/out)

•   PaisaPay

(in/out) PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203).

•   PaisaPayEscrowEMI

(in/out) PaisaPayEscrowEMI (Equal Monthly Installments) payment method. The PaisaPayEscrowEMI payment method is only for the India site (site ID 203).

•   PayPal

(in/out) PayPal payment method.

•   PayPalOrPaisaPay

(in/out) Either the PayPal or the PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203).
PriceRangeFilter PriceRangeFilterType Optional Limits the result set to just those items where the price is within the specified range. The PriceRangeFilterType includes a minimum and a maximum price.
PriceRangeFilter.MaxPrice AmountType (double) Optional Specifies the maximum current price an item listing can have to be included in the searches result set. Use alone to specify a maximum price or with MinPrice to define a range the items' prices must be. See "Data Types" in the eBay Web Services Guide for information about specifying double values.
PriceRangeFilter.MinPrice AmountType (double) Optional Specifies the minimum current price an item listing can have to be included in the searches result set. Use alone to specify a minimum price or with MaxPrice to define a range the items' prices must be. See "Data Types" in the eBay Web Services Guide for information about specifying double values.
ProductID string Conditional An exclusive query to retrieve items that were listed with the specified eBay catalog product. You must pass ProductID, Query, ExternalProductID, or CategoryID in the request. If you use ProductID, do not use Query, ExternalProductID, or CategoryID.

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.

See Searching for Listings by ProductID.
ProximitySearch ProximitySearchType Optional Limits the result set to just those items whose location is within a specified distance of a postal code. The ProximitySearchType includes a maximum distance and a postal code.
ProximitySearch.MaxDistance int Optional The maximum distance from the specified postal code to search for items.
ProximitySearch.PostalCode string Optional The postal code to use as the basis for the proximity search.
Quantity int Optional Limits the results to listings that offer a certain number of items matching the query. If Lot is also specified, then Quantity is the number of lots multiplied by the number of objects in each lot. Use QuantityOperator to specify that you are seeking listings with quantities greater than, equal to, or less than Quantity.
QuantityOperator QuantityOperatorCodeType Optional Limits the results to listings with quantities greater than, equal to, or less than Quantity. Controls the set of listings to return (not the details to return for each listing).

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   Equal

(in/out) Used by QuantityOperator to specify that you are seeking quantities equal to Quantity.

•   GreaterThan

(in/out) Used by QuantityOperator to specify that you are seeking quantities greater than Quantity.

•   GreaterThanOrEqual

(in/out) Used by QuantityOperator to specify that you are seeking quantities greater than or equal to Quantity.

•   LessThan

(in/out) Used by QuantityOperator to specify that you are seeking quantities less than Quantity.

•   LessThanOrEqual

(in/out) Used by QuantityOperator to specify that you are seeking quantities less than or equal to Quantity.
Query string Conditional A query that specifies a search string. The search string consists of one or more keywords to search for in the listing title and/or description. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words. You can use AND or OR logic by including certain modifiers. Wildcards (e.g., *) are also supported. Be careful when using spaces before or after modifiers and wildcards (+, -, or *). See the eBay Web Services Guide for a list of valid modifiers and examples. Query is not applicable in combination with ExternalProductID or ProductID.
Max length: 350 (characters).

See Searching by Keywords.
SearchFlags SearchFlagsCodeType Optional,
repeatable: [0..*]		 Secondary search criterion that checks item descriptions for keywords that match the query, limits the search results to only charity items, limits the result set to those items with PayPal as a payment method, and/or provides other criteria to refine the search.

Applicable values:

•   Charity

(in) Return only charity item listings.

•   CustomCode

(in) Reserved for internal or future use.

•   NowAndNew

Deprecated as of version 601.
(in) Return only items that have been listed with Now and New. Applicable for certain sites only. See the eBay Web Services Guide.
Deprecation version: 601. See also Deprecated Objects.

•   PayPalBuyerPaymentOption

(in) Return only item listings where PayPal is a payment method offered by the seller.

•   SearchInDescription

(in) Include the description field of item listings in keyword search. Item listings returned are those where specified search keywords appear in the description, as well as the title and sub-title.
SearchLocationFilter SearchLocationFilterType Optional Limits the result set to just those items that meet location criteria: listed in a specified eBay site, location where the seller has the item, location from which the user is searching, and/or items listed with a specified currency.
SearchLocationFilter
  .CountryCode 		CountryCodeType Optional Country the item is either located in or available to (depending on the value specified in ItemLocation).

Applicable values: See CountryCode.
SearchLocationFilter.Currency CurrencyCodeType Optional Limits the result set to just those items with a specified currency.

Applicable values: See Currency.
SearchLocationFilter
  .ItemLocation 		ItemLocationCodeType Optional Specifies whether the filter should be for items located in the country specified in Country or available to that country.

Applicable values:

•   CustomCode

(in) Reserved for internal or future use.

•   ItemAvailableIn

(in) Items available to the specified country.

•   ItemLocatedIn

(in) Items located in the specified country.
SearchLocationFilter
  .SearchLocation 		SearchLocationType Optional Specifies filtering based on the location of the item or its availability relative to an eBay site. Or, allows for filtering based on regional listing.
SearchLocationFilter
  .SearchLocation.RegionID 		string Optional Specifies a region ID. The item must have been listed for the specified region to be returned in the search result set.
SearchLocationFilter
  .SearchLocation.SiteLocation 		SiteLocationType Optional Specifies a filter based on a particular eBay site and the item's relation to that site (items listed with a site's currency, items located in the country for the site, items available to the country for the site, and items listed on the specified site).
SearchLocationFilter
  .SearchLocation.SiteLocation
  .SiteID 		SiteIDFilterCodeType Optional Specifies the criteria for filtering search results by site, where site is determined by the site ID in the SOAP URL or, for Unified Schema XML requests, X-EBAY-API-SITEID HTTP Header.

Applicable values:

•   AvailableInCountryImplied

(in) Items available to the country implied by the site specified in the request. For the US site, this implies listings from ALL English-language countries that are available to the US.

•   BelgiumListing

(in) Items located in Belgium or listed on one of the two Belgian sites.

•   CustomCode

(in) Reserved for internal or future use.

•   ListedInCurrencyImplied

(in) Items listed in the currency implied by the site specified in the request.

•   LocatedInCountryImplied

(in) Items located in the country implied by the site specified in the request.

•   SiteImplied

(in) Items listed on the site specified in the request, regardless of listing currency.
SearchRequest SearchRequestType Optional A query consisting of a set of attributes (Item Specifics). Use this kind of query to search against the Item Specifics in listings (e.g., to search for a particular shoe size). If the query includes multiple attributes, the search engine will apply "AND" logic to the query and narrow the results. Use GetProductFinder to determine the list of valid attributes and how many are permitted for the specified characteristic set. Retrieves items along with any buying guide details that are associated with the specified product finder. Applicable in combination with the Query argument. Cannot be used in combination with ProductID or ExternalProductID.

If you are searching for tickets, see TicketFinder instead.

See:
    Searching by Item Specifics (Buy-Side Product Finder)
    (GetSearchResults) TicketFinder

SearchRequest.ProductFinderID int Conditional Numeric identifier for a buy-side product finder. A product finder defines how to search for Item Specifics in listings (e.g., how to search against a particular shoe size). See the eBay Web Services guide for details about product finders. You need to specify a product finder ID when you are searching against a listing's Item Specifics (i.e., when you use SearchAttributes). A few categories, such as US Event Tickets and US eBay Motors, can also return a subset of Item Specifics (e.g., the event venue, section, and row for a ticket listing) in the search results. To retrieve this data, you must specify the product finder ID, and also specify a detail level of ItemReturnAttributes or ReturnAll.

Use GetProductFinder to determine valid product finder IDs. If you have trouble with GetProductFinder, use the pfid parameter from the URL of the Product Finder search page on the site you're interested in. See the Knowledge Base article referenced below for more details.

See Knowledge Base: ProductFinderID for Buy-Side Searches.
SearchRequest.SearchAttributes SearchAttributesType Optional,
repeatable: [0..*]		 A query consisting of a set of attributes (search criteria). If the query includes multiple attributes, the search engine will apply "AND" logic to the query. Use GetProductFinder to determine the list of valid attributes and how many are permitted for the specified characteristic set. If specified, ProductFinderID must also be specified.
SearchRequest.SearchAttributes
  .AttributeID 		int Conditional Unique identifier for the attribute within the characteristic set. Required if SearchAttributes is specified.
SearchRequest.SearchAttributes
  .DateSpecifier 		DateSpecifierCodeType Conditional Specifies the date sub-component that the attribute represents. This only applies to date attributes. Required when searching by date attributes. Allows for separate text fields or drop-down lists to be rendered for each sub-component. For example, the day, month, and year can be rendered as separate drop-down lists.

Applicable values:

•   CustomCode

(in) Reserved for internal or future use.

•   D

(in) The day subcomponent of a date.

•   M

(in) The month subcomponent of a date.

•   Y

(in) The year subcomponent of a date.
SearchRequest.SearchAttributes
  .RangeSpecifier 		RangeCodeType Conditional Indicates that the attribute represents the high or low end in a range, such as a date range or a price range. Required when searching on ranges.

Applicable values:

•   CustomCode

(in) Reserved for internal or future use.

•   High

(in) High end of the range.

•   Low

(in) Low end of the range.
SearchRequest.SearchAttributes
  .ValueList 		ValType Conditional,
repeatable: [0..*]		 Container for the list of one or more valid values that the user has selected for the searchable attribute. If multiple values are specified, the search engine applies "OR" logic to the query (i.e., at least one of the specified values must match). Required if SearchAttributes is specified.
SearchRequest.SearchAttributes
  .ValueList.ValueID 		int Conditional Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristic set.

In item-listing requests, if the ID is defined as -3 or -6 (Other) in GetAttributesCS or GetProductSellingPages, use ValueLiteral to specify the string value that the user entered. Otherwise, use ValueID to specify the ID that is pre-defined in GetAttributesCS or GetProductSellingPages. In item-listing requests and product searches, the possible ID values are:
-3 = User entered an arbitrary value (not an "Other" field)
-6 = User entered a value in an "Other" field
-100 = Value not specified (null)
#### (integer) = Identifier for a pre-defined value that the user selected (e.g., -14 or 1001)
For eBay.com, required if ValueList is specified. Not applicable to Half.com.

See Attribute Elements.
SearchRequest.SearchAttributes
  .ValueList.ValueLiteral 		string Conditional The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute.

For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID.

For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings.
Max length: see description.
SearchType SearchTypeCodeType Optional Limits the listings in the result set based on whether they are in the Gallery. The choices are items in the Gallery or Gallery and non-Gallery items.

Applicable values:

•   All

(in) Return Gallery and non-Gallery item listings.

•   CustomCode

(in) Reserved for internal or future use.

•   Gallery

(in) Return Gallery items only.
SellerBusinessType SellerBusinessCodeType Optional Limits the results to those of a particular seller business type such as commercial or private. Applies only to the following sites: UK, France, and Germany.

Applicable values:

•   Commercial

(in/out) Commercial seller account.

•   CustomCode

(in/out)

•   Private

(in/out) Private seller account.

•   Undefined

(in/out) Type of seller account not defined.
StoreSearchFilter SearchStoreFilterType Optional Limits the result set to just those items that meet criteria related to eBay Stores sellers and eBay Stores. Use this to retrieve items listed in a particular seller's eBay Store or in all store sellers' eBay Stores. This filter always causes item description text to be searched with the string specified in the Query field. That is, StoreSearchFilter forces the type of search that would have occurred if you had specified SearchInDescription in the SearchFlags field.
StoreSearchFilter.StoreName string Optional The name of the eBay Store in which the item is listed. The name of the store is case sensitive.
StoreSearchFilter.StoreSearch StoreSearchCodeType Optional Specifies the type of store search used in the filtering: one eBay Store (name specified in StoreName) or all eBay stores, and also by listing type. Possible values are enumerated in the StoreSearchCodeType code list.

Applicable values:

•   AllItemsInTheStore

(in) Within a single store for all items (specify store in SearchStoreFilterType.StoreName).

•   AuctionItemsInTheStore

(in) Within a single store for auction items (specify store in SearchStoreFilterType.StoreName).

•   BuyItNowItemsInAllStores

(in) Across all stores for basic fixed price items, Store Inventory format items, and auction items with Buy It Now.

•   BuyItNowItemsInTheStore

(in) Within a single store for basic fixed price items, Store Inventory format items, and auction items with Buy It Now. (Specify store in SearchStoreFilterType.StoreName).

•   CustomCode

(in) Reserved for internal or future use.
TicketFinder TicketDetailsType Optional Searches for event ticket listings only. If specified, this cannot be empty. For example, to search for all tickets (with no event, date, city, or quantity constraints), specify EventType with a value of Any. If specified, Query is optional. Query is useful when the user wants to search for a particular event name (like "eric clapton") or a venue that might be included in the listing title. If TicketFinder and SearchRequest are both specified in the same request, SearchRequest is ignored.

See Performing a Simple Ticket Finder Search.
TicketFinder.CityName string Optional The city in which the event venue is located. Specify the full name of the city. Use the canonical spelling, such as "Los Angeles" (not "LA"). When you search for tickets, if eBay doesn't recognize the city, eBay drops CityName and returns results that match other fields in the request. For the eBay US site, eBay only searches by CityName if you also specify StateOrProvince.

Note: If your application needs to provide users with a predefined list of city names that eBay recognizes, you can call GetProductFinder to find all the cities that the ticket finder currently supports. GetProductFinder is a more complex call.
Max length: 60.
TicketFinder.EventDate DateType Optional The date of the event. If specified, the results only include listings that specify this date in their Item Specifics.

When you search for tickets, we support these combinations:
- Year (matches any ticket in the specified year)
- Month (matches any day in the specified month, in any year)
- Year and Month (matches any day in the specified year and month)
- Month and Day (matches the specified month and day in any year)
- Year, Month, and Day (matches the specified year, month, and day)
TicketFinder.EventDate.Day int Optional A calendar day (e.g., 2 or 02). For ticket searches, Day is only valid if Month is also specified.
Min: 1. Max: 31.
TicketFinder.EventDate.Month int Conditional A calendar month (e.g., 2 or 02 for February). For ticket searches, Month is required if Day is specified.
Min: 1. Max: 12.
TicketFinder.EventDate.Year int Optional A year in the form YYYY. For ticket searches on the US site, only specify 2007 or 2008. If you specify any other year, it is ignored.
TicketFinder.EventType TicketEventTypeCodeType Conditional The type of event, such as a concert or a sporting event. The eBay US, UK, and Germany sites support different values.
Default: Any.

Applicable values: See EventType.
TicketFinder.StateOrProvince string Optional The state or province where the event venue is located. Applicable to eBay US searches only. Use the full name, such as "California" (not "CA"). If StateOrProvince isn't specified or no match is found in the product finder, eBay ignores CityName (if it is also specified).
Max length: 60.
TicketFinder.TicketQuantity int Optional The number of tickets available in the listing, as defined in the listing's Item Specifics. (This is not the same as LotSize or Quantity.)

- For the US site, specify a value from 1 to 10.
- For the UK site, specify a value from 1 to 10.
- For the DE site, specify a value from 1 to 4.

To search for any quantity (or to include other quantities in the results), do not specify TicketQuantity at all.
Min: 1. Max: 10.
TotalOnly boolean Optional Retrieves the total quantity of matching items, without returning the item data. See PaginationResult.TotalNumberOfEntries in the response. If TotalOnly and Categories.CategoriesOnly are both specified in the request and their values are inconsistent with each other, TotalOnly overrides Categories.CategoriesOnly. That is, if TotalOnly is true and Categories.CategoriesOnly is false, the results include matching categories but no item data or buying guides. If TotalOnly is false and Categories.CategoriesOnly is true, the results include matching categories, item data, and buying guides. If TotalOnly is not specified, it has no logical effect.
UserIdFilter UserIdFilterType Optional Limits the the result set to just those items listed by one or more specified sellers or those items not listed by the one or more specified sellers.
UserIdFilter.ExcludeSellers UserIDType (string) Optional Contains one or more eBay user IDs of sellers whose listings should NOT be returned in the search result set. That is, the sellers' items are excluded from the search results. A comma is used to separate multiple seller IDs. You can specify a maximum of 100 sellers.
UserIdFilter.IncludeSellers UserIDType (string) Optional Contains one or more eBay user IDs of sellers whose listings should be returned in the search result set. If you use this filter, then only listings of the specified sellers are returned. A comma is used to separate multiple seller IDs. You can specify a maximum of 100 sellers.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetSearchResults
GetSearchResults Output

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

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

The XML prototype 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"?>
<GetSearchResultsResponse 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 -->
  <AllCategoriesExpansionArray> ExpansionArrayType 
    <ExpansionItem> SearchResultItemType 
      <Item> ItemType 
        <AttributeSetArray> AttributeSetArrayType 
          <AttributeSet attributeSetID="int"> AttributeSetType 
            <Attribute attributeID="int"> AttributeType 
              <Value> ValType 
                <ValueID> int </ValueID>
                <ValueLiteral> string </ValueLiteral>
              </Value>
              <!-- ... more Value nodes here ... -->
            </Attribute>
            <!-- ... more Attribute nodes here ... -->
          </AttributeSet>
          <!-- ... more AttributeSet nodes here ... -->
        </AttributeSetArray>
        <BestOfferEnabled> boolean </BestOfferEnabled>
        <BuyerGuaranteePrice> AmountType (double) </BuyerGuaranteePrice>
        <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
        <BuyItNowPrice> AmountType (double) </BuyItNowPrice>
        <Country> CountryCodeType </Country>
        <Currency> CurrencyCodeType </Currency>
        <Distance> DistanceType 
          <DistanceMeasurement> int </DistanceMeasurement>
          <DistanceUnit> string </DistanceUnit>
        </Distance>
        <GiftIcon> int </GiftIcon>
        <GroupCategoryID> string </GroupCategoryID>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType 
          <ConvertedBuyItNowPrice> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedStartPrice> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
          <StartTime> dateTime </StartTime>
          <ViewItemURL> anyURI </ViewItemURL>
          <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
        </ListingDetails>
        <ListingDuration> token </ListingDuration>
        <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
        <!-- ... more ListingEnhancement nodes here ... -->
        <ListingType> ListingTypeCodeType </ListingType>
        <LocalListing> boolean </LocalListing>
        <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
        <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
        <!-- ... more PaymentMethods nodes here ... -->
        <PictureDetails> PictureDetailsType 
          <GalleryType> GalleryTypeCodeType </GalleryType>
          <GalleryURL> anyURI </GalleryURL>
          <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
        </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 
          <FeedbackScore> int </FeedbackScore>
          <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType 
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice> AmountType (double) </CurrentPrice>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType 
          <DefaultShippingCost> AmountType (double) </DefaultShippingCost>
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <Site> SiteCodeType </Site>
        <Storefront> StorefrontType 
          <StoreCategory2ID> long </StoreCategory2ID>
          <StoreCategoryID> long </StoreCategoryID>
          <StoreName> string </StoreName>
          <StoreURL> anyURI </StoreURL>
        </Storefront>
        <Title> string </Title>
      </Item>
      <ItemSpecific> NameValueListArrayType 
        <NameValueList> NameValueListType 
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value nodes here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes here ... -->
      </ItemSpecific>
      <SearchResultValues> SearchResultValuesCodeType </SearchResultValues>
      <!-- ... more SearchResultValues nodes here ... -->
    </ExpansionItem>
    <!-- ... more ExpansionItem nodes here ... -->
    <TotalAvailable> int </TotalAvailable>
  </AllCategoriesExpansionArray>
  <BuyingGuideDetails> BuyingGuideDetailsType 
    <BuyingGuide> BuyingGuideType 
      <CategoryID> string </CategoryID>
      <Name> string </Name>
      <ProductFinderID> int </ProductFinderID>
      <URL> anyURI </URL>
    </BuyingGuide>
    <!-- ... more BuyingGuide nodes here ... -->
    <BuyingGuideHub> anyURI </BuyingGuideHub>
  </BuyingGuideDetails>
  <CategoryArray> CategoryArrayType 
    <Category> CategoryType 
      <CategoryID> string </CategoryID>
      <CategoryLevel> int </CategoryLevel>
      <CategoryName> string </CategoryName>
      <CategoryParentID> string </CategoryParentID>
      <!-- ... more CategoryParentID nodes here ... -->
      <CategoryParentName> string </CategoryParentName>
      <!-- ... more CategoryParentName nodes here ... -->
      <NumOfItems> int </NumOfItems>
    </Category>
    <!-- ... more Category nodes here ... -->
  </CategoryArray>
  <DuplicateItems> boolean </DuplicateItems>
  <FilterRemovedExpansionArray> ExpansionArrayType 
    <ExpansionItem> SearchResultItemType 
      <Item> ItemType 
        <AttributeSetArray> AttributeSetArrayType 
          <AttributeSet attributeSetID="int"> AttributeSetType 
            <Attribute attributeID="int"> AttributeType 
              <Value> ValType 
                <ValueID> int </ValueID>
                <ValueLiteral> string </ValueLiteral>
              </Value>
              <!-- ... more Value nodes here ... -->
            </Attribute>
            <!-- ... more Attribute nodes here ... -->
          </AttributeSet>
          <!-- ... more AttributeSet nodes here ... -->
        </AttributeSetArray>
        <BestOfferEnabled> boolean </BestOfferEnabled>
        <BuyerGuaranteePrice> AmountType (double) </BuyerGuaranteePrice>
        <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
        <BuyItNowPrice> AmountType (double) </BuyItNowPrice>
        <Country> CountryCodeType </Country>
        <Currency> CurrencyCodeType </Currency>
        <Distance> DistanceType 
          <DistanceMeasurement> int </DistanceMeasurement>
          <DistanceUnit> string </DistanceUnit>
        </Distance>
        <GiftIcon> int </GiftIcon>
        <GroupCategoryID> string </GroupCategoryID>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType 
          <ConvertedBuyItNowPrice> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedStartPrice> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
          <StartTime> dateTime </StartTime>
          <ViewItemURL> anyURI </ViewItemURL>
          <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
        </ListingDetails>
        <ListingDuration> token </ListingDuration>
        <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
        <!-- ... more ListingEnhancement nodes here ... -->
        <ListingType> ListingTypeCodeType </ListingType>
        <LocalListing> boolean </LocalListing>
        <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
        <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
        <!-- ... more PaymentMethods nodes here ... -->
        <PictureDetails> PictureDetailsType 
          <GalleryType> GalleryTypeCodeType </GalleryType>
          <GalleryURL> anyURI </GalleryURL>
          <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
        </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 
          <FeedbackScore> int </FeedbackScore>
          <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType 
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice> AmountType (double) </CurrentPrice>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType 
          <DefaultShippingCost> AmountType (double) </DefaultShippingCost>
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <Site> SiteCodeType </Site>
        <Storefront> StorefrontType 
          <StoreCategory2ID> long </StoreCategory2ID>
          <StoreCategoryID> long </StoreCategoryID>
          <StoreName> string </StoreName>
          <StoreURL> anyURI </StoreURL>
        </Storefront>
        <Title> string </Title>
      </Item>
      <ItemSpecific> NameValueListArrayType 
        <NameValueList> NameValueListType 
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value nodes here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes here ... -->
      </ItemSpecific>
      <SearchResultValues> SearchResultValuesCodeType </SearchResultValues>
      <!-- ... more SearchResultValues nodes here ... -->
    </ExpansionItem>
    <!-- ... more ExpansionItem nodes here ... -->
    <TotalAvailable> int </TotalAvailable>
  </FilterRemovedExpansionArray>
  <HasMoreItems> boolean </HasMoreItems>
  <InternationalExpansionArray> ExpansionArrayType 
    <ExpansionItem> SearchResultItemType 
      <Item> ItemType 
        <AttributeSetArray> AttributeSetArrayType 
          <AttributeSet attributeSetID="int"> AttributeSetType 
            <Attribute attributeID="int"> AttributeType 
              <Value> ValType 
                <ValueID> int </ValueID>
                <ValueLiteral> string </ValueLiteral>
              </Value>
              <!-- ... more Value nodes here ... -->
            </Attribute>
            <!-- ... more Attribute nodes here ... -->
          </AttributeSet>
          <!-- ... more AttributeSet nodes here ... -->
        </AttributeSetArray>
        <BestOfferEnabled> boolean </BestOfferEnabled>
        <BuyerGuaranteePrice> AmountType (double) </BuyerGuaranteePrice>
        <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
        <BuyItNowPrice> AmountType (double) </BuyItNowPrice>
        <Country> CountryCodeType </Country>
        <Currency> CurrencyCodeType </Currency>
        <Distance> DistanceType 
          <DistanceMeasurement> int </DistanceMeasurement>
          <DistanceUnit> string </DistanceUnit>
        </Distance>
        <GiftIcon> int </GiftIcon>
        <GroupCategoryID> string </GroupCategoryID>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType 
          <ConvertedBuyItNowPrice> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedStartPrice> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
          <StartTime> dateTime </StartTime>
          <ViewItemURL> anyURI </ViewItemURL>
          <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
        </ListingDetails>
        <ListingDuration> token </ListingDuration>
        <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
        <!-- ... more ListingEnhancement nodes here ... -->
        <ListingType> ListingTypeCodeType </ListingType>
        <LocalListing> boolean </LocalListing>
        <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
        <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
        <!-- ... more PaymentMethods nodes here ... -->
        <PictureDetails> PictureDetailsType 
          <GalleryType> GalleryTypeCodeType </GalleryType>
          <GalleryURL> anyURI </GalleryURL>
          <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
        </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 
          <FeedbackScore> int </FeedbackScore>
          <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType 
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice> AmountType (double) </CurrentPrice>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType 
          <DefaultShippingCost> AmountType (double) </DefaultShippingCost>
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <Site> SiteCodeType </Site>
        <Storefront> StorefrontType 
          <StoreCategory2ID> long </StoreCategory2ID>
          <StoreCategoryID> long </StoreCategoryID>
          <StoreName> string </StoreName>
          <StoreURL> anyURI </StoreURL>
        </Storefront>
        <Title> string </Title>
      </Item>
      <ItemSpecific> NameValueListArrayType 
        <NameValueList> NameValueListType 
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value nodes here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes here ... -->
      </ItemSpecific>
      <SearchResultValues> SearchResultValuesCodeType </SearchResultValues>
      <!-- ... more SearchResultValues nodes here ... -->
    </ExpansionItem>
    <!-- ... more ExpansionItem nodes here ... -->
    <TotalAvailable> int </TotalAvailable>
  </InternationalExpansionArray>
  <ItemsPerPage> int </ItemsPerPage>
  <PageNumber> int </PageNumber>
  <PaginationResult> PaginationResultType 
    <TotalNumberOfEntries> int </TotalNumberOfEntries>
    <TotalNumberOfPages> int </TotalNumberOfPages>
  </PaginationResult>
  <RelatedSearchKeywordArray> RelatedSearchKeywordArrayType 
    <Keyword> string </Keyword>
    <!-- ... more Keyword nodes here ... -->
  </RelatedSearchKeywordArray>
  <SearchResultItemArray> SearchResultItemArrayType 
    <SearchResultItem> SearchResultItemType 
      <Item> ItemType 
        <AttributeSetArray> AttributeSetArrayType 
          <AttributeSet attributeSetID="int"> AttributeSetType 
            <Attribute attributeID="int"> AttributeType 
              <Value> ValType 
                <ValueID> int </ValueID>
                <ValueLiteral> string </ValueLiteral>
              </Value>
              <!-- ... more Value nodes here ... -->
            </Attribute>
            <!-- ... more Attribute nodes here ... -->
          </AttributeSet>
          <!-- ... more AttributeSet nodes here ... -->
        </AttributeSetArray>
        <BestOfferEnabled> boolean </BestOfferEnabled>
        <BuyerGuaranteePrice> AmountType (double) </BuyerGuaranteePrice>
        <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
        <BuyItNowPrice> AmountType (double) </BuyItNowPrice>
        <Country> CountryCodeType </Country>
        <Currency> CurrencyCodeType </Currency>
        <Distance> DistanceType 
          <DistanceMeasurement> int </DistanceMeasurement>
          <DistanceUnit> string </DistanceUnit>
        </Distance>
        <GiftIcon> int </GiftIcon>
        <GroupCategoryID> string </GroupCategoryID>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType 
          <ConvertedBuyItNowPrice> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedStartPrice> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
          <StartTime> dateTime </StartTime>
          <ViewItemURL> anyURI </ViewItemURL>
          <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
        </ListingDetails>
        <ListingDuration> token </ListingDuration>
        <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
        <!-- ... more ListingEnhancement nodes here ... -->
        <ListingType> ListingTypeCodeType </ListingType>
        <LocalListing> boolean </LocalListing>
        <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
        <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
        <!-- ... more PaymentMethods nodes here ... -->
        <PictureDetails> PictureDetailsType 
          <GalleryType> GalleryTypeCodeType </GalleryType>
          <GalleryURL> anyURI </GalleryURL>
          <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
        </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 
          <FeedbackScore> int </FeedbackScore>
          <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType 
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice> AmountType (double) </CurrentPrice>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType 
          <DefaultShippingCost> AmountType (double) </DefaultShippingCost>
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <Site> SiteCodeType </Site>
        <Storefront> StorefrontType 
          <StoreCategory2ID> long </StoreCategory2ID>
          <StoreCategoryID> long </StoreCategoryID>
          <StoreName> string </StoreName>
          <StoreURL> anyURI </StoreURL>
        </Storefront>
        <Title> string </Title>
      </Item>
      <ItemSpecific> NameValueListArrayType 
        <NameValueList> NameValueListType 
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value nodes here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes here ... -->
      </ItemSpecific>
      <SearchResultValues> SearchResultValuesCodeType </SearchResultValues>
      <!-- ... more SearchResultValues nodes here ... -->
    </SearchResultItem>
    <!-- ... more SearchResultItem nodes here ... -->
  </SearchResultItemArray>
  <SpellingSuggestion> SpellingSuggestionType 
    <MatchingItemCount> int </MatchingItemCount>
    <Text> string </Text>
    <!-- ... more Text nodes here ... -->
  </SpellingSuggestion>
  <StoreExpansionArray> ExpansionArrayType 
    <ExpansionItem> SearchResultItemType 
      <Item> ItemType 
        <AttributeSetArray> AttributeSetArrayType 
          <AttributeSet attributeSetID="int"> AttributeSetType 
            <Attribute attributeID="int"> AttributeType 
              <Value> ValType 
                <ValueID> int </ValueID>
                <ValueLiteral> string </ValueLiteral>
              </Value>
              <!-- ... more Value nodes here ... -->
            </Attribute>
            <!-- ... more Attribute nodes here ... -->
          </AttributeSet>
          <!-- ... more AttributeSet nodes here ... -->
        </AttributeSetArray>
        <BestOfferEnabled> boolean </BestOfferEnabled>
        <BuyerGuaranteePrice> AmountType (double) </BuyerGuaranteePrice>
        <BuyerProtection> BuyerProtectionCodeType </BuyerProtection>
        <BuyItNowPrice> AmountType (double) </BuyItNowPrice>
        <Country> CountryCodeType </Country>
        <Currency> CurrencyCodeType </Currency>
        <Distance> DistanceType 
          <DistanceMeasurement> int </DistanceMeasurement>
          <DistanceUnit> string </DistanceUnit>
        </Distance>
        <GiftIcon> int </GiftIcon>
        <GroupCategoryID> string </GroupCategoryID>
        <ItemID> ItemIDType (string) </ItemID>
        <ListingDetails> ListingDetailsType 
          <ConvertedBuyItNowPrice> AmountType (double) </ConvertedBuyItNowPrice>
          <ConvertedStartPrice> AmountType (double) </ConvertedStartPrice>
          <EndTime> dateTime </EndTime>
          <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
          <StartTime> dateTime </StartTime>
          <ViewItemURL> anyURI </ViewItemURL>
          <ViewItemURLForNaturalSearch> anyURI </ViewItemURLForNaturalSearch>
        </ListingDetails>
        <ListingDuration> token </ListingDuration>
        <ListingEnhancement> ListingEnhancementsCodeType </ListingEnhancement>
        <!-- ... more ListingEnhancement nodes here ... -->
        <ListingType> ListingTypeCodeType </ListingType>
        <LocalListing> boolean </LocalListing>
        <MotorsGermanySearchable> boolean </MotorsGermanySearchable>
        <PaymentMethods> BuyerPaymentMethodCodeType </PaymentMethods>
        <!-- ... more PaymentMethods nodes here ... -->
        <PictureDetails> PictureDetailsType 
          <GalleryType> GalleryTypeCodeType </GalleryType>
          <GalleryURL> anyURI </GalleryURL>
          <PhotoDisplay> PhotoDisplayCodeType </PhotoDisplay>
        </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 
          <FeedbackScore> int </FeedbackScore>
          <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
          <UserID> UserIDType (string) </UserID>
        </Seller>
        <SellingStatus> SellingStatusType 
          <BidCount> int </BidCount>
          <ConvertedCurrentPrice> AmountType (double) </ConvertedCurrentPrice>
          <CurrentPrice> AmountType (double) </CurrentPrice>
        </SellingStatus>
        <ShippingDetails> ShippingDetailsType 
          <DefaultShippingCost> AmountType (double) </DefaultShippingCost>
          <ShippingType> ShippingTypeCodeType </ShippingType>
        </ShippingDetails>
        <Site> SiteCodeType </Site>
        <Storefront> StorefrontType 
          <StoreCategory2ID> long </StoreCategory2ID>
          <StoreCategoryID> long </StoreCategoryID>
          <StoreName> string </StoreName>
          <StoreURL> anyURI </StoreURL>
        </Storefront>
        <Title> string </Title>
      </Item>
      <ItemSpecific> NameValueListArrayType 
        <NameValueList> NameValueListType 
          <Name> string </Name>
          <Value> string </Value>
          <!-- ... more Value nodes here ... -->
        </NameValueList>
        <!-- ... more NameValueList nodes here ... -->
      </ItemSpecific>
      <SearchResultValues> SearchResultValuesCodeType </SearchResultValues>
      <!-- ... more SearchResultValues nodes here ... -->
    </ExpansionItem>
    <!-- ... more ExpansionItem nodes here ... -->
    <TotalAvailable> int </TotalAvailable>
  </StoreExpansionArray>
</GetSearchResultsResponse>
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
AllCategoriesExpansionArray ExpansionArrayType Conditionally Can be returned if the request specifies that ExpandSearch is true. Provides additional search results when a small result set would have been returned with the original search. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, and ExpandSearch is true, the search results are expanded to include (if matching the query) the AllCategoriesExpansionArray container for items, as well as other containers. The AllCategoriesExpansionArray container contains items available if category filters are removed.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem 		SearchResultItemType Conditionally,
repeatable: [0..*]		 Item that is the result of an expanded search. If, in a GetSearchResults request, you specify true for ExpandSearch, the search is expanded when a small result set is returned. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, then the search results are expanded. Specifically, the search returns items (if there are matches) in one or more of the following containers: InternationalExpansionArray (for items available from international sellers), FilterRemovedExpansionArray (items that would be returned if filters such as PriceRangeFilter are removed), StoreExpansionArray (for items listed in the Store Inventory Format), and AllCategoriesExpansionArray (for items available if category filters are removed). The maximum number of items returned in each container is 6 to 10.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item 		ItemType Conditionally Contains summary data for the item listing itself, with the properties that define the listing. For all item data, use an item-retrieval call, such as GetItem. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray 		AttributeSetArrayType Conditionally AttributeSetArray is one format that is used to to specify Item Specifics on the eBay Web site. (Also see Item.ItemSpecifics.) Item Specifics describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard property of a book.

Contains one or more instances of AttributeSet in a list. For attributes in general, an item can be associated with no more than two full attribute sets (one for the primary category and one for the secondary category). For some international sites, an item can specify an additional site-wide attribute set for the item condition.

Older applications can still use AttributeSetArray to specify a return policy (which is defined in a site-wide attribute set for most sites). However, as eBay may deprecate return policy attributes in the future, we strongly recommend that you use the new Item.ReturnPolicy node instead to specify the seller's return policy.

Note: AttributeSetArray does not support the newer "custom Item Specifics" model. See the ItemSpecifics node instead.

For the AddItem family of calls: Some categories (such as Event Tickets and US Real Estate) require Item Specifics. See the eBay Web Services Guide links below for information on working with Item Specifics. Use GetCategory2CS and GetAttributesCS to determine when attributes are required for a category. Also use attributes to specify the item condition.

For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add attributes. If the listing has bids but ends in more than 12 hours, you cannot change existing attribute data, but you can add attributes that were not previously specified. The most reliable way to do this is to pass in the entire AttributeSetArray with all the attributes you want in the listing (not just the ones you want to change, because that usually causes the others to be removed). To delete all attributes when you revise or relist, specify Item.AttributeSetArray in DeletedField and don't pass AttributeSetArray in the request. If the original listing's attributes are no longer valid and you get errors when you try to revise the listing, you can try to pass in the entire AttributeSetArray again with corrections. If that doesn't work, you can end the item and relist it with a set of valid attributes.

For GetCategoryListings only: For GetCategoryListings, AttributeSetArray can return the item condition (not other Item Specifics), if specified.

For GetSearchResults only: GetSearchResults can return the item condition when the request either specifies IncludeCondition as true; or specifies a product finder search (and a detail level of ItemReturnAttributes or ReturnAll). If IncludeCondition was true, see the ItemSpecific node for a simpler view of the condition value.
Note: AttributeSetArray only returns the condition attribute's ValueID. You would need to use GetAttributesCS to figure out the meaning of this ID. It's easier to just look at the ItemSpecific node.
If SearchRequest or TicketFinder was used to perform a product finder search, the list of attributes is limited to Item Specifics that would be included in the summary search results on the Web site, if any. At this time, GetSearchResults only returns event ticket venue name, section, and row (if specified) for eBay US (site 0); and the mileage and year for eBay Motors vehicles (site 100 and international eBay Motors sites that support this feature). In other categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.)

For GetItemRecommendations only: In GetItemRecommendations, if you use the Suggested Attributes engine, the engine interprets attributes you pass in as attributes that do NOT need recommendations (i.e., attributes that the seller has already filled in as desired). The engine only returns recommendations for attributes that you do not specify, and only for attributes associated with the primary category.

For Half.com, this is only returned in GetItem. It is not applicable in AddItem and other requests.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Working with Attribute-Based Features
    Specifying an Item's Condition
    Offering a Clear Return Policy
    (AddItem) Item.ReturnPolicy
    Revising Items that Include Item Specifics (Attributes)
    Relisting Items that Include Item Specifics (Attributes)

AllCategoriesExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet 		AttributeSetType Conditionally,
repeatable: [0..*]		 Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way.

For the AddItem family of calls and GetItem, an AttributeSetArray can contain a maximum of 2 full attribute sets (one for each category in which the item is listed) if the primary and secondary categories are mapped to different characteristic sets. If they are mapped to the same characteristic set, the AttributeSetArray can contain one full attribute set.

An AttributeSetArray can also contain any number of additional site-wide attribute sets. In item-listing requests, AttributeSet is required if the category is mapped to a characteristic set with required attributes. On the US site, attributes are usually required for Tickets, eBay Motors vehicles, and Real Estate listings. See GetCategory2CS and GetAttributesCS. See the Developer's Guide for information about attribute meta-data and validation rules that are applicable when listing items.

In GetItem, the Half.com item condition may be returned once in an AttributeSet node with Half.com IDs and values, and once in a separate AttributeSet node with a site-wide eBay item condition. The Half.com IDs are not necessarily returned in GetAttributesCS, so you can use the eBay.com data instead. Half.com listings may also return an AttributeSet node with other eBay attributes.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet
  [ attribute attributeSetID ]		 int Conditionally Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristics set ID. Call GetCategory2CS to determine valid characteristics set IDs. For GetCategoryListings, you can ignore this value. Not applicable to Half.com.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute 		AttributeType Conditionally,
repeatable: [0..*]		 A salient aspect or feature of an item in a given category. Attributes are known as "Item Specifics" in the eBay Web site. Use attributes to describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard attribute for books. In item-listing requests, multiple attributes can be specified. Some categories (e.g., Tickets) always require certain attributes to be specified. Therefore, in item-listing requests you need to at least specify "editable" attributes (EditType 0 and EditType 2 attributes) if they are identified as required in the attribute meta-data. See the eBay Web Services guide for information about attrribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required.

If you are revising or relisting an item, you don't need to pass in attributes that were already specified in the original listing. To remove an optional attribute, set all its value IDs to "-100". If the item has bids (or items have been sold) but there are more than 12 hours remaining until the listing ends, you can add Attribute nodes but you cannot remove or modify data in previously specified Attribute nodes. If the item has bids and the listing ends within 12 hours, you cannot add or remove Attribute nodes or modify the contents of previously specified Attribute nodes.

For GetCategoryListings, this returns the item condition only (and it is only returned if IncludeCondition = true in the request). Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute
  [ attribute attributeID ]		 int Conditionally Constant value that identifies the attribute in a language-independent way. Unique within the attribute set. See the Developer's Guide topics on Item Specifics and Pre-filled Item Information for information about determining valid attribute IDs. Not applicable to Half.com.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value 		ValType Conditionally,
repeatable: [0..*]		 A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values.

For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueID 		int Conditionally Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristic set.

In item-listing requests, if the ID is defined as -3 or -6 (Other) in GetAttributesCS or GetProductSellingPages, use ValueLiteral to specify the string value that the user entered. Otherwise, use ValueID to specify the ID that is pre-defined in GetAttributesCS or GetProductSellingPages. In item-listing requests and product searches, the possible ID values are:
-3 = User entered an arbitrary value (not an "Other" field)
-6 = User entered a value in an "Other" field
-100 = Value not specified (null)
#### (integer) = Identifier for a pre-defined value that the user selected (e.g., -14 or 1001)
For eBay.com, required if ValueList is specified. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Attribute Elements.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueLiteral 		string Conditionally The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute.

For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID.

For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings.
Max length: see description.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .BestOfferEnabled 		boolean Conditionally Indicates, when true, that an item is available by Best Offer.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .BuyerGuaranteePrice 		AmountType (double) Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .BuyerProtection 		BuyerProtectionCodeType Conditionally Indicates the status of the item's eligibility for the PayPal Buyer Protection program.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) Item is eligible per standard criteria.

•   ItemIneligible

(out) Item is ineligible (e.g., category not applicable).

•   ItemMarkedEligible

(out) Item marked eligible per other criteria.

•   ItemMarkedIneligible

(out) Item marked ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) For the Australia site, indicates that there is no PayPal Buyer Protection coverage. Coverage details would be in the following sections of the View Item page: the Buy Safely section and the Payment Details section.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See Miscellaneous Item Field Differences.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Longer Lasting Buy It Now
    Revising US eBay Motors Listings

AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Field Differences for eBay Sites.
AllCategoriesExpansionArray
  .ExpansionItem.Item.Distance 		DistanceType Conditionally The distance used in a proximity search distance calculation.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item.Distance
  .DistanceMeasurement 		int Conditionally The measurement used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item.Distance
  .DistanceUnit 		string Conditionally The unit used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .GroupCategoryID 		string Conditionally GroupCategoryID is returned if there is a value of BestMatchCategoryGroup in the Order field for the GetSearchResults call. However, the results depend on the items and groups requested.

The Best Match algorithm will try to evenly fit the items and return groups of 'Best Matching' Categories. A 'category group' can be a parent category that contains the best-matching items from several of its subcategories. Within each category group, items will be also sorted by best match. The only condition when you may not get a GroupCategoryID returned at all is when the request is for one group and there is more than one category that has matching items. Very rarely, the same item will appear once in the group for its primary category and once in another group for its secondary category, in the same result set. Also very occasionally, a Store Inventory Item can appear in the results before a regular listing.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, None, ReturnAll.
AllCategoriesExpansionArray
  .ExpansionItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .ConvertedBuyItNowPrice 		AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .SellerBusinessType 		SellerBusinessCodeType Conditionally Type of seller account. This value is not returned for most sites. This value is not returned for the German site (site ID 77) or eBay Motors site (site ID 100).

Applicable values:

•   Commercial

(in/out) Commercial seller account.

•   CustomCode

(in/out)

•   Private

(in/out) Private seller account.

•   Undefined

(in/out) Type of seller account not defined.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    GetCategoryFeatures
    Fees per Site



Applicable values: See ListingDurationCodeType
AllCategoriesExpansionArray
  .ExpansionItem.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).




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.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.

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


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Different Ways of Selling
    Listing Types (Formats)
    GetCategoryFeatures
    Fees per Site

AllCategoriesExpansionArray
  .ExpansionItem.Item
  .LocalListing 		boolean Conditionally Indicates, when true, that an item is available locally.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .MotorsGermanySearchable 		boolean Conditionally Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany.

If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. See the eBay Web Services Guide for applicable categories, revise and relist rules, and additional information on featuring vehicles on the Mobile.de Site.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.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: See PaymentMethods.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Payment Method Differences (PaymentMethod)
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema for rules regarding repeating nodes

AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Introduction to Pictures in Item Listings.
AllCategoriesExpansionArray
  .ExpansionItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

AllCategoriesExpansionArray
  .ExpansionItem.Item
  .PictureDetails.PhotoDisplay 		PhotoDisplayCodeType Conditionally Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   None

(in/out) No special image display options. Valid for US Motors listings.

•   PicturePack

(in/out) Increase the number of images displayed. Only available for images hosted with eBay. See GetCategoryFeatures and the online Help (on the eBay site) for additional information. Picture Pack applies to all sites (including US Motors), except for NL (site ID 146). You can specify a minimum of one EPS picture, or no SuperSize-qualified EPS pictures in the request. For the NL site, PicturePack is replaced with SuperSize.

•   SiteHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, site-hosted pictures in a slideshow format.

•   SuperSize

(in/out) Increase the size of each image and allow buyers to enlarge images further. Only available for site-hosted (EPS) images. Not valid for US Motors listings. For all sites that do not automatically upgrade SuperSize to PicturePack (see note below), specifying no SuperSize-qualified images is now accepted in the request.

Note: SuperSize is automatically upgraded to PicturePack for the same SuperSize fee on the US Motors Parts & Accessories Category and US (site ID 0) and CA (site ID 2) and CAFR (site ID 210). This upgrade applies only to EPS images (including Picture Manager images).

•   SuperSizePictureShow

(in/out) This value is no longer applicable. Use SuperSize instead. Formerly, the value displays multiple, super-size, site-hosted pictures in a slideshow format. Valid for US Motors listings.

•   VendorHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, vendor-hosted pictures in a slideshow format. Not valid for US Motors listings.


(Not all values in PhotoDisplayCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.

See:
    Categories
    Specifying eBay Live Auctions Categories
    Listing US and CA eBay Motors Items
    (RelistItem) GalleryType
    KB Article: Listing with ExternalProductID and CategoryID

AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.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.)

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .SearchDetails.Picture 		boolean Conditionally Indicates whether a listing has an image associated with it.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .SearchDetails.RecentListing 		boolean Conditionally Indicates whether a listing is no more than one day old.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.

See Categories.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Working with Anonymous User Information.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item.Seller
  .UserID 		UserIDType (string) Conditionally Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID stays the same for every auction.

For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized.

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .SellingStatus.BidCount 		int Conditionally Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
AllCategoriesExpansionArray
  .ExpansionItem.Item
  .SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item.Site 		SiteCodeType Always The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API).

Not applicable to Half.com.

Applicable values: See Site.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    The US and International eBay Sites
    Specifying the Target Site
    Field Differences for eBay Sites

AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item.Storefront
  .StoreCategory2ID 		long Conditionally Applicable for eBay Store sellers only. Numeric ID for a second custom category that the seller created in their eBay Store. eBay Stores sellers can create up to 300 custom categories for their stores. (One additional Store category cannot be customized and retains the value of "Other").
If you specify an invalid value, the values are the same for both the primary and secondary store categories, or if the seondary store category is specified but the primary is left blank (or other), the system resets the value to 0 (None). In short, the primary store category must be set to something meaningful and different from the second store category in order to set the secondary store category to a value other than 0. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.Item.Storefront
  .StoreCategoryID 		long Conditionally Numeric ID for a custom category that the seller created in their eBay Store, if any. eBay Stores sellers can create up to three levels of custom categories for their stores. Items can only be listed in store categories that have no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the Other store category. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.ItemSpecific 		NameValueListArrayType Conditionally A list of attribute and value pairs. GetSearchResults can return this when the request either specifies IncludeCondition as true or searches for the Item Condition by using SearchRequest. If IncludeCondition was true, this returns the item condition (e.g., New). If SearchRequest was used to search for the item condition or for a US eBay Motors vehicle, the list returns the item condition or the vehicle mileage and year. That is, the results only include attributes that would be included in the summary search results on the Web site, if any. In most categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.) Not returned when TicketFinder is used.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .ExpansionItem
  .SearchResultValues 		SearchResultValuesCodeType Conditionally,
repeatable: [0..*]		 Contains additional information about the item listing returned in Item. This information includes whether the item has an image associated with it, and more. May contain zero, one, or multiple SearchResultValuesCodeType values indicating different pieces of additional information about the listing. These values are analogous to the icons that appear in an item listing's line in a Search page. Output only.

Applicable values:

•   CharityListing

(out) Indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item purchase price to a selected nonprofit organization. Not applicable for eBay Motors, international sites, and Real Estate and Tickets listings.

•   CustomCode

(out)

•   Escrow

(out)

•   Gift

(out)

•   New

(out) Indicates items listed one day or less earlier than the current query. If the listing is no more than one day old, New returns a value of true.

•   Picture

(out)




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
AllCategoriesExpansionArray
  .TotalAvailable 		int Conditionally The number of matching items available under the expansion.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingGuideDetails BuyingGuideDetailsType Conditionally Contains URLs and other information about relevant buying guides (if any), as well as the site's buying guide hub. Unavailable in the Sandbox environment. 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. Only returned for product finder searches (using SearchRequest.SearchAttributes) and for searches that retrieve matching categories along with item data (using Categories.CategoriesOnly=false).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
BuyingGuideDetails.BuyingGuide BuyingGuideType Conditionally,
repeatable: [0..*]		 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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
BuyingGuideDetails.BuyingGuide
  .ProductFinderID 		int Conditionally Identifies the product finder (if any) that is associated with the buying guide. Only returned for product finder searches.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
CategoryArray CategoryArrayType Conditionally Shows the distribution of items across each category. Consists of statistical information about categories that contain items that match the query, if any. Returns empty if no matches are found or when the Categories filter was not passed in the request. (For categories associated with specific items, see items returned in each search result.) You must use fields within the Categories input container if you want the CategoryArray response container to be returned.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
CategoryArray.Category CategoryType Conditionally,
repeatable: [0..*]		 Contains details about one category. For GetCategories, this node is not returned when no detail level is specified.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
CategoryArray.Category
  .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.

DetailLevel: ItemReturnCategories.
CategoryArray.Category
  .CategoryLevel 		int Conditionally The level where the category fits in the site's category hierarchy. For example, if this field has a value of 2, then the category is two levels below the root category in the site's category hierarchy. For the GetSearchResults response, NumOfItems indicates the total quantity of matching items in a category. Matching categories at the same level (i.e., in sibling categories) are sorted by NumOfItems, descending order.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
CategoryArray.Category
  .CategoryName 		string Conditionally Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).

In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings.
Max length: 30.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
CategoryArray.Category
  .CategoryParentID 		string Conditionally,
repeatable: [0..*]		 Category ID identifying a category that is an ancestor of the category indicated in CategoryID. For GetCategories, returns the same value as CategoryID if the CategoryLevel is 1. For GetSuggestedCategories, multiple CategoryParentID fields can be returned in sequence, starting with the root category and ending with the category that is the direct parent of the category specified in CategoryID. Use these parent fields and the CategoryID field to build the fully qualified category browse path or "breadcrumbs" (e.g., 58058:3516:3517). For GetPopularKeywords, -1 represents the root category.
Max length: 10.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
CategoryArray.Category
  .CategoryParentName 		string Conditionally,
repeatable: [0..*]		 Display name of the category indicated in CategoryParentID. For GetSuggestedCategories, multiple CategoryParentName fields can be returned in sequence, starting with the root category and ending with the category that is the direct parent of the category specified in CategoryName. Use these parent fields and the CategoryName field to build the fully qualified category browse path or "breadcrumbs" (e.g., Computers & Networking > Technology Books > Certification).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
CategoryArray.Category
  .NumOfItems 		int Conditionally The total quantity of matching items in the category. In the GetSearchResults response, matching categories at the same level (i.e., sibling categories) are sorted by this value. That is, if the request specifies that fewer categories or subcategories should be returned, the ones with the most matching items are returned first. See the Developer's guide for more information.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
DuplicateItems boolean Conditionally Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray ExpansionArrayType Conditionally Can be returned if the request specifies that ExpandSearch is true. Provides additional search results when a small result set would have been returned with the original search. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, and ExpandSearch is true, the search results are expanded to include (if matching the query) the FilterRemovedExpansionArray container for items, as well as other containers. The FilterRemovedExpansionArray container contains items that would be returned if filters such as PriceRangeFilter are removed.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem 		SearchResultItemType Conditionally,
repeatable: [0..*]		 Item that is the result of an expanded search. If, in a GetSearchResults request, you specify true for ExpandSearch, the search is expanded when a small result set is returned. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, then the search results are expanded. Specifically, the search returns items (if there are matches) in one or more of the following containers: InternationalExpansionArray (for items available from international sellers), FilterRemovedExpansionArray (items that would be returned if filters such as PriceRangeFilter are removed), StoreExpansionArray (for items listed in the Store Inventory Format), and AllCategoriesExpansionArray (for items available if category filters are removed). The maximum number of items returned in each container is 6 to 10.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item 		ItemType Conditionally Contains summary data for the item listing itself, with the properties that define the listing. For all item data, use an item-retrieval call, such as GetItem. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray 		AttributeSetArrayType Conditionally AttributeSetArray is one format that is used to to specify Item Specifics on the eBay Web site. (Also see Item.ItemSpecifics.) Item Specifics describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard property of a book.

Contains one or more instances of AttributeSet in a list. For attributes in general, an item can be associated with no more than two full attribute sets (one for the primary category and one for the secondary category). For some international sites, an item can specify an additional site-wide attribute set for the item condition.

Older applications can still use AttributeSetArray to specify a return policy (which is defined in a site-wide attribute set for most sites). However, as eBay may deprecate return policy attributes in the future, we strongly recommend that you use the new Item.ReturnPolicy node instead to specify the seller's return policy.

Note: AttributeSetArray does not support the newer "custom Item Specifics" model. See the ItemSpecifics node instead.

For the AddItem family of calls: Some categories (such as Event Tickets and US Real Estate) require Item Specifics. See the eBay Web Services Guide links below for information on working with Item Specifics. Use GetCategory2CS and GetAttributesCS to determine when attributes are required for a category. Also use attributes to specify the item condition.

For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add attributes. If the listing has bids but ends in more than 12 hours, you cannot change existing attribute data, but you can add attributes that were not previously specified. The most reliable way to do this is to pass in the entire AttributeSetArray with all the attributes you want in the listing (not just the ones you want to change, because that usually causes the others to be removed). To delete all attributes when you revise or relist, specify Item.AttributeSetArray in DeletedField and don't pass AttributeSetArray in the request. If the original listing's attributes are no longer valid and you get errors when you try to revise the listing, you can try to pass in the entire AttributeSetArray again with corrections. If that doesn't work, you can end the item and relist it with a set of valid attributes.

For GetCategoryListings only: For GetCategoryListings, AttributeSetArray can return the item condition (not other Item Specifics), if specified.

For GetSearchResults only: GetSearchResults can return the item condition when the request either specifies IncludeCondition as true; or specifies a product finder search (and a detail level of ItemReturnAttributes or ReturnAll). If IncludeCondition was true, see the ItemSpecific node for a simpler view of the condition value.
Note: AttributeSetArray only returns the condition attribute's ValueID. You would need to use GetAttributesCS to figure out the meaning of this ID. It's easier to just look at the ItemSpecific node.
If SearchRequest or TicketFinder was used to perform a product finder search, the list of attributes is limited to Item Specifics that would be included in the summary search results on the Web site, if any. At this time, GetSearchResults only returns event ticket venue name, section, and row (if specified) for eBay US (site 0); and the mileage and year for eBay Motors vehicles (site 100 and international eBay Motors sites that support this feature). In other categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.)

For GetItemRecommendations only: In GetItemRecommendations, if you use the Suggested Attributes engine, the engine interprets attributes you pass in as attributes that do NOT need recommendations (i.e., attributes that the seller has already filled in as desired). The engine only returns recommendations for attributes that you do not specify, and only for attributes associated with the primary category.

For Half.com, this is only returned in GetItem. It is not applicable in AddItem and other requests.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Working with Attribute-Based Features
    Specifying an Item's Condition
    Offering a Clear Return Policy
    (AddItem) Item.ReturnPolicy
    Revising Items that Include Item Specifics (Attributes)
    Relisting Items that Include Item Specifics (Attributes)

FilterRemovedExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet 		AttributeSetType Conditionally,
repeatable: [0..*]		 Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way.

For the AddItem family of calls and GetItem, an AttributeSetArray can contain a maximum of 2 full attribute sets (one for each category in which the item is listed) if the primary and secondary categories are mapped to different characteristic sets. If they are mapped to the same characteristic set, the AttributeSetArray can contain one full attribute set.

An AttributeSetArray can also contain any number of additional site-wide attribute sets. In item-listing requests, AttributeSet is required if the category is mapped to a characteristic set with required attributes. On the US site, attributes are usually required for Tickets, eBay Motors vehicles, and Real Estate listings. See GetCategory2CS and GetAttributesCS. See the Developer's Guide for information about attribute meta-data and validation rules that are applicable when listing items.

In GetItem, the Half.com item condition may be returned once in an AttributeSet node with Half.com IDs and values, and once in a separate AttributeSet node with a site-wide eBay item condition. The Half.com IDs are not necessarily returned in GetAttributesCS, so you can use the eBay.com data instead. Half.com listings may also return an AttributeSet node with other eBay attributes.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet
  [ attribute attributeSetID ]		 int Conditionally Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristics set ID. Call GetCategory2CS to determine valid characteristics set IDs. For GetCategoryListings, you can ignore this value. Not applicable to Half.com.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute 		AttributeType Conditionally,
repeatable: [0..*]		 A salient aspect or feature of an item in a given category. Attributes are known as "Item Specifics" in the eBay Web site. Use attributes to describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard attribute for books. In item-listing requests, multiple attributes can be specified. Some categories (e.g., Tickets) always require certain attributes to be specified. Therefore, in item-listing requests you need to at least specify "editable" attributes (EditType 0 and EditType 2 attributes) if they are identified as required in the attribute meta-data. See the eBay Web Services guide for information about attrribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required.

If you are revising or relisting an item, you don't need to pass in attributes that were already specified in the original listing. To remove an optional attribute, set all its value IDs to "-100". If the item has bids (or items have been sold) but there are more than 12 hours remaining until the listing ends, you can add Attribute nodes but you cannot remove or modify data in previously specified Attribute nodes. If the item has bids and the listing ends within 12 hours, you cannot add or remove Attribute nodes or modify the contents of previously specified Attribute nodes.

For GetCategoryListings, this returns the item condition only (and it is only returned if IncludeCondition = true in the request). Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute
  [ attribute attributeID ]		 int Conditionally Constant value that identifies the attribute in a language-independent way. Unique within the attribute set. See the Developer's Guide topics on Item Specifics and Pre-filled Item Information for information about determining valid attribute IDs. Not applicable to Half.com.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value 		ValType Conditionally,
repeatable: [0..*]		 A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values.

For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueID 		int Conditionally Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristic set.

In item-listing requests, if the ID is defined as -3 or -6 (Other) in GetAttributesCS or GetProductSellingPages, use ValueLiteral to specify the string value that the user entered. Otherwise, use ValueID to specify the ID that is pre-defined in GetAttributesCS or GetProductSellingPages. In item-listing requests and product searches, the possible ID values are:
-3 = User entered an arbitrary value (not an "Other" field)
-6 = User entered a value in an "Other" field
-100 = Value not specified (null)
#### (integer) = Identifier for a pre-defined value that the user selected (e.g., -14 or 1001)
For eBay.com, required if ValueList is specified. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Attribute Elements.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueLiteral 		string Conditionally The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute.

For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID.

For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings.
Max length: see description.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .BestOfferEnabled 		boolean Conditionally Indicates, when true, that an item is available by Best Offer.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .BuyerGuaranteePrice 		AmountType (double) Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .BuyerProtection 		BuyerProtectionCodeType Conditionally Indicates the status of the item's eligibility for the PayPal Buyer Protection program.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) Item is eligible per standard criteria.

•   ItemIneligible

(out) Item is ineligible (e.g., category not applicable).

•   ItemMarkedEligible

(out) Item marked eligible per other criteria.

•   ItemMarkedIneligible

(out) Item marked ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) For the Australia site, indicates that there is no PayPal Buyer Protection coverage. Coverage details would be in the following sections of the View Item page: the Buy Safely section and the Payment Details section.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See Miscellaneous Item Field Differences.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Longer Lasting Buy It Now
    Revising US eBay Motors Listings

FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Field Differences for eBay Sites.
FilterRemovedExpansionArray
  .ExpansionItem.Item.Distance 		DistanceType Conditionally The distance used in a proximity search distance calculation.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item.Distance
  .DistanceMeasurement 		int Conditionally The measurement used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item.Distance
  .DistanceUnit 		string Conditionally The unit used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .GroupCategoryID 		string Conditionally GroupCategoryID is returned if there is a value of BestMatchCategoryGroup in the Order field for the GetSearchResults call. However, the results depend on the items and groups requested.

The Best Match algorithm will try to evenly fit the items and return groups of 'Best Matching' Categories. A 'category group' can be a parent category that contains the best-matching items from several of its subcategories. Within each category group, items will be also sorted by best match. The only condition when you may not get a GroupCategoryID returned at all is when the request is for one group and there is more than one category that has matching items. Very rarely, the same item will appear once in the group for its primary category and once in another group for its secondary category, in the same result set. Also very occasionally, a Store Inventory Item can appear in the results before a regular listing.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, None, ReturnAll.
FilterRemovedExpansionArray
  .ExpansionItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .ConvertedBuyItNowPrice 		AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .SellerBusinessType 		SellerBusinessCodeType Conditionally Type of seller account. This value is not returned for most sites. This value is not returned for the German site (site ID 77) or eBay Motors site (site ID 100).

Applicable values:

•   Commercial

(in/out) Commercial seller account.

•   CustomCode

(in/out)

•   Private

(in/out) Private seller account.

•   Undefined

(in/out) Type of seller account not defined.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    GetCategoryFeatures
    Fees per Site



Applicable values: See ListingDurationCodeType
FilterRemovedExpansionArray
  .ExpansionItem.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).




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.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.

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


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Different Ways of Selling
    Listing Types (Formats)
    GetCategoryFeatures
    Fees per Site

FilterRemovedExpansionArray
  .ExpansionItem.Item
  .LocalListing 		boolean Conditionally Indicates, when true, that an item is available locally.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .MotorsGermanySearchable 		boolean Conditionally Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany.

If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. See the eBay Web Services Guide for applicable categories, revise and relist rules, and additional information on featuring vehicles on the Mobile.de Site.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.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: See PaymentMethods.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Payment Method Differences (PaymentMethod)
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema for rules regarding repeating nodes

FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Introduction to Pictures in Item Listings.
FilterRemovedExpansionArray
  .ExpansionItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

FilterRemovedExpansionArray
  .ExpansionItem.Item
  .PictureDetails.PhotoDisplay 		PhotoDisplayCodeType Conditionally Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   None

(in/out) No special image display options. Valid for US Motors listings.

•   PicturePack

(in/out) Increase the number of images displayed. Only available for images hosted with eBay. See GetCategoryFeatures and the online Help (on the eBay site) for additional information. Picture Pack applies to all sites (including US Motors), except for NL (site ID 146). You can specify a minimum of one EPS picture, or no SuperSize-qualified EPS pictures in the request. For the NL site, PicturePack is replaced with SuperSize.

•   SiteHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, site-hosted pictures in a slideshow format.

•   SuperSize

(in/out) Increase the size of each image and allow buyers to enlarge images further. Only available for site-hosted (EPS) images. Not valid for US Motors listings. For all sites that do not automatically upgrade SuperSize to PicturePack (see note below), specifying no SuperSize-qualified images is now accepted in the request.

Note: SuperSize is automatically upgraded to PicturePack for the same SuperSize fee on the US Motors Parts & Accessories Category and US (site ID 0) and CA (site ID 2) and CAFR (site ID 210). This upgrade applies only to EPS images (including Picture Manager images).

•   SuperSizePictureShow

(in/out) This value is no longer applicable. Use SuperSize instead. Formerly, the value displays multiple, super-size, site-hosted pictures in a slideshow format. Valid for US Motors listings.

•   VendorHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, vendor-hosted pictures in a slideshow format. Not valid for US Motors listings.


(Not all values in PhotoDisplayCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.

See:
    Categories
    Specifying eBay Live Auctions Categories
    Listing US and CA eBay Motors Items
    (RelistItem) GalleryType
    KB Article: Listing with ExternalProductID and CategoryID

FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.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.)

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .SearchDetails.Picture 		boolean Conditionally Indicates whether a listing has an image associated with it.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .SearchDetails.RecentListing 		boolean Conditionally Indicates whether a listing is no more than one day old.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.

See Categories.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Working with Anonymous User Information.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item.Seller
  .UserID 		UserIDType (string) Conditionally Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID stays the same for every auction.

For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized.

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .SellingStatus.BidCount 		int Conditionally Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
FilterRemovedExpansionArray
  .ExpansionItem.Item
  .SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item.Site 		SiteCodeType Always The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API).

Not applicable to Half.com.

Applicable values: See Site.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    The US and International eBay Sites
    Specifying the Target Site
    Field Differences for eBay Sites

FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item.Storefront
  .StoreCategory2ID 		long Conditionally Applicable for eBay Store sellers only. Numeric ID for a second custom category that the seller created in their eBay Store. eBay Stores sellers can create up to 300 custom categories for their stores. (One additional Store category cannot be customized and retains the value of "Other").
If you specify an invalid value, the values are the same for both the primary and secondary store categories, or if the seondary store category is specified but the primary is left blank (or other), the system resets the value to 0 (None). In short, the primary store category must be set to something meaningful and different from the second store category in order to set the secondary store category to a value other than 0. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.Item.Storefront
  .StoreCategoryID 		long Conditionally Numeric ID for a custom category that the seller created in their eBay Store, if any. eBay Stores sellers can create up to three levels of custom categories for their stores. Items can only be listed in store categories that have no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the Other store category. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.ItemSpecific 		NameValueListArrayType Conditionally A list of attribute and value pairs. GetSearchResults can return this when the request either specifies IncludeCondition as true or searches for the Item Condition by using SearchRequest. If IncludeCondition was true, this returns the item condition (e.g., New). If SearchRequest was used to search for the item condition or for a US eBay Motors vehicle, the list returns the item condition or the vehicle mileage and year. That is, the results only include attributes that would be included in the summary search results on the Web site, if any. In most categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.) Not returned when TicketFinder is used.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .ExpansionItem
  .SearchResultValues 		SearchResultValuesCodeType Conditionally,
repeatable: [0..*]		 Contains additional information about the item listing returned in Item. This information includes whether the item has an image associated with it, and more. May contain zero, one, or multiple SearchResultValuesCodeType values indicating different pieces of additional information about the listing. These values are analogous to the icons that appear in an item listing's line in a Search page. Output only.

Applicable values:

•   CharityListing

(out) Indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item purchase price to a selected nonprofit organization. Not applicable for eBay Motors, international sites, and Real Estate and Tickets listings.

•   CustomCode

(out)

•   Escrow

(out)

•   Gift

(out)

•   New

(out) Indicates items listed one day or less earlier than the current query. If the listing is no more than one day old, New returns a value of true.

•   Picture

(out)




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
FilterRemovedExpansionArray
  .TotalAvailable 		int Conditionally The number of matching items available under the expansion.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
HasMoreItems boolean Always Indicates whether there are more items, not yet returned, that match the search criteria.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray ExpansionArrayType Conditionally Can be returned if the request specifies that ExpandSearch is true. Provides additional search results when a small result set would have been returned with the original search. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, and ExpandSearch is true, the search results are expanded to include (if matching the query) the InternationalExpansionArray container for items, as well as other containers. The InternationalExpansionArray container contains items available from international sellers.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem 		SearchResultItemType Conditionally,
repeatable: [0..*]		 Item that is the result of an expanded search. If, in a GetSearchResults request, you specify true for ExpandSearch, the search is expanded when a small result set is returned. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, then the search results are expanded. Specifically, the search returns items (if there are matches) in one or more of the following containers: InternationalExpansionArray (for items available from international sellers), FilterRemovedExpansionArray (items that would be returned if filters such as PriceRangeFilter are removed), StoreExpansionArray (for items listed in the Store Inventory Format), and AllCategoriesExpansionArray (for items available if category filters are removed). The maximum number of items returned in each container is 6 to 10.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item 		ItemType Conditionally Contains summary data for the item listing itself, with the properties that define the listing. For all item data, use an item-retrieval call, such as GetItem. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray 		AttributeSetArrayType Conditionally AttributeSetArray is one format that is used to to specify Item Specifics on the eBay Web site. (Also see Item.ItemSpecifics.) Item Specifics describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard property of a book.

Contains one or more instances of AttributeSet in a list. For attributes in general, an item can be associated with no more than two full attribute sets (one for the primary category and one for the secondary category). For some international sites, an item can specify an additional site-wide attribute set for the item condition.

Older applications can still use AttributeSetArray to specify a return policy (which is defined in a site-wide attribute set for most sites). However, as eBay may deprecate return policy attributes in the future, we strongly recommend that you use the new Item.ReturnPolicy node instead to specify the seller's return policy.

Note: AttributeSetArray does not support the newer "custom Item Specifics" model. See the ItemSpecifics node instead.

For the AddItem family of calls: Some categories (such as Event Tickets and US Real Estate) require Item Specifics. See the eBay Web Services Guide links below for information on working with Item Specifics. Use GetCategory2CS and GetAttributesCS to determine when attributes are required for a category. Also use attributes to specify the item condition.

For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add attributes. If the listing has bids but ends in more than 12 hours, you cannot change existing attribute data, but you can add attributes that were not previously specified. The most reliable way to do this is to pass in the entire AttributeSetArray with all the attributes you want in the listing (not just the ones you want to change, because that usually causes the others to be removed). To delete all attributes when you revise or relist, specify Item.AttributeSetArray in DeletedField and don't pass AttributeSetArray in the request. If the original listing's attributes are no longer valid and you get errors when you try to revise the listing, you can try to pass in the entire AttributeSetArray again with corrections. If that doesn't work, you can end the item and relist it with a set of valid attributes.

For GetCategoryListings only: For GetCategoryListings, AttributeSetArray can return the item condition (not other Item Specifics), if specified.

For GetSearchResults only: GetSearchResults can return the item condition when the request either specifies IncludeCondition as true; or specifies a product finder search (and a detail level of ItemReturnAttributes or ReturnAll). If IncludeCondition was true, see the ItemSpecific node for a simpler view of the condition value.
Note: AttributeSetArray only returns the condition attribute's ValueID. You would need to use GetAttributesCS to figure out the meaning of this ID. It's easier to just look at the ItemSpecific node.
If SearchRequest or TicketFinder was used to perform a product finder search, the list of attributes is limited to Item Specifics that would be included in the summary search results on the Web site, if any. At this time, GetSearchResults only returns event ticket venue name, section, and row (if specified) for eBay US (site 0); and the mileage and year for eBay Motors vehicles (site 100 and international eBay Motors sites that support this feature). In other categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.)

For GetItemRecommendations only: In GetItemRecommendations, if you use the Suggested Attributes engine, the engine interprets attributes you pass in as attributes that do NOT need recommendations (i.e., attributes that the seller has already filled in as desired). The engine only returns recommendations for attributes that you do not specify, and only for attributes associated with the primary category.

For Half.com, this is only returned in GetItem. It is not applicable in AddItem and other requests.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Working with Attribute-Based Features
    Specifying an Item's Condition
    Offering a Clear Return Policy
    (AddItem) Item.ReturnPolicy
    Revising Items that Include Item Specifics (Attributes)
    Relisting Items that Include Item Specifics (Attributes)

InternationalExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet 		AttributeSetType Conditionally,
repeatable: [0..*]		 Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way.

For the AddItem family of calls and GetItem, an AttributeSetArray can contain a maximum of 2 full attribute sets (one for each category in which the item is listed) if the primary and secondary categories are mapped to different characteristic sets. If they are mapped to the same characteristic set, the AttributeSetArray can contain one full attribute set.

An AttributeSetArray can also contain any number of additional site-wide attribute sets. In item-listing requests, AttributeSet is required if the category is mapped to a characteristic set with required attributes. On the US site, attributes are usually required for Tickets, eBay Motors vehicles, and Real Estate listings. See GetCategory2CS and GetAttributesCS. See the Developer's Guide for information about attribute meta-data and validation rules that are applicable when listing items.

In GetItem, the Half.com item condition may be returned once in an AttributeSet node with Half.com IDs and values, and once in a separate AttributeSet node with a site-wide eBay item condition. The Half.com IDs are not necessarily returned in GetAttributesCS, so you can use the eBay.com data instead. Half.com listings may also return an AttributeSet node with other eBay attributes.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet
  [ attribute attributeSetID ]		 int Conditionally Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristics set ID. Call GetCategory2CS to determine valid characteristics set IDs. For GetCategoryListings, you can ignore this value. Not applicable to Half.com.
InternationalExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute 		AttributeType Conditionally,
repeatable: [0..*]		 A salient aspect or feature of an item in a given category. Attributes are known as "Item Specifics" in the eBay Web site. Use attributes to describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard attribute for books. In item-listing requests, multiple attributes can be specified. Some categories (e.g., Tickets) always require certain attributes to be specified. Therefore, in item-listing requests you need to at least specify "editable" attributes (EditType 0 and EditType 2 attributes) if they are identified as required in the attribute meta-data. See the eBay Web Services guide for information about attrribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required.

If you are revising or relisting an item, you don't need to pass in attributes that were already specified in the original listing. To remove an optional attribute, set all its value IDs to "-100". If the item has bids (or items have been sold) but there are more than 12 hours remaining until the listing ends, you can add Attribute nodes but you cannot remove or modify data in previously specified Attribute nodes. If the item has bids and the listing ends within 12 hours, you cannot add or remove Attribute nodes or modify the contents of previously specified Attribute nodes.

For GetCategoryListings, this returns the item condition only (and it is only returned if IncludeCondition = true in the request). Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute
  [ attribute attributeID ]		 int Conditionally Constant value that identifies the attribute in a language-independent way. Unique within the attribute set. See the Developer's Guide topics on Item Specifics and Pre-filled Item Information for information about determining valid attribute IDs. Not applicable to Half.com.
InternationalExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value 		ValType Conditionally,
repeatable: [0..*]		 A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values.

For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueID 		int Conditionally Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristic set.

In item-listing requests, if the ID is defined as -3 or -6 (Other) in GetAttributesCS or GetProductSellingPages, use ValueLiteral to specify the string value that the user entered. Otherwise, use ValueID to specify the ID that is pre-defined in GetAttributesCS or GetProductSellingPages. In item-listing requests and product searches, the possible ID values are:
-3 = User entered an arbitrary value (not an "Other" field)
-6 = User entered a value in an "Other" field
-100 = Value not specified (null)
#### (integer) = Identifier for a pre-defined value that the user selected (e.g., -14 or 1001)
For eBay.com, required if ValueList is specified. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Attribute Elements.
InternationalExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueLiteral 		string Conditionally The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute.

For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID.

For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings.
Max length: see description.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item
  .BestOfferEnabled 		boolean Conditionally Indicates, when true, that an item is available by Best Offer.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item
  .BuyerGuaranteePrice 		AmountType (double) Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item
  .BuyerProtection 		BuyerProtectionCodeType Conditionally Indicates the status of the item's eligibility for the PayPal Buyer Protection program.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) Item is eligible per standard criteria.

•   ItemIneligible

(out) Item is ineligible (e.g., category not applicable).

•   ItemMarkedEligible

(out) Item marked eligible per other criteria.

•   ItemMarkedIneligible

(out) Item marked ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) For the Australia site, indicates that there is no PayPal Buyer Protection coverage. Coverage details would be in the following sections of the View Item page: the Buy Safely section and the Payment Details section.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See Miscellaneous Item Field Differences.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Longer Lasting Buy It Now
    Revising US eBay Motors Listings

InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Field Differences for eBay Sites.
InternationalExpansionArray
  .ExpansionItem.Item.Distance 		DistanceType Conditionally The distance used in a proximity search distance calculation.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item.Distance
  .DistanceMeasurement 		int Conditionally The measurement used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item.Distance
  .DistanceUnit 		string Conditionally The unit used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item
  .GroupCategoryID 		string Conditionally GroupCategoryID is returned if there is a value of BestMatchCategoryGroup in the Order field for the GetSearchResults call. However, the results depend on the items and groups requested.

The Best Match algorithm will try to evenly fit the items and return groups of 'Best Matching' Categories. A 'category group' can be a parent category that contains the best-matching items from several of its subcategories. Within each category group, items will be also sorted by best match. The only condition when you may not get a GroupCategoryID returned at all is when the request is for one group and there is more than one category that has matching items. Very rarely, the same item will appear once in the group for its primary category and once in another group for its secondary category, in the same result set. Also very occasionally, a Store Inventory Item can appear in the results before a regular listing.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, None, ReturnAll.
InternationalExpansionArray
  .ExpansionItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .ConvertedBuyItNowPrice 		AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .SellerBusinessType 		SellerBusinessCodeType Conditionally Type of seller account. This value is not returned for most sites. This value is not returned for the German site (site ID 77) or eBay Motors site (site ID 100).

Applicable values:

•   Commercial

(in/out) Commercial seller account.

•   CustomCode

(in/out)

•   Private

(in/out) Private seller account.

•   Undefined

(in/out) Type of seller account not defined.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    GetCategoryFeatures
    Fees per Site



Applicable values: See ListingDurationCodeType
InternationalExpansionArray
  .ExpansionItem.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).




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.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.

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


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Different Ways of Selling
    Listing Types (Formats)
    GetCategoryFeatures
    Fees per Site

InternationalExpansionArray
  .ExpansionItem.Item
  .LocalListing 		boolean Conditionally Indicates, when true, that an item is available locally.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item
  .MotorsGermanySearchable 		boolean Conditionally Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany.

If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. See the eBay Web Services Guide for applicable categories, revise and relist rules, and additional information on featuring vehicles on the Mobile.de Site.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.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: See PaymentMethods.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Payment Method Differences (PaymentMethod)
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema for rules regarding repeating nodes

InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Introduction to Pictures in Item Listings.
InternationalExpansionArray
  .ExpansionItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

InternationalExpansionArray
  .ExpansionItem.Item
  .PictureDetails.PhotoDisplay 		PhotoDisplayCodeType Conditionally Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   None

(in/out) No special image display options. Valid for US Motors listings.

•   PicturePack

(in/out) Increase the number of images displayed. Only available for images hosted with eBay. See GetCategoryFeatures and the online Help (on the eBay site) for additional information. Picture Pack applies to all sites (including US Motors), except for NL (site ID 146). You can specify a minimum of one EPS picture, or no SuperSize-qualified EPS pictures in the request. For the NL site, PicturePack is replaced with SuperSize.

•   SiteHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, site-hosted pictures in a slideshow format.

•   SuperSize

(in/out) Increase the size of each image and allow buyers to enlarge images further. Only available for site-hosted (EPS) images. Not valid for US Motors listings. For all sites that do not automatically upgrade SuperSize to PicturePack (see note below), specifying no SuperSize-qualified images is now accepted in the request.

Note: SuperSize is automatically upgraded to PicturePack for the same SuperSize fee on the US Motors Parts & Accessories Category and US (site ID 0) and CA (site ID 2) and CAFR (site ID 210). This upgrade applies only to EPS images (including Picture Manager images).

•   SuperSizePictureShow

(in/out) This value is no longer applicable. Use SuperSize instead. Formerly, the value displays multiple, super-size, site-hosted pictures in a slideshow format. Valid for US Motors listings.

•   VendorHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, vendor-hosted pictures in a slideshow format. Not valid for US Motors listings.


(Not all values in PhotoDisplayCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.

See:
    Categories
    Specifying eBay Live Auctions Categories
    Listing US and CA eBay Motors Items
    (RelistItem) GalleryType
    KB Article: Listing with ExternalProductID and CategoryID

InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.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.)

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item
  .SearchDetails.Picture 		boolean Conditionally Indicates whether a listing has an image associated with it.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item
  .SearchDetails.RecentListing 		boolean Conditionally Indicates whether a listing is no more than one day old.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.

See Categories.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Working with Anonymous User Information.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item.Seller
  .UserID 		UserIDType (string) Conditionally Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID stays the same for every auction.

For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized.

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item
  .SellingStatus.BidCount 		int Conditionally Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
InternationalExpansionArray
  .ExpansionItem.Item
  .SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item.Site 		SiteCodeType Always The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API).

Not applicable to Half.com.

Applicable values: See Site.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    The US and International eBay Sites
    Specifying the Target Site
    Field Differences for eBay Sites

InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item.Storefront
  .StoreCategory2ID 		long Conditionally Applicable for eBay Store sellers only. Numeric ID for a second custom category that the seller created in their eBay Store. eBay Stores sellers can create up to 300 custom categories for their stores. (One additional Store category cannot be customized and retains the value of "Other").
If you specify an invalid value, the values are the same for both the primary and secondary store categories, or if the seondary store category is specified but the primary is left blank (or other), the system resets the value to 0 (None). In short, the primary store category must be set to something meaningful and different from the second store category in order to set the secondary store category to a value other than 0. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.Item.Storefront
  .StoreCategoryID 		long Conditionally Numeric ID for a custom category that the seller created in their eBay Store, if any. eBay Stores sellers can create up to three levels of custom categories for their stores. Items can only be listed in store categories that have no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the Other store category. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.ItemSpecific 		NameValueListArrayType Conditionally A list of attribute and value pairs. GetSearchResults can return this when the request either specifies IncludeCondition as true or searches for the Item Condition by using SearchRequest. If IncludeCondition was true, this returns the item condition (e.g., New). If SearchRequest was used to search for the item condition or for a US eBay Motors vehicle, the list returns the item condition or the vehicle mileage and year. That is, the results only include attributes that would be included in the summary search results on the Web site, if any. In most categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.) Not returned when TicketFinder is used.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .ExpansionItem
  .SearchResultValues 		SearchResultValuesCodeType Conditionally,
repeatable: [0..*]		 Contains additional information about the item listing returned in Item. This information includes whether the item has an image associated with it, and more. May contain zero, one, or multiple SearchResultValuesCodeType values indicating different pieces of additional information about the listing. These values are analogous to the icons that appear in an item listing's line in a Search page. Output only.

Applicable values:

•   CharityListing

(out) Indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item purchase price to a selected nonprofit organization. Not applicable for eBay Motors, international sites, and Real Estate and Tickets listings.

•   CustomCode

(out)

•   Escrow

(out)

•   Gift

(out)

•   New

(out) Indicates items listed one day or less earlier than the current query. If the listing is no more than one day old, New returns a value of true.

•   Picture

(out)




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
InternationalExpansionArray
  .TotalAvailable 		int Conditionally The number of matching items available under the expansion.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
ItemsPerPage int Always Indicates the maximum number of items that can be returned in a SearchResultItemArray for any given call.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
PageNumber int Always Indicates the page of data returned by the current call. For instance, for the first set of items can be returned, this field has a value of one.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
PaginationResult PaginationResultType Always Indicates the results of the pagination, including the total number of pages of data that can be returned and the total number of items that can be returned.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
PaginationResult
  .TotalNumberOfEntries 		int Always Indicates the total number of entries that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no entries are available.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
PaginationResult
  .TotalNumberOfPages 		int Always Indicates the total number of pages of data that could be returned by repeated requests. For GetOrders, not applicable to eBay.com (for GetOrders, applicable to Half.com). Returned with a value of 0 if no pages are available.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
RelatedSearchKeywordArray RelatedSearchKeywordArrayType Conditionally Container for keywords related to the original keywords in the request. Can be returned if the request specified more than zero in the MaxRelatedSearchKeywords field.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
RelatedSearchKeywordArray
  .Keyword 		string Conditionally,
repeatable: [0..*]		 Related keyword.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray SearchResultItemArrayType Conditionally Contains the returned item listings, if any. The data for each listing is returned in an ItemType object.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem 		SearchResultItemType Conditionally,
repeatable: [0..*]		 Contains data for an item listing found by a search.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item 		ItemType Conditionally Contains summary data for the item listing itself, with the properties that define the listing. For all item data, use an item-retrieval call, such as GetItem. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .AttributeSetArray 		AttributeSetArrayType Conditionally AttributeSetArray is one format that is used to to specify Item Specifics on the eBay Web site. (Also see Item.ItemSpecifics.) Item Specifics describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard property of a book.

Contains one or more instances of AttributeSet in a list. For attributes in general, an item can be associated with no more than two full attribute sets (one for the primary category and one for the secondary category). For some international sites, an item can specify an additional site-wide attribute set for the item condition.

Older applications can still use AttributeSetArray to specify a return policy (which is defined in a site-wide attribute set for most sites). However, as eBay may deprecate return policy attributes in the future, we strongly recommend that you use the new Item.ReturnPolicy node instead to specify the seller's return policy.

Note: AttributeSetArray does not support the newer "custom Item Specifics" model. See the ItemSpecifics node instead.

For the AddItem family of calls: Some categories (such as Event Tickets and US Real Estate) require Item Specifics. See the eBay Web Services Guide links below for information on working with Item Specifics. Use GetCategory2CS and GetAttributesCS to determine when attributes are required for a category. Also use attributes to specify the item condition.

For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add attributes. If the listing has bids but ends in more than 12 hours, you cannot change existing attribute data, but you can add attributes that were not previously specified. The most reliable way to do this is to pass in the entire AttributeSetArray with all the attributes you want in the listing (not just the ones you want to change, because that usually causes the others to be removed). To delete all attributes when you revise or relist, specify Item.AttributeSetArray in DeletedField and don't pass AttributeSetArray in the request. If the original listing's attributes are no longer valid and you get errors when you try to revise the listing, you can try to pass in the entire AttributeSetArray again with corrections. If that doesn't work, you can end the item and relist it with a set of valid attributes.

For GetCategoryListings only: For GetCategoryListings, AttributeSetArray can return the item condition (not other Item Specifics), if specified.

For GetSearchResults only: GetSearchResults can return the item condition when the request either specifies IncludeCondition as true; or specifies a product finder search (and a detail level of ItemReturnAttributes or ReturnAll). If IncludeCondition was true, see the ItemSpecific node for a simpler view of the condition value.
Note: AttributeSetArray only returns the condition attribute's ValueID. You would need to use GetAttributesCS to figure out the meaning of this ID. It's easier to just look at the ItemSpecific node.
If SearchRequest or TicketFinder was used to perform a product finder search, the list of attributes is limited to Item Specifics that would be included in the summary search results on the Web site, if any. At this time, GetSearchResults only returns event ticket venue name, section, and row (if specified) for eBay US (site 0); and the mileage and year for eBay Motors vehicles (site 100 and international eBay Motors sites that support this feature). In other categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.)

For GetItemRecommendations only: In GetItemRecommendations, if you use the Suggested Attributes engine, the engine interprets attributes you pass in as attributes that do NOT need recommendations (i.e., attributes that the seller has already filled in as desired). The engine only returns recommendations for attributes that you do not specify, and only for attributes associated with the primary category.

For Half.com, this is only returned in GetItem. It is not applicable in AddItem and other requests.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Working with Attribute-Based Features
    Specifying an Item's Condition
    Offering a Clear Return Policy
    (AddItem) Item.ReturnPolicy
    Revising Items that Include Item Specifics (Attributes)
    Relisting Items that Include Item Specifics (Attributes)

SearchResultItemArray
  .SearchResultItem.Item
  .AttributeSetArray
  .AttributeSet 		AttributeSetType Conditionally,
repeatable: [0..*]		 Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way.

For the AddItem family of calls and GetItem, an AttributeSetArray can contain a maximum of 2 full attribute sets (one for each category in which the item is listed) if the primary and secondary categories are mapped to different characteristic sets. If they are mapped to the same characteristic set, the AttributeSetArray can contain one full attribute set.

An AttributeSetArray can also contain any number of additional site-wide attribute sets. In item-listing requests, AttributeSet is required if the category is mapped to a characteristic set with required attributes. On the US site, attributes are usually required for Tickets, eBay Motors vehicles, and Real Estate listings. See GetCategory2CS and GetAttributesCS. See the Developer's Guide for information about attribute meta-data and validation rules that are applicable when listing items.

In GetItem, the Half.com item condition may be returned once in an AttributeSet node with Half.com IDs and values, and once in a separate AttributeSet node with a site-wide eBay item condition. The Half.com IDs are not necessarily returned in GetAttributesCS, so you can use the eBay.com data instead. Half.com listings may also return an AttributeSet node with other eBay attributes.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .AttributeSetArray
  .AttributeSet
  [ attribute attributeSetID ]		 int Conditionally Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristics set ID. Call GetCategory2CS to determine valid characteristics set IDs. For GetCategoryListings, you can ignore this value. Not applicable to Half.com.
SearchResultItemArray
  .SearchResultItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute 		AttributeType Conditionally,
repeatable: [0..*]		 A salient aspect or feature of an item in a given category. Attributes are known as "Item Specifics" in the eBay Web site. Use attributes to describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard attribute for books. In item-listing requests, multiple attributes can be specified. Some categories (e.g., Tickets) always require certain attributes to be specified. Therefore, in item-listing requests you need to at least specify "editable" attributes (EditType 0 and EditType 2 attributes) if they are identified as required in the attribute meta-data. See the eBay Web Services guide for information about attrribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required.

If you are revising or relisting an item, you don't need to pass in attributes that were already specified in the original listing. To remove an optional attribute, set all its value IDs to "-100". If the item has bids (or items have been sold) but there are more than 12 hours remaining until the listing ends, you can add Attribute nodes but you cannot remove or modify data in previously specified Attribute nodes. If the item has bids and the listing ends within 12 hours, you cannot add or remove Attribute nodes or modify the contents of previously specified Attribute nodes.

For GetCategoryListings, this returns the item condition only (and it is only returned if IncludeCondition = true in the request). Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute
  [ attribute attributeID ]		 int Conditionally Constant value that identifies the attribute in a language-independent way. Unique within the attribute set. See the Developer's Guide topics on Item Specifics and Pre-filled Item Information for information about determining valid attribute IDs. Not applicable to Half.com.
SearchResultItemArray
  .SearchResultItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value 		ValType Conditionally,
repeatable: [0..*]		 A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values.

For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueID 		int Conditionally Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristic set.

In item-listing requests, if the ID is defined as -3 or -6 (Other) in GetAttributesCS or GetProductSellingPages, use ValueLiteral to specify the string value that the user entered. Otherwise, use ValueID to specify the ID that is pre-defined in GetAttributesCS or GetProductSellingPages. In item-listing requests and product searches, the possible ID values are:
-3 = User entered an arbitrary value (not an "Other" field)
-6 = User entered a value in an "Other" field
-100 = Value not specified (null)
#### (integer) = Identifier for a pre-defined value that the user selected (e.g., -14 or 1001)
For eBay.com, required if ValueList is specified. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Attribute Elements.
SearchResultItemArray
  .SearchResultItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueLiteral 		string Conditionally The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute.

For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID.

For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings.
Max length: see description.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .BestOfferEnabled 		boolean Conditionally Indicates, when true, that an item is available by Best Offer.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.Item
  .BuyerGuaranteePrice 		AmountType (double) Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .BuyerProtection 		BuyerProtectionCodeType Conditionally Indicates the status of the item's eligibility for the PayPal Buyer Protection program.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) Item is eligible per standard criteria.

•   ItemIneligible

(out) Item is ineligible (e.g., category not applicable).

•   ItemMarkedEligible

(out) Item marked eligible per other criteria.

•   ItemMarkedIneligible

(out) Item marked ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) For the Australia site, indicates that there is no PayPal Buyer Protection coverage. Coverage details would be in the following sections of the View Item page: the Buy Safely section and the Payment Details section.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See Miscellaneous Item Field Differences.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Longer Lasting Buy It Now
    Revising US eBay Motors Listings

SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Field Differences for eBay Sites.
SearchResultItemArray
  .SearchResultItem.Item
  .Distance 		DistanceType Conditionally The distance used in a proximity search distance calculation.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.Item
  .Distance.DistanceMeasurement 		int Conditionally The measurement used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.Item
  .Distance.DistanceUnit 		string Conditionally The unit used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.Item
  .GroupCategoryID 		string Conditionally GroupCategoryID is returned if there is a value of BestMatchCategoryGroup in the Order field for the GetSearchResults call. However, the results depend on the items and groups requested.

The Best Match algorithm will try to evenly fit the items and return groups of 'Best Matching' Categories. A 'category group' can be a parent category that contains the best-matching items from several of its subcategories. Within each category group, items will be also sorted by best match. The only condition when you may not get a GroupCategoryID returned at all is when the request is for one group and there is more than one category that has matching items. Very rarely, the same item will appear once in the group for its primary category and once in another group for its secondary category, in the same result set. Also very occasionally, a Store Inventory Item can appear in the results before a regular listing.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, None, ReturnAll.
SearchResultItemArray
  .SearchResultItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .ListingDetails
  .ConvertedBuyItNowPrice 		AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .ListingDetails
  .SellerBusinessType 		SellerBusinessCodeType Conditionally Type of seller account. This value is not returned for most sites. This value is not returned for the German site (site ID 77) or eBay Motors site (site ID 100).

Applicable values:

•   Commercial

(in/out) Commercial seller account.

•   CustomCode

(in/out)

•   Private

(in/out) Private seller account.

•   Undefined

(in/out) Type of seller account not defined.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    GetCategoryFeatures
    Fees per Site



Applicable values: See ListingDurationCodeType
SearchResultItemArray
  .SearchResultItem.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).




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.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.

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


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Different Ways of Selling
    Listing Types (Formats)
    GetCategoryFeatures
    Fees per Site

SearchResultItemArray
  .SearchResultItem.Item
  .LocalListing 		boolean Conditionally Indicates, when true, that an item is available locally.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.Item
  .MotorsGermanySearchable 		boolean Conditionally Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany.

If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. See the eBay Web Services Guide for applicable categories, revise and relist rules, and additional information on featuring vehicles on the Mobile.de Site.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.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: See PaymentMethods.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Payment Method Differences (PaymentMethod)
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema for rules regarding repeating nodes

SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Introduction to Pictures in Item Listings.
SearchResultItemArray
  .SearchResultItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

SearchResultItemArray
  .SearchResultItem.Item
  .PictureDetails.PhotoDisplay 		PhotoDisplayCodeType Conditionally Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   None

(in/out) No special image display options. Valid for US Motors listings.

•   PicturePack

(in/out) Increase the number of images displayed. Only available for images hosted with eBay. See GetCategoryFeatures and the online Help (on the eBay site) for additional information. Picture Pack applies to all sites (including US Motors), except for NL (site ID 146). You can specify a minimum of one EPS picture, or no SuperSize-qualified EPS pictures in the request. For the NL site, PicturePack is replaced with SuperSize.

•   SiteHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, site-hosted pictures in a slideshow format.

•   SuperSize

(in/out) Increase the size of each image and allow buyers to enlarge images further. Only available for site-hosted (EPS) images. Not valid for US Motors listings. For all sites that do not automatically upgrade SuperSize to PicturePack (see note below), specifying no SuperSize-qualified images is now accepted in the request.

Note: SuperSize is automatically upgraded to PicturePack for the same SuperSize fee on the US Motors Parts & Accessories Category and US (site ID 0) and CA (site ID 2) and CAFR (site ID 210). This upgrade applies only to EPS images (including Picture Manager images).

•   SuperSizePictureShow

(in/out) This value is no longer applicable. Use SuperSize instead. Formerly, the value displays multiple, super-size, site-hosted pictures in a slideshow format. Valid for US Motors listings.

•   VendorHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, vendor-hosted pictures in a slideshow format. Not valid for US Motors listings.


(Not all values in PhotoDisplayCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnCategories.

See:
    Categories
    Specifying eBay Live Auctions Categories
    Listing US and CA eBay Motors Items
    (RelistItem) GalleryType
    KB Article: Listing with ExternalProductID and CategoryID

SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnCategories.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.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.)

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.Item
  .SearchDetails.Picture 		boolean Conditionally Indicates whether a listing has an image associated with it.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.Item
  .SearchDetails.RecentListing 		boolean Conditionally Indicates whether a listing is no more than one day old.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnCategories.

See Categories.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnCategories.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Working with Anonymous User Information.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item.Seller
  .UserID 		UserIDType (string) Conditionally Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID stays the same for every auction.

For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized.

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.Item
  .SellingStatus.BidCount 		int Conditionally Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SearchResultItemArray
  .SearchResultItem.Item
  .SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item.Site 		SiteCodeType Always The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API).

Not applicable to Half.com.

Applicable values: See Site.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    The US and International eBay Sites
    Specifying the Target Site
    Field Differences for eBay Sites

SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .Storefront.StoreCategory2ID 		long Conditionally Applicable for eBay Store sellers only. Numeric ID for a second custom category that the seller created in their eBay Store. eBay Stores sellers can create up to 300 custom categories for their stores. (One additional Store category cannot be customized and retains the value of "Other").
If you specify an invalid value, the values are the same for both the primary and secondary store categories, or if the seondary store category is specified but the primary is left blank (or other), the system resets the value to 0 (None). In short, the primary store category must be set to something meaningful and different from the second store category in order to set the secondary store category to a value other than 0. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.Item
  .Storefront.StoreCategoryID 		long Conditionally Numeric ID for a custom category that the seller created in their eBay Store, if any. eBay Stores sellers can create up to three levels of custom categories for their stores. Items can only be listed in store categories that have no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the Other store category. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.ItemSpecific 		NameValueListArrayType Conditionally A list of attribute and value pairs. GetSearchResults can return this when the request either specifies IncludeCondition as true or searches for the Item Condition by using SearchRequest. If IncludeCondition was true, this returns the item condition (e.g., New). If SearchRequest was used to search for the item condition or for a US eBay Motors vehicle, the list returns the item condition or the vehicle mileage and year. That is, the results only include attributes that would be included in the summary search results on the Web site, if any. In most categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.) Not returned when TicketFinder is used.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SearchResultItemArray
  .SearchResultItem
  .SearchResultValues 		SearchResultValuesCodeType Conditionally,
repeatable: [0..*]		 Contains additional information about the item listing returned in Item. This information includes whether the item has an image associated with it, and more. May contain zero, one, or multiple SearchResultValuesCodeType values indicating different pieces of additional information about the listing. These values are analogous to the icons that appear in an item listing's line in a Search page. Output only.

Applicable values:

•   CharityListing

(out) Indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item purchase price to a selected nonprofit organization. Not applicable for eBay Motors, international sites, and Real Estate and Tickets listings.

•   CustomCode

(out)

•   Escrow

(out)

•   Gift

(out)

•   New

(out) Indicates items listed one day or less earlier than the current query. If the listing is no more than one day old, New returns a value of true.

•   Picture

(out)




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
SpellingSuggestion SpellingSuggestionType Conditionally Suggestion for a different spelling of the search term or terms, along with the number of matching items that would have been returned if the suggestions had been used. The suggestions are given in Text tags and the suggestion for the first word is given before the suggestion for subsequent words. Suggestions are based on correctly-spelled terms in items, so suggestions vary over time and depend on whether a word or word combination is in one or more items.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SpellingSuggestion
  .MatchingItemCount 		int Conditionally The number of matching items if the suggested spelling of the search term or terms had been used. If multiple terms are used, MatchingItemCount applies to the terms taken as a unit.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
SpellingSuggestion.Text string Conditionally,
repeatable: [0..*]		 Suggestion for a different spelling of the search term or terms. The suggestions are given in Text tags and the suggestion for the first word is given before the suggestion for subsequent words. Suggestions are based on correctly-spelled terms in items, so suggestions vary over time and depend on whether a word or word combination is in one or more items.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray ExpansionArrayType Conditionally Contains items listed in the Store Inventory Format, if the request specifies that ExpandSearch is true.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem 		SearchResultItemType Conditionally,
repeatable: [0..*]		 Item that is the result of an expanded search. If, in a GetSearchResults request, you specify true for ExpandSearch, the search is expanded when a small result set is returned. For example, on the US site (site ID 0), if a search would normally result in fewer than 10 items, then the search results are expanded. Specifically, the search returns items (if there are matches) in one or more of the following containers: InternationalExpansionArray (for items available from international sellers), FilterRemovedExpansionArray (items that would be returned if filters such as PriceRangeFilter are removed), StoreExpansionArray (for items listed in the Store Inventory Format), and AllCategoriesExpansionArray (for items available if category filters are removed). The maximum number of items returned in each container is 6 to 10.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item 		ItemType Conditionally Contains summary data for the item listing itself, with the properties that define the listing. For all item data, use an item-retrieval call, such as GetItem. Output only.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray 		AttributeSetArrayType Conditionally AttributeSetArray is one format that is used to to specify Item Specifics on the eBay Web site. (Also see Item.ItemSpecifics.) Item Specifics describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard property of a book.

Contains one or more instances of AttributeSet in a list. For attributes in general, an item can be associated with no more than two full attribute sets (one for the primary category and one for the secondary category). For some international sites, an item can specify an additional site-wide attribute set for the item condition.

Older applications can still use AttributeSetArray to specify a return policy (which is defined in a site-wide attribute set for most sites). However, as eBay may deprecate return policy attributes in the future, we strongly recommend that you use the new Item.ReturnPolicy node instead to specify the seller's return policy.

Note: AttributeSetArray does not support the newer "custom Item Specifics" model. See the ItemSpecifics node instead.

For the AddItem family of calls: Some categories (such as Event Tickets and US Real Estate) require Item Specifics. See the eBay Web Services Guide links below for information on working with Item Specifics. Use GetCategory2CS and GetAttributesCS to determine when attributes are required for a category. Also use attributes to specify the item condition.

For ReviseItem only: When you revise a listing, if the listing has bids and ends within 12 hours, you cannot change or add attributes. If the listing has bids but ends in more than 12 hours, you cannot change existing attribute data, but you can add attributes that were not previously specified. The most reliable way to do this is to pass in the entire AttributeSetArray with all the attributes you want in the listing (not just the ones you want to change, because that usually causes the others to be removed). To delete all attributes when you revise or relist, specify Item.AttributeSetArray in DeletedField and don't pass AttributeSetArray in the request. If the original listing's attributes are no longer valid and you get errors when you try to revise the listing, you can try to pass in the entire AttributeSetArray again with corrections. If that doesn't work, you can end the item and relist it with a set of valid attributes.

For GetCategoryListings only: For GetCategoryListings, AttributeSetArray can return the item condition (not other Item Specifics), if specified.

For GetSearchResults only: GetSearchResults can return the item condition when the request either specifies IncludeCondition as true; or specifies a product finder search (and a detail level of ItemReturnAttributes or ReturnAll). If IncludeCondition was true, see the ItemSpecific node for a simpler view of the condition value.
Note: AttributeSetArray only returns the condition attribute's ValueID. You would need to use GetAttributesCS to figure out the meaning of this ID. It's easier to just look at the ItemSpecific node.
If SearchRequest or TicketFinder was used to perform a product finder search, the list of attributes is limited to Item Specifics that would be included in the summary search results on the Web site, if any. At this time, GetSearchResults only returns event ticket venue name, section, and row (if specified) for eBay US (site 0); and the mileage and year for eBay Motors vehicles (site 100 and international eBay Motors sites that support this feature). In other categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.)

For GetItemRecommendations only: In GetItemRecommendations, if you use the Suggested Attributes engine, the engine interprets attributes you pass in as attributes that do NOT need recommendations (i.e., attributes that the seller has already filled in as desired). The engine only returns recommendations for attributes that you do not specify, and only for attributes associated with the primary category.

For Half.com, this is only returned in GetItem. It is not applicable in AddItem and other requests.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Working with Attribute-Based Features
    Specifying an Item's Condition
    Offering a Clear Return Policy
    (AddItem) Item.ReturnPolicy
    Revising Items that Include Item Specifics (Attributes)
    Relisting Items that Include Item Specifics (Attributes)

StoreExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet 		AttributeSetType Conditionally,
repeatable: [0..*]		 Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way.

For the AddItem family of calls and GetItem, an AttributeSetArray can contain a maximum of 2 full attribute sets (one for each category in which the item is listed) if the primary and secondary categories are mapped to different characteristic sets. If they are mapped to the same characteristic set, the AttributeSetArray can contain one full attribute set.

An AttributeSetArray can also contain any number of additional site-wide attribute sets. In item-listing requests, AttributeSet is required if the category is mapped to a characteristic set with required attributes. On the US site, attributes are usually required for Tickets, eBay Motors vehicles, and Real Estate listings. See GetCategory2CS and GetAttributesCS. See the Developer's Guide for information about attribute meta-data and validation rules that are applicable when listing items.

In GetItem, the Half.com item condition may be returned once in an AttributeSet node with Half.com IDs and values, and once in a separate AttributeSet node with a site-wide eBay item condition. The Half.com IDs are not necessarily returned in GetAttributesCS, so you can use the eBay.com data instead. Half.com listings may also return an AttributeSet node with other eBay attributes.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet
  [ attribute attributeSetID ]		 int Conditionally Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristics set ID. Call GetCategory2CS to determine valid characteristics set IDs. For GetCategoryListings, you can ignore this value. Not applicable to Half.com.
StoreExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute 		AttributeType Conditionally,
repeatable: [0..*]		 A salient aspect or feature of an item in a given category. Attributes are known as "Item Specifics" in the eBay Web site. Use attributes to describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard attribute for books. In item-listing requests, multiple attributes can be specified. Some categories (e.g., Tickets) always require certain attributes to be specified. Therefore, in item-listing requests you need to at least specify "editable" attributes (EditType 0 and EditType 2 attributes) if they are identified as required in the attribute meta-data. See the eBay Web Services guide for information about attrribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required.

If you are revising or relisting an item, you don't need to pass in attributes that were already specified in the original listing. To remove an optional attribute, set all its value IDs to "-100". If the item has bids (or items have been sold) but there are more than 12 hours remaining until the listing ends, you can add Attribute nodes but you cannot remove or modify data in previously specified Attribute nodes. If the item has bids and the listing ends within 12 hours, you cannot add or remove Attribute nodes or modify the contents of previously specified Attribute nodes.

For GetCategoryListings, this returns the item condition only (and it is only returned if IncludeCondition = true in the request). Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute
  [ attribute attributeID ]		 int Conditionally Constant value that identifies the attribute in a language-independent way. Unique within the attribute set. See the Developer's Guide topics on Item Specifics and Pre-filled Item Information for information about determining valid attribute IDs. Not applicable to Half.com.
StoreExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value 		ValType Conditionally,
repeatable: [0..*]		 A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values.

For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueID 		int Conditionally Constant value that identifies the attribute or characteristic in a language-independent way. Unique within the characteristic set.

In item-listing requests, if the ID is defined as -3 or -6 (Other) in GetAttributesCS or GetProductSellingPages, use ValueLiteral to specify the string value that the user entered. Otherwise, use ValueID to specify the ID that is pre-defined in GetAttributesCS or GetProductSellingPages. In item-listing requests and product searches, the possible ID values are:
-3 = User entered an arbitrary value (not an "Other" field)
-6 = User entered a value in an "Other" field
-100 = Value not specified (null)
#### (integer) = Identifier for a pre-defined value that the user selected (e.g., -14 or 1001)
For eBay.com, required if ValueList is specified. Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Attribute Elements.
StoreExpansionArray
  .ExpansionItem.Item
  .AttributeSetArray
  .AttributeSet.Attribute.Value
  .ValueLiteral 		string Conditionally The descriptive name of an attribute or characteristic value (e.g., "New" might be a literal value for a Condition attribute). In item-listing requests, if you send ValueID with an id of -3 or -6, you must use ValueLiteral to enter the value the user specified. Otherwise, eBay treats the request as if no value was sent at all. For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value.ValueLiteral. The max length allowed varies per attribute.

For GetSearchResults requests (in SearchRequest), only use ValueLiteral for attributes that support free-text values. That is, if eBay defines a value name and a unique value ID for an attribute in GetProductFinder, do not pass the name in ValueLiteral (because it won't work). Instead, specify the unique value ID in ValueID.

For Half.com, use AttributeArray.Attribute.Value.ValueLiteral in listing requests. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, AttributeArray.Attribute.Value.ValueLiteral is required when you use AddItem. See the eBay Web Services Guide for valid values. For the Half.com Notes attribute, the max length is 500 characters. You can revise AttributeArray.Attribute.Value.ValueLiteral for Half.com listings.
Max length: see description.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item
  .BestOfferEnabled 		boolean Conditionally Indicates, when true, that an item is available by Best Offer.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item
  .BuyerGuaranteePrice 		AmountType (double) Conditionally For the Australia site, BuyerGuaranteePrice is the PayPal Buyer Protection coverage, offered for the item at the time of purchase. Details of coverage are in the following sections of the View Item page: the Buy Safely section and the Payment Details section.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item
  .BuyerProtection 		BuyerProtectionCodeType Conditionally Indicates the status of the item's eligibility for the PayPal Buyer Protection program.

Not applicable to Half.com.

Applicable values:

•   CustomCode

(out) Reserved for internal or future use.

•   ItemEligible

(out) Item is eligible per standard criteria.

•   ItemIneligible

(out) Item is ineligible (e.g., category not applicable).

•   ItemMarkedEligible

(out) Item marked eligible per other criteria.

•   ItemMarkedIneligible

(out) Item marked ineligible per special criteria (e.g., seller's account closed).

•   NoCoverage

(out) For the Australia site, indicates that there is no PayPal Buyer Protection coverage. Coverage details would be in the following sections of the View Item page: the Buy Safely section and the Payment Details section.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See Miscellaneous Item Field Differences.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Longer Lasting Buy It Now
    Revising US eBay Motors Listings

StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Field Differences for eBay Sites.
StoreExpansionArray
  .ExpansionItem.Item.Distance 		DistanceType Conditionally The distance used in a proximity search distance calculation.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item.Distance
  .DistanceMeasurement 		int Conditionally The measurement used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item.Distance
  .DistanceUnit 		string Conditionally The unit used in a proximity search distance calculation.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item
  .GroupCategoryID 		string Conditionally GroupCategoryID is returned if there is a value of BestMatchCategoryGroup in the Order field for the GetSearchResults call. However, the results depend on the items and groups requested.

The Best Match algorithm will try to evenly fit the items and return groups of 'Best Matching' Categories. A 'category group' can be a parent category that contains the best-matching items from several of its subcategories. Within each category group, items will be also sorted by best match. The only condition when you may not get a GroupCategoryID returned at all is when the request is for one group and there is more than one category that has matching items. Very rarely, the same item will appear once in the group for its primary category and once in another group for its secondary category, in the same result set. Also very occasionally, a Store Inventory Item can appear in the results before a regular listing.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, None, ReturnAll.
StoreExpansionArray
  .ExpansionItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .ConvertedBuyItNowPrice 		AmountType (double) Conditionally Converted value of the BuyItNowPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .ConvertedStartPrice 		AmountType (double) Conditionally Converted value of the StartPrice in the currency of the site that returned this response. For active items, refresh this value every 24 hours to pick up the current conversion rates.

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item
  .ListingDetails
  .SellerBusinessType 		SellerBusinessCodeType Conditionally Type of seller account. This value is not returned for most sites. This value is not returned for the German site (site ID 77) or eBay Motors site (site ID 100).

Applicable values:

•   Commercial

(in/out) Commercial seller account.

•   CustomCode

(in/out)

•   Private

(in/out) Private seller account.

•   Undefined

(in/out) Type of seller account not defined.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    GetCategoryFeatures
    Fees per Site



Applicable values: See ListingDurationCodeType
StoreExpansionArray
  .ExpansionItem.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).




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.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.

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


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Different Ways of Selling
    Listing Types (Formats)
    GetCategoryFeatures
    Fees per Site

StoreExpansionArray
  .ExpansionItem.Item
  .LocalListing 		boolean Conditionally Indicates, when true, that an item is available locally.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item
  .MotorsGermanySearchable 		boolean Conditionally Listing upgrade that features the item in eBay search results on the mobile.de partner site. Applicable to eBay Germany.

If true in listing requests and responses, the seller is purchasing or has purchased cross-promotional placement on the mobile.de site. See the eBay Web Services Guide for applicable categories, revise and relist rules, and additional information on featuring vehicles on the Mobile.de Site.

Not applicable to Half.com.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.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: See PaymentMethods.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

See:
    Payment Method Differences (PaymentMethod)
    Listing an Item
    (SetUserPreferences) SellerPaymentPreferences
    Overview of the API Schema for rules regarding repeating nodes

StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Introduction to Pictures in Item Listings.
StoreExpansionArray
  .ExpansionItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

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

StoreExpansionArray
  .ExpansionItem.Item
  .PictureDetails.PhotoDisplay 		PhotoDisplayCodeType Conditionally Specifies the type of image display used in a listing. Some options are only available if images are hosted through eBay Picture Services (EPS). eBay determines this by parsing the associated PictureURL. Cannot be used in combination with Listing Designer layouts. Specify None or do not add PhotoDisplay when ListingDesigner.LayoutID is a value other than 0.

Applicable values:

•   CustomCode

(in/out) Reserved for internal or future use.

•   None

(in/out) No special image display options. Valid for US Motors listings.

•   PicturePack

(in/out) Increase the number of images displayed. Only available for images hosted with eBay. See GetCategoryFeatures and the online Help (on the eBay site) for additional information. Picture Pack applies to all sites (including US Motors), except for NL (site ID 146). You can specify a minimum of one EPS picture, or no SuperSize-qualified EPS pictures in the request. For the NL site, PicturePack is replaced with SuperSize.

•   SiteHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, site-hosted pictures in a slideshow format.

•   SuperSize

(in/out) Increase the size of each image and allow buyers to enlarge images further. Only available for site-hosted (EPS) images. Not valid for US Motors listings. For all sites that do not automatically upgrade SuperSize to PicturePack (see note below), specifying no SuperSize-qualified images is now accepted in the request.

Note: SuperSize is automatically upgraded to PicturePack for the same SuperSize fee on the US Motors Parts & Accessories Category and US (site ID 0) and CA (site ID 2) and CAFR (site ID 210). This upgrade applies only to EPS images (including Picture Manager images).

•   SuperSizePictureShow

(in/out) This value is no longer applicable. Use SuperSize instead. Formerly, the value displays multiple, super-size, site-hosted pictures in a slideshow format. Valid for US Motors listings.

•   VendorHostedPictureShow

(in/out) This value is no longer applicable. Formerly, the value displays multiple, vendor-hosted pictures in a slideshow format. Not valid for US Motors listings.


(Not all values in PhotoDisplayCodeType apply to this field.)


DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.

See:
    Categories
    Specifying eBay Live Auctions Categories
    Listing US and CA eBay Motors Items
    (RelistItem) GalleryType
    KB Article: Listing with ExternalProductID and CategoryID

StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.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.)

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item
  .SearchDetails.Picture 		boolean Conditionally Indicates whether a listing has an image associated with it.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item
  .SearchDetails.RecentListing 		boolean Conditionally Indicates whether a listing is no more than one day old.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.

See Categories.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnCategories.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See Working with Anonymous User Information.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item.Seller
  .UserID 		UserIDType (string) Conditionally Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A".

Note that in this format, the anonymous bidder ID stays the same for every auction.

For GetMyeBayBuying only, when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3.

Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

Note that when IncludeFeedback is true in a GetSearchResults request, the response contains the seller's User ID. Please note that a seller's UserID is not anonymized.

For PlaceOffer, see also SellingStatus.HighBidder.

DetailLevel: ReturnAll.

See Working with Anonymous User Information.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item
  .SellingStatus.BidCount 		int Conditionally Number of bids placed so far against the item. Only applicable to competitive-bid item listings (Chinese auctions).

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.
StoreExpansionArray
  .ExpansionItem.Item
  .SellingStatus
  .ConvertedCurrentPrice 		AmountType (double) Conditionally Converted value of the CurrentPrice in the currency of the site that returned this response. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Only returned when the item's CurrentPrice on the listing site is in different currency than the currency of the host site for the user/application making the API call. ConvertedCurrentPrice is not returned for Classified listings (Classified listings are not available on all sites).

In multi-variation listings, this value matches the lowest-priced variation that is still available for sale.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    Determining Shipping Costs for a Listing
    Revising Items for restrictions on changing item properties with ReviseItem

StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item.Site 		SiteCodeType Always The name of the site on which the item is listed. The listing site affects the business logic and validation rules that are applied to the request, which in turn affect the values that are returned in the response, as well as values that appear on the eBay Web site. For example, the listing site can affect the validation of Category in listing requests, international business seller requirements, the values of converted (localized) prices in responses, the item-related time stamps that are displayed on the eBay Web site, the visibility of the item in some types of searches (e.g., GetCategoryListings), and other information. In some cases, the rules are determined by a combination of the site, the user's registration address, and other information. You cannot change the site when you revise a listing.

When you specify Item.Site in AddItem, it must be consistent with the numeric site ID that you specify in the request URL (for the SOAP API) or the X-EBAY- API-SITEID header (for the XML API).

Not applicable to Half.com.

Applicable values: See Site.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.

See:
    The US and International eBay Sites
    Specifying the Target Site
    Field Differences for eBay Sites

StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item.Storefront
  .StoreCategory2ID 		long Conditionally Applicable for eBay Store sellers only. Numeric ID for a second custom category that the seller created in their eBay Store. eBay Stores sellers can create up to 300 custom categories for their stores. (One additional Store category cannot be customized and retains the value of "Other").
If you specify an invalid value, the values are the same for both the primary and secondary store categories, or if the seondary store category is specified but the primary is left blank (or other), the system resets the value to 0 (None). In short, the primary store category must be set to something meaningful and different from the second store category in order to set the secondary store category to a value other than 0. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.Item.Storefront
  .StoreCategoryID 		long Conditionally Numeric ID for a custom category that the seller created in their eBay Store, if any. eBay Stores sellers can create up to three levels of custom categories for their stores. Items can only be listed in store categories that have no child categories (subcategories). If you attempt to list an item in a category that has subcategories, the call response contains a warning, and the item is listed in the Other store category. In GetSearchResults and GetProducts, this field currently returns 0. As a workaround, use GetItem or related calls to get the ID.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.ItemSpecific 		NameValueListArrayType Conditionally A list of attribute and value pairs. GetSearchResults can return this when the request either specifies IncludeCondition as true or searches for the Item Condition by using SearchRequest. If IncludeCondition was true, this returns the item condition (e.g., New). If SearchRequest was used to search for the item condition or for a US eBay Motors vehicle, the list returns the item condition or the vehicle mileage and year. That is, the results only include attributes that would be included in the summary search results on the Web site, if any. In most categories, no summary attributes are returned in search results (even when the item is listed with Item Specifics.) Not returned when TicketFinder is used.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem.ItemSpecific
  .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.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .ExpansionItem
  .SearchResultValues 		SearchResultValuesCodeType Conditionally,
repeatable: [0..*]		 Contains additional information about the item listing returned in Item. This information includes whether the item has an image associated with it, and more. May contain zero, one, or multiple SearchResultValuesCodeType values indicating different pieces of additional information about the listing. These values are analogous to the icons that appear in an item listing's line in a Search page. Output only.

Applicable values:

•   CharityListing

(out) Indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item purchase price to a selected nonprofit organization. Not applicable for eBay Motors, international sites, and Real Estate and Tickets listings.

•   CustomCode

(out)

•   Escrow

(out)

•   Gift

(out)

•   New

(out) Indicates items listed one day or less earlier than the current query. If the listing is no more than one day old, New returns a value of true.

•   Picture

(out)




DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.

GranularityLevel: Coarse.
StoreExpansionArray
  .TotalAvailable 		int Conditionally The number of matching items available under the expansion.

DetailLevel: ItemReturnAttributes, ItemReturnCategories, ReturnAll. Also returned if DetailLevel is not provided on input.



Back to top

Input Output Detail Controls Samples Change History Top Errors for GetSearchResults
GetSearchResults Detail Controls


Detail Control: DetailLevel

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

The none column indicates the fields that are returned when you do not specify a DetailLevel.

GetSearchResults supports the ItemReturnCategories, ItemReturnAttributes, and ReturnAll values of DetailLevel and the Coarse value of GranularityLevel.

If you use ItemReturnCategories, the search results include the primary category of retrieved items and, if applicable, the secondary category.

If you use ItemReturnAttributes, the search results include Item Specifics that are applicable to search results (as displayed on the eBay Web site's search results page). For example, for event tickets, the search results can include the venue name, section, and row attributes. For eBay Motors, the search results can include the mileage and year attributes.

If you use Coarse, the search results can include the ItemID, Title, ViewItemURL, ListingType, StartTime, EndTime, and several other fields (see the GranularityLevel table) in addition to any fields resulting from the detail level you specify.

If you use ReturnAll, all applicable fields are returned.

YThe field is always returned.
(Y)The field is conditionally returned. See the field description for clarification of conditions.
-The field is not returned.

Output Field none ItemReturnAttributes ItemReturnCategories None ReturnAll
AllCategoriesExpansionArray(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.AttributeSetArray(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.AttributeSetArray
  .AttributeSet		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.AttributeSetArray
  .AttributeSet.Attribute		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.AttributeSetArray
  .AttributeSet.Attribute.Value		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.AttributeSetArray
  .AttributeSet.Attribute.Value.ValueID		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.AttributeSetArray
  .AttributeSet.Attribute.Value.ValueLiteral		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.BestOfferEnabled(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item
  .BuyerGuaranteePrice		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.BuyerProtection(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.BuyItNowPrice(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.Country(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.Currency(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.Distance(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.Distance
  .DistanceMeasurement		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.Distance
  .DistanceUnit		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.GiftIcon(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.GroupCategoryID-(Y)(Y)(Y)(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ItemID(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingDetails(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingDetails
  .ConvertedBuyItNowPrice		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingDetails
  .ConvertedStartPrice		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingDetails
  .EndTime		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingDetails
  .SellerBusinessType		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingDetails
  .StartTime		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingDetails
  .ViewItemURL		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingDetails
  .ViewItemURLForNaturalSearch		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingDuration(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingEnhancement(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.ListingType(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.LocalListing(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item
  .MotorsGermanySearchable		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.PaymentMethods(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.PictureDetails(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.PictureDetails
  .GalleryType		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.PictureDetails
  .GalleryURL		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.PictureDetails
  .PhotoDisplay		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.PostalCode(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.PrimaryCategory--(Y)--
AllCategoriesExpansionArray.ExpansionItem.Item.PrimaryCategory
  .CategoryID		--(Y)--
AllCategoriesExpansionArray.ExpansionItem.Item.SearchDetails(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.SearchDetails
  .BuyItNowEnabled		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.SearchDetails
  .Picture		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.SearchDetails
  .RecentListing		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.SecondaryCategory--(Y)--
AllCategoriesExpansionArray.ExpansionItem.Item.SecondaryCategory
  .CategoryID		--(Y)--
AllCategoriesExpansionArray.ExpansionItem.Item.Seller(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.ExpansionItem.Item.Seller
  .FeedbackScore		(Y)(Y)(Y)-(Y)
AllCategoriesExpansionArray.Expans