Trading API883

DetailLevelCodeType ( token )

Specifies standard subsets of data to return for each result within the set of results in the response payload. If no detail level is specified, a base set of data is returned. The base set of data varies per call.

Types that use DetailLevelCodeType:

Calls that use one or more enumerations of DetailLevelCodeType:

Enumeration Values

Value Description Which calls use this value *
ItemReturnAttributes For GetItem, returns Item Specifics and Pre-filled Item Information, if any. For GetSearchResults, only returns Item Specifics (if any) that are applicable to search results, and only under certain conditions. See the description of Item.AttributeSetArray for details about the effects for applicable calls. Also see the description of Item.ProductListingDetails for GetItem. GetItem, GetSellingManagerTemplates
ItemReturnCategories For the GetSearchResults call, returns the primary category and, if applicable, the secondary category (not used by any call)
ItemReturnDescription Returns Description, plus the ListingDesigner node and some additional information if applicable GetItem, GetItemTransactions, GetOrderTransactions, GetSellerList, GetSellerTransactions, GetSellingManagerTemplates
ReturnAll Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. GetAdFormatLeads, GetBestOffers, GetCategories, GetCategory2CS, GetCategoryFeatures, GetCategoryMappings, GetFeedback, GetItem, GetItemTransactions, GetMyeBayBuying, GetMyeBaySelling, GetOrders, GetOrderTransactions, GetSellerEvents, GetSellerList, GetSellerTransactions, GetSellingManagerTemplates, GetTaxTable, GetUser, GetUserDisputes
ReturnHeaders Returns message headers. For GetMyMessages, if you include MessageIDs or AlertIDs in the request, this detail level returns header information, without body text, for the specified message ID or alert ID values. If you include a FolderID, header information is returned only for the messages and alerts in the specified folder. If you do not include MessageIDs or AlertIDs, this detail level returns header information for Alerts and Messages as follows: - If all the Alerts have been read, they are sorted in date order, with the most recent first. - If one of the Alerts has not been read, the Read Alerts come first, sorted most recent first, followed by the Unread Alert(s). - All messages in ascending order by date received with the oldest messages first. Note that even when restricted by this detail level to return only header information, GetMyMessages may return a high volume of data. GetMyMessages
ReturnMessages Returns full message information. For GetMyMessages, if you include MessageIDs or AlertIDs in the request, this detail level returns message information for the specified message ID or alert ID values. If you include a FolderID, message information is returned only for the messages and alerts in the specified folder. GetMyMessages
ReturnSummary Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See "GetMyMessages" in the eBay Web Services Guide for a code sample that demonstrates this. GetCategoryFeatures, GetMyeBayBuying, GetMyeBaySelling, GetMyMessages, GetUser, GetUserDisputes
  * See the Enumeration Index to see exact use of each enumeration value in the API.

Copyright © 2005–2014 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.