Description

eBay Shopping API Version 643

Type

SOAP

Style

Document

See Also

Methods | Complex Types | Simple Types | Elements | Attributes

Methods

Name	Description
FindHalfProducts	Finds product listings on Half.com.
FindItems	Finds items based on the given search criteria.
FindItemsAdvanced	Advanced item search adding more search parameters.
FindPopularItems	Finds most popular items for a given category or keyword.
FindPopularSearches	Finds the keywords that users are searching on for listings.
FindProducts	Finds products based on the given search criteria.
FindReviewsAndGuides	Finds reviews and guides based on the given search criteria.
GetCategoryInfo	Get information about the given category.
GeteBayTime	Gets the official time of the eBay server.
GetItemStatus	Gets the status of one or more items.
GetMultipleItems	Gets details for multiple shopping items.
GetShippingCosts	Gets the shiping cost for a shopping item.
GetSingleItem	Gets details for a single shopping item.
GetUserProfile	Retrieves the profile for the user specified.

Description

Finds product listings on Half.com.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:FindHalfProductsRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.
ns:AvailableItemsOnly	xs:boolean	0..1	If true, only retrieve data for products that have been used to pre-fill active listings on the Half.com site. If false, retrieve all products that match the query.
ns:DomainName	xs:string	0..*	A domain to search in.
ns:ProductID	ns:ProductIDType	0..1	Use this to retrieve product details for one specific product. Specify the ID as a string, and use the type attribute to indicate the nature of the ID you are specifying.
ns:QueryKeywords	xs:string	0..1	One or more keywords to search for.
ns:SellerID	xs:string	0..1	The ID of a specific seller.
ns:ProductSort	ns:ProductSortCodeType	0..1	Sorts the list of products returned.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts the list of products returned.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of products to return per page in a single call.
ns:PageNumber	xs:int	0..1	Specifies which page of data to return in the current call.

Output (Literal)

The output of this method is the document element ns:FindHalfProductsResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:DomainHistogram	ns:DomainHistogramType	0..1	A histogram that lists the number of matching products found and the domains in which they were found.
ns:PageNumber	xs:int	0..1	The number of the page of data returned.
ns:ApproximatePages	xs:int	0..1	The total number of pages that can be returned, given the same query and filters in the request.
ns:MoreResults	xs:boolean	0..1	If true, more pages of results are available. That is, PageNumber is less than ApproximatePages.
ns:TotalProducts	xs:int	0..1	The total number of matching products found. (If more than 2000 products are found, the call fails with an error.)
ns:Products	ns:HalfProductsType	0..1	An set of Half.com catalog products.
ns:ProductSearchURL	xs:anyURI	0..1	A URL for product search results that corresponds to your search request.

Description

Finds items based on the given search criteria.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:FindItemsRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:QueryKeywords	xs:string	0..1	A query that specifies a string for searching titles of items on eBay.
ns:ItemSort	ns:SimpleItemSortCodeType	0..1	Sorts search results based on the value you specify.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts search results in ascending or descending order, in conjunction with the value you specify in ItemSort.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of entries to return in a single call.
ns:PostalCode	xs:string	0..1	Specifies the postal code where the buyer is located.
ns:SellerID	xs:string	0..*	The ID of a specific seller.
ns:SellerIDExclude	xs:string	0..*	Specify this value if you want search results to be filtered so that the items returned do not include items sold by a specific seller or by specific sellers.
ns:HideDuplicateItems	xs:boolean	0..1	Specifies whether or not to remove duplicate items from search results.

Output (Literal)

The output of this method is the document element ns:FindItemsResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:Item	ns:SimpleItemType	0..*	Contains summary data for an item listing.
ns:TotalItems	xs:int	0..1	Indicates the total number of items on eBay that match the query.
ns:ItemSearchURL	xs:anyURI	0..1	A URL equivalent to your FindItems search query.
ns:DuplicateItems	xs:boolean	0..1	Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.

Description

Advanced item search adding more search parameters.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:FindItemsAdvancedRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.
ns:BidCountMax	xs:int	0..1	Limits the results to items with a maximum number of bids.
ns:BidCountMin	xs:int	0..1	Limits the results to items with a minimum number of bids.
ns:CategoryHistogramMaxParents	xs:int	0..1	Maximum number of matching categories to return at the highest level (root level) of the category hierarchy (level 1).
ns:CategoryHistogramMaxChildren	xs:int	0..1	Maximum number of matching subcategories to return at each level of the category hierarchy below the root level.
ns:QueryKeywords	xs:string	0..1	A query that specifies a string for searching titles of items on eBay.
ns:CategoryID	xs:string	0..1	Specify CategoryID to restrict your query to a specific category.
ns:ItemSort	ns:SimpleItemSortCodeType	0..1	Sorts search results based on the value you specify.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts search results in ascending or descending order, in conjunction with the value you specify in ItemSort.
ns:GroupMaxEntries	xs:int	0..1	GroupMaxEntries is used when you specify that BestMatch search results are grouped by category (by using BestMatchCategoryGroup in the ItemSort field.)
ns:GroupsMax	xs:int	0..1	GroupsMax is used when you specify that BestMatch search results are grouped by category (by using BestMatchCategoryGroup in the ItemSort field.)
ns:EndTimeFrom	xs:dateTime	0..1	Limits the results to items ending within a time range.
ns:EndTimeTo	xs:dateTime	0..1	Limits the results to items ending within a time range.
ns:ModTimeFrom	xs:dateTime	0..1	Limits the results to active items whose status has changed since the specified time.
ns:SellerID	xs:string	0..*	The ID of a specific seller.
ns:SellerIDExclude	xs:string	0..*	Specify this value if you want search results to be filtered so that the items returned do not include items sold by a specific seller or by specific sellers.
ns:ItemType	ns:ItemTypeCodeType	0..1	Filters items based on criteria related to the listing type of items.
ns:MaxDistance	xs:int	0..1	The maximum distance from the postal code specified in the PostalCode field. (The PostalCode field contains the postal code of the buyer.)
ns:PostalCode	xs:string	0..1	The postal code where the buyer is located.
ns:ProductID	ns:ProductIDType	0..1	You can use this input field to search by ISBN, UPC, EAN, or eBay Product Reference ID, as in the following examples. To search using an ISBN, specify ProductID.Type=ISBN and set ProductID.Value to an ISBN value. To search using an eBay Product Reference ID, specify ProductID.Type=Reference and set ProductID.Value to an eBay Product Reference ID value.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of entries to be returned in a single call.
ns:PageNumber	xs:int	0..1	Specifies the number of the page of data to return in the current call.
ns:PriceMax	ns:AmountType	0..1	Specifies the maximum current price an item can have to be included in the response.
ns:PriceMin	ns:AmountType	0..1	Specifies the minimum current price an item listing can have to be included in the searches result set.
ns:Condition	ns:ItemConditionCodeType	0..1	Limits the results to new OR used items (exclusive, not both), plus items that have no condition specified.
ns:CharityID	xs:int	0..1	Limits results to items that support the specified nonprofit charity organization.
ns:SearchFlag	ns:SearchFlagCodeType	0..*	Search for charity listings, free-shipping listings, and listings with other features.
ns:PaymentMethod	ns:PaymentMethodSearchCodeType	0..1	Limits results to items that accept a specific payment method or methods.
ns:StoreName	xs:string	0..1
ns:StoreSearch	ns:StoreSearchCodeType	0..1	Specifies the type of store search used for filtering results.
ns:SellerBusinessType	ns:SellerBusinessCodeType	0..1	Limits the results to those of a particular seller business type such as commercial or private.
ns:Quantity	xs:int	0..1	Limits the results to listings that offer a certain number of items matching the query.
ns:QuantityOperator	ns:QuantityOperatorCodeType	0..1	Limits the results to listings with quantities greater than, equal to, or less than the value you specify in Quantity.
ns:Currency	ns:CurrencyCodeType	0..1	Limits the result set to just those items with a specified currency.
ns:ItemsAvailableTo	ns:CountryCodeType	0..1	Limits the result set to just those items available to the specified country.
ns:ItemsLocatedIn	ns:CountryCodeType	0..1	Limits the result set to just those items located in the specified country.
ns:PreferredLocation	ns:PreferredLocationCodeType	0..1	Specifies the criteria for filtering search results by site, where site is determined by the site ID in the request.
ns:FeedbackScoreMax	xs:int	0..1	Specifies the maximum feedback score of a seller whose items can be included in the response.
ns:FeedbackScoreMin	xs:int	0..1	Specifies the mininum feedback score of a seller whose items can be included in the response.
ns:ExcludeFlag	ns:ExcludeFlagCodeType	0..*	Excludes items with the specified flag from the search.
ns:DescriptionSearch	xs:boolean	0..1	Specifies whether you want to include the item's description in a search.
ns:HideDuplicateItems	xs:boolean	0..1	Specifies whether or not to remove duplicate items from search results.
ns:ShippingLocation	ns:CountryCodeType	0..1	ShippingLocation should be used together with PostalCode for shipping cost calculations.
ns:ShippingPostalCode	xs:string	0..1	This postal code is for international shipping cost calculations.
ns:ItemLocationRegion	ns:ItemLocationRegionCodeType	0..1	Allows you to search for items in a specified region.
ns:CategoryIDExclude	xs:string	0..*	Specify a CategoryIDExclude value in your request if you want search results to be filtered so that the items returned do not include items that belong to the specified category.

Output (Literal)

The output of this method is the document element ns:FindItemsAdvancedResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:SearchResult	ns:SearchResultType	0..*	Contains the returned item listings, if any.
ns:PageNumber	xs:int	0..1	Indicates the page of data returned by the current call. For instance, for the first set of items returned, this field has a value of 1.
ns:TotalPages	xs:int	0..1	Indicates the total number of pages of data that could be returned by repeated requests.
ns:TotalItems	xs:int	0..1	Indicates the total number of items that could be returned by repeated requests.
ns:CategoryHistogram	ns:CategoryArrayType	0..1	Statistical (histogram) information about categories that contain items that match the query, if any.
ns:TotalStoresExpansionItems	xs:int	0..1	Total item count for a store expansion of the search.
ns:TotalInternationalExpansionItems	xs:int	0..1	Total item count for an international expansion of the search.
ns:ItemSearchURL	xs:anyURI	0..1	A URL for search results that corresponds to your search request.
ns:DuplicateItems	xs:boolean	0..1	Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.

Description

Finds most popular items for a given category or keyword.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:FindPopularItemsRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:CategoryID	xs:string	0..*	Specify CategoryID to restrict your query to a specific category.
ns:QueryKeywords	xs:string	0..1	A query that specifies a string for searching titles of items on eBay.
ns:CategoryIDExclude	xs:string	0..*	Specify this value if you want search results to be filtered so that the popular items returned do not include items that belong to a specific category.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of entries to return in a single call.

Output (Literal)

The output of this method is the document element ns:FindPopularItemsResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:ItemArray	ns:SimpleItemArrayType	0..1	A list of active items that were listed with the requested product.

Description

Finds the keywords that users are searching on for listings.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:FindPopularSearchesRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:CategoryID	xs:string	0..*	Specify CategoryID to restrict your query to a specific category.
ns:QueryKeywords	xs:string	0..*	A query that specifies a string for searching titles of items on eBay.
ns:MaxKeywords	xs:int	0..1	The maximum number of keywords to be retrieved per category for this call.
ns:MaxResultsPerPage	xs:int	0..1	Specifies the maximum number of PopularSearchResults per page in the returned list.
ns:PageNumber	xs:int	0..1	Specifies the number of the page of data to return in the current call.
ns:IncludeChildCategories	xs:boolean	0..1	If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories.

Output (Literal)

The output of this method is the document element ns:FindPopularSearchesResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:PopularSearchResult	ns:PopularSearchesType	0..*	Returns most popular search words by category.
ns:PageNumber	xs:int	0..1	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.
ns:TotalPages	xs:int	0..1	Indicates the total number of pages of data that could be returned by repeated requests.

Description

Finds products based on the given search criteria.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:FindProductsRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.
ns:AvailableItemsOnly	xs:boolean	0..1	If true, only retrieve data for products that have been used to pre-fill active listings on the specified eBay site. If false, retrieve all products that match the query.
ns:DomainName	xs:string	0..*	A domain to search in.
ns:ProductID	ns:ProductIDType	0..1	Use this to retrieve product details for one specific product.
ns:QueryKeywords	xs:string	0..1	One or more keywords to search for. When you use a keyword search, eBay searches the product catalogs for matching words in the product title, description, and/or Item Specifics, and it returns a list of matching products, with no items.
ns:ProductSort	ns:ProductSortCodeType	0..1	Sorts the list of products returned.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts search results in ascending or descending order. Only applicable with ProductSort.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of products to return per page in a single call.
ns:PageNumber	xs:int	0..1	Specifies which page of data to return in the current call.
ns:CategoryID	xs:string	0..1	Include a Category ID number in your request to restrict your query to a specific category.
ns:HideDuplicateItems	xs:boolean	0..1	Specifies whether or not to remove duplicate items from search results.

Output (Literal)

The output of this method is the document element ns:FindProductsResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:ApproximatePages	xs:int	0..1	The total number of pages that can be returned, given the same query and filters in the request.
ns:MoreResults	xs:boolean	0..1	If true, more pages of results are available. That is, PageNumber is less than ApproximatePages.
ns:DomainHistogram	ns:DomainHistogramType	0..1	A histogram that lists the number of matching products found and the domains in which they were found.
ns:ItemArray	ns:SimpleItemArrayType	0..1	A list of active items that were listed with the requested product.
ns:PageNumber	xs:int	0..1	The number of the page of data returned.
ns:Product	ns:CatalogProductType	0..*	An eBay catalog product.
ns:TotalProducts	xs:int	0..1	The total number of matching products found. (If more than 2000 products are found, the call fails with an error.)
ns:DuplicateItems	xs:boolean	0..1	Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.

Description

Finds reviews and guides based on the given search criteria.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:FindReviewsAndGuidesRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:ProductID	ns:ProductIDType	0..1	Use this to retrieve reviews (not guides) for one specific product.
ns:UserID	xs:string	0..1	Retrieves reviews and guides written by the specified user.
ns:CategoryID	xs:string	0..1	Specify a single CategoryID to restrict your query to a specific Guide category.
ns:MaxResultsPerPage	xs:int	0..1	Specifies the maximum number of reviews per page (not guides) in the returned list.
ns:PageNumber	xs:int	0..1	Specifies the number of the page of data to return in the current call.
ns:ReviewSort	ns:ReviewSortCodeType	0..1	Include ReviewSort in your request if you want to sort by a parameter, such as CreationTime.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts search results in ascending or descending order, in conjunction with the value you specify in ReviewsSort.

Output (Literal)

The output of this method is the document element ns:FindReviewsAndGuidesResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:ReviewCount	xs:int	0..1	Number of returned reviews.
ns:BuyingGuideCount	xs:int	0..1	Number of returned buying guides.
ns:ReviewerRank	xs:int	0..1	Rank of reviewer if using user search.
ns:TotalHelpfulnessVotes	xs:int	0..1	Number of helpfulness votes if using user search.
ns:ProductID	ns:ProductIDType	0..1	The eBay or external IDs associated with the product.
ns:ReviewsAndGuidesURL	xs:anyURI	0..1	URL to the reviews and guides page.
ns:PageNumber	xs:int	0..1	The number of the page of data returned.
ns:TotalPages	xs:int	0..1	Indicates the total number of pages of data that could be returned by repeated requests.
ns:BuyingGuideDetails	ns:BuyingGuideDetailsType	0..1	Contains information for up to 5 buying guides that match the query.
ns:ReviewDetails	ns:ReviewDetailsType	0..1	Contains information about review details.
ns:PositiveHelpfulnessVotes	xs:int	0..1	Number of helpfulness votes if using user search.

Description

Get information about the given category.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:GetCategoryInfoRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:CategoryID	xs:string	0..1	Use an ID of -1 to retrieve the root category and the top-level (level 1) meta categories.
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.

Output (Literal)

The output of this method is the document element ns:GetCategoryInfoResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:CategoryArray	ns:CategoryArrayType	0..1	List of the returned categories.
ns:CategoryCount	xs:int	0..1	Indicates the number of categories returned (i.e., the number of CategoryType objects in CategoryArray).
ns:UpdateTime	xs:dateTime	0..1	Indicates the last date and time that eBay modified the category hierarchy for the specified eBay site.
ns:CategoryVersion	xs:string	0..1	Indicates the version of the category hierarchy on the specified eBay site.

Description

Gets the official time of the eBay server.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:GeteBayTimeRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*

Output (Literal)

The output of this method is the document element ns:GeteBayTimeResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*

Description

Gets the status of one or more items.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:GetItemStatusRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:ItemID	xs:string	0..*	The item ID that uniquely identifies the item listing for which to retrieve the data.

Output (Literal)

The output of this method is the document element ns:GetItemStatusResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:Item	ns:SimpleItemType	0..*	Collection of Item status objects in an SimpleItemArrayType object, that can include zero, one, or multiple ItemType objects.

Description

Gets details for multiple shopping items.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:GetMultipleItemsRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:ItemID	xs:string	0..*
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.

Output (Literal)

The output of this method is the document element ns:GetMultipleItemsResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:Item	ns:SimpleItemType	0..*	Contains details for a listing (or multiple) listings that correspond to the item ID(s) specified in the request.

Description

Gets the shiping cost for a shopping item.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:GetShippingCostsRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:ItemID	xs:string	0..1	The item ID that uniquely identifies the item listing for which to retrieve the data.
ns:QuantitySold	xs:int	0..1	Number of items sold to a single buyer and to be shipped together.
ns:DestinationPostalCode	xs:string	0..1	Destination country postal code (or zipcode, for US).
ns:DestinationCountryCode	ns:CountryCodeType	0..1	Destination country code.
ns:IncludeDetails	xs:boolean	0..1	Indicates whether to return the ShippingDetails container in the response.

Output (Literal)

The output of this method is the document element ns:GetShippingCostsResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:ShippingDetails	ns:ShippingDetailsType	0..1	Shipping-related details for the specified item.
ns:ShippingCostSummary	ns:ShippingCostSummaryType	0..1	Shipping-related details for the specified item.

Description

Gets details for a single shopping item.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:GetSingleItemRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:ItemID	xs:string	0..1	The item ID that uniquely identifies the item listing for which to retrieve the data.
ns:VariationSKU	xs:string	0..1	Variation-level SKU that uniquely identifes a variation within the listing identified by ItemID.
ns:VariationSpecifics	ns:NameValueListArrayType	0..1	Name-value pairs that identify one or more variations within the listing identified by ItemID.
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.

Output (Literal)

The output of this method is the document element ns:GetSingleItemResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:Item	ns:SimpleItemType	0..1	Contains details about the listing whose ID was specified in the request.

Description

Retrieves the profile for the user specified.

Action

Style

Document

Input (Literal)

The input of this method is the document element ns:GetUserProfileRequest of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:UserID	xs:string	0..1	Specifies the user whose data will returned by the call.
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.

Output (Literal)

The output of this method is the document element ns:GetUserProfileResponse of type having the structure defined by the following table.

Element	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:User	ns:SimpleUserType	0..1	Contains the returned user data for the specified eBay user.
ns:FeedbackHistory	ns:FeedbackHistoryType	0..1	Summary feedback data for a user. Contains counts of positive, neutral, and negative feedback for predefined time periods.
ns:FeedbackDetails	ns:FeedbackDetailType	0..*	The FeedbackDetails container has fields (ItemID, etc.) with information about one feedback entry.

Complex Types

Name	Description
ns:AbstractRequestType	Base type definition of the request payload, which can carry any type of payload content plus optional versioning information and detail level requirements.
ns:AbstractResponseType	Base type definition of a response payload that can carry any type of payload content with following optional elements: - timestamp of response message - application-level acknowledgement - application-level (business-level) errors and warnings
ns:AddressType	Contains the data for one user address.
ns:AmountType	Basic type for specifying monetary amounts.
ns:AverageRatingDetailsType	Applicable to sites that support the Detailed Seller Ratings feature.
ns:BusinessSellerDetailsType	Displays the seller's information (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.
ns:BuyingGuideDetailsType	Information about zero or more buying guides and the site's buying guide hub.
ns:BuyingGuideType	Information that identifies a buying guide.
ns:CatalogProductType	Information about an eBay catalog product.
ns:CategoryArrayType	Container for a list of categories.
ns:CategoryType	Contains details about a category.
ns:CharityType	Identifies a Giving Works listing and benefiting nonprofit charity organization.
ns:DistanceType	Distance, used for a proximity search.
ns:DomainHistogramType	A generic type used for histograms.
ns:ErrorParameterType	A variable that contains specific information about the context of this error.
ns:ErrorType	These are request errors (as opposed to system errors) that occur due to problems with business-level data (e.g., an invalid combination of arguments) that the application passed in.
ns:ExternalProductIDType	Contains an ISBN value, EAN value, UPC value, ticket keywords, or eBay catalog product ID, plus other meta-data.
ns:FeedbackDetailType	Detailed feedback information for a user.
ns:FeedbackHistoryType	Specifies all feedback summary information (except Score).
ns:FeedbackPeriodType	Contains the data for one type of feedback for one predefined time period.
ns:FindHalfProductsRequestType	Searches Half.com for stock product information (stock description and Item Specifics), such as information about a particular kind of DVD or book.
ns:FindHalfProductsResponseType	Returns stock product information in Half.com catalogs, such as information about a particular DVD or book.
ns:FindItemsAdvancedRequestType	Searches for items based on a variety of input fields. Enables you to specify what item data is returned. Returns detailed information about items.
ns:FindItemsAdvancedResponseType	Contains the item listings matching your search criteria.
ns:FindItemsRequestType	Searches for items based on a query or seller ID. If you use keywords, this call returns items that contain the keywords in the title. A maximum of 50 items is returned.
ns:FindItemsResponseType
ns:FindPopularItemsRequestType	Find popular items
ns:FindPopularItemsResponseType	Popular items, detail level is default for simple item type. addition with WatchCount.
ns:FindPopularSearchesRequestType	Retrieves the words most frequently used by eBay users when searching for listings.
ns:FindPopularSearchesResponseType	Contains the keyword data for the requested categories.
ns:FindProductsRequestType	Searches for stock product information.
ns:FindProductsResponseType	Returns stock product information in eBay catalogs, such as information about a particular DVD or camera. Optionally, also returns items that match the product.
ns:FindReviewsAndGuidesRequestType	Splitting include reviews and guides from GetProducts.
ns:FindReviewsAndGuidesResponseType	Find reviews and guides response type.
ns:GetCategoryInfoRequestType	This call will give you the ability to retrieve high level Category information, relevant for a buy-side application.
ns:GetCategoryInfoResponseType	Contains the category data for the eBay site specified as input.
ns:GeteBayTimeRequestType	Gets the official eBay system time in GMT.
ns:GeteBayTimeResponseType	The Timestamp field indicates the official eBay system time in GMT.
ns:GetItemStatusRequestType	Contains a single ItemID or an array of ItemIDs.
ns:GetItemStatusResponseType	Returns status information for all items in a list.
ns:GetMultipleItemsRequestType	Retrieves publicly available data for one or more listings.
ns:GetMultipleItemsResponseType	Response to request of GetMultipleItems.
ns:GetShippingCostsRequestType	Gets shipping costs for an item.
ns:GetShippingCostsResponseType	Response to call of GetShippingCosts.
ns:GetSingleItemRequestType	Retrieves publicly available data for a single listing.
ns:GetSingleItemResponseType
ns:GetUserProfileRequestType	Retrieves user information based on the user ID you specify.
ns:GetUserProfileResponseType
ns:HalfCatalogProductType	Information about an Half.com catalog product.
ns:HalfProductsType	Information about an eBay catalog product.
ns:HistogramEntryType	A generic histogram entry type.
ns:InternationalShippingServiceOptionType	Shipping costs and options related to an international shipping service.
ns:NameValueListArrayType	A list of one or more valid names and corresponding values.
ns:NameValueListType	A name and corresponding value (a name/value pair).
ns:PicturesType	Defines variation-specific pictures associated with one VariationSpecificName (e.g., Color) whose values differ across variations.
ns:PopularSearchesType	Contains search word information, as it is related to a category.
ns:ProductIDType	Product ID has an attribute of ProductIDCodeType and a string value.
ns:ReturnPolicyType	Type for the return policy details of an item.
ns:ReviewDetailsType	Contains product reviews written by eBay members.
ns:ReviewType	A product review written by an eBay member.
ns:SalesTaxType	Type for expressing sales tax data.
ns:SearchResultType	Container for items. Can contain zero, one, or multiple SimpleItemType objects, each of which has data for an item listing.
ns:SellingStatusType	Contains various details about the current status of a listing.
ns:ShippingCostSummaryType	Type for the shipping-related details for an item or transaction.
ns:ShippingDetailsType	Type for the shipping-related details for an item or transaction.
ns:ShippingServiceOptionType	Shipping costs and options related to a domestic shipping service.
ns:SimpleItemArrayType	Container for a list of items.
ns:SimpleItemType
ns:SimpleUserType	Type to contain the data for one eBay user.
ns:StorefrontType	Contains information related to the item in the context of a seller's eBay Store.
ns:TaxJurisdictionType	Tax-related details for a region or jurisdiction.
ns:TaxTableType	Sales tax details for zero or more jurisdictions (states, provinces, etc).
ns:VariationSpecificPictureSetType	At least one container is required (minOccurs="1") if Pictures container is present in the request.
ns:VariationsType	Variations are multiple similar (but not identical) items in a single fixed-price (or Store Inventory Format) listing.
ns:VariationType	This element hold the values that define the SKU, StartPrice, Quantity, VariationDetails, and VariationSpecifics.
ns:VATDetailsType	Container for eBay's Business User features.

Description

Base type definition of the request payload, which can carry any type of payload content plus optional versioning information and detail level requirements.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*

Referenced By

• Complex Type ns:FindHalfProductsRequestType

• Complex Type ns:FindItemsAdvancedRequestType

• Complex Type ns:FindItemsRequestType

• Complex Type ns:FindPopularItemsRequestType

• Complex Type ns:FindPopularSearchesRequestType

• Complex Type ns:FindProductsRequestType

• Complex Type ns:FindReviewsAndGuidesRequestType

• Complex Type ns:GetCategoryInfoRequestType

• Complex Type ns:GeteBayTimeRequestType

• Complex Type ns:GetItemStatusRequestType

• Complex Type ns:GetMultipleItemsRequestType

• Complex Type ns:GetShippingCostsRequestType

• Complex Type ns:GetSingleItemRequestType

• Complex Type ns:GetUserProfileRequestType

Remarks

 All concrete request types are derived from the abstract request type. The naming convention we use for the concrete type names is the name of the service (the verb or call name) followed by "RequestType": VerbNameRequestType

Description

Base type definition of a response payload that can carry any type of payload content with following optional elements:
- timestamp of response message
- application-level acknowledgement
- application-level (business-level) errors and warnings

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*

Referenced By

• Complex Type ns:FindHalfProductsResponseType

• Complex Type ns:FindItemsAdvancedResponseType

• Complex Type ns:FindItemsResponseType

• Complex Type ns:FindPopularItemsResponseType

• Complex Type ns:FindPopularSearchesResponseType

• Complex Type ns:FindProductsResponseType

• Complex Type ns:FindReviewsAndGuidesResponseType

• Complex Type ns:GetCategoryInfoResponseType

• Complex Type ns:GeteBayTimeResponseType

• Complex Type ns:GetItemStatusResponseType

• Complex Type ns:GetMultipleItemsResponseType

• Complex Type ns:GetShippingCostsResponseType

• Complex Type ns:GetSingleItemResponseType

• Complex Type ns:GetUserProfileResponseType

Description

Contains the data for one user address.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Name	xs:string	0..1	User's name for the address.
ns:Street	xs:string	0..1	A concatenation of Street1 and Street2, primarily for RegistrationAddress.
ns:Street1	xs:string	0..1	Line 1 of the user's street address.
ns:Street2	xs:string	0..1	Line 2 of the user's address (such as an apartment number).
ns:CityName	xs:string	0..1	The name of the user's city. Also applicable to Half.com (for GetOrders).
ns:County	xs:string	0..1	County information for the user.
ns:StateOrProvince	xs:string	0..1	The region of the user's address.
ns:CountryName	xs:string	0..1	The name of the user's country. Also applicable to Half.com (for GetOrders).
ns:Phone	xs:string	0..1	User's primary phone number.
ns:PhoneCountryPrefix	xs:string	0..1	Country Prefix of the secondary phone number.
ns:PhoneAreaOrCityCode	xs:string	0..1	Area or City Code of a user's primary phone number.
ns:PhoneLocalNumber	xs:string	0..1	The local number portion of the user's primary phone number.
ns:Phone2CountryPrefix	xs:string	0..1	Country prefix of a user's secondary phone number.
ns:Phone2AreaOrCityCode	xs:string	0..1	Area or City Code of a user's secondary phone number.
ns:Phone2LocalNumber	xs:string	0..1	The local number portion of the user's secondary phone number.
ns:PostalCode	xs:string	0..1	User's postal code.
ns:AddressID	xs:string	0..1	ID assigned to the address in the eBay database. For GetOrders, applies only to Half.com.
ns:ExternalAddressID	xs:string	0..1	ID assigned to the address by the owner of the address (fitting only if the address is owned by PayPal; see AddressOwner).
ns:InternationalName	xs:string	0..1	Seller's international name that is associated with the payment address.
ns:InternationalStateAndCity	xs:string	0..1	International state and city for the seller's payment address.
ns:InternationalStreet	xs:string	0..1	Seller's international street address that is associated with the payment address.
ns:CompanyName	xs:string	0..1	User's company name.
ns:FirstName	xs:string	0..1	Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
ns:LastName	xs:string	0..1	Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'.
any		0..*

Referenced By

• Element ns:Address [type BusinessSellerDetailsType]

Remarks

This is the base type for a number of user addresses, including seller payment address, buyer shipping address and buyer and seller registration address.

Description

Basic type for specifying monetary amounts.

Derived By

Extending xs:double

Attributes

Name	Type	Required?	Default	Description
ns:currencyID	ns:CurrencyCodeType	Yes		Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values.

Referenced By

• Element ns:BuyItNowPrice [type SimpleItemType]

• Element ns:CODCost [type ShippingDetailsType]

• Element ns:ConvertedBuyItNowPrice [type SimpleItemType]

• Element ns:ConvertedCurrentPrice [type SellingStatusType]

• Element ns:ConvertedCurrentPrice [type SimpleItemType]

• Element ns:CurrentPrice [type SimpleItemType]

• Element ns:CurrentPrice [type SellingStatusType]

• Element ns:InsuranceCost [type ShippingDetailsType]

• Element ns:InsuranceCost [type ShippingCostSummaryType]

• Element ns:InternationalInsuranceCost [type ShippingDetailsType]

• Element ns:ItemPrice [type FeedbackDetailType]

• Element ns:ListedShippingServiceCost [type ShippingCostSummaryType]

• Element ns:MinimumToBid [type SimpleItemType]

• Element ns:MinPrice [type HalfCatalogProductType]

• Element ns:PriceMax [type FindItemsAdvancedRequestType]

• Element ns:PriceMin [type FindItemsAdvancedRequestType]

• Element ns:SalesTaxAmount [type SalesTaxType]

• Element ns:ShippingInsuranceCost [type InternationalShippingServiceOptionType]

• Element ns:ShippingInsuranceCost [type ShippingServiceOptionType]

• Element ns:ShippingServiceAdditionalCost [type InternationalShippingServiceOptionType]

• Element ns:ShippingServiceAdditionalCost [type ShippingServiceOptionType]

• Element ns:ShippingServiceCost [type ShippingCostSummaryType]

• Element ns:ShippingServiceCost [type InternationalShippingServiceOptionType]

• Element ns:ShippingServiceCost [type ShippingServiceOptionType]

• Element ns:ShippingSurcharge [type ShippingServiceOptionType]

• Element ns:StartPrice [type VariationType]

Remarks

 A double value (e.g., 1.00 or 1.0) is meaningful as a monetary amount when accompanied by a specification of the currency, in which case the value specifies the amount in that currency. An AmountType expresses both the value (a double) and the currency. Details such as prices, fees, costs, and payments are specified as amount types.

Description

Applicable to sites that support the Detailed Seller Ratings feature.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:RatingDetail	ns:FeedbackRatingDetailCodeType	0..1	The area of a specific average detailed seller rating.
ns:Rating	xs:double	0..1	An average detailed seller rating applying to the area in the corresponding RatingDetail field.
ns:RatingCount	xs:long	0..1	The number of detailed seller ratings in the area in the corresponding RatingDetail field.
any		0..*

Referenced By

• Element ns:AverageRatingDetails [type FeedbackHistoryType]

Remarks

The AverageRatingDetailsType contains the average detailed seller ratings in an area. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers.

Description

Displays the seller's information (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Address	ns:AddressType	0..1	Displays the Address of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.
ns:Fax	xs:string	0..1	Displays the fax number of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.
ns:Email	xs:string	0..1	Displays the email address of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.
ns:AdditionalContactInformation	xs:string	0..1	Displays the AdditionalContactInformation of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.
ns:TradeRegistrationNumber	xs:string	0..1	Displays the TradeRegistrationNumber of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.
ns:LegalInvoice	xs:boolean	0..1	Displays the LegalInvoice of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.
ns:TermsAndConditions	xs:string	0..1	Displays the TermsAndConditions of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.
ns:VATDetails	ns:VATDetailsType	0..1	Displays the VATDetails of the seller (in a business card format) as part of the data returned in the GetSingleItem call if the seller's SellerBusinessCodeType is set to 'Commercial'.
any		0..*

Referenced By

• Element ns:BusinessSellerDetails [type SimpleItemType]

Remarks

Note that this option is only available for sites that have Business Seller options enabled.

Description

Information about zero or more buying guides and the site's buying guide hub.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:BuyingGuide	ns:BuyingGuideType	0..*	Information that identifies a buying guide.
ns:BuyingGuideHub	xs:anyURI	0..1	URL of the buying guide home page for the site being searched.
any		0..*

Referenced By

• Element ns:BuyingGuideDetails [type FindReviewsAndGuidesResponseType]

Remarks

Buying guides contain content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Multiple buying guides can be returned. See the eBay Web Services Guide for additional information.

Description

Information that identifies a buying guide.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Name	xs:string	0..1	Display name of the buying guide.
ns:URL	xs:anyURI	0..1	URL for the buying guide.
ns:CategoryID	xs:string	0..1	Identifies the category (if any) that is associated with the buying guide.
ns:Title	xs:string	0..1	The title of the buying guide.
ns:Text	xs:string	0..1	The text of the guide. If the guide is longer than 2000 characters, the text is cut off and it ends with "...".
ns:CreationTime	xs:dateTime	0..1	The time and date when the guide was posted.
ns:UserID	xs:string	0..1	The author's eBay user ID.
any		0..*

Referenced By

• Element ns:BuyingGuide [type BuyingGuideDetailsType]

Remarks

 A buying guide provides 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.

Description

Information about an eBay catalog product.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:DomainName	xs:string	0..1	The name of the domain in which the product was found.
ns:DetailsURL	xs:anyURI	0..1	Fully qualified URL for optional information about the product, such as a movie's description or film credits.
ns:DisplayStockPhotos	xs:boolean	0..1	If true, your application can attempt to display stock photos that are returned. If false, your application should not attempt to display any stock photos that are returned.
ns:ProductID	ns:ProductIDType	0..*	The eBay or external IDs associated with the product.
ns:ItemCount	xs:int	0..1	Total number of listings on the requested eBay site that use stock information from this catalog product.
ns:ItemSpecifics	ns:NameValueListArrayType	0..1	A list of name/value pairs that are included in the product's pre-filled Item Specifics.
ns:ReviewCount	xs:int	0..1	The total number of reviews that are available for this product on the eBay Web site.
ns:StockPhotoURL	xs:anyURI	0..1	Fully qualified URL for a stock image (if any) that is associated with the eBay catalog product.
ns:Title	xs:string	0..1	The title of the product, as specified in the catalog.
ns:ProductState	ns:ProductStateCodeType	0..1	Indicates that the product has changed or will soon change (usually due to a migration from one catalog to another catalog).
any		0..*

Referenced By

• Element ns:Product [type FindProductsResponseType]

Description

Container for a list of categories.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Category	ns:CategoryType	0..*	Contains details about a category.

Referenced By

• Element ns:CategoryArray [type GetCategoryInfoResponseType]

• Element ns:CategoryHistogram [type FindItemsAdvancedResponseType]

Description

Contains details about a category.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:CategoryID	xs:string	0..1	The numeric ID of a category on eBay.
ns:CategoryLevel	xs:int	0..1	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 2 levels below the root category.
ns:CategoryName	xs:string	0..1	Display name of the category as it would appear on the eBay Web site.
ns:CategoryParentID	xs:string	0..1	Category ID identifying a category that is an ancestor of the category indicated in CategoryID.
ns:CategoryParentName	xs:string	0..1	Display name of the category indicated in CategoryParentID.
ns:ItemCount	xs:int	0..1	The total quantity of matching items in the category.
ns:CategoryNamePath	xs:string	0..1
ns:CategoryIDPath	xs:string	0..1
ns:LeafCategory	xs:boolean	0..1	If true, indicates that the category indicated in CategoryID is a leaf category, in which items may be listed (if the category is not also expired or virtual).
any		0..*

Referenced By

• Element ns:Category [type CategoryArrayType]

Description

Identifies a Giving Works listing and benefiting nonprofit charity organization.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:CharityID	xs:string	0..1	A unique identification number assigned by eBay to registered nonprofit charity organizations.
ns:CharityName	xs:string	0..1	The name of the benefiting nonprofit charity organization selected by the charity seller.
ns:CharityNumber	xs:int	0..1	A unique identification number assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works.
ns:DonationPercent	xs:float	0..1	The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization.
ns:Mission	xs:string	0..1	The stated mission of the nonprofit charity organization.
ns:LogoURL	xs:string	0..1	The URL of the nonprofit charity organization.
ns:CharityListing	xs:boolean	0..1	If true, indicates that the seller has chosen to use eBay Giving Works to donate a percentage of the item's purchase price to a selected nonprofit organization.
ns:Status	ns:CharityStatusCodeType	0..1	The status of the nonprofit charity organization.
any		0..*

Referenced By

• Element ns:Charity [type SimpleItemType]

Remarks

Currently supported through the US and eBay Motors sites only. The Ad Format and Mature Audiences categories are not supported. Not applicable for US eBay Motors, international, Real Estate, and Tickets.

Description

Distance, used for a proximity search.

Derived By

Extending xs:double

Attributes

Name	Type	Required?	Default	Description
ns:unit	xs:string	No

Referenced By

• Element ns:DistanceFromBuyer [type SimpleItemType]

Description

A generic type used for histograms.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Domain	ns:HistogramEntryType	0..*	Each histogram entry shows how many matching products were found in each matching domain.
any		0..*

Referenced By

• Element ns:DomainHistogram [type FindProductsResponseType]

• Element ns:DomainHistogram [type FindHalfProductsResponseType]

Description

A variable that contains specific information about the context of this error.

Derived By

Restricting xs:anyType

Attributes

Name	Type	Required?	Default	Description
ns:ParamID	xs:string	No		The index of the parameter in the error.

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Value	xs:string	0..1	The value of the variable.
any		0..*

Referenced By

• Element ns:ErrorParameters [type ErrorType]

Remarks

For example, if you pass in an attribute set ID that does not match the specified category, the attribute set ID might be returned as an error parameter. Use error parameters to flag fields that users need to correct. Also use error parameters to distinguish between errors when multiple errors are returned.

Description

These are request errors (as opposed to system errors) that occur due to problems with business-level data (e.g., an invalid combination of arguments) that the application passed in.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:ShortMessage	xs:string	0..1	A brief description of the condition that raised the error.
ns:LongMessage	xs:string	0..1	A more detailed description of the condition that raised the error.
ns:ErrorCode	xs:token	0..1	A unique code that identifies the particular error condition that occurred.
ns:UserDisplayHint	xs:boolean	0..1	This field is not currently in use for eBay Shopping Web Services.
ns:SeverityCode	ns:SeverityCodeType	0..1	Indicates whether the error caused the request to fail.
ns:ErrorParameters	ns:ErrorParameterType	0..*	Some warning and error messages return one or more variables that contain contextual information about the error.
ns:ErrorClassification	ns:ErrorClassificationCodeType	0..1	API errors are divided between two classes: system errors and request errors.
any		0..*

Referenced By

• Element ns:Errors [type AbstractResponseType]

Description

Contains an ISBN value, EAN value, UPC value, ticket keywords, or eBay catalog product ID, plus other meta-data.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Value	xs:string	0..1	An industry-standard value that uniquely identifies the product.
ns:ReturnSearchResultOnDuplicates	xs:boolean	0..1	Applicable for listing use cases only (not buy-side searching).
ns:Type	ns:ExternalProductCodeType	0..1	The kind of identifier being used. The choices listed are for requests, are are required if Value is specified. For Half.com listing use cases, only ISBN, UPC, and EAN are supported.
ns:AlternateValue	xs:string	0..*	An industry-standard value that provides an alternate identification for the product, if any.
any		0..*

Remarks

For event tickets, this type can contain a set of keywords that uniquely identify the product. Only applicable to certain categories that support Pre-filled Item Information.

Description

Detailed feedback information for a user.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:CommentingUser	xs:string	0..1	eBay user ID for the user who left the feedback.
ns:CommentingUserScore	xs:int	0..1	Feedback score of the user in CommentingUser.
ns:CommentText	xs:string	0..1	Text message left by the user in CommentingUser.
ns:CommentTime	xs:dateTime	0..1	Date and time (in GMT) that the feedback was submitted to eBay.
ns:CommentType	ns:CommentTypeCodeType	0..1	Type of feedback.
ns:FeedbackResponse	xs:string	0..1	Textual comment that the user targeted by feedback may leave in response or rebuttal to the feedback.
ns:FollowUp	xs:string	0..1	Explanation a user can give to a response.
ns:ItemID	xs:string	0..1	The ID that uniquely identifies the item listing.
ns:Role	ns:TradingRoleCodeType	0..1	Indicates whether the user who was the feedback recipient was a Buyer or the Seller for that transaction.
ns:ItemTitle	xs:string	0..1	Name of the listing for which feedback was provided.
ns:ItemPrice	ns:AmountType	0..1	The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType.
ns:FeedbackID	xs:string	0..1	Unique identifier for the feedback entry.
ns:TransactionID	xs:string	0..1	Unique identifier for the transaction about which this feedback entry was left.
ns:CommentReplaced	xs:boolean	0..1	Indicates whether eBay replaced the comment with a message that the comment was removed.
ns:ResponseReplaced	xs:boolean	0..1	Indicates whether eBay replaced the response with a message that the response was removed.
ns:FollowUpReplaced	xs:boolean	0..1	Indicates whether eBay replaced the follow-up with a message that the follow-up was removed.
ns:Countable	xs:boolean	0..1	Specifies if a user's feedback score is or is not countable.
any		0..*

Referenced By

• Element ns:FeedbackDetails [type GetUserProfileResponseType]

Remarks

Conveys the score for the feedback, the textual comment, and other information.

Description

Specifies all feedback summary information (except Score).

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:BidRetractionFeedbackPeriods	ns:FeedbackPeriodType	0..*	Bid retractions count, for multiple predefined time periods preceding the call.
ns:NegativeFeedbackPeriods	ns:FeedbackPeriodType	0..*	Negative feedback entries count, for multiple predefined time periods preceding the call.
ns:NeutralFeedbackPeriods	ns:FeedbackPeriodType	0..*	Neutral feedback entries count, for multiple predefined time periods preceding the call.
ns:PositiveFeedbackPeriods	ns:FeedbackPeriodType	0..*	Positive feedback entries count, for multiple predefined time periods preceding the call.
ns:TotalFeedbackPeriods	ns:FeedbackPeriodType	0..*	Total feedback score, for multiple predefined time periods preceding the call.
ns:UniqueNegativeFeedbackCount	xs:long	0..1	Total number of negative Feedback comments received by the user, including weekly repeats.
ns:UniquePositiveFeedbackCount	xs:long	0..1	Total number of positive Feedback comments received by the user, including weekly repeats.
ns:AverageRatingDetails	ns:AverageRatingDetailsType	0..*	Container for information about detailed seller ratings (DSRs) that buyers have left for a seller.
ns:NeutralCommentCountFromSuspendedUsers	xs:long	0..1	Number of neutral comments received from suspended users.
ns:UniqueNeutralFeedbackCount	xs:long	0..1	Total number of neutral Feedback comments received by the user, including weekly repeats.
any		0..*

Referenced By

• Element ns:FeedbackHistory [type GetUserProfileResponseType]

Remarks

Contains objects that each convey feedback counts for positive, negative, neutral, and total feedback counts - for various time periods each. Also conveys counts of bid retractions for the predefined time periods.

Description

Contains the data for one type of feedback for one predefined time period.

Derived By

Restricting xs:anyType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:PeriodInDays	xs:int	0..1	Indicates the time period for the feedback count.
ns:Count	xs:long	0..1	Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays.
any		0..*

Referenced By

• Element ns:BidRetractionFeedbackPeriods [type FeedbackHistoryType]

• Element ns:NegativeFeedbackPeriods [type FeedbackHistoryType]

• Element ns:NeutralFeedbackPeriods [type FeedbackHistoryType]

• Element ns:PositiveFeedbackPeriods [type FeedbackHistoryType]

• Element ns:TotalFeedbackPeriods [type FeedbackHistoryType]

Remarks

Parent FeedbackPeriodArrayType object indicates the type of feedback counted: positive, neutral, negative, or total.

Description

Searches Half.com for stock product information (stock description and Item Specifics), such as information about a particular kind of DVD or book.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.
ns:AvailableItemsOnly	xs:boolean	0..1	If true, only retrieve data for products that have been used to pre-fill active listings on the Half.com site. If false, retrieve all products that match the query.
ns:DomainName	xs:string	0..*	A domain to search in.
ns:ProductID	ns:ProductIDType	0..1	Use this to retrieve product details for one specific product. Specify the ID as a string, and use the type attribute to indicate the nature of the ID you are specifying.
ns:QueryKeywords	xs:string	0..1	One or more keywords to search for.
ns:SellerID	xs:string	0..1	The ID of a specific seller.
ns:ProductSort	ns:ProductSortCodeType	0..1	Sorts the list of products returned.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts the list of products returned.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of products to return per page in a single call.
ns:PageNumber	xs:int	0..1	Specifies which page of data to return in the current call.

Referenced By

• Element ns:FindHalfProductsRequest

Remarks

Also, retrieves up to 30 Half.com listings associated with a product.

Description

Returns stock product information in Half.com catalogs, such as information about a particular DVD or book.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:DomainHistogram	ns:DomainHistogramType	0..1	A histogram that lists the number of matching products found and the domains in which they were found.
ns:PageNumber	xs:int	0..1	The number of the page of data returned.
ns:ApproximatePages	xs:int	0..1	The total number of pages that can be returned, given the same query and filters in the request.
ns:MoreResults	xs:boolean	0..1	If true, more pages of results are available. That is, PageNumber is less than ApproximatePages.
ns:TotalProducts	xs:int	0..1	The total number of matching products found. (If more than 2000 products are found, the call fails with an error.)
ns:Products	ns:HalfProductsType	0..1	An set of Half.com catalog products.
ns:ProductSearchURL	xs:anyURI	0..1	A URL for product search results that corresponds to your search request.

Referenced By

• Element ns:FindHalfProductsResponse

Remarks

Optionally, also returns items that match the product.

Description

Searches for items based on a variety of input fields. Enables you to specify what item data is returned. Returns detailed information about items.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.
ns:BidCountMax	xs:int	0..1	Limits the results to items with a maximum number of bids.
ns:BidCountMin	xs:int	0..1	Limits the results to items with a minimum number of bids.
ns:CategoryHistogramMaxParents	xs:int	0..1	Maximum number of matching categories to return at the highest level (root level) of the category hierarchy (level 1).
ns:CategoryHistogramMaxChildren	xs:int	0..1	Maximum number of matching subcategories to return at each level of the category hierarchy below the root level.
ns:QueryKeywords	xs:string	0..1	A query that specifies a string for searching titles of items on eBay.
ns:CategoryID	xs:string	0..1	Specify CategoryID to restrict your query to a specific category.
ns:ItemSort	ns:SimpleItemSortCodeType	0..1	Sorts search results based on the value you specify.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts search results in ascending or descending order, in conjunction with the value you specify in ItemSort.
ns:GroupMaxEntries	xs:int	0..1	GroupMaxEntries is used when you specify that BestMatch search results are grouped by category (by using BestMatchCategoryGroup in the ItemSort field.)
ns:GroupsMax	xs:int	0..1	GroupsMax is used when you specify that BestMatch search results are grouped by category (by using BestMatchCategoryGroup in the ItemSort field.)
ns:EndTimeFrom	xs:dateTime	0..1	Limits the results to items ending within a time range.
ns:EndTimeTo	xs:dateTime	0..1	Limits the results to items ending within a time range.
ns:ModTimeFrom	xs:dateTime	0..1	Limits the results to active items whose status has changed since the specified time.
ns:SellerID	xs:string	0..*	The ID of a specific seller.
ns:SellerIDExclude	xs:string	0..*	Specify this value if you want search results to be filtered so that the items returned do not include items sold by a specific seller or by specific sellers.
ns:ItemType	ns:ItemTypeCodeType	0..1	Filters items based on criteria related to the listing type of items.
ns:MaxDistance	xs:int	0..1	The maximum distance from the postal code specified in the PostalCode field. (The PostalCode field contains the postal code of the buyer.)
ns:PostalCode	xs:string	0..1	The postal code where the buyer is located.
ns:ProductID	ns:ProductIDType	0..1	You can use this input field to search by ISBN, UPC, EAN, or eBay Product Reference ID, as in the following examples. To search using an ISBN, specify ProductID.Type=ISBN and set ProductID.Value to an ISBN value. To search using an eBay Product Reference ID, specify ProductID.Type=Reference and set ProductID.Value to an eBay Product Reference ID value.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of entries to be returned in a single call.
ns:PageNumber	xs:int	0..1	Specifies the number of the page of data to return in the current call.
ns:PriceMax	ns:AmountType	0..1	Specifies the maximum current price an item can have to be included in the response.
ns:PriceMin	ns:AmountType	0..1	Specifies the minimum current price an item listing can have to be included in the searches result set.
ns:Condition	ns:ItemConditionCodeType	0..1	Limits the results to new OR used items (exclusive, not both), plus items that have no condition specified.
ns:CharityID	xs:int	0..1	Limits results to items that support the specified nonprofit charity organization.
ns:SearchFlag	ns:SearchFlagCodeType	0..*	Search for charity listings, free-shipping listings, and listings with other features.
ns:PaymentMethod	ns:PaymentMethodSearchCodeType	0..1	Limits results to items that accept a specific payment method or methods.
ns:StoreName	xs:string	0..1
ns:StoreSearch	ns:StoreSearchCodeType	0..1	Specifies the type of store search used for filtering results.
ns:SellerBusinessType	ns:SellerBusinessCodeType	0..1	Limits the results to those of a particular seller business type such as commercial or private.
ns:Quantity	xs:int	0..1	Limits the results to listings that offer a certain number of items matching the query.
ns:QuantityOperator	ns:QuantityOperatorCodeType	0..1	Limits the results to listings with quantities greater than, equal to, or less than the value you specify in Quantity.
ns:Currency	ns:CurrencyCodeType	0..1	Limits the result set to just those items with a specified currency.
ns:ItemsAvailableTo	ns:CountryCodeType	0..1	Limits the result set to just those items available to the specified country.
ns:ItemsLocatedIn	ns:CountryCodeType	0..1	Limits the result set to just those items located in the specified country.
ns:PreferredLocation	ns:PreferredLocationCodeType	0..1	Specifies the criteria for filtering search results by site, where site is determined by the site ID in the request.
ns:FeedbackScoreMax	xs:int	0..1	Specifies the maximum feedback score of a seller whose items can be included in the response.
ns:FeedbackScoreMin	xs:int	0..1	Specifies the mininum feedback score of a seller whose items can be included in the response.
ns:ExcludeFlag	ns:ExcludeFlagCodeType	0..*	Excludes items with the specified flag from the search.
ns:DescriptionSearch	xs:boolean	0..1	Specifies whether you want to include the item's description in a search.
ns:HideDuplicateItems	xs:boolean	0..1	Specifies whether or not to remove duplicate items from search results.
ns:ShippingLocation	ns:CountryCodeType	0..1	ShippingLocation should be used together with PostalCode for shipping cost calculations.
ns:ShippingPostalCode	xs:string	0..1	This postal code is for international shipping cost calculations.
ns:ItemLocationRegion	ns:ItemLocationRegionCodeType	0..1	Allows you to search for items in a specified region.
ns:CategoryIDExclude	xs:string	0..*	Specify a CategoryIDExclude value in your request if you want search results to be filtered so that the items returned do not include items that belong to the specified category.

Referenced By

• Element ns:FindItemsAdvancedRequest

Remarks

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

Description

Contains the item listings matching your search criteria.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:SearchResult	ns:SearchResultType	0..*	Contains the returned item listings, if any.
ns:PageNumber	xs:int	0..1	Indicates the page of data returned by the current call. For instance, for the first set of items returned, this field has a value of 1.
ns:TotalPages	xs:int	0..1	Indicates the total number of pages of data that could be returned by repeated requests.
ns:TotalItems	xs:int	0..1	Indicates the total number of items that could be returned by repeated requests.
ns:CategoryHistogram	ns:CategoryArrayType	0..1	Statistical (histogram) information about categories that contain items that match the query, if any.
ns:TotalStoresExpansionItems	xs:int	0..1	Total item count for a store expansion of the search.
ns:TotalInternationalExpansionItems	xs:int	0..1	Total item count for an international expansion of the search.
ns:ItemSearchURL	xs:anyURI	0..1	A URL for search results that corresponds to your search request.
ns:DuplicateItems	xs:boolean	0..1	Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.

Referenced By

• Element ns:FindItemsAdvancedResponse

Description

Searches for items based on a query or seller ID. If you use keywords, this call returns items that contain the keywords in the title. A maximum of 50 items is returned.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:QueryKeywords	xs:string	0..1	A query that specifies a string for searching titles of items on eBay.
ns:ItemSort	ns:SimpleItemSortCodeType	0..1	Sorts search results based on the value you specify.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts search results in ascending or descending order, in conjunction with the value you specify in ItemSort.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of entries to return in a single call.
ns:PostalCode	xs:string	0..1	Specifies the postal code where the buyer is located.
ns:SellerID	xs:string	0..*	The ID of a specific seller.
ns:SellerIDExclude	xs:string	0..*	Specify this value if you want search results to be filtered so that the items returned do not include items sold by a specific seller or by specific sellers.
ns:HideDuplicateItems	xs:boolean	0..1	Specifies whether or not to remove duplicate items from search results.

Referenced By

• Element ns:FindItemsRequest

Remarks

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

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:Item	ns:SimpleItemType	0..*	Contains summary data for an item listing.
ns:TotalItems	xs:int	0..1	Indicates the total number of items on eBay that match the query.
ns:ItemSearchURL	xs:anyURI	0..1	A URL equivalent to your FindItems search query.
ns:DuplicateItems	xs:boolean	0..1	Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.

Referenced By

• Element ns:FindItemsResponse

Description

Find popular items

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:CategoryID	xs:string	0..*	Specify CategoryID to restrict your query to a specific category.
ns:QueryKeywords	xs:string	0..1	A query that specifies a string for searching titles of items on eBay.
ns:CategoryIDExclude	xs:string	0..*	Specify this value if you want search results to be filtered so that the popular items returned do not include items that belong to a specific category.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of entries to return in a single call.

Referenced By

• Element ns:FindPopularItemsRequest

Description

Popular items, detail level is default for simple item type. addition with WatchCount.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:ItemArray	ns:SimpleItemArrayType	0..1	A list of active items that were listed with the requested product.

Referenced By

• Element ns:FindPopularItemsResponse

Description

Retrieves the words most frequently used by eBay users when searching for listings.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:CategoryID	xs:string	0..*	Specify CategoryID to restrict your query to a specific category.
ns:QueryKeywords	xs:string	0..*	A query that specifies a string for searching titles of items on eBay.
ns:MaxKeywords	xs:int	0..1	The maximum number of keywords to be retrieved per category for this call.
ns:MaxResultsPerPage	xs:int	0..1	Specifies the maximum number of PopularSearchResults per page in the returned list.
ns:PageNumber	xs:int	0..1	Specifies the number of the page of data to return in the current call.
ns:IncludeChildCategories	xs:boolean	0..1	If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories.

Referenced By

• Element ns:FindPopularSearchesRequest

Remarks

These keywords are generated weekly by eBay. Thus, calls retrieve static data. FindPopularSearches is not available for the following sites: FR, HK, MY, PH, PL, SG, SE.

Description

Contains the keyword data for the requested categories.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:PopularSearchResult	ns:PopularSearchesType	0..*	Returns most popular search words by category.
ns:PageNumber	xs:int	0..1	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.
ns:TotalPages	xs:int	0..1	Indicates the total number of pages of data that could be returned by repeated requests.

Referenced By

• Element ns:FindPopularSearchesResponse

Remarks

A category's data are contained in a CategoryArrayType object if there is no error (one or more CategoryType objects). Returns category data as well as related search data.

Description

Searches for stock product information.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.
ns:AvailableItemsOnly	xs:boolean	0..1	If true, only retrieve data for products that have been used to pre-fill active listings on the specified eBay site. If false, retrieve all products that match the query.
ns:DomainName	xs:string	0..*	A domain to search in.
ns:ProductID	ns:ProductIDType	0..1	Use this to retrieve product details for one specific product.
ns:QueryKeywords	xs:string	0..1	One or more keywords to search for. When you use a keyword search, eBay searches the product catalogs for matching words in the product title, description, and/or Item Specifics, and it returns a list of matching products, with no items.
ns:ProductSort	ns:ProductSortCodeType	0..1	Sorts the list of products returned.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts search results in ascending or descending order. Only applicable with ProductSort.
ns:MaxEntries	xs:int	0..1	Specifies the maximum number of products to return per page in a single call.
ns:PageNumber	xs:int	0..1	Specifies which page of data to return in the current call.
ns:CategoryID	xs:string	0..1	Include a Category ID number in your request to restrict your query to a specific category.
ns:HideDuplicateItems	xs:boolean	0..1	Specifies whether or not to remove duplicate items from search results.

Referenced By

• Element ns:FindProductsRequest

Description

Returns stock product information in eBay catalogs, such as information about a particular DVD or camera. Optionally, also returns items that match the product.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:ApproximatePages	xs:int	0..1	The total number of pages that can be returned, given the same query and filters in the request.
ns:MoreResults	xs:boolean	0..1	If true, more pages of results are available. That is, PageNumber is less than ApproximatePages.
ns:DomainHistogram	ns:DomainHistogramType	0..1	A histogram that lists the number of matching products found and the domains in which they were found.
ns:ItemArray	ns:SimpleItemArrayType	0..1	A list of active items that were listed with the requested product.
ns:PageNumber	xs:int	0..1	The number of the page of data returned.
ns:Product	ns:CatalogProductType	0..*	An eBay catalog product.
ns:TotalProducts	xs:int	0..1	The total number of matching products found. (If more than 2000 products are found, the call fails with an error.)
ns:DuplicateItems	xs:boolean	0..1	Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request.

Referenced By

• Element ns:FindProductsResponse

Description

Splitting include reviews and guides from GetProducts.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:ProductID	ns:ProductIDType	0..1	Use this to retrieve reviews (not guides) for one specific product.
ns:UserID	xs:string	0..1	Retrieves reviews and guides written by the specified user.
ns:CategoryID	xs:string	0..1	Specify a single CategoryID to restrict your query to a specific Guide category.
ns:MaxResultsPerPage	xs:int	0..1	Specifies the maximum number of reviews per page (not guides) in the returned list.
ns:PageNumber	xs:int	0..1	Specifies the number of the page of data to return in the current call.
ns:ReviewSort	ns:ReviewSortCodeType	0..1	Include ReviewSort in your request if you want to sort by a parameter, such as CreationTime.
ns:SortOrder	ns:SortOrderCodeType	0..1	Sorts search results in ascending or descending order, in conjunction with the value you specify in ReviewsSort.

Referenced By

• Element ns:FindReviewsAndGuidesRequest

Description

Find reviews and guides response type.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:ReviewCount	xs:int	0..1	Number of returned reviews.
ns:BuyingGuideCount	xs:int	0..1	Number of returned buying guides.
ns:ReviewerRank	xs:int	0..1	Rank of reviewer if using user search.
ns:TotalHelpfulnessVotes	xs:int	0..1	Number of helpfulness votes if using user search.
ns:ProductID	ns:ProductIDType	0..1	The eBay or external IDs associated with the product.
ns:ReviewsAndGuidesURL	xs:anyURI	0..1	URL to the reviews and guides page.
ns:PageNumber	xs:int	0..1	The number of the page of data returned.
ns:TotalPages	xs:int	0..1	Indicates the total number of pages of data that could be returned by repeated requests.
ns:BuyingGuideDetails	ns:BuyingGuideDetailsType	0..1	Contains information for up to 5 buying guides that match the query.
ns:ReviewDetails	ns:ReviewDetailsType	0..1	Contains information about review details.
ns:PositiveHelpfulnessVotes	xs:int	0..1	Number of helpfulness votes if using user search.

Referenced By

• Element ns:FindReviewsAndGuidesResponse

Description

This call will give you the ability to retrieve high level Category information, relevant for a buy-side application.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:CategoryID	xs:string	0..1	Use an ID of -1 to retrieve the root category and the top-level (level 1) meta categories.
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.

Referenced By

• Element ns:GetCategoryInfoRequest

Description

Contains the category data for the eBay site specified as input.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:CategoryArray	ns:CategoryArrayType	0..1	List of the returned categories.
ns:CategoryCount	xs:int	0..1	Indicates the number of categories returned (i.e., the number of CategoryType objects in CategoryArray).
ns:UpdateTime	xs:dateTime	0..1	Indicates the last date and time that eBay modified the category hierarchy for the specified eBay site.
ns:CategoryVersion	xs:string	0..1	Indicates the version of the category hierarchy on the specified eBay site.

Referenced By

• Element ns:GetCategoryInfoResponse

Remarks

The category data is returned as a CategoryArrayType object, that contains zero, one, or multiple CategoryType objects. Each CategoryType object contains the detail data for one category. Other fields indicate how many categories are returned in a call, when the category hierarchy was last updated, and the version of the category hierarchy (all three of which can differ from one eBay site to the next).

Description

Gets the official eBay system time in GMT.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*

Referenced By

• Element ns:GeteBayTimeRequest

Description

The Timestamp field indicates the official eBay system time in GMT.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*

Referenced By

• Element ns:GeteBayTimeResponse

Remarks

The value returned represents the date and time when eBay processed the request. The value is in the ISO 8601 date-time format (YYYY-MM-DDTHH:MM:SS.SSSZ).

Description

Contains a single ItemID or an array of ItemIDs.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:ItemID	xs:string	0..*	The item ID that uniquely identifies the item listing for which to retrieve the data.

Referenced By

• Element ns:GetItemStatusRequest

Description

Returns status information for all items in a list.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:Item	ns:SimpleItemType	0..*	Collection of Item status objects in an SimpleItemArrayType object, that can include zero, one, or multiple ItemType objects.

Referenced By

• Element ns:GetItemStatusResponse

Remarks

Some of the Item information is returned in an SimpleItemArrayType object, that can include zero, one, or multiple ItemType objects.

Description

Retrieves publicly available data for one or more listings.

Derived By

Extending ns:AbstractRequestType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:MessageID	xs:string	0..1	If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any		0..*
ns:ItemID	xs:string	0..*
ns:IncludeSelector	xs:string	0..1	Defines standard subsets of fields to return within the response.

Referenced By

• Element ns:GetMultipleItemsRequest

Remarks

Use this call to retrieve much of the information that is visible on a listing's View Item page on the eBay Web site, such as title, prices, and basic shipping costs. Provide ItemID for every item for which you want information. This call returns the same minimal information that is returned by GetSingleItem, for each item with no IncludeSelector specified. (Use GetShippingCosts to retrieve more detailed shipping cost information for a given item.) Duplicated items are returned as a single item.

Description

Response to request of GetMultipleItems.

Derived By

Extending ns:AbstractResponseType

Content Model

Contains elements as defined in the following table.

Component	Type	Occurs	Description
		1..1
ns:Timestamp	xs:dateTime	0..1	This value represents the date and time when eBay processed the request.
ns:Ack	ns:AckCodeType	0..1	Indicates whether the call was successfully processed by eBay.
ns:Errors	ns:ErrorType	0..*	A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build	xs:string	0..1	This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version	xs:string	0..1	The release version that eBay used to process the request.
ns:CorrelationID	xs:string	0..1	If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any		0..*
ns:Item	ns:SimpleItemType	0..*	Contains details for a listing (or multiple) listings that correspond to the item ID(s) specified in the request.

Referenced By

• Element ns:GetMultipleItemsResponse