eBay Versioning Strategy

Base type definition of the request payload, which can carry any type of payload content plus optional versioning information and detail level requirements. 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 If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response. If you're making a lot of calls, you can use this for tracking that a response is returned for every request and to match particular responses to particular requests. (In this case, specify a different value for each request.) You can specify any value that is useful to you. No 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 This value represents the date and time when eBay processed the request. The time zone of this value is <a href="types/simpleTypes.html#dateTime">GMT</a> and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about this time format and converting to and from the GMT time zone. Always Indiates whether the call was successfully processed by eBay. Always PartialFailure A list of application-level errors or warnings (if any) that were raised when eBay processed the request. Application-level errors occur due to problems with business-level data on the client side or on the eBay server side. For example, an error would occur if the request contains an invalid combination of fields, or it is missing a required field, or the value of the field is not recognized. An error could also occur if eBay encountered a problem in our internal business logic while processing the request. Only returned if there were warnings or errors. Conditionally This refers to the particular software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. Always The release version that eBay used to process the request. Note: This is usually the latest release version, as specified in the release notes. (eBay releases the API to international sites about a week after we release it to the US site.) If a field in the response returns the token "CustomCode", it usually means that the field is a code type (a token or enumeration), and that in your request URL (or HTTP header) you specified a version that is older than the version in which the token was added to the call. Always eBay Versioning Strategy http://developer.ebay.com/DevZone/XML/docs/HowTo/eBayWS/eBaySchemaVersioning.html If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. Only returned if MessageID was used. Conditionally AckCodeType - Type declaration to be used by other schema. This code identifies the acknowledgement code types that eBay could use to communicate the status of processing a (request) message to an application. This code would be used as part of a response message that contains an application-level acknowledgement element. (out) Request processing succeeded (out) Request processing failed (out) Request processing completed with warning information being included in the response message (out) Request processing completed with some failures. See the Errors data to determine which portions of the request failed. (out) Reserved for internal or future use. An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. (out) Reserved for internal or future use. A variable that contains specific information about the context of this error. 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. The value of the variable. Conditionally The index of the parameter in the error. Conditionally 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. A brief description of the condition that raised the error. Conditionally Errors by Number Errors/ErrorMessages.html A more detailed description of the condition that raised the error. Conditionally Errors by Number Errors/ErrorMessages.html A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. Conditionally Errors by Number Errors/ErrorMessages.html This field is not currently in use for eBay Shopping Web Services. Indicates whether the error message text is intended to be displayed to an end user or intended only to be parsed by the application. If true or not present (the default), the message text is intended for the end user. If false, the message text is intended for the application, and the application should translate the error into a more appropriate message. Indicates whether the error caused the request to fail. If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay. If the source of the problem is on eBay's side, you can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form. When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future. Conditionally Errors by Number Errors/ErrorMessages.html Requirements for Error Handling http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ErrorHandlingGuidelines more information (in the eBay Trading Web Services guide) Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. You can usually predict where these will occur by looking at the "replaceable_value" indicators in our Errors by Number page. Conditionally Errors by Number Errors/ErrorMessages.html API errors are divided between two classes: system errors and request errors. Conditionally Errors by Number Errors/ErrorMessages.html SeverityCodeType - Type declaration to be used by other schema. This code identifies the severity of an API error. A code indicates whether there is an API- level error or warning that needs to be communicated to the client. (out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning. (out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data. (out) Reserved for internal or future use Basic type for specifying monetary amounts. 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. Currency in which the monetary amount is specified. See CurrencyCodeType for applicable values. INR, CAD, HKD, AUD, CHF, MYR, EUR, PHP, PLN, USD, SGD, SEK, GBP GetShippingCosts Conditionally GetSingleItem Conditionally FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: Details

FindItemsAdvanced No Applicable to sites that support the Detailed Seller Ratings feature. 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. The area of a specific average detailed seller rating. Users retrieve detailed ratings as averages of the ratings left by buyers. 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. GetUserProfile

IncludeSelector: FeedbackHistory

Always An average detailed seller rating applying to the area in the corresponding RatingDetail field. GetUserProfile

IncludeSelector: FeedbackHistory

Always The number of detailed seller ratings in the area in the corresponding RatingDetail field. GetUserProfile

IncludeSelector: FeedbackHistory

Always Identifies payment methods used by a buyer to pay a seller. On item listings, identifies one of the payment methods seller will accept for the item. Available payment methods can differ by site and item. Payment methods are not applicable to eBay Real Estate ad format listings. No payment method specified. For example, no payment methods would be specified for Ad format listings. Money order/cashiers check. Not applicable to US/CA eBay Motors listings. American Express. Not applicable to US/CA eBay Motors listings. Payment instructions are contained in the item's description. Credit card. Not applicable to Real Estate or US/CA eBay Motors listings. Personal check. Cash on delivery. Only applicable to the following eBay sites: AT (16), BEFR (24), BENL (123), CH (193), DE (77), ES (186), FR (71), HK (201), IN (203), IT (101), PL (212), and SG (216). Not applicable to Real Estate listings. Visa/Mastercard. These qualify as safe payment methods. Not applicable to US/CA eBay Motors listings. PaisaPay (for India site only). This qualifies as a safe payment method. Other forms of payment. Not applicable to US/CA eBay Motors listings (see PaymentSeeDescription instead). PayPal is accepted as a payment method. This qualifies as a safe payment method. If PayPal is specified for US/CA eBay Motors vehicles, it is for the vehicle deposit (not for purchasing the vehicle). Discover card. Not applicable to US/CA eBay Motors listings. Payment on delivery. Not applicable to Real Estate or US/CA eBay Motors listings. Direct transfer of money. Not applicable to US/CA eBay Motors listings. If the seller has bank account information on file, and MoneyXferAcceptedInCheckout = true, then the bank account information will be displayed in Checkout. All other online payments. Not applicable to US/CA eBay Motors listings. Deprecated. Deprecated. Deprecated. Deprecated. Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. Loan check option (applicable only to the US eBay Motors site, except in the Parts and Accessories category, and the eBay Canada site for motors). Cash-in-person option. Applicable only to US and Canada eBay Motors vehicles, (not the Parts and Accessories category). Elektronisches Lastschriftverfahren (direct debit). Only applicable to Express Germany. Information about zero or more buying guides and the site's buying guide hub. 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. Information that identifies a buying guide. A buying guide contains content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. FindReviewsAndGuides Conditionally URL of the buying guide home page for the site being searched. Your application can present this URL as a link. Optionally, you can use a value like "See all buying guides" as the link's display name. FindReviewsAndGuides Always Information that identifies a buying guide. 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. Display name of the buying guide. FindReviewsAndGuides only returns 20 characters, followed by "..." if the name is longer than 20 characters. For the full title, see BuyingGuide.Title instead. FindReviewsAndGuides Conditionally URL for the buying guide. Your application can present this as a link. Use the value of Name or Title as the link's display name. FindReviewsAndGuides Conditionally Identifies the category (if any) that is associated with the buying guide. For FindReviewsAndGuides, this can be a category that is higher or lower in the hierarchy than the category specified in the request. For a matching categories search, you can use this information to determine the order that the buying guides are returned in when multiple guides are found. Optionally, you can use this information to determine where to present the buying guide link in your application. 10 FindReviewsAndGuides Conditionally The title of the buying guide. 55 FindReviewsAndGuides Conditionally The text of the guide. If the guide is longer than 2000 characters, the text is cut off and it ends with "...". See BuyingGuide.URL for a link to the full text of the review. 2000 FindReviewsAndGuides Conditionally The time and date when the guide was posted. FindReviewsAndGuides Conditionally The author's eBay user ID. FindReviewsAndGuides Conditionally Information about an eBay catalog product. The name of the domain in which the product was found. If the product is mapped to multiple domains, eBay returns the most applicable domain (as determined by eBay). Always returned when Product is returned. FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

Fully qualified URL for optional information about the product, such as a movie's description or film credits. This information is hosted through the eBay Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link in product search results so that end users can view additional descriptive details about the product. This is usually always returned when Product is returned, but it may be safest to check for the existence of this field. FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

If true, your application can attempt to display stock photos that are returned. If false, your application should not attempt to display any stock photos that are returned. This recommendation is useful for catalog data related to products like coins, where stock photos are not necessarily applicable or available. An application with a graphical user interface can use this flag to determine when to hide customized stock photo widgets. Always returned when Product is returned. FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

The eBay or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

Total number of listings on the requested eBay site that use stock information from this catalog product. This value can be greater than the number of listings returned in ItemArray. To retrieve more listings, use FindItemsAdvanced. Only returned when you search by ProductID (and you pass Items or Details in IncludeSelector). 0 FindProducts Conditionally

IncludeSelector: Items, Details

A list of name/value pairs that are included in the product's pre-filled Item Specifics. These indicate common aspects or characteristics of the product, such as Publisher (for a book). Also see ProductID for ISBN, UPC, or EAN values, if applicable. This is usually returned. (We are not aware of any cases in which this node is not be returned. However, it may be safest to check for the existence of this node.) FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

The total number of reviews that are available for this product on the eBay Web site. This can be greater than the number of reviews returned by FindProducts. In a future release, we will provide the capability to retrieve details about reviews. Always returned when Product is returned. FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

0 Fully qualified URL for a stock image (if any) that is associated with the eBay catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

The title of the product, as specified in the catalog. Always returned when Product is returned. FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

Container for a list of categories. Contains details about a category. FindItemsAdvanced

IncludeSelector: CategoryHistogram

Conditionally GetCategoryInfo

IncludeSelector: ChildCategories

Always Contains details about a category. The numeric ID of a category on eBay. Use an ID of -1 to retrieve the root category and the top-level (level 1) meta categories. You can determine other CategoryIDs from the response from this call, or from a specific item (retrieved from another call like FindItemsAdvanced or GetSingleItem), or from the eBay website. FindItemsAdvanced

IncludeSelector: CategoryHistogram

Conditionally GetCategoryInfo

IncludeSelector: None, ChildCategories

Always 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. Note that the value of CategoryLevel will always be 1 level below the level of the requested category. To retrieve a category's children, pass its CategoryID back into the request. In the FindItemsAdvanced response, ItemCount indicates the total quantity of matching items in the category. In the FindItemsAdvanced response, sibling categories (i.e., matching categories at the same level) are sorted by ItemCount, descending order. FindItemsAdvanced

IncludeSelector: CategoryHistogram

Conditionally GetCategoryInfo

IncludeSelector: None, ChildCategories

Always Display name of the category as it would appear on the eBay Web site. FindItemsAdvanced

IncludeSelector: CategoryHistogram

Conditionally GetCategoryInfo

IncludeSelector: None, ChildCategories

Always Category ID identifying a category that is an ancestor of the category indicated in CategoryID. FindItemsAdvanced

IncludeSelector: CategoryHistogram

Conditionally GetCategoryInfo

IncludeSelector: None, ChildCategories

Always Display name of the category indicated in CategoryParentID. FindItemsAdvanced

IncludeSelector: CategoryHistogram

Conditionally GetCategoryInfo

IncludeSelector: None, ChildCategories

Conditionally The total quantity of matching items in the category. In the FindItemsAdvanced response, matching categories at the same level (i.e., sibling categories) are sorted by ItemCount. That is, if the request specifies that fewer categories or subcategories should be returned, the ones with the most matching items are returned first. FindItemsAdvanced

IncludeSelector: CategoryHistogram

Conditionally The fully qualified category display name as it would appear on the eBay site (e.g., Home & Garden:Kitchen:Tools & Gadgets). GetCategoryInfo

IncludeSelector: None, ChildCategories

Always The fully qualified category ID (e.g., 11700:20625:20635 for Home & Garden:Kitchen:Tools & Gadgets). GetCategoryInfo

IncludeSelector: None, ChildCategories

Always 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). GetCategoryInfo

IncludeSelector: None, ChildCategories

Always CharityStatusCodeType - Type declaration to be used by other schema. Indicates the nonprofit status of the nonprofit charity organization registered with the dedicated eBay Giving Works provider. (out) The specified nonprofit charity organization is a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider. (out) The specified nonprofit charity organization is no longer a valid nonprofit charity organization according to the requirements of the dedicated eBay Giving Works provider. (out) Reserved for internal or future use. Identifies a Giving Works listing and benefiting nonprofit charity organization. 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. GetSingleItem Conditionally

IncludeSelector: Details

A unique identification number assigned by eBay to registered nonprofit charity organizations. GetSingleItem Conditionally

IncludeSelector: Details

The name of the benefiting nonprofit charity organization selected by the charity seller. GetSingleItem Conditionally

IncludeSelector: Details

A unique identification number assigned to a nonprofit charity organization by the dedicated provider of eBay Giving Works. Being superseded by CharityID. Max 10 digits. GetSingleItem Conditionally

IncludeSelector: Details

The percentage of the purchase price that the seller chooses to donate to the selected nonprofit organization. This percentage is displayed in the Giving Works item listing. Possible values: 10.0 to 100.0. Percentages must increment by 5.0. Minimum donation percentages may be required for Giving Works listings, see http://pages.ebay.com/help/sell/selling-nonprofit.html for details. DonationPercent is required input when listing Giving Works items. GetSingleItem Conditionally

IncludeSelector: Details

The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing. GetSingleItem Conditionally

IncludeSelector: Details

The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing. GetSingleItem Conditionally

IncludeSelector: Details

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. The status of the nonprofit charity organization. GetSingleItem Conditionally

IncludeSelector: Details

CommentTypeCodeType - Type declaration to be used by other schema. These are the possible codes to specify the types of feedback/comment. Additional information about feedback is available in the online Help of the eBay site. (in/out) Positive feedback. Increases total feedback score. (in/out) Neutral feedback. No effect on total feedback score. (in/out) Negative feedback. Decreases total feedback score. (out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. (out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. (out) Reserved for internal or future use. Defines the standard 2-letter ISO 3166 country code set, plus some additional country codes that eBay uses. (The additional codes appear at the end of this code list and are noted as non-ISO.) For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site: http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html French Polynesia. Includes Tahiti. NOTE: APO/FPO was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country code list for backward compatibility. NOTE: Guernsey was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Jan Mayen was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Jersey was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. NOTE: Tahiti was defined in eBay list previously but they are not defined in ISO 3166. This country will remain on eBay country list for backward compatibility. This Code is currently deprecated Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. Defines the standard 3-letter ISO 4217 currency code set. However, only certain currency codes are currently valid for use on eBay. The valid codes are documented below with the notation "(in/out)". Other codes in this list are for future use. The documentation below specifies English names for each currency. A reference: http://www.xe.com/iso4217.htm Indian Rupee. Applicable to listings on the India site (site ID 203). Canadian Dollar. Applicable to listings on the Canada site (site ID 2) (Items listed on the Canada site can also specify USD.) Chinese Yuan Renminbi. Hong Kong Dollar. Applicable to listings on the Hong Kong site (site ID 201). Australian Dollar. Applicable to listings on the Australia site (site ID 15). Swiss Franc. Applicable to listings on the Switzerland site (site ID 193). Malaysian Ringgit. Applicable to listings on the Malaysia site (site ID 207). Euro. Applicable to listings on these site: Austria (site 16), Belgium_French (site 23), France (site 71), Germany (site 77), Italy (site 101), Belgium_Dutch (site 123), Netherlands (site 146), Spain (site 186), Ireland (site 205). Philippines Peso. Applicable to listings on the Philippines site (site ID 211). Poland, Zloty. Applicable to listings on the Poland site (site ID 212). US Dollar. Applicable to listings on the US (site ID 0), eBayMotors (site 100), and Canada (site 2) sites. Singapore Dollar. Applicable to listings on the Singapore site (site 216). Swedish Krona. Applicable to listings on the Sweden site (site 218). New Taiwan Dollar. Pound Sterling. Applicable to listings on the UK site (site ID 3). Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. The item cannot be downloaded. The item can be downloaded by using a URL. The item can be downloaded according to instructions specified by the seller. Distance, used for a proximity search. A generic type used for histograms. Each histogram entry shows how many matching products were found in each matching domain. A domain is like a high-level category, or a group of categories whose items share the same basic product characteristics. FindHalfProducts Conditionally

IncludeSelector: DomainHistogram

FindProducts Conditionally

IncludeSelector: DomainHistogram

Indicates the type of external product ID being used to identify a stock product. (in/out) ExternalProductID.Value contains an ISBN value. Required when you pass an ISBN as the external product ID. (This value is also applicable to Half.com listings.) (in/out) ExternalProductID.Value contains a UPC value. Required when you pass a UPC as the external product ID. (This value is also applicable to Half.com listings.) (in) ExternalProductID.Value contains an eBay catalog product ID. Required when you pass an eBay product ID as the external product ID. Not applicable with FindItemsAdvanced, FindItemsAdvancedExpress, or FindProducts. ExternalProductID.Value contains an EAN value. Required when you pass an EAN as the external product ID. Not applicable with FindItemsAdvancedExpress. (in) ExternalProductID.Value contains a set of keywords that uniquely identify the product. Only applicable when listing event ticket. See the eBay Web Services guide for information about valid ticket keywords for an external product ID. Required when you pass a set of keywords as the external product ID. Not applicable with FindItemsAdvanced, FindItemsAdvancedExpress, or FindProducts. With FindItemsAdvanced, use TicketFinder instead. Reserved for future use. (out) Reserved for internal or future use Contains an ISBN value, EAN value, UPC value, ticket keywords, or eBay catalog product ID, plus other meta-data. 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. An industry-standard value that uniquely identifies the product. The valid values are dictated by the Type property. Required if Type is specified. Max length 13 for ISBN (as of February 2007), 13 for EAN, 12 for UPC, and 4000 for ProductID. No max length for ticket keywords (but passing too much data can result in "no match found" errors). For AddItem and related calls: If the primary and secondary categories are both catalog-enabled, the value must apply to the primary category. Event tickets listings support a set of keywords that uniquely identify the listing. The ticket keywords specify the event name (the title shown on the ticket), venue name, and event date and time. See the eBay Web Services guide for more information and validation rules. For convenience, you can pass an eBay product ID as input (not limited to media categories). Required for Half.com listing use cases, and this can only be an ISBN, UPC, or EAN value. For FindItemsAdvanced and FindProducts input only: Only ISBN, EAN, and UPC values are currently supported as input. For FindItemsAdvancedExpress input only: To pass an external product ID in the request, use ExternalProductIDValue and ExternalProductIDType instead. For FindItemsAdvancedExpress, FindProducts, and GetSellerPayments output only: Also see AlternateValue, which is returned if the catalog defines multiple ISBN values (e.g., one for ISBN-13 and one for ISBN-10). Please note that some catalogs return ISBN values that are not 10 or 13 characters, and some values contain non-alphanumeric symbols (e.g., $). See description AddItem GetItemRecommendations VerifyAddItem Item.ExternalProductID Conditionally FindProducts Conditionally Conditionally FindItemsAdvanced Conditionally GetSellerPayments Conditionally FindItemsAdvancedExpress Conditionally Applicable for listing use cases only (not buy-side searching). Indicates what eBay should do if more than one product matches the value passed in Value. Only takes effect when more than one match is found. If true, the response should include an error and all matching product IDs. If false, the response should include an error but should not return the matching product IDs. This field is also applicable when listing Half.com items. AddItem GetItemRecommendations VerifyAddItem No Item.ExternalProductID The kind of identifier being used. The choices are listed For requests, required if Value is specified. For Half.com listing use cases, only ISBN, UPC, and EAN are supported. FindItemsAdvancedExpress returns this value in ProductArray.Product.ExternalProductID.Type. To pass an external product ID in the request, use ExternalProductIDType and ExternalProductIDValue instead. FindProducts supports ISBN, UPC, and EAN. AddItem GetItemRecommendations VerifyAddItem Item.ExternalProductID MPN Conditionally FindProducts ISBN, UPC, EAN Conditionally Conditionally FindItemsAdvanced ISBN, UPC, EAN Conditionally GetSellerPayments ISBN, UPC, EAN Conditionally FindItemsAdvancedExpress ISBN, UPC Conditionally (FindItemsAdvancedExpress) ExternalProductIDType io_FindItemsAdvancedExpress.html#Request.ExternalProductIDType An industry-standard value that provides an alternate identification for the product, if any. Currently, this only returns an alternate ISBN value. If the catalog defines both an ISBN-13 and ISBN-10, then the ISBN-13 is returned in Value and the ISBN-10 is returned in AlternateValue. (That is, the ISBN-13 is considered to be the preferred identifier.) If the catalog only defines one ISBN, it is returned in Value (and AlternateValue is not returned). Please note that some catalogs return ISBN values that are not 10 or 13 characters, and some values contain non-alphanumeric symbols (e.g., $). 4000 FindProducts FindItemsAdvancedExpress GetSellerPayments Conditionally Detailed feedback information for a user. Conveys the score for the feedback, the textual comment, and other information. eBay user ID for the user who left the feedback. GetUserProfile

IncludeSelector: FeedbackDetails

Always Feedback score of the user in CommentingUser. GetUserProfile

IncludeSelector: FeedbackDetails

Always Text message left by the user in CommentingUser. Used to provide a more in-depth description of the user's opinion of the transaction. Returned as text in the language that the comment was originally left in. GetUserProfile

IncludeSelector: FeedbackDetails

Always Date and time (in GMT) that the feedback was submitted to eBay. GetUserProfile

IncludeSelector: FeedbackDetails

Always Type of feedback. Can be Positive, Neutral, Negative, or Withdrawn (see the CommentTypeCodeType code list). Positive feedbacks add to the user's total feedback score, negative feedbacks lower the score, and neutral feedbacks do not affect the score (but do affect the overall picture of the user's online reputation). GetUserProfile

IncludeSelector: FeedbackDetails

Always Textual comment that the user targeted by feedback may leave in response or rebuttal to the feedback. GetUserProfile

IncludeSelector: FeedbackDetails

Always Explanation a user can give to a response. GetUserProfile

IncludeSelector: FeedbackDetails

Always The ID that uniquely identifies the item listing. GetUserProfile

IncludeSelector: FeedbackDetails

Always Indicates whether the user who was the feedback recipient was a Buyer or the Seller for that transaction. GetUserProfile

IncludeSelector: FeedbackDetails

Always Name of the listing for which feedback was provided. Returned as CDATA. Not returned if a listing ended more than 90 days ago. GetUserProfile

IncludeSelector: FeedbackDetails

Always The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType. Not returned if a listing ended more than 90 days ago. GetUserProfile

IncludeSelector: FeedbackDetails

Always Unique identifier for the feedback entry. GetUserProfile

IncludeSelector: FeedbackDetails

Always Unique identifier for the transaction about which this feedback entry was left. This field is not returned in the case of TransactionIDs from Chinese auction listings, because a value of zero is used for TransactionIDs in such cases. GetUserProfile

IncludeSelector: FeedbackDetails

Always Indicates whether eBay replaced the comment with a message that the comment was removed. GetUserProfile

IncludeSelector: FeedbackDetails

Always Indicates whether eBay replaced the response with a message that the response was removed. GetUserProfile

IncludeSelector: FeedbackDetails

Always Indicates whether eBay replaced the follow-up with a message that the follow-up was removed. GetUserProfile

IncludeSelector: FeedbackDetails

Always Specifies if a user's feedback score is or is not countable. This field is returned only when a user's feedback score is not countable (value is false). GetUserProfile

IncludeSelector: FeedbackDetails

Always Specifies all feedback summary information (except Score). 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. Bid retractions count, for multiple predefined time periods preceding the call. GetUserProfile

IncludeSelector: FeedbackHistory

Always Negative feedback entries count, for multiple predefined time periods preceding the call. GetUserProfile

IncludeSelector: FeedbackHistory

Always Neutral feedback entries count, for multiple predefined time periods preceding the call. GetUserProfile

IncludeSelector: FeedbackHistory

Always Positive feedback entries count, for multiple predefined time periods preceding the call. GetUserProfile

IncludeSelector: FeedbackHistory

Always Total feedback score, for multiple predefined time periods preceding the call. GetUserProfile

IncludeSelector: FeedbackHistory

Always Number of unique negative comments. GetUserProfile

IncludeSelector: FeedbackHistory

Always Number of unique positive comments. GetUserProfile

IncludeSelector: FeedbackHistory

Always Container for information about detailed seller ratings (DSRs) that buyers have left for a seller. Sellers have access to the number of ratings they've received, as well as to the averages of DSRs they've received in each DSR area (i.e., to the average of ratings in the item-description area, etc.). GetUserProfile

IncludeSelector: FeedbackHistory

Always Number of neutral comments received from suspended users. GetUserProfile

IncludeSelector: FeedbackHistory

Always Contains the data for one type of feedback for one predefined time period. Parent FeedbackPeriodArrayType object indicates the type of feedback counted: positive, neutral, negative, or total. Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted. GetUserProfile

IncludeSelector: FeedbackHistory

Always Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays. GetUserProfile

IncludeSelector: FeedbackHistory

Always Applicable to sites that support the Detailed Seller Ratings feature. The FeedbackRatingDetailCodeType is the list of areas for detailed seller ratings. 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. Detailed seller rating in the area of "item as described." Detailed seller rating in the area of "communication." Detailed seller rating in the area of "shipping time." Inapplicable to motor vehicle items. Detailed seller rating in the area of "charges for shipping and handling." Inapplicable to motor vehicle items. (out) Reserved for internal or future use. FeedbackRatingStarCodeType - Type declaration to be used by other schema. The color of a feedback score star visually denotes the range in which the member's summary feedback score falls. The score is the net positive feedback minus the net negative feedback left for the member. No graphic displayed, feedback score 0-9. Yellow Star, feedback score 10-49. Blue Star, feedback score 50-99. Turquoise Star, feedback score 100-499. Purple Star, feedback score 500-999. Red Star, feedback score 1,000-4,999 Green Star, feedback score 5,000-9,999. Yellow Shooting Star, feedback score 10,000-24,999. Turquoise Shooting Star, feedback score 25,000-49,999. Purple Shooting Star, feedback score 50,000-99,999. Red Shooting Star, feedback score 100,000 and above. Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. Searches Half.com for stock product information (stock description and Item Specifics), such as information about a particular kind of DVD or book. Also, retrieves up to 30 Half.com listings associated with a product.

Searches Half.com for stock product information (stock description and Item Specifics), such as information about a particular kind of DVD or book. Also, retrieves up to 30 Half.com listings associated with a product.

IncludeSelector Defines standard subsets of fields to return within the response. If you don't specify this field, the call returns a default set of fields, focusing on product details only (see the "Detail Controls" link below). If you specify this field, the additional fields you retrieve can affect the call's response time (performance). Applicable values: •   Items Include a brief set of item fields in the response. Only applicable when you are searching by ProductID. Not applicable with QueryKeywords. •   DomainHistogram Include the DomainHistogram in the response. The histogram lists the number of matching products found and the domains in which they were found. (A domain is like a high-level category.) When many matching products are found, you may see significantly slower response times when you include the histogram. Use a comma to specify multiple values. (In this case, the results are cumulative.) See "FindHalfProducts Samples" for an example of how to use this field. See "Detail Controls" for a complete list of fields that can be returned for each selector. Yes FindHalfProducts No 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. This is useful when you use QueryKeywords and you only want to find products that have associated items (that is, where ItemArray would not be empty). This does not retrieve ItemArray; this only controls which products are returned (or counted). To retrieve ItemArray, pass Items in IncludeSelector. false FindHalfProducts No A domain to search in. This is like searching a section of a catalog. If not specified, the product search is conducted across all domains. To determine valid domain names, first use this call with QueryKeywords. Domain names are returned for each product (and summarized in the domain histogram, if you specify DomainHistogram in IncludeSelector). A domain is a named grouping of categories whose items share common product characteristics. For example, all bound books have a binding or format (e.g., Hardcover), but audiobooks don't. So audiobooks would have their own domain. To limit your search to audiobooks, you would specify Audiobooks as the domain. Only useful when QueryKeywords is specified. If you use this with ProductID, AND logic is applied. In this case, if you specify an ID that doesn't match the domain (as Half.com has defined it), no matching product will be found. Therefore, we recommend that you only use DomainName with QueryKeywords. FindHalfProducts No 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. You can request up to 10 IDs of the same type by separating them with commas, such as 014633155310,014633145496. The request requires either QueryKeywords or ProductID, but these fields cannot be used together. 4000 FindHalfProducts Conditionally One or more keywords to search for. When you use a keyword search, Half.com 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. To retrieve items, use ProductID instead. (If you don't already have a product ID, you can get product IDs from the response after conducting a keyword search.) If specified, you must pass in at least 3 alphanumeric characters. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for products containing these words. To use AND or OR logic, use Half.com's standard search string modifiers. Wildcards (+, -, or *) are also supported. Be careful when using spaces before or after modifiers and wildcards. Some keyword queries can result in response times of 30 seconds or longer. If more than 2000 matches are found, the call fails with an error. If this kind of error occurs, refine the search by passing in more keywords and/or by using DomainName to restrict the search to certain domains (such as DVDs). If you are searching for a particular book, DVD, CD, or video game and you already know its ISBN or EAN (for a book) or UPC, consider using ProductID instead to retrieve more precise results. The request requires either QueryKeywords or ProductID, but these fields cannot be used together. 350 FindHalfProducts Conditionally The ID of a specific seller. Specify this value in combination with ProductID if you want search results to be filtered so that the items returned are only items in a specific product, sold by a specific seller. To specify SellerID, use SellerID and ProductID together. FindHalfProducts No Sorts the list of products returned. This is mostly only useful with QueryKeywords. (When you use ExternalProductID or ProductReferenceID, Half.com usually only returns one product.) Popularity FindHalfProducts No Sorts the list of products returned. Descending FindHalfProducts No Specifies the maximum number of products to return per page in a single call. This is mostly only useful with QueryKeywords. (When you use ProductID, Half.com usually only returns one product, and up to 30 items for that product.) 1 20 1 FindHalfProducts No Specifies which page of data to return in the current call. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). 1 2000 1 FindHalfProducts No Returns stock product information in Half.com catalogs, such as information about a particular DVD or book. Optionally, also returns items that match the product. A histogram that lists the number of matching products found and the domains in which they were found. A domain is essentially a set of categories that share certain common features (as determined by Half.com). Each domain has its own name and ID. FindHalfProducts

IncludeSelector: DomainHistogram

Conditionally The number of the page of data returned. If many products are found and multiple pages of results are available, use this in combination with ApproximatePages and HasMore to decide which page to retrieve next. As FindHalfProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request). 1 2000 FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Always The total number of pages that can be returned, given the same query and filters in the request. As FindHalfProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set MaxEntries to 1 in the request). 1 2000 FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Always If true, more pages of results are available. That is, PageNumber is less than ApproximatePages. FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Always The total number of matching products found. (If more than 2000 products are found, the call fails with an error.) 0 2000 FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Always An set of Half.com catalog products. This contains stock information about a particular DVD, book, or other product. When you use QueryKeywords in the request, FindHalfProducts returns a maximum of 20 products per page. When you use ProductID in the request, FindHalfProducts usually only returns 1 product. (If more than one product matches the same ProductID, FindHalfProducts will return all of those products. As of the time of this writing, we expect this to be a rare case.) 20 FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Always Searches for items based on a variety of input fields. Enables you to specify what item data is returned. Returns detailed information about items. Searching for Items by Using a Query http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingItemsWithQuery related information (applies primarily to the eBay Trading API) Searching for Matching Categories http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingForMatchingCategories information about finding listings in categories (applies primarily to the eBay Trading API)

Searches for items based on many possible input fields. Detailed information is returned about items.

FindItems, GetSingleItem IncludeSelector Defines standard subsets of fields to return within the response. If you don't specify this field, a default set of fields is returned. Click "Detail Controls" below and see "none" for the default fields. If you specify this field, then the set of fields returned includes the default fields. If you specify this field, the additional fields returned can affect the call's response time (performance), including in the case of feedback data. Applicable values: •   Details Include most available fields in the response (except fields that significantly affect the call's performance). •   SearchDetails Include additional item information in the response. (This can affect the call's performance.) •   SellerInfo Include information about the seller in the response. •   ItemSpecifics Include ItemSpecifics in the response. •   ExpansionItemCount Include the counts of items that would be returned with expansions. •   CategoryHistogram Include a CategoryHistogram container with information about categories that match your search (up to 2 levels). Use a comma to specify multiple values. (In this case, the results are cumulative.) See "FindItemAdvanced Samples" for an example of how to use this field. See "Detail Controls" for a complete list of fields that can be returned for each selector. Yes Detail Controls #detailControls FindItemsAdvanced Samples #samples FindItemsAdvanced No Limits the results to items with a maximum number of bids. FindItemsAdvanced No Limits the results to items with a minimum number of bids. FindItemsAdvanced No Maximum number of matching categories to return at the highest level (root level) of the category hierarchy (level 1). If you specify this field along with a category ID, then the response will contain child categories of the category ID you specify and subcategories for each child category. 10 3 FindItemsAdvanced No Maximum number of matching subcategories to return at each level of the category hierarchy below the root level. If you specify this field along with a category ID, then the response will contain child categories of the category ID you specify and subcategories for each child category. 10 3 FindItemsAdvanced No A query that specifies a string for searching titles of items on eBay. If you are using a URL, then to search for multiple words, use "%20". For example, use Harry%20Potter to search for items containing those words in any order. You can incorporate wildcards into a multi-word search, as in the following: ap*%20ip*. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words. FindItemsAdvanced requires that you specify at least one of the following: QueryKeywords, CategoryID, ProductID, or SellerID. 3 350 (characters) FindItemsAdvanced Conditionally Searching by Keywords http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByKeywords related information (applies primarily to the eBay Trading API) string types/simpleTypes.html#string Specify CategoryID to restrict your query to a specific category. CategoryID cannot be used with the following input fields: EndTimeFrom, EndTimeTo, PriceMin, or PriceMax. If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories: Use the CategoryHistogram value in the IncludeSelector field to retrieve matching categories. Then make another FindItemsAdvanced call with the ID of a matching category. FindItemsAdvanced requires that you specify at least one of the following: QueryKeywords, CategoryID, ProductID, or SellerID. CategoryID can be used in combination with QueryKeywords. If you pass CategoryID without QueryKeywords, CategoryID must be a leaf category ID. That is, it cannot be a root-level ID. 10 FindItemsAdvanced Conditionally Searching by Category ID http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByCategoryID related information (applies primarily to the eBay Trading API) Sorts search results based on the value you specify. See the SortOrder field for values for specifying that results are returned in ascending or descending order. (By default, results are returned in descending order.) EndTime FindItemsAdvanced No Sorts search results in ascending or descending order, in conjunction with the value you specify in ItemSort. The default is descending order. For example, if you specify an ItemSort value of BestMatch, the most relevant items will be returned first, because the default SortOrder value is Descending. If you specify an ItemSort value of EndTime (to sort items by end time), and a SortOrder value of Ascending, then items ending in less time (from the time of the call) are returned before items ending in more time. Descending FindItemsAdvanced No GroupMaxEntries is used when you specify that BestMatch search results are grouped by category (by using BestMatchCategoryGroup in the ItemSort field.) In GroupMaxEntries, you specify the maximum number of entries per group that you want in the search results. There is not a direct correlation between the number of items returned in a regular sort (or in a BestMatch sort) and the number of items that are returned when you specify BestMatchCategoryGroup in the ItemSort field. When you specify BestMatchCategoryGroup in the ItemSort field, not more than 2 pages of results are returned. When you specify GroupMaxEntries, specify GroupsMax. FindItemsAdvanced No GroupsMax is used when you specify that BestMatch search results are grouped by category (by using BestMatchCategoryGroup in the ItemSort field.) In GroupsMax, you specify the maximum number of groups that you want in the search results. There is not a direct correlation between the number of items returned in a regular sort (or in a BestMatch sort) and the number of items that are returned when you specify BestMatchCategoryGroup in the ItemSort field. When you specify BestMatchCategoryGroup in the ItemSort field, not more than 2 pages of results are returned. When you specify GroupsMax, specify GroupMaxEntries. FindItemsAdvanced No Limits the results to items ending within a time range. EndTimeFrom specifies the beginning of the time range. Specify a time in the future. If you specify a time in the past, the current time is used. If specified, EndTimeTo must also be specified (with a value equal to or later than EndTimeFrom). Specify the time in GMT. Cannot be used with the ModTimeFrom filter. FindItemsAdvanced Conditionally Limits the results to items ending within a time range. EndTimeTo specifies the end of the time range. If specified, EndTimeFrom must also be specified (with a value equal to or earlier than EndTimeTo). Specify the time in GMT. Cannot be used with the ModTimeFrom filter. FindItemsAdvanced Conditionally Limits the results to active items whose status has changed since the specified time. Specify a time in the past. Time must be in GMT. Cannot be used with the EndTime filters. FindItemsAdvanced No The ID of a specific seller. Specify this value if you want search results to be filtered so that the items returned are only items sold by a specific seller or by specific sellers. SellerID is an unbounded field. If you are using a URL, and you want to specify multiple values, use a comma. For example, to specify FavSellerBlue and FavSellerGreen, specify SellerID=FavSellerBlue,FavSellerGreen. FindItemsAdvanced requires that you specify at least one of the following: QueryKeywords, CategoryID, ProductID, or SellerID. If you want Store Inventory format (StoresFixedPrice) items to be returned, you must also specify the AllItemTypes value in the ItemType field. The value you specify in SellerID is ignored if it is invalid. You can specify a maximum of 100 sellers. FindItemsAdvanced No 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. The SellerIDExclude input field need not be used if you specified the SellerID input field. SellerIDExclude is an unbounded field. If you are using a URL, and you want to specify multiple values, use a comma. For example, if you want to specify FavSellerBlue and FavSellerGreen, specify SellerIDExclude=FavSellerBlue,FavSellerGreen. You can specify a maximum of 100 sellers. FindItemsAdvanced No Filters items based on criteria related to the listing type of items. FindItemsAdvanced No The maximum distance from the item-location value you specify in PostalCode. FindItemsAdvanced No The postal code where an item is located. FindItemsAdvanced No 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. If you do not know the eBay Product Reference ID of a product, use FindProducts to retrieve the desired eBay Product Reference ID. FindItemsAdvanced requires that you specify at least one of the following: QueryKeywords, CategoryID, ProductID, or SellerID. If you use the ProductID field, do not use QueryKeywords, CategoryID, or SellerID. FindItemsAdvanced No Specifies the maximum number of entries to return in a single call. If the number of available items is less than the value you specify, the lower number is returned. If you want the response to contain only the total number of items matching the query, specify a MaxEntries value of 0. 20 100 FindItemsAdvanced No Specifies the number of the page of data to return in the current call. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). 1 FindItemsAdvanced No Specifies the maximum current price an item can have to be included in the response. Specified as in the following URL snippet: PriceMax.Value=500. Optionally, you can also specify a currency ID, e.g., as part of a URL, PriceMax.currencyID=EUR. Use PriceMax to specify a maximum price or use PriceMax with PriceMin to specify a price range. FindItemsAdvanced No Specifies the minimum current price an item listing can have to be included in the searches result set. Use alone to specify a minimum price or with MaxPrice to define a range the items' prices must be. Specified as in the following URL snippet: PriceMin.Value=400. Optionally, you can also specify a currency ID, e.g., as part of a URL, PriceMin.currencyID=EUR. FindItemsAdvanced No Limits the results to new or used items, plus items that have no condition specified. Matches the new or used condition that the seller specified in the Item Specifics section of the listing. (That is, this won't specifically match on items where the seller only put the word "New" in the listing's title.) Only applicable to the following sites: United Kingdom (UK, site ID 3), Australia (AU, site ID 15), Germany (DE, site ID 77), and India (IN, site ID 203). FindItemsAdvanced No Limits results to items that support the specified nonprofit charity organization. FindItemsAdvanced No Search for charity listings, items with free shipping, and other features. FindItemsAdvanced No Limits results to items that accept a specific payment method or methods. FindItemsAdvanced No The name of the eBay Store in which the item is listed (case sensitive). FindItemsAdvanced No Specifies the type of store search used for filtering results. FindItemsAdvanced No Limits the results to those of a particular seller business type such as commercial or private. FindItemsAdvanced No Limits the results to listings that offer a certain number of items matching the query. The Quantity field is used with QuantityOperator to specify that you are seeking listings with quantities greater than, equal to, or less than the value you specify in Quantity. FindItemsAdvanced No Limits the results to listings with quantities greater than, equal to, or less than the value you specify in Quantity. FindItemsAdvanced No Limits the result set to just those items with a specified currency. FindItemsAdvanced No Limits the result set to just those items available to the specified country. FindItemsAdvanced No Limits the result set to just those items located in the specified country. FindItemsAdvanced No Specifies the criteria for filtering search results by site, where site is determined by the site ID in the request. FindItemsAdvanced No Contains the item listings matching your search criteria. Contains the returned item listings, if any. The data for each listing is returned in an Item container. FindItemsAdvanced

IncludeSelector: none, Details, SearchDetails, ItemSpecifics, SellerInfo, ExpansionItemCount, CategoryHistogram

Conditionally 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 1. FindItemsAdvanced

IncludeSelector: none, Details, SearchDetails, ItemSpecifics, SellerInfo, ExpansionItemCount, CategoryHistogram

Always Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available. FindItemsAdvanced

IncludeSelector: none, Details, SearchDetails, ItemSpecifics, SellerInfo, ExpansionItemCount, CategoryHistogram

Always Indicates the total number of items that could be returned by repeated requests. Returned with a value of 0 if no items match your search request. FindItemsAdvanced

IncludeSelector: none, Details, SearchDetails, ItemSpecifics, SellerInfo, ExpansionItemCount, CategoryHistogram

Always Statistical (histogram) information about categories that contain items that match the query, if any. For categories associated with specific items, see items returned in each search result. Shows the distribution of items across each category. Not returned if there is no match. FindItemsAdvanced

IncludeSelector: CategoryHistogram

Conditionally Total item count for a store expansion of the search. FindItemsAdvanced

IncludeSelector: ExpansionItemCount

Conditionally Total item count for an international expansion of the search. FindItemsAdvanced

IncludeSelector: ExpansionItemCount

Conditionally A URL for search results that corresponds to your search request. FindItemsAdvanced

IncludeSelector: none, Details, SearchDetails, ItemSpecifics, SellerInfo, ExpansionItemCount, CategoryHistogram

Conditionally Searches for items based 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.

Searches for items based 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.

FindItemsAdvanced, GetSingleItem, GetItemStatus, GetShippingCosts A query that specifies a string for searching titles of items on eBay. If you are using a URL, then to search for multiple words, use "%20". For example, use Harry%20Potter to search for items containing those words in any order. You can incorporate wildcards into a multi-word search, as in the following: ap*%20ip*. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words. FindItems requires that you specify either QueryKeywords, SellerID, or both. 350 (characters) FindItems Conditionally string types/simpleTypes.html#string Sorts search results based on the value you specify. See the SortOrder field for values for specifying that results are returned in ascending or descending order. (By default, results are returned in descending order.) EndTime FindItems No Sorts search results in ascending or descending order, in conjunction with the value you specify in ItemSort. The default is descending order. For example, if you specify an ItemSort value of BestMatch, the most relevant items will be returned first, because the default SortOrder value is Descending. If you specify an ItemSort value of EndTime (to sort items by end time), and a SortOrder value of Ascending, then items ending in less time (from the time of the call) are returned before items ending in more time. Descending FindItems No Specifies the maximum number of entries to return in a single call. If the number of entries that can be returned is less than the value you specify, the lower number is returned. 50 3 FindItems No Specifies the postal code where the buyer is located. FindItems No The ID of a specific seller. Specify this value if you want search results to be filtered so that the items returned are only items sold by a specific seller or by specific sellers. SellerID is an unbounded field. If you are using a URL, and you want to specify multiple values, use a comma. For example, to specify FavSellerBlue and FavSellerGreen, specify SellerID=FavSellerBlue,FavSellerGreen. The value you specify in SellerID is ignored if it is invalid. You can specify a maximum of 100 sellers. FindItems Conditionally 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. The SellerIDExclude input field need not be used if you specified the SellerID input field. SellerIDExclude is an unbounded field. If you are using a URL, and you want to specify multiple values, use a comma. For example, if you want to specify FavSellerBlue and FavSellerGreen, specify SellerIDExclude=FavSellerBlue,FavSellerGreen. You can specify a maximum of 100 sellers. FindItems No Contains summary data for an item listing. FindItems Conditionally Indicates the total number of items on eBay that match the query. FindItems Always A URL equivalent to your FindItems search query. FindItems returns a maximum of 50 items, so you can use the value in ItemSearchURL to provide users with a link for viewing more items. FindItems Conditionally Find popular items

Searches for popular items based on a category or keyword. Returns WatchCount in addition to item information.

FindPopularSearches Specify CategoryID to restrict your query to a specific category. Up to 10 categories may be specified. If you are using a URL, and you want to specify more than one CategoryID, separate the values with a comma. For example, to specify Fiction Books and Children's Books, specify CategoryID=377,279. If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories: Use the FindItemsAdvanced CategoryHistogram value in the IncludeSelector field to retrieve matching categories. Then make another FindItemsAdvanced call with the ID of a matching category. CategoryID can be used in combination with QueryKeywords and CategoryIDExclude. To retrieve the most popular items across all categorys, do not submit a CategoryID. 10 FindPopularItems No A query that specifies a string for searching titles of items on eBay. If you are using a URL, then to search for multiple words, use "%20". For example, use Harry%20Potter to search for items containing those words in any order. You can incorporate wildcards into a multi-word search, as in the following: ap*%20ip*. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words. QueryKeywords can be used in combination with CategoryID and CategoryIDExclude. 3 350 (characters) FindPopularItems No Searching by Keywords http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByKeywords 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. CategoryIDExclude is an unbounded field. If you are using a URL, you can separate multiple values with a comma. For example, if you want to specify Records and SuperAudio CDs, specify CategoryIDExclude=306,46354. CategoryIDExclude can be used in combination with QueryKeywords and CategoryID. The CategoryIDExclude input field need not be used if you specified the CategoryID input field. FindPopularItems No Popular items, detail level is default for simple item type. addition with WatchCount. A list of active items that were listed with the requested product. FindPopularItems Always Retrieves the words more frequently used by eBay users when searching for listings. 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.

Finds the words more frequently used by eBay users when searching for listings. If you use keywords, this call returns available alternative keywords in addition to popular related keywords.

FindPopularItems Specify CategoryID to restrict your query to a specific category. Up to 10 categories may be specified If you are using a URL, and you want to specify multiple values, use a comma. For example, if you want to specify Fiction Books and Children's Books, specify CategoryID=377,279. If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories: Use the FindItemsAdvanced CategoryHistogram value in the IncludeSelector field to retrieve matching categories. Then make another FindItemsAdvanced call with the ID of a matching category. CategoryID can be used in combination with QueryKeywords and IncludeChildCategories. When IncludeChildCategories is true and used in conjunction with CategoryID, one and only one CategoryID is allowed. Otherwise, up to 10 CategoryIDs are allowed. To retrieve the most popular keywords for a root category, set one of the CategoryIDs to -1 or do not include CategoryID in the Request. 10 FindPopularSearches No A query that specifies a string for searching titles of items on eBay. If you are using a URL, then to search for multiple words, use "%20". For example, use Harry%20Potter to search for items containing those words in any order. You can incorporate wildcards into a multi-word search, as in the following: ap*%20ip*. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words. QueryKeywords can be used in combination with CategoryID and IncludeChildCategories. FindPopularSearches No The maximum number of keywords to be retrieved per category for this call. FindPopularSearches No 1 1000 20 Specifies the maximum number of PopularSearchResults per page in the returned list. If not specified, the default returns 20 results per page. FindPopularSearches 20 No Specifies the number of the page of data to return in the current call. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). FindPopularSearches 1 No If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories. When IncludeChildCategories is true and used in conjunction with CategoryID, one and only one CategoryID is allowed. If false, keywords are returned only for the categories identified by CategoryID. The default is false. FindPopularSearches false No Contains the keyword data for the requested categories. A category's data are contained in a CategoryArrayType object if there is no error (one or more CategoryType objects). Each CategoryType contains its ID, parent ID and keyword list. Organization of keywords by category. For each category, its ID and its parent's ID and keywords are listed. FindPopularSearches Always Indicates the page of data returned by the current call. For instance, for the first set of items can be returned, this field has a value of one. FindPopularSearches Conditionally Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available. FindPopularSearches Conditionally

Searches for stock product information (stock description and Item Specifics), such as information about a particular kind of DVD or camera. Also, retrieves up to 200 eBay listings associated with a product.

FindItemsAdvanced IncludeSelector Defines standard subsets of fields to return within the response. If you don't specify this field, the call returns a default set of fields, focusing on product details only (see the "Detail Controls" link below). If you specify this field, the additional fields you retrieve can affect the call's response time (performance). Applicable values: •   Details Include all available item fields in the response. Only applicable when you are searching by ProductID. Not applicable with QueryKeywords. •   DomainHistogram Include the DomainHistogram in the response. The histogram lists the number of matching products found and the domains in which they were found. (A domain is like a high-level category.) When many matching products are found, you may see significantly slower response times when you include the histogram. •   Items Include a brief set of item fields in the response. Only applicable when you are searching by ProductID. Not applicable with QueryKeywords. Use a comma to specify multiple values. (In this case, the results are cumulative.) See "FindProducts Samples" for an example of how to use this field. See "Detail Controls" for a complete list of fields that can be returned for each selector. Yes FindProducts No 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. This is useful when you use QueryKeywords and you only want to find products that have associated items (that is, where ItemArray would not beempty). This does not retrieve ItemArray; this only controls which products are returned (or counted). To retrieve ItemArray, pass Items in IncludeSelector. false FindProducts No A domain to search in. This is like searching a section of a catalog. If not specified, the product search is conducted across all domains. To determine valid domain names, first use this call with QueryKeywords. Domain names are returned for each product (and summarized in the domain histogram, if you specify DomainHistogram in IncludeSelector). A domain is a named grouping of categories whose items share common product characteristics. For example, all bound books have a binding or format (e.g., Hardcover), but audiobooks don't. So audiobooks would have their own domain. To limit your search to audiobooks, you would specify Audiobooks as the domain. Only useful when QueryKeywords is specified. If you use this with ProductID, AND logic is applied. In this case, if you specify an ID that doesn't match the domain (as eBay has defined it), no matching product will be found. Therefore, we recommend that you only use DomainName with QueryKeywords. FindProducts No 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. The request requires either QueryKeywords or ProductID, but these fields cannot be used together. 4000 FindProducts Conditionally 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. To retrieve items, use ProductID instead. (If you don't already have a product ID, you can get product IDs from the response after conducting a keyword search.) If specified, you must pass in at least 3 alphanumeric characters. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for products containing these words. To use AND or OR logic, use eBay's standard search string modifiers. Wildcards (+, -, or *) are also supported. Be careful when using spaces before or after modifiers and wildcards. Some keyword queries can result in response times of 30 seconds or longer. If more than 2000 matches are found, the call fails with an error. If this kind of error occurs, refine the search by passing in more keywords and/or by using DomainName to restrict the search to certain domains (such as DVDs). If you are searching for a particular book, DVD, CD, or video game and you already know its ISBN or EAN (for a book) or UPC, consider using ProductID instead to retrieve more precise results. The request requires either QueryKeywords or ProductID, but these fields cannot be used together. 350 FindProducts Conditionally Sorts the list of products returned. This is mostly only useful with QueryKeywords. (When you use ProductID, eBay usually only returns one product.) Also see SortOrder. If PorductSort and SortOrder are not specified, products are sorted by popularity in descending order. Popularity FindProducts No Sorts search results in ascending or descending order. Only applicable with ProductSort. If you specify ProductSort without SortOrder, the order defaults to Descending for all criteria except Title (which defaults to Ascending). Descending FindProducts No Specifies the maximum number of products to return per page in a single call. This is mostly only useful with QueryKeywords. (When you use ProductID, eBay usually only returns one product, and up to 200 items for that product.) 1 20 1 FindProducts No Specifies which page of data to return in the current call. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). 1 2000 1 FindProducts No Returns stock product information in eBay catalogs, such as information about a particular DVD or camera. Optionally, also returns items that match the product. The total number of pages that can be returned, given the same query and filters in the request. As FindProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set MaxEntries to 1 in the request). 1 2000 FindProducts Always

IncludeSelector: none, DomainHistogram, Items, Details

If true, more pages of results are available. That is, PageNumber is less than ApproximatePages. FindProducts Always

IncludeSelector: none, DomainHistogram, Items, Details

A histogram that lists the number of matching products found and the domains in which they were found. A domain describes a set of categories that share certain common characteristics (as determined by eBay). Each domain has its own name and ID. Only returned when you specify DomainHistogram in IncludeSelector. FindProducts Conditionally

IncludeSelector: DomainHistogram

A list of active items that were listed with the requested product. Only returned when you specify Items in IncludeSelector, and the product has matching items that are currently active on eBay. FindProducts Conditionally

IncludeSelector: Items, Details

The number of the page of data returned. If many products are found and multiple pages of results are available, use this in combination with ApproximatePages and MoreResults to decide which page to retrieve next. As FindProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set MaxEntries to 1 in the request). 1 2000 FindProducts Always

IncludeSelector: none, DomainHistogram, Items, Details

An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. When you use QueryKeywords in the request, FindProducts returns a maximum of 20 products per page. When you use ProductID in the request, FindProducts usually only returns 1 product. (If more than one product matches the same ProductID, FindProducts will return all of those products. As of the time of this writing, we expect this to be a rare case.) 20 FindProducts Always

IncludeSelector: none, DomainHistogram, Items, Details

The total number of matching products found. (If more than 2000 products are found, the call fails with an error.) 0 2000 FindProducts Always

IncludeSelector: none, DomainHistogram, Items, Details

Splitting include reviews and guides from GetProducts.

Searches reviews and guides based on product, category, or user. The response provides information about each user or product's reviews and guides.

FindItemsAdvanced, FindProducts, GetCategoryInfo Use this to retrieve reviews (not guides) 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. Same as FindProducts, supports Reference, ISBN, UPC, EAN. ProductID can be used in combination with UserID to return Reviews and Guides. ProductID and CategoryID cannot be used together. FindReviewsAndGuides No Retrieves reviews and guides written by the specified user. UserID can be combined with either ProductID or CategoryID but not both (as ProductID and CategoryID cannot be used together). FindReviewsAndGuides No Specify a single CategoryID to restrict your query to a specific Guide category. If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories: Use the FindItemsAdvanced CategoryHistogram value in the IncludeSelector field to retrieve matching categories. Then make another FindReviewsAndGuides call with the ID of a matching category. CategoryID can be used in combination with UserID to return Reviews and Guides. ProductID and CategoryID cannot be used together. FindReviewsAndGuides No Specifies the maximum number of reviews per page (not guides) in the returned list. If not specified, the default returns 5 results per page. FindReviewsAndGuides 5 20 No Specifies the number of the page of data to return in the current call. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). FindReviewsAndGuides No Find reviews and guides response type. Number of returned reviews. FindReviewsAndGuides Always Number of returned buying guides. FindReviewsAndGuides Always Rank of reviewer if using user search. FindReviewsAndGuides Conditionally Number of helpfulness votes if using user search. FindReviewsAndGuides Conditionally The eBay or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. FindReviewsAndGuides Conditionally URL to the reviews and guides page. FindReviewsAndGuides Always The number of the page of data returned. If many products are found and multiple pages of results are available, use this in combination with TotalPages to decide which page to retrieve next. As FindProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set MaxResultsPerPage to 1 in the request). 1 2000 FindReviewsAndGuides Always Indicates the total number of pages of data that could be returned by repeated requests. Returned with a value of 0 if no pages are available. FindReviewsAndGuides Always Contains information for up to 5 buying guides that match the query. Buying guides provide useful information about shopping in a particular domain, like Digital Cameras. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. If no buying guides are associated with the product, this only returns a link to the buying guide hub (the main Guides page). Count limited by MaxResultsPerPage in request. FindReviewsAndGuides Always Contains information about review details. Count limited by MaxResultsPerPage in request. FindReviewsAndGuides Conditionally Number of helpfulness votes if using user search. FindReviewsAndGuides Conditionally This call will give you the ability to retrieve high level Category information, relevant for a buy-side application.

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

FindItemsAdvanced IncludeSelector Use an ID of -1 to retrieve the root category and the top-level (level 1) meta categories. You can determine other CategoryIDs from the response from this call, or from a specific item (retrieved from another call like FindItemsAdvanced or GetSingleItem), or from the eBay website. 19 (Note: The eBay database specifies 38. Currently, Category ID's are usually 9 to 12 digits) GetCategoryInfo Yes Defines standard subsets of fields to return within the response. If you don't specify this field, the call returns a default set of fields. If you specify this field, the additional fields (child categories) you retrieve can affect the call's response time (decrease performance). Yes Detail Controls #detailControls GetCategoryInfo Samples #samples GetCategoryInfo No Contains the category data for the eBay site specified as input. 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). List of the returned categories. The category array contains one CategoryType object for each returned category. Returns empty if no detail level is specified. GetCategoryInfo

IncludeSelector: None, ChildCategories

Always Indicates the number of categories returned (i.e., the number of CategoryType objects in CategoryArray). GetCategoryInfo

IncludeSelector: None, ChildCategories

Always Indicates the last date and time that eBay modified the category hierarchy for the specified eBay site. GetCategoryInfo

IncludeSelector: None, ChildCategories

Always Indicates the version of the category hierarchy on the specified eBay site. GetCategoryInfo

IncludeSelector: None, ChildCategories

Always Contains a single ItemID or an array of ItemIDs.

Allows you to get the status for a group of items. Returns status information such as ListingStatus and End Time for all items that are listed in the request.

Contains the item ID and description of a listing. 19 (Note: The eBay database specifies 38. However, Item IDs are usually 9 to 12 digits) GetItemStatus Yes Returns status information for all items in a list. Some of the Item information is returned in an SimpleItemArrayType object, that can include zero, one, or multiple ItemType objects. Collection of Item status objects in an SimpleItemArrayType object, that can include zero, one, or multiple ItemType objects. GetItemStatus Always Retrieves publicly available data for one or more listings. 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.)

Retrieves publicly available data for one or more listings.

GetSingleItem The item ID that uniquely identifies the item listing for which to retrieve the data. You can provide a maximum of 10 ItemIDs. You can determine an item's ID by calling FindItems or from the eBay Web site. Provide ItemID for every item for which you want information. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) (FindItems) Item.ItemID FindItems.html#Response.Item.ItemID GetMultipleItems Yes Response to request of GetMultipleItems. Contains details for a listing whose ID was specified in the request. GetMultipleItems Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

Gets shipping costs for an item. This is one of the ways a buyer or seller can obtain shipping cost information for an existing item (for which the caller is either the buyer or seller) at any point in the life of of the listing, before or after a buyer has committed to purchasing the item(s). This call works for both flat rate shipping and calculated shipping. Flat rate shipping costs are established by the seller before bidding occurs. Calculated shipping costs are calculated by eBay with its shipping partners based on postal code, but note that insurance cost can only be determined once the final item price is known when the listing ends. To determine whether a listing has ended, use GetSingleItem. It is best to call GetShippingCosts only after determining via GetSingleItem or FindItems that the item actually has shipping cost information.

Gets shipping costs for an item.

GetSingleItem The item ID that uniquely identifies the item listing for which to retrieve the data. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetShippingCosts Yes Number of items sold to a single buyer and to be shipped together. 1 GetShippingCosts No Destination country postal code (or zipcode, for US). Ignored if no country code is provided. Optional tag for some countries. More likely to be required for large countries. Ignored for flat rate shipping. GetShippingCosts Conditionally Destination country code. If DestinationCountryCode is US, postal code is required and represents US zip code. US GetShippingCosts Conditionally Indicates whether to return the ShippingDetails container in the response. false GetShippingCosts Conditionally Response to call of GetShippingCosts. Shipping-related details for the specified item. This container is only returned if IncludeDetails is true on input. Any error about shipping services (returned by a vendor of eBay's who calculates shipping costs) is returned in ShippingRateErrorMessage. Errors from a shipping service are likely to be related to issues with shipping specifications, such as package size and the selected shipping method not supported by a particular shipping service. GetShippingCosts Conditionally Shipping-related details for the specified item. Any error about shipping services (returned by a vendor of eBay's who calculates shipping costs) is returned in ShippingRateErrorMessage. Errors from a shipping service are likely to be related to issues with shipping specifications, such as package size and the selected shipping method not supported by a particular shipping service. GetShippingCosts Always Retrieves publicly available data for a single listing. Use this call to retrieve most of the information that is visible on a listing's View Item page on the eBay Web site, such as title, description, prices, basic seller and bidder information, and other details about the listing.Also returns basic shipping costs. For more shipping details, use GetShippingCosts.

Gets publicly visible details about one listing. This gives you most of the data that eBay shows on the View Item page (title, description, price, and other details).

FindItems, GetItemStatus, GetShippingCosts, GetSingleItem IncludeSelector The item ID that uniquely identifies the item listing for which to retrieve the data. You can determine an item's ID by calling FindItems or from the eBay Web site. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) (FindItems) Item.ItemID FindItems.html#Response.Item.ItemID GetSingleItem Yes Defines standard subsets of fields to return within the response. If you don't specify this field, the call returns a default set of fields (see the "Detail Controls" link below). If you specify this field, the additional fields you retrieve can affect the call's response time (performance). Applicable values: •   Details Include most available fields in the response (except fields that significantly affect the call's performance). •   Description Include the Description field in the response. (This can affect the call's performance.) •   ShippingCosts Include basic shipping costs in the response. (Use GetShippingCosts to retrieve more details.) •   ItemSpecifics Include ItemSpecifics in the response. Use a comma to specify multiple values. (In this case, the results are cumulative.) See "GetSingleItem Samples" for an example of how to use this field. See "Detail Controls" for a complete list of fields that can be returned for each selector. Yes Detail Controls #detailControls GetSingleItem Samples #samples GetSingleItem No Contains details about the listing whose ID was specified in the request. GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

Retrieves user information based on the user ID you specify. The response contains detailed information about a user. You can specify the types of user information you want in the response.

FindItems IncludeSelector Specifies the user whose data will returned by the call. GetUserProfile Yes Defines standard subsets of fields to return within the response. If you don't specify this field, a default set of fields is returned. Click "Detail Controls" below and see "none" for the default fields. If you specify this field, then the set of fields returned includes the default fields. If you specify this field, the additional fields returned can affect the call's response time (performance), including in the case of feedback data. Applicable values: •   Details Include most available fields (such as StoreURL) in the response (except fields that can affect the call's response time). •   FeedbackDetails Include a container for information about one feedback entry. •   FeedbackHistory Include a container for summary feedback data for a user. Use a comma to specify multiple values. (In this case, the results are cumulative.) See "GetUserProfile Samples" for an example of how to use this field. See "Detail Controls" for a complete list of fields that can be returned for each selector. Yes Detail Controls #detailControls GetUserProfile Samples #samples GetUserProfile No Contains the returned user data for the specified eBay user. GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always Summary feedback data for a user. Contains counts of positive, neutral, and negative feedback for predefined time periods. GetUserProfile

IncludeSelector: FeedbackHistory

Always The FeedbackDetails container has fields (ItemID, etc.) with information about one feedback entry. When you call GetUserProfile, the 5 (maximum) most recent feedback records are returned in FeedbackDetails containers. GetUserProfile

IncludeSelector: FeedbackDetails

Always Gets the official eBay system time in GMT.

Gets the official eBay system time in GMT.

The Timestamp field indicates the official eBay system time in GMT. 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). Information about an Half.com catalog product. The title of the product, as specified in the catalog. Always returned when Product is returned. FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Conditionally Fully qualified URL for optional information about the product, such as a movie's description or film credits. This information is hosted through the Half.com Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link in product search results so that end users can view additional descriptive details about the product. This is usually always returned when Product is returned, but it may be safest to check for the existence of this field. FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Conditionally Fully qualified URL for a stock image (if any) that is associated with the Half.com catalog product. The URL is for the image Half.com usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. Only returned if a URL is available for the product. FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Conditionally Contains basic shipping-related costs for the item. If Item.Quantity is greater than 1, this is the shipping cost for one item. If the seller offers a choice of more than one shipping service (such as USPS Ground or Expediated), this is the cost of the "first" shipping option (usually the lowest cost option). FindHalfProducts

IncludeSelector: Items

Conditionally If true, your application can attempt to display stock photos that are returned. If false, your application should not attempt to display any stock photos that are returned. This recommendation is useful for catalog data related to products like coins, where stock photos are not necessarily applicable or available. An application with a graphical user interface can use this flag to determine when to hide customized stock photo widgets. Always returned when Product is returned. FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Conditionally Total number of listings on the Half.com site that use stock information from this catalog product. This value can be greater than the number of listings returned in ItemArray. Only returned when you search by ProductID (and you pass Items or Details in IncludeSelector). 0 FindHalfProducts

IncludeSelector: Items

Conditionally The Half.com or external IDs associated with the product. Use the Reference value as input to search for the same product in the future, or use the ISBN, EAN, or UPC value (if returned). The ISBN, EAN, and UPC values can also be useful as keys if your application is comparing products across different sites. Always returned when Product is returned. FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Conditionally The name of the domain in which the product was found. If the product is mapped to multiple domains, Half.com returns the most applicable domain (as determined by Half.com). Always returned when Product is returned. FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Conditionally A list of name/value pairs that are included in the product's pre-filled Item Specifics. These indicate common aspects or characteristics of the product, such as Publisher (for a book). Also see ProductID for ISBN, UPC, or EAN values, if applicable. This is usually returned. (We are not aware of any cases in which this node is not be returned. However, it may be safest to check for the existence of this node.) FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Conditionally A list of active items that were listed with the requested product. Results are sorted by current price (lowest first), then by recent positive feedback (highest first). Only returned when you specify Items in IncludeSelector, and the product has matching items that are currently active on Half.com. FindHalfProducts

IncludeSelector: Items

Conditionally The total number of reviews that are available for this product on the Half.com Web site. This can be greater than the number of reviews returned by FindProducts. In a future release, we will provide the capability to retrieve details about reviews. Always returned when Product is returned. FindHalfProducts 0

IncludeSelector: none, DomainHistogram, Items

Conditionally Controls values for item condition, especially for Books catalog. New, unread, unused and in perfect condition. Item still in original packaging, no wear and tear, all facets of the product are intact. (Could easily be mistaken for brand new.) Doesn't look brand new but has no easily noticeable damage and very minimal wear and tear. (You would give it to a good friend as a gift) Very minimal damage to the item and still includes all accessories such as dust jackets, liner notes, and cases. (You would use it yourself, but wouldn't necessarily give it as a gift) Some damage to the item but integrity still intact. May be missing an accessory. (Item beaten up a bit but it works) Some damage to the item and visibly used. (out) Reserved for internal or future use Information about an eBay catalog product. An set of Half.com catalog products. This contains stock information about a particular DVD, book, or other product. When you use QueryKeywords in the request, FindHalfProducts returns a maximum of 20 products per page. When you use ProductID in the request, FindHalfProducts usually only returns 1 product. (If more than one product matches the same ProductID, FindProducts will return all of those products. As of the time of this writing, we expect this to be a rare case.) FindHalfProducts

IncludeSelector: none, DomainHistogram, Items

Always A generic histogram entry type. This is the domain name. A product can be mapped to more than one domain. This means that even if a name appears in this histogram and the Count is greater than 1, you won't necessarily see the same name returned for each returned product (in the Product node of the response). That is, Product.DomainName only returns the most applicable domain name (as determined by eBay). FindHalfProducts Conditionally

IncludeSelector: DomainHistogram

FindProducts Conditionally

IncludeSelector: DomainHistogram

This is the number of products found in the domain. If a product is mapped to more than one domain, it is counted separately for each domain. (For example, if the same product name appears in both Children's Books and Fiction Books, the count for both of these domains will include that product.) This means you cannot sum the product counts to determine the total number of matching products across all domains. The histogram is only intended to show the number of matching products in each individual domain. FindHalfProducts Conditionally

IncludeSelector: DomainHistogram

FindProducts Conditionally

IncludeSelector: DomainHistogram

The seller's requirements regarding whether the buyer pays for shipping insurance. (in/out) The seller offers the buyer the choice of paying for shipping insurance or not. (in/out) The seller requires that the buyer pay for shipping insurance. (in/out) The seller does not offer shipping insurance to the buyer. (in/out) The seller is not charging separately for shipping insurance costs; any insurance is already included in the base shipping cost. (in/out) Shipping insurance is not offered as a separate option on the site where the item is listed. (Some shipping services, such as DE_InsuredExpressOrCourier, include insurance as part of the service.) If another insurance option is specified in the listing request and the site does not support shipping insurance as a separate option, eBay will reset the insurance option to this value. At the time of this writing, this option is only meaningful for the eBay Germany, Austria, and Switzerland sites. Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. Shipping costs and options related to an international shipping service. When used as input, if one is provided, at least one domestic ShippingService must be provided. This type does not exist before compatibility level 383. The insurance cost associated with shipping a single item with this shipping service. If the buyer bought more than one of this item, this proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. GetShippingCosts Conditionally An international shipping service offered for shipping the item (for example, UPS Ground). For flat and calculated shipping. GetShippingCosts Conditionally Cost of shipping each additional item beyond the first item. Zero for single- item listings. For flat shipping only. GetShippingCosts Conditionally The basic shipping cost of the item. If multiple items were purchased, this includes the ShippingServiceAdditionalCost. GetShippingCosts Conditionally Seller-preferred presentation order relative to other service options. Valid values are: 1, 2 and 3 (first, second and third choices). For flat and calculated shipping. GetShippingCosts Conditionally An international location or region to which the item may be shipped via this particular shipping service. Associated with the shipping service by the seller. This is basically the same as SimpleItemType.ShipToLocations except that this is spelled out and the other is abbreviated. GetShippingCosts Conditionally Specifies a predefined subset of item conditions. The predefined set of fields can vary for different calls. The seller specified the Item Condition as New, or did not specify a condition. (Excludes items that the seller listed as Used.) The seller specified the Item Condition as Used, or did not specify a condition. (Excludes items that the seller listed as New.) (out) Reserved for internal or future use. Identifies listing-type-related filters. (in) Only retrieve listings eligible for competitive bidding at auction. That is, only retrieve listings for which ListingType is Chinese, Dutch, or Live (regardless of the BuyItNowEnabled value). If a listing has a listing type of any of the following, it is not retrieved: StoresFixedPrice, FixedPriceItem, and AdType. (in) Only retrieves listings that can be purchased at a fixed price. That is, only retrieves listings for which listing type is StoresFixedPrice or FixedPriceItem. Whether StoresFixedPrice items are retrieved depends on the site default. If StoresFixedPrice items are retrieved, they are returned after the other retrieved items. Also retrieves Chinese and Dutch auction listings for which BuyItNowEnabled is true. Does not retrieve listings for which listing type is AdType or Live, and does not retrieve auction listings for which BuyItNowEnabled is false. (in) Returns all listing types (the default for FindItemsAdvanced). It is recommended that you use AllItemTypes instead of AllItems. Whether StoresFixedPrice items are retrieved depends on the site default. (in) Only retrieves listings for which the listing type is StoresFixedPrice. (in) Excludes listings that have listing type set to StoresFixedPrice. Excludes listings that have listing type set to AdType or Live. Excludes auction listings in which BuyItNowEnabled is false. (in) Excludes listings that have listing type set to StoresFixedPrice. (in) Retrieves listings whether or not listing type is set to StoresFixedPrice; include auction items. In searches for items, you must specify the AllItemTypes value if you want Store Inventory format (StoresFixedPrice) items to be returned. (in) Retrieves fixed-price items. Whether StoresFixedPrice items are retrieved does not depend on the site default. The StoresFixedPrice items are retrieved after the basic fixed price items. Items are retrieved whether or not listing type is set to StoresFixedPrice. Does not retrieve items for which listing type is AdType or Live. Does not retrieve auction items for which BuyItNowEnabled is false. (out) Reserved for internal or future use. (in) Only retrieves Classified Ad format listings. Restricts listings to return only items that have the Ad Format feature. Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., total price and buyer/high bidder) and the final value fee. This processing can take several minutes. If you retrieve a sold item and no details about the buyer/high bidder are returned, use this listing status information to determine whether eBay has finished processing the listing. (out) The listing is still live, or it has recently ended but eBay has not completed processing the listing (e.g., we're still determining the high bidder). A multi-item listing is considered active until all items have winning bids or purchases or the listing's end time has passed. (That is, if the listing has a Quantity of 10, the sale of 1 of those items doesn't end the listing.) If the listing has ended but this Active status is returned, please allow several minutes for eBay to finish processing the listing. (out) The listing has ended and eBay has completed processing of the sale (if any), such as determining the high bidder. (out) The listing has ended and eBay has completed processing of the sale (if any), such as determining the high bidder. You can think of Completed and Ended as essentially equivalent. (The difference is only meaningful to the seller of the item, as Completed indicates whether eBay has finished calculating certain selling fees.) (out) Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. Specifies the selling format used for a listing. Unknown auction type. (This is not normally used.) Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. Multiple-quantity online auction format. A Dutch auction has a Quantity greater than 1. Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. Live auction, on-site auction that can include non-eBay bidders. Live auctions are listed on the eBay Live Auctions site, in live auction categories. They can also appear on eBay if the seller lists the lot in a secondary category that is an eBay category. Reserved for future use. Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings. A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only specified by sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store. Second chance offer made to a non-winning bidder on an ended listing. A seller can make an offer to a non-winning bidder when either the winning bidder has failed to pay for an item or the seller has a duplicate of the item. Second-chance offer items are on eBay, but they do not appear when browsing or searching listings. You need to already know the item ID in order to retrieve a second-chance offer. A basic fixed-price listing with a Quantity of 1 or more. Allows no auction-style bidding. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Fixed-price listings appear on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner. Half.com listing (item is listed on Half.com, not on eBay). Reserved for future use. Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay). For Germany only: eBay Express-only format (item is listed only on eBay Express Germany, not on eBay). Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. A list of one or more valid names and corresponding values. One Item Specific that the seller has specified in the Item Specifics section of the listing, if any. For FindProducts, this can also be an Item Specific that is defined for a product. That is, Item Specifics can be returned both for items and products in FindProducts. GetSingleItem Conditionally

IncludeSelector: ItemSpecifics

FindItemsAdvanced Conditionally

IncludeSelector: ItemSpecifics

FindHalfProducts Conditionally

IncludeSelector: none, Items, DomainHistogram

FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

A name and corresponding value (a name/value pair). The name of the item specific. This field is always returned for each item specific that is returned (if any). However if the seller didn't select a value for the item specific, we suggest you don't show the name (to avoid confusing users). For the item condition, this usually includes the word "Condition" for eBay US, UK, Australia, and India listings; and "Artikelzustand" for eBay Germany, Austria, and Switzerland listings. The Name fields in return policy item specifics (if any) usually include the word "return", "refund", and/or "warranty" for eBay US, Canada, UK, Australia, and India listings; and "Rucknahme", "return", and/or "refund" for eBay Germany, Austria, and Switzerland listings. Note: Ignore item specifics with SIFFTAS in the name. These are for internal use by eBay and aren't meaningful to users. GetSingleItem Conditionally

IncludeSelector: ItemSpecifics

FindItemsAdvanced Conditionally

IncludeSelector: ItemSpecifics

FindHalfProducts Conditionally

IncludeSelector: none, Items, DomainHistogram

FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

A value for the item specific. In GetSingleItem, this field is always returned for each item specific that is returned (if any). However, if the seller didn't select a value for the item specific, this field may return empty, or it may return a value like "-", "Not Selected", or "Unspecified" (or the equivalent in the language of the site). For the item condition, this usually includes the word "New" or "Used" for eBay US, UK, Australia, and India listings; and "Neu" or "Gebraucht" for eBay Germany, Austria, and Switzerland listings. GetSingleItem Conditionally

IncludeSelector: ItemSpecifics

FindItemsAdvanced Conditionally

IncludeSelector: ItemSpecifics

FindHalfProducts Conditionally

IncludeSelector: none, Items, DomainHistogram

FindProducts Conditionally

IncludeSelector: none, Items, DomainHistogram, Details

Used for specifying items for which a specific payment method or methods are accepted. PayPal payment method. PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203). Either the PayPal or the PaisaPay payment method. The PaisaPay payment method is only for the India site (site ID 203). (out) Reserved for internal or future use. Contains CategoryID/QueryKeywords, AlternateKeywords, RelatedKeywords. Numeric ID of a category on eBay. FindPopularSearches Conditionally Category ID identifying a category that is an ancestor of the category indicated in CategoryID. FindPopularSearches Conditionally Specifies which query keywords corresponds to this PopularSearchResult. Query Keywords are returned in the output to clarify which result set corresponds to which Query Keyword inputs (as there can be more than one set of keywords in the input). FindPopularSearches Conditionally Alternative search keywords for the query keywords, separated by semicolons. You can use this to find other search terms buyers and sellers may be interested in. For example, if a seller lists an item with "wedding" in the title, they may also be interested in adding "bridal" to the title because bridal is an alternative search keyword which buyers have used. FindPopularSearches Conditionally Keywords related to the query keywords, separated by semicolons. You can use this to find more detailed related keywords. For example, the query keyword "wedding" is related to searches for "wedding decorations;wedding favors;wedding supplies;wedding dresses..." which helps the seller and buyer specify their query with more detail and precision. FindPopularSearches Conditionally Specifies the criteria for filtering search results by site, where site is determined by the site ID in the request. (in) Items listed in the currency implied by the site specified in the request. (in) Items located in the country implied by the site specified in the request. (in) Items available to the country implied by the site specified in the request. For the US site, this implies listings from ALL English-language countries that are available to the US. (in) Items listed on the site specified in the request, regardless of listing currency. (in) Items located in Belgium or listed on one of the two Belgian sites. (out) Reserved for internal or future use. ProductID type for product searches. ISBN-10 or ISBN-13 value for books. (The string length of ProductID indicates whether the ID is 10 or 13 characters.) If you know a book's ISBN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. Max length of corresponding value: 13 EAN value for books. (This is used more commonly in European countries.) If you know a book's EAN, you can use this instead of the eBay CatalogItem or Reference ID to search for that book. Max length of corresponding value: 13 UPC value for products in Music (e.g., CDs), DVDs & Movies, and Video Games categories (or domains). If you know a product's UPC, you can use this instead of the eBay CatalogItem or Reference ID to search for that product. Max length of corresponding value: 12 Reserved for future use. Reserved for future use. An eBay catalog product ID. This is an ID that was used to list a particular item. The CatalogItem ID represents a particular version of a catalog product. (A given version could have an older or newer description, set of Item Specifics, or other details.) So the same product could have different CatalogItem IDs at different times. Use this for searching when you you have obtained the product ID from a listed item (using the eBay Web site UI or another source), and you don't know the reference ID yet. Max length of corresponding value: 4000 The global reference ID for an eBay catalog product. A reference ID is a fixed reference to a product (regardless of version). Use this instead of CatalogItem when you know a product's reference ID (because older CatalogItem IDs are more likely to become obsolete over time.) One reference ID can be associated with multiple CatalogItem IDs. To determine valid reference IDs for products, first call FindProducts with QueryKeywords (or ProductID). Each product in the response includes a reference ID. (out) Reserved for internal or future use. Product ID has an attribute of ProductIDCodeType and a string value. The nature of identifier being used. For FindHalfProducts, FindProducts, FindItemsAdvanced, and FindReviewsAndGuides, only Reference, ISBN, UPC, and EAN are supported. Required when ProductID is specified. FindReviewsAndGuides FindHalfProducts FindProducts FindItemsAdvanced CatalogItem,MPN, Keywords Conditionally FindReviewsAndGuides Conditionally Controls the order of product (not item) searches. Sort by product popularity (as determined by eBay). (This is the default sort order.) Sort by average rating. Sort by the number of reviews on eBay. Sort by the number of active items listed with this product. Sort by the product title. Reserved for values that are not available in the version of the schema you are using. If eBay adds a new value to this code type as of a newer version, we return CustomCode instead when you specify a lower request version. Used by QuantityOperator to specify that you are seeking quantities less than Quantity. Specifies quantities less than or equal to Quantity. Specifies quantities equal to Quantity. Specifies quantities greater than Quantity. Specifies quantities greater than or equal to Quantity. Reserved for internal or future use. Type for the return policy details of an item. Specifies how a refund will be made, e.g. as an exchange. GetSingleItem Conditionally

IncludeSelector: Details

Specifies the length of time in which the item must be returned under the return policy. GetSingleItem Conditionally

IncludeSelector: Details

Information about returns accepted. GetSingleItem Conditionally

IncludeSelector: Details

A description of the return policy for the item. GetSingleItem Conditionally

IncludeSelector: Details

Information about the warranty offered. GetSingleItem Conditionally

IncludeSelector: Details

The type of warranty offered. GetSingleItem Conditionally

IncludeSelector: Details

The length of the warranty offered. GetSingleItem Conditionally

IncludeSelector: Details

Contains the EAN. GetSingleItem Conditionally

IncludeSelector: Details

The party who pays the cost of shipping for a returned item. GetSingleItem Conditionally

IncludeSelector: Details

Contains product reviews written by eBay members. The product's average rating (out of 5) based on all reviews. For example, a value like 4.5 would mean the average rating is 4.5 out of 5. (See ReviewCount for the total number of reviews.) 0 5 FindReviewsAndGuides Conditionally An eBay member's review of the product. 20 FindReviewsAndGuides Conditionally A product review written by an eBay member. A link to the full review on the eBay Web site. This URL optimized for natural search: "_W0QQ" is like "?" (question mark), "QQ" is like "&" (ampersand), and "Z" is like "=" (equals sign). Note: For a link to all reviews for the product, remove the upvr parameter from this URL. See the eBay Web Services guide for an example. FindReviewsAndGuides Conditionally The title of the review. 55 FindReviewsAndGuides Conditionally The eBay member's rating of the product. 0 5 FindReviewsAndGuides Conditionally The text of the review. If the review is longer than 2000 characters, the text is cut off and it ends with "...". See Review.URL for a link to the full text of the review. 2000 FindReviewsAndGuides Conditionally The reviewer's eBay user ID. FindReviewsAndGuides Conditionally The time and date when the reviewer posted the review. FindReviewsAndGuides Conditionally Type for expressing sales tax data. Percent of an item's price to be charged as the sales tax for the transaction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). GetShippingCosts Conditionally State or jurisdiction for which the sales tax is being collected. Only returned if the seller specified a value. GetShippingCosts Conditionally (US only) Whether shipping costs were part of the base amount that was taxed. Flat or calculated shipping. GetShippingCosts Conditionally (US only) The amount of sales tax, calculated for a transaction based on the SalesTaxPercent and pricing information. GetShippingCosts Conditionally SearchFlagCodeType - Search flags for FindItemsAdvanced. Return only charity item listings. Return only gift items. Return only items that have been listed with Now and New. Applicable for certain sites only. Perform a local search. If specified, only items with free shipping for the user's location are returned. The user's location is determined from the site ID specified in the request. If false, no filtering is done via this attribute. A listing is not considered a free shipping listing if it requires insurance or requires pick up or requires a shipping surcharge. Return Gallery items only. Picture. Limits the results to Get It Fast listings. Limits the results to only those listings for which lot size is 2 or greater. Limits the results based on each item's eligibility to appear on the mobile.de site. If specified, queries for eligible items only. If not specified, the search results are not affected. Only applicable for items listed on the eBay Germany site (site ID 77) in subcategories of mobile.de search-enabled categories. If specified, limits the results to digitally delivered good only. (out) Reserved for internal or future use. Container for items. Can contain zero, one, or multiple SimpleItemType objects, each of which has data for an item listing. Category name breadcrumb. Used in building a category-browsing path, i.e. a path of "breadcrumbs" (e.g., Computers & Networking > Technology Books > Certification). FindItemsAdvanced Conditionally Category ID breadcrumb. Used in building a category-browsing path, i.e. a path of "breadcrumbs" (e.g., Computers & Networking > Technology Books > Certification). FindItemsAdvanced Conditionally Item count of the category. FindItemsAdvanced Conditionally Array of simple items. FindItemsAdvanced Conditionally Type of seller account. This value can be returned if the German site (site ID 77) or eBay Motors site (site ID 100) is specified. Type of seller account not defined. Private seller account. Commercial seller account. (out) Reserved for internal or future use. Type for the shipping-related details for an item or transaction. The name of a shipping service. GetShippingCosts Always The basic shipping cost of the item. If multiple items were purchased, this includes the ShippingServiceAdditionalCost. GetShippingCosts Always GetSingleItem Conditionally

IncludeSelector: ShippingCosts

FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

FindHalfProducts Conditionally

IncludeSelector: Items

FindPopularItems Conditionally FindProducts Conditionally

IncludeSelector: Items, Details

The cost of insurance. For flat rate shipping, this is the value set by the seller, if any. For calculated shipping, this is the value calculated by eBay with the shipping carrier for the particular item and can only be determined once the final item price is known when the listing ends. To determine whether a listing has ended, see EndTime or ListingStatus in GetSingleItem. GetShippingCosts Conditionally GetSingleItem Conditionally

IncludeSelector: ShippingCosts

How the seller stated that cost of shipping is to be determined, such as flat rate or calculated or free. In GetSingleItem, this is always returned when ShippingCostSummary is returned. GetShippingCosts Freight, Free Always GetSingleItem Freight, Free Conditionally

IncludeSelector: ShippingCosts

FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

FindHalfProducts Conditionally

IncludeSelector: Items

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. This field is ignored when Item.ListingType equals Express. GetShippingCosts Conditionally Type for the shipping-related details for an item or transaction. Indicates whether the seller has opted the listing into the Get It Fast feature. If GetItFast is true and if at least one of the domestic shipping services offered by the seller is an expedited shipping service, every shipping service offered by the seller is considered a Get It Fast service, and the seller commits to delivering the item to the buyer-selected shipping service within one day. GetShippingCosts Conditionally Enabling Get It Fast http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetItFast The cost of insurance. For flat rate shipping, this is the value set by the seller, if any. For calculated shipping, this is the value calculated by eBay with the shipping carrier for the particular item and can only be determined once the final item price is known when the listing ends. To determine whether a listing has ended, use GetSingleItem. Not applicable to eBay Motors vehicle listings. 0.00 GetShippingCosts Conditionally Whether the seller offers shipping insurance and, if so, whether the insurance is optional or required. Flat and calculated shipping. This field is ignored when Item.ListingType equals Express. GetShippingCosts Conditionally Shipping costs and options related to an international shipping service. Not applicable to Half.com or eBay Motors vehicle listings. This field is ignored when Item.ListingType=Express. GetShippingCosts Conditionally

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

Sales tax details. US site only. Flat and calculated shipping. If your application normally calculates sales tax without using eBay's tax tables, you should understand how purchases via eBay Express will affect the way you process payments. For general information about listings on eBay Express, see the eBay Web Services Guide links below. Not applicable to eBay Motors vehicle listings. GetShippingCosts Conditionally Specify Sales Tax for Express and eBay http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExpressTax For most applicable calls, returns the words No Error or returns an error message related to an attempt to calculate shipping rates. For calculated shipping only. Not applicable to Half.com or eBay Motors vehicle listings. GetShippingCosts Conditionally Shipping costs and options related to domestic shipping services offered by the seller. Flat and calculated shipping. Not applicable to Half.com or eBay Motors vehicle listings. GetShippingCosts Conditionally Tax details for a jurisdiction such as a state or province. Returned empty in if no tax table was used. Not applicable to Half.com. GetShippingCosts Conditionally The cost of insurance for items shipped internationally. For flat rate shipping, this is the value set by the seller, if any. For calculated shipping, this is the value calculated by eBay with the shipping carrier for the particular item and can only be determined once the final item price is known when the listing ends. To determine whether a listing has ended, use GetSingleItem. Not applicable to eBay Motors vehicle listings. 0.00 GetShippingCosts Conditionally Whether the seller offers shipping insurance for items shipped internationally and, if so, whether the insurance is optional or required. Flat and calculated shipping. This field is ignored when Item.ListingType equals Express. GetShippingCosts Conditionally Shipping costs and options related to a domestic shipping service. The insurance cost associated with shipping a single item with this shipping service. If the buyer bought more than one of this item, this proportional to QuantitySold. If the item has not yet been sold, insurance information cannot be calculated and the value is 0.00. For calculated shipping only. GetShippingCosts Conditionally A domestic shipping service offered for shipping the item (for example, UPS Ground). For flat and calculated shipping. GetShippingCosts Conditionally The meaning of this element depends on the call and on whether flat or calculated shipping has been selected. (For example, it could be the cost to ship a single item, the cost to ship all items, or the cost to ship just the first of many items, with ShippingServiceAdditionalCost accounting for the rest.) For flat and calculated shipping. GetShippingCosts Conditionally The cost of shipping each additional item beyond the first item. For input, this is required if the listing is for multiple items and should be zero for single-item listings. Default value is 0.00. For flat shipping only. Not applicable to Half.com. GetShippingCosts Conditionally Seller-preferred presentation order relative to other service options. Valid values: 1 (1st choice), 2 (2nd choice), 3 (3rd choice). For flat and calculated shipping. Not applicable to Half.com. GetShippingCosts Conditionally Indicates whether the service is an expedited shipping service. See Enabling Get It Fast. Not applicable to Half.com. GetShippingCosts Conditionally The minimum guaranteed number of days in which the shipping carrier can ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com. GetShippingCosts Conditionally The maximum guaranteed number of days the shipping carrier will take to ship an item (not including the time it takes the seller to deliver the item to the shipping carrier). See Enabling Get It Fast. Not applicable to Half.com. GetShippingCosts Conditionally An additional fee to charge US buyers who ship via UPS to Alaska, Hawaii or Puerto Rico. Can only be assigned a value for Parts and Accessories items on the eBay US and Motors sites. Only returned if set. If some transactions in an order have a surcharge, surcharge is added only for those transactions. Flat rate shipping only. GetShippingCosts Conditionally An international location or region to which the item may be shipped via this particular shipping service. Associated with the shipping service by the seller. Use GeteBayDetails to determine which locations are valid per site. These values are string equivalents of values found in ShippingRegionCodeType and CountryCodeType. GetShippingCosts Conditionally ShipToLocation http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShipToLocation The shipping cost model offered by the seller. The flat rate shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller. The calculated shipping model: the posted cost of shipping is based on the seller-offered and buyer-selected shipping service, where the shipping costs are calculated by eBay and the shipping carrier based on the buyer's address, and any packaging/handling costs established by the seller are automatically rolled into the total. The freight shipping model: the cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code). Currently, Freight can only be specified on input via eBay Web site, not via API. Free is used when the seller is declaring that shipping is free for the buyer. Since Free cannot be selected via API, the seller has two options for signifying that shipping is free when listing an item: - omit shipping details, mention in the item description that shipping is free, and set ShippingTermsInDescription to true - select an arbitrary shipping service and set its shipping cost to 0, mention in the item description that shipping is free, and set ShippingTermsInDescription to true The latter is a better way to communicate "free shipping" because eBay picks up the "0" cost and can more accurately identify shipping costs in search results. The seller did not specify the shipping type. The seller specified one or more flat domestic shipping services and one or more calculated international shipping services. The seller specified one or more calculated domestic shipping services and one or more flat international shipping services. Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. Container for a list of items. Can contain zero, one, or multiple SimpleItemType objects, each of which conveys the data for one item listing. Contains data for an item listing. FindItemsAdvanced FindPopularItems Always FindHalfProducts Conditionally

IncludeSelector: Items

FindProducts Conditionally

IncludeSelector: Items, Details

Sorts items by Best Match, and no sort order applies. If specified, then Best Match sort also applies to CategoryHistogram. Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. Sorts items by end time in ascending or descending order. Sort by number of bids on the item in ascending or descending order. Sort by country; no sort order can be specified. Sort by current bid in ascending or descending order. Sort by distance, ascending order only. Sort by start date, recently-listed first. (in) Sort by BestMatchCategoryGroup so results are grouped by Best Match within a category. (in) This value is part of the Price Plus Shipping Sort feature, to be enabled by the end of Sept. 2007 for the following sites: US (site ID 0), Germany (77), Canada (2), and Australia (15). The Price Plus Shipping Sort feature causes item sorting to consider shipping costs. Specify PricePlusShippingAsc to sort items by lowest cost first, as follows: Lowest-total-cost (for items where shipping was properly specified), then freight-shipping items, then items for which shipping was not specified (sorted by price). Whether the seller will accept a best offer for this item. This feature enables a buyer to make a lower-priced binding offer on a fixed price item. Buyers can't see how many offers have been made (only the seller can see this information). To make a best offer on a listing, use the eBay Web site. (eBay Help) Making a Best Offer (for Buyers) http://pages.ebay.com/help/buy/best-offer.html (eBay DE Hilfe) Preis vorschlagen http://pages.ebay.de/help/buy/best-offer.html GetSingleItem Always

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Conditionally

IncludeSelector: Details

The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed. For Chinese auctions (Quantity=1, competitive bidding online auctions), Buy It Now lets a user purchase the item at a fixed price and end the auction immediately. On most sites, after a Chinese auction has bids, the listing is no longer eligible for Buy It Now. However, calls can still return the Buy It Now Price that the seller set for the listing. Use the Item.BidCount field to determine whether an auction with Buy It Now has bids or not. Some eBay sites also support Buy It Now for Dutch auctions (multi-quantity, competitive bidding), where you can buy multiple items from the same listing at a fixed price, instead of bidding. On some sites, the Buy It Now option remains available for Dutch auctions even after there are bids. See Item.BuyItNowAvailable. For fixed-price (FixedPriceItem) and Store Inventory listings (StoresFixedPrice), see CurrentPrice or ConvertedCurrentPrice instead. Only returned if an item was listed with Buy It Now. (GetSingleItem) Item.ListingType GetSingleItem.html#Response.Item.ListingType Item.BuyItNowAvailable #Response.Item.BuyItNowAvailable Item.ConvertedBuyItNowPrice #Response.Item.ConvertedBuyItNowPrice Item.ConvertedCurrentPrice #Response.Item.ConvertedCurrentPrice (eBay Help) Buying with Buy It Now http://pages.ebay.com/help/buy/how-buy-bin.html (eBay DE Hilfe) Kaufen mit Sofort-Kaufen http://pages.ebay.de/help/buy/how-buy-bin.html GetSingleItem Conditionally

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Conditionally

IncludeSelector: Details

The seller's description of the item, if any. This can include HTML markup and JavaScript. See <a href="types/simpleTypes.html#string">string</a> in Simple Schema Types. Some sellers don't specify their own listing description. Instead, they use a stock description from a catalog available through eBay. (GetSingleItem doesn't return this stock information.) 500000 (some sites may allow more, but the exact number may vary) GetSingleItem Conditionally

IncludeSelector: Description

The ID that uniquely identifies the item listing. eBay generates this ID when an item is listed. This ID is unique across all eBay sites. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetItemStatus Always GetMultipleItems Always GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindHalfProducts Conditionally

IncludeSelector: Items

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

For Dutch auctions (not Chinese auctions) this indicates whether there is a Buy It Now option. (On some sites, the Buy It Now option remains available for Dutch auctions even after there are bids.) Applicable to the Germany site (site ID 77) only. FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetItemStatus Conditionally GetMultipleItems Conditionally GetSingleItem Conditionally

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindProducts Conditionally

IncludeSelector: Items, Details

The listing's Buy It Now Price (if any), converted into the currency of the site to which you sent this request. Price fields are returned as doubles, not necessarily in the traditional monetary format of the site's country. For example, a US Dollar value might be returned as 3.880001 instead of 3.88. For Chinese auctions (Quantity=1, competitive bidding online auctions), Buy It Now lets a user purchase the item at a fixed price and end the auction immediately. On most sites, after a Chinese auction has bids, the listing is no longer eligible for Buy It Now. However, calls like FindItems still return the Buy It Now Price that the seller set for the listing. Use the Item.BidCount field to determine whether an auction with Buy It Now has bids or not (and therefore whether it is still eligible to be purchased with Buy It Now). Some eBay sites also support Buy It Now for Dutch auctions (multi-quantity, competitive bidding), where you can buy multiple items from the same listing at a fixed price, instead of bidding. On some sites, the Buy It Now option remains available for Dutch auctions even after there are bids. See Item.BuyItNowAvailable. For fixed-price (FixedPriceItem) and Store Inventory listings (StoresFixedPrice), see CurrentPrice or ConvertedCurrentPrice instead. Only returned if an item was listed with Buy It Now. For active items, refresh this value every 24 hours to pick up the current conversion rates (if this value has been converted). (GetSingleItem) Item.ListingType GetSingleItem.html#Response.Item.ListingType Item.BuyItNowAvailable #Response.Item.BuyItNowAvailable Item.BuyItNowPrice #Response.Item.BuyItNowPrice Item.ConvertedCurrentPrice #Response.Item.ConvertedCurrentPrice (eBay Help) Buying with Buy It Now http://pages.ebay.com/help/buy/how-buy-bin.html (eBay DE Hilfe) Kaufen mit Sofort-Kaufen http://pages.ebay.de/help/buy/how-buy-bin.html FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetMultipleItems Conditionally GetSingleItem Conditionally

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindProducts Conditionally

IncludeSelector: Items, Details

Time stamp (in <a href="types/simpleTypes.html#dateTime">GMT</a>) when the listing is scheduled to end or the actual end time if the item has ended. FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetItemStatus Always GetMultipleItems Always GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

Time stamp (in <a href="types/simpleTypes.html#dateTime">GMT</a>) that eBay recorded as the moment that the listing was made available. GetSingleItem Always

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Conditionally

IncludeSelector: Details

The URL to view this listing on eBay. This URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines. For example, this URL specifies the item title, and it is optimized for natural search: "_W0QQ" is like "?" (question mark), "QQ" is like "&" (ampersand), and "Z" is like "=" (equals sign). You shouldn't modify the query syntax in your application. For example, eBay won't recognize the URL if you change QQ to ?. FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetMultipleItems Always GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindHalfProducts Conditionally

IncludeSelector: Items

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

The format of the listing, such as online auction, fixed price, or advertisement format. FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

Auction, Half GetMultipleItems Always GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

Auction, Half FindPopularItems Always Auction, Half FindProducts Conditionally

IncludeSelector: Items, Details

Auction, Half Physical location of the item, as specified by the seller. (This gives a general indication of where the item will be shipped or delivered from.) GetMultipleItems GetSingleItem Conditionally

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

Identifies the payment method (such as PayPal) the seller will accept when the buyer pays for the item. Note: If the seller only accepts PayPal, the buyer can still pay with a credit card. PayPal supports major credit cards. Payment methods are not applicable to eBay Real Estate advertisement listings, or other Classified Ad format listings. GetSingleItem Conditionally Escrow, PrePayDelivery, CODPrePayDelivery, PostalTransfer

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Escrow, PrePayDelivery, CODPrePayDelivery, PostalTransfer Conditionally

IncludeSelector: Details

URL for a picture used as the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image. FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetMultipleItems Conditionally GetSingleItem Conditionally

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindPopularItems Conditionally FindProducts Conditionally

IncludeSelector: Items, Details

Contains the URL for an image associated with the item, if any. Only returned if the seller chose to include at least one picture in the listing. (This doesn't return URLs of pictures that the seller specified via HTML IMG tags in Description.) Items listed the main eBay site can have a maximum of 12 picture URLs hosted by eBay Picture Services or a maximum of 6 picture URLs hosted by a third party (such as the seller or a photo site). On the US eBay Motors site (for all vehicle listings), and on the eBay Canada Motors site, a listing can have up to 24 picture URLs. eBay uses the seller's first picture at the top of the listing's View Item page. 150 24 GetMultipleItems Conditionally GetSingleItem Conditionally

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

Postal code indicating the physical location of the item, as specified by the seller. (This gives a general indication of where the item will be shipped or delivered from.) GetSingleItem Conditionally

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Conditionally

IncludeSelector: Details

Numeric ID of the first (or only) category in which the item is listed. (Listings can appear in more than one category.) Note: Currently, GetSingleItem does not return a listing's secondary category, if any. GetMultipleItems Always GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

Display name of the first (or only) category in which the item is listed. This is a fully qualified category breadcrumb (e.g., Computers & Networking:Laptops, Notebooks). GetMultipleItems Always GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

The number of items the seller is offering in the listing. (Subtract Item.QuantitySold from this value to calculate the number of items currently available for sale.) If an online auction (with competitive bidding) has a Quantity of 1, it's a Chinese auction. If Quantity is greater than 1,it's a Dutch auction. Basic fixed-price and Store Inventory listings can have a Quantity of 1 or more. The listing's current or Buy It Now price is the price of 1 item in the listing. Note: A seller can also offer multiple items for sale with a single price for all the items. For example, instead of listing 10 lightbulbs for US 2.00 each, they might list 10 lightbulbs for USD 20.00 (where you have to buy all 10). This is called a "lot". If the listing includes a lot (or multiple lots), Quantity does not specify the lot size; it only reflects how many lots are being sold. For example, if the listing includes 5 lots of 10 lightbulbs each, Quantity would be 5. (GetSingleItem does not return information about lot sizes.) Item.ListingType #Response.Item.ListingType GetSingleItem Conditionally

IncludeSelector: Details

Container for information about this listing's seller. GetSingleItem Always

IncludeSelector: Details

FindHalfProducts Conditionally

IncludeSelector: Items

FindItemsAdvanced Conditionally

IncludeSelector: SellerInfo

The number of bids that have been placed on the item. On most sites, once a Chinese auction has bids, the listing is no longer eligible for Buy It Now. (This is not necessarily true for Dutch auctions. See Item.BuyItNowAvailable for Dutch auctions.) FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetMultipleItems Conditionally GetSingleItem Conditionally

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

GetItemStatus Always FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

The listing's current price, converted to the currency of the site specified in the request. If the item is a multi-quantity listing, this is the price of one item. Price fields are returned as doubles, not necessarily in the usual monetary amount format of the site. For example, a US Dollar value might be returned as 3.879938 instead of 3.88. For competitive-bidding listings (Chinese and Dutch auctions), this is the current minimum bid price (if the listing has no bids) or the current high bid (if the listing has bids). (Compare to BuyItNowPrice). For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), and Ad format (AdType) listings, this is the current fixed price. For active items, refresh this value every 24 hours to pick up the current conversion rates (if this value has been converted). FindItems GetItemStatus Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetMultipleItems Conditionally (GetSingleItem) Item.CurrentPrice GetSingleItem.html#Response.Item.CurrentPrice GetSingleItem Conditionally

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

(GetSingleItem) Item.CurrentPrice GetSingleItem.html#Response.Item.CurrentPrice GetItemStatus Always FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item. For competitive-bidding listings (Chinese and Dutch auctions), this is the current minimum bid price (if the listing has no bids) or the current high bid (if the listing has bids). (Compare to BuyItNowPrice). For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), and Ad format (AdType) listings, this is the current fixed price. GetSingleItem Conditionally

IncludeSelector: Details

(GetSingleItem) Item.ConvertedCurrentPrice GetSingleItem.html#Response.Item.ConvertedCurrentPrice FindItemsAdvanced Conditionally

IncludeSelector: Details

FindHalfProducts Conditionally

IncludeSelector: Items

FindProducts Conditionally

IncludeSelector: Details

For single-item (Quantity = 1) auction listings (Chinese type) that have ended and have a winning bidder, indicates the user who is the current high bidder. For single-item basic fixed price (FixedPriceItem) or Store Inventory (StoresFixedPrice) listings that have ended, indicates the user who purchased the item. Not returned for auctions that have received no bids; fixed price and Store Inventory listings that are still active; or any multi-item (Quantity > 1) listings (Dutch, FixedPriceItem, StoresFixedPrice). Item.Quantity #Response.Item.Quantity GetSingleItem Conditionally

IncludeSelector: Details

GetItemStatus Conditionally

IncludeSelector: Details

Specifies a listing's status in eBay's processing workflow. If an item's EndTime is in the past, but no details about the buyer or high bidder are shown (and the user is not anonymous), use this listing status information to determine whether eBay has finished processing the listing. FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetItemStatus Always GetMultipleItems Always GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

Number of items purchased so far from this listing. (Subtract this value from Item.Quantity to calculate the number of items currently available for sale.) GetSingleItem Always

IncludeSelector: Details

Indicates whether any bids on this item are greater than the seller's reserve price for the listing (if any). A reserve is the lowest price at which the seller is willing to sell the item. The reserve price is higher than the listing's opening bid (minimum bid) and lower than the Buy It Now price, if any. (The reserve price is only known to the seller.) Some sellers don't set a reserve at all. If a listing does have a reserve price, the highest bidder will only win the item if their bid is also above that price. Only returned for online auctions that have a reserve price. (Fixed price, Store Inventory, and classified ad listings don't have reserve prices.) GetSingleItem Conditionally

IncludeSelector: Details

GetItemStatus Conditionally

IncludeSelector: Details

An international location or region to which the seller is willing to ship this item. Applicable values: •   Americas (North, South, or Latin America) •   Asia •   Caribbean •   Europe •   EuropeanUnion •   LatinAmerica •   MiddleEast •   NorthAmerica •   Oceania (Pacific region other than Asia) •   SouthAmerica •   WillNotShip (No shipping, buyer must pick up the item) •   Worldwide (Seller will ship worldwide) •   2-letter country identifier (See CountryCodeType for values) CountryCodeType types/CountryCodeType.html GetSingleItem Conditionally

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Conditionally

IncludeSelector: Details

The name of the eBay site on which the item was originally listed. For example, if the item is listed on the eBay US site, the value would be US. If it's listed on the eBay Germany site, the value would be Germany. The listing's original site can affect the values of converted (localized) prices (when your request specifies a site that is different from the listing's site). GetSingleItem Conditionally

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Conditionally

IncludeSelector: Details

Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). For ended listings, the time left is PT0S (zero seconds). FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetItemStatus Always GetMultipleItems Always GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

Name of the item as it appears in the listing or in search and browse results. For US eBay Motors cars, trucks, and motorcycles, this value shows the vehicle Make and Model instead of the seller's own title. (For the seller's title, look for Subtitle in Item.ItemSpecifics.NameValueList.Name in GetSingleItem, and then use the corresponding value in Item.ItemSpecifics.NameValueList.Value.) FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

GetMultipleItems Always GetSingleItem Always

IncludeSelector: none, Description, ItemSpecifics, ShippingCosts, Details

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

Contains basic shipping-related costs for the item. If Item.Quantity is greater than 1, this is the shipping cost for one item. If the seller offers a choice of more than one shipping service (such as UPS Ground and USPS Media mail), this is the cost of the "first" shipping option (usually the lowest cost option). If a listing has shipping costs, use GetShippingCosts if you want to get more details about the services and costs that the seller is offering. GetShippingCosts GetShippingCosts.html GetSingleItem Conditionally

IncludeSelector: ShippingCosts

FindItems Conditionally FindItemsAdvanced Conditionally

IncludeSelector: none, Details, SearchDetails, SellerInfo, ItemSpecifics, ExpansionItemCount, CategoryHistogram

FindPopularItems Always FindProducts Conditionally

IncludeSelector: Items, Details

Category-specific fields that the seller added to describe the listing. The names of these fields are different for items in different categories, so they're returned in a generic name/value structure. The field names are usually very well known within the category. For example, a book's item specifics might include a field like Publication Year=2007 (where Publication Year is returned in Name, and 2007 is returned in Value), and a field like Format=Hardcover. But a car's item specifics would be different from a book's, with fields like Make=Toyota and Model=Prius. And a ticket's item specifics would be different from those of books and cars, with fields like EventType=Concerts and Venue=The Fillmore. Some of the most common uses for item specifics are the item condition and return policy. The return policy can include multiple name/value fields (to explain how soon the item must be returned, how soon the refund will be given, and so forth). Only contains data if the listing includes Item Specifics. GetSingleItem Conditionally

IncludeSelector: ItemSpecifics

FindItemsAdvanced Conditionally

IncludeSelector: ItemSpecifics

The number of times the listing's View Item page has been viewed (as determined by eBay). Only returned if the seller has chosen to include a hit counter in the listing, and if the seller has also chosen to make the listing's hit count publicly visible. This field is retrieved asynchronously. If you believe the item has a publicly visible hit count, but this field is not returned, retry the call. GetSingleItem Conditionally

IncludeSelector: Details

Subtitle of the item. Only returned if the seller included a subtitle for the listing. For US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or listings in CA eBay Motors passenger vehicle and motorcycle categories, see the ItemSpecifics node for the subtitle instead. GetSingleItem Conditionally

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Conditionally

IncludeSelector: Details

The fully qualified ID breadcrumb (path) of the first category. For example, if the primary category ID is 45678, and its parent category's ID is 123, the breadcrumb (path) would be 123:45678. GetSingleItem Always

IncludeSelector: Details

ID of the second category in which the item is listed. GetSingleItem Conditionally

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Conditionally

IncludeSelector: Details

Name of the second category in which the item is listed. GetSingleItem Conditionally

IncludeSelector: Details

FindItemsAdvanced Conditionally

IncludeSelector: Details

FindProducts Conditionally

IncludeSelector: Details

The fully qualified ID breadcrumb (path) of the second category. For example, if the secondary category ID is 45678, and its parent category's ID is 123, the breadcrumb (path) would be 123:45678. GetSingleItem Conditionally

IncludeSelector: Details

Identifier for a Giving Works listing and the benefiting nonprofit charity organization. GetSingleItem Conditionally FindItemsAdvanced Conditionally

IncludeSelector: SearchDetails

For a digitally delivered item, the requirements for using the item. FindItemsAdvanced Conditionally

IncludeSelector: SearchDetails

For a digitally delivered item, the digital-download method. FindItemsAdvanced Conditionally

IncludeSelector: SearchDetails

The item is featured in eBay search results on the mobile.de partner site. Applicable to eBay Germany. FindItemsAdvanced Conditionally

IncludeSelector: SearchDetails

A Get It Fast listing. FindItemsAdvanced Conditionally

IncludeSelector: SearchDetails

If true, a generic gift icon displays next the listing's title in search and browse pages. FindItemsAdvanced Conditionally

IncludeSelector: SearchDetails

Whether the item has a picture. FindItemsAdvanced Conditionally

IncludeSelector: SearchDetails

Whether the item is no more than one day old. FindItemsAdvanced Conditionally

IncludeSelector: SearchDetails

Whether the item is a storefront listing. FindItemsAdvanced Conditionally

IncludeSelector: SellerInfo

FindHalfProducts Conditionally

IncludeSelector: Items

The distance of the item from the buyer. FindItemsAdvanced Conditionally

IncludeSelector: SearchDetails

Two-letter ISO 3166 country code. Used with the Location field to indicate the city and country where the item is located. FindItemsAdvanced Conditionally

IncludeSelector: Details

FindHalfProducts Conditionally

IncludeSelector: Items

FindProducts Conditionally

IncludeSelector: Details

Watch count for the item. FindPopularItems Always Half condition codes like brand new etc FindHalfProducts Conditionally

IncludeSelector: Items

Seller notes while listing items. FindHalfProducts Conditionally

IncludeSelector: Items

If a seller specified return policy details, then this container has fields with those details. The fields that can be returned in this container vary by site. GetSingleItem Conditionally

IncludeSelector: Details

Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to Chinese and Dutch auction listings. Returns null for basic Fixed Price (FixedPriceItem),Store Inventory (StoresFixedPrice), and Ad type listings. 4000 GetSingleItem Conditionally

IncludeSelector: Details

A prototype description of a well-known type of item, such as a popular book. When returned for GetSingleItem, is always of type Reference, and serves as a global reference ID for an eBay catalog product. When used as input, retrieves 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. The request requires either QueryKeywords or ProductID, but these fields cannot be used together. 4000 GetSingleItem Conditionally

IncludeSelector: Details

Type to contain the data for one eBay user. Depending on the context, the user might be the seller or the buyer in a transaction, or the bidder or winning bidder in a listing. An object of this type is returned by a number of calls, including the GetUser call. The user's eBay user ID. A unique value. If a bidder's user information is made anonymous, the real ID value will be replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. Note that the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". GetSingleItem Always

IncludeSelector: Details

GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always FindItemsAdvanced Conditionally

IncludeSelector: SellerInfo

Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private. If a bidder's user information is made anonymous, the value -99 is returned. GetSingleItem Always

IncludeSelector: Details

GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always Visual indicator of user's feedback score. GetSingleItem Always

IncludeSelector: Details

GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always FindItemsAdvanced Conditionally

IncludeSelector: SellerInfo

The aggregate feedback score of a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user. (The buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.) That one feedback can be positive, negative, or neutral. The aggregate feedback score of a user represents that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private, then FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. If a bidder's user information is made anonymous, the value -99 is returned. GetSingleItem Conditionally

IncludeSelector: Details

GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always FindHalfProducts Conditionally

IncludeSelector: Items

FindItemsAdvanced Conditionally

IncludeSelector: Details

Indicates whether eBay has made this user's information anonymous. This occurs when the listing prices (reserve, current, or Buy It Now) reach or exceed a certain amount (such as $200 USD at the time of this writing). If true, certain other fields about this user are not returned, or their values include no identifying characteristics. (The rules are explained in the description of each field.) If false, all user-specific fields contain the user's actual data. GetSingleItem Conditionally HighBidder

IncludeSelector: Details

GetItemStatus Conditionally HighBidder

IncludeSelector: Details

If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change. GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always The date the specified user originally registered with eBay. If a bidder's user information is made anonymous, the value -99 is returned. GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always The eBay site with which the user is registered. If a bidder's user information is made anonymous, the value -99 is returned. GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always The registration-related status of the user. GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always Type of seller account. GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always The URL of the seller's eBay Store page. GetUserProfile

IncludeSelector: Details

Always The name of the seller's eBay Store. GetUserProfile

IncludeSelector: Details

Always URL for seller's other items. GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always A link to the user's AboutMe page. GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always A link to the URL of the user's MyWorld page. GetUserProfile

IncludeSelector: Details

Always Location of a user's image on the MyWorld page (small version). GetUserProfile

IncludeSelector: Details

Always Location of a user's image on the MyWorld page (large version). GetUserProfile

IncludeSelector: Details

Always The URL of reviews and guides. GetUserProfile

IncludeSelector: Details

Always The URL of feedback details. GetUserProfile

IncludeSelector: none, Details, FeedbackDetails, FeedbackHistory

Always The percentage value of a user's positive feedback. GetSingleItem Seller

IncludeSelector: Details

Always eBay sites (by the country in which each resides) on which a user is registered and on which items can be listed. USA, site ID 0, abbreviation US, currency USD. Canada, site ID 2, abbreviation CA, currencies CAD and USD. United Kingdom, site ID 3, abbreviation UK, currency GBP. Australia, site ID 15, abbreviation AU, currency AUD. Austria, site ID 16, abbreviation AT, currency EUR. Belgium (French), site ID 23, abbreviation BEFR, currency EUR. France, site ID 71, abbreviation FR, currency EUR. Germany, site ID 77, abbreviation DE, currency EUR. Italy, site ID 101, abbreviation IT, currency EUR. Belgium (Dutch), site ID 123, abbreviation BENL, currency EUR. Netherlands, site ID 146, abbreviation NL, currency EUR. Spain, site ID 186, abbreviation ES, currency EUR. Switzerland, site ID 193, abbreviation CH, currency CHF. Taiwan, site ID 196, abbreviation TW, currency TWD. eBay Motors, site ID 100, currency USD. Hong Kong, site ID 201, abbreviation HK, currency HKD. Singapore, site ID 216, abbreviation SG, currency SGD. India, site ID 203, abbreviation IN, currency INR. China, site ID 223, abbreviation CN, currency CNY. Ireland, site ID 205, abbreviation IE, currency EUR. Malaysia, site ID 207, abbreviation MY, currency MYR. Philippines, site ID 211, abbreviation PH, currency PHP. Poland, site ID 212, abbreviation PL, currency PLN. Sweden, site ID 218, abbreviation SE, currency SEK. Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. CanadaFrench, site ID 210, abbreviation CAFR, currencies CAD and USD. Indicates the order of sorting. Sorts results in ascending (low to high) order. Sorts results in descending (high to low) order. Placeholder value. See <a href="types/simpleTypes.html#token">token</a>. Identifies the StoreSearch codes (e.g., for FindItemsAdvanced requests). (in) Within a single store for all items (specify a store in the appropriate input field). (in) Within a single store for auction items (specify a store in the appropriate input field). (in) Within a single store for basic fixed price items, Store Inventory format items, and auction items with Buy It Now (specify a store in the appropriate input field). (in) Across all stores for basic fixed price items, Store Inventory format items, and auction items with Buy It Now. (out) Reserved for internal or future use. Contains information related to the item in the context of a seller's eBay Store. Applicable for auction format, Basic Fixed Price, and Store Inventory format items listed by eBay Stores sellers. The URL of the seller's eBay Store page. FindProducts only returned a default URL at the time of this writing. FindHalfProducts returns the URL of the seller's Half.com Shop page. FindItemsAdvanced Conditionally

IncludeSelector: SellerInfo

FindHalfProducts Conditionally

IncludeSelector: Items

The name of the seller's eBay Store. FindProducts returns an empty value for all items at the time of this writing. FindHalfProducts returns the name of seller's Half.com Shop, which is the SellerID. 200 FindItemsAdvanced Conditionally

IncludeSelector: SellerInfo

FindHalfProducts Conditionally

IncludeSelector: Items

Tax-related details for a region or jurisdiction. Representative identifier for the jurisdiction. Typically an abbreviation (e.g. CA for California). GetShippingCosts Conditionally The tax percent to apply for a listing shipped to this jurisdiction. The value passed in is stored with a precision of 3 digits after the decimal point (##.###). GetTaxTable: this tag has no value if the user's tax table has not been set. GetShippingCosts Conditionally Whether shipping costs are to be part of the base amount that is taxed. GetTaxTable: This tag is empty if the user did not previously provide information. GetShippingCosts Conditionally Sales tax details for zero or more jurisdictions (states, provinces, etc). Sales tax details for zero or more jurisdictions (states, provinces, etc). Information is only returned for the jurisdictions for which the user provided tax information. ShippingIncludedInTax and SalesTaxPercent are returned but are empty. GetShippingCosts Conditionally A means for identifying a person's role in doing business on eBay. (in/out) Acting as buyer. (in/out) Acting as seller. (out) Reserved for future use An eBay ID that uniquely identifies a user. For GetAllBidders, if the user chose to be anonymized, a generic ID is returned. These codes indicate the current state or status of a an eBay user account. (out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem (out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement (out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category (out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email (out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay (out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status (out) Records for the specified user have been deleted (out) User has completed registration and confirmation, but is pending a verification of credit card information (out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items (out) User record has been merged with another account record for the same user (out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email (out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the verification of credit card information is still pending (out) Half.com User; user has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending (out) Reserved for internal or future use 535