Container for Bulk Data Exchange Requests. Defines default or required values for requests in the payload. Container for Bulk Data Exchange Responses. Defines default or required values for requests in the payload. The numeric eBay Site Code for which to route the requests in the payload. E.g. 77 for eBay Germany. BulkDataExchange Yes Default version for each request in the payload. Can be overridden at the request level. BulkDataExchange Yes Authentication information for the user on whose behalf the application is making the request. Only registered eBay users are allowed to make API calls. To verify that a user is registered, your application needs to pass a user-specific value called an "authentication token" in the request. This is equivalent to signing in on the eBay Web site. As API calls do not pass session information, you need to pass the user's authentication token every time you invoke a call on their behalf. All calls require an authentication token, except the calls you use to retrieve a token in the first place. (For such calls, you use the eBay member's username and password instead.) Yes A report that contains price and quantity information for all of the active listings for a specific seller. A seller can use this information to maintain their inventory on eBay. <br><br> The eBay servers read the token information passed in by the seller's application to determine which seller's data to retrieve. Reports price and quantity details for a seller's active listings. Trading http://developer.ebay.com/devzone/xml/docs/reference/ebay ReviseInventoryStatus Enables a seller to change the price and quantity of currently active fixed-price items. Can be uploaded in bulk with Large Merchant Services. ReviseFixedPriceItem Enables a seller to change the properties of a single currently active listing. Can be uploaded in bulk with Large Merchant Services. A report that contains all of the active listings for a specific seller. The eBay servers read the token information passed in by the seller's application to determine which seller's data to retrieve. Describes or includes keywords associated with the SKU. ActiveInventoryReport Always Defines and lists a new fixed-price item. A fixed-price listing can include multiple identical items. Defines and lists a new fixed-price item. A fixed-price listing can include multiple identical items. samples AddItem, AddItems, AddToItemDescription, EndFixedPriceItem, GetItem, GetCategories, GetItemRecommendations, RelistFixedPriceItem, ReviseFixedPriceItem, VerifyAddFixedPriceItem ListingAnItem UseTopicAlias ListingItemsIntro UseTopicAlias Pictures UseTopicAlias Variations UseTopicAlias ConsideringBestMatch UseTopicAlias Child fields hold the values that define the new fixed-price listing. AddFixedPriceItem Yes Returns the item ID, SKU (if any), and the estimated fees for the new listing (except the Final Value Fee, which isn't calculated until the item has sold), the start and end times of the listing, and other details. Unique item ID for the new fixed-price listing. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddFixedPriceItem Always Item-level SKU for the new listing, if the seller specified Item.SKU in the request. Variation SKUs are not returned (see GetItem instead). AddFixedPriceItem Conditionally Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller specified Item.ScheduleTime in the request. AddFixedPriceItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. AddFixedPriceItem Always Child elements contain the estimated listing fees for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. eBay.com Fees http://pages.ebay.com/help/sell/fees.html AddFixedPriceItem Always FinalValueFeesAndCredits UseTopicAlias Final Value Fees http://pages.ebay.com/help/sell/fvf.html FeesPerSite UseTopicAlias UsingFeaturePacks UseTopicAlias ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or if it has expired with no replacement, CategoryID does not return a value. 10 AddFixedPriceItem Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 AddFixedPriceItem Conditionally The nature of the discount, if a discount applied. AddFixedPriceItem Conditionally Ends the specified fixed-price listing before the date and time at which it would normally end (per the listing duration). Ends the specified fixed-price listing before the date and time at which it would normally end (per the listing duration). samples EndItem, RelistFixedPriceItem EndingItemsEarly UseTopicAlias Unique item ID that identifies the item listing that you want to end. <br><br> In the EndFixedPriceItem request, either ItemID or SKU is required. If both are passed in and they don't refer to the same listing, eBay ignores SKU and considers only the ItemID. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) EndFixedPriceItem Conditionally Indicates the seller's reason for ending the listing early. This field is required if the seller is ending the item early and the item did not successfully sell. EndFixedPriceItem Yes The unique SKU of the item being ended. A SKU (stock keeping unit) is an identifier defined by a seller. SKU can only be used to end an item if you listed the item by using AddFixedPriceItem or RelistFixedPriceItem, and you set Item.InventoryTrackingMethod to SKU at the time the item was listed. (These criteria are necessary to uniquely identify the listing by a SKU.) <br><br> In the EndFixedPriceItem request, either ItemID or SKU is required. If both are passed in and they don't refer to the same listing, eBay ignores SKU and considers only the ItemID. <br><br> To remove a SKU when you revise or relist an item, use DeletedField in the revision or relist call. 50 EndFixedPriceIteme> Conditionally Acknowledgement that includes SKU, as well as the date and time the auction was ended due to the call to EndFixedPriceItem. Indicates the date and time (returned in GMT) the specified item listing was ended. EndItem Always The SKU (stock-keeping unit) that the seller specified for the listing, if any. 50 EndFixedPriceIteme> Conditionally Contains information about user invoice and related order information. To use this report, you must perform the one-time steps described in <a href="http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1394"> Support Knowledge Base Article - LMS: FeeSettlementReport one time set-up process </a>. Contains information about user invoice and related order information, such as: fee type, fee amount, item category, order id, transaction id, item id, and item title. Contains information about user invoice and related order information, such as: fee type, fee amount, item category, order id, transaction id, item id, and item title. Some setup steps are required. See the Knowledgebase Article at the following link. Setting Up the FeeSettlementReport http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1394 The invoice identifier is an alphanumeric value that uniquely identifies the invoice for the specified invoice period for the associated customer account. FeeSettlementReport Always site username FeeSettlementReport Always eBay Account Id. FeeSettlementReport Always Beginning date time of invoice period. FeeSettlementReport Always Ending date time of invoice period. FeeSettlementReport Always Date time of billing process (BIP). FeeSettlementReport Always Invoice due date. FeeSettlementReport Always This invoice amount. FeeSettlementReport Always Amount of the previous invoice. The LastInvoiceAmount is included in the report if at least one invoice has already been sent to the user requesting this report. FeeSettlementReport Conditionally The rounding adjustment will be calculated as: the difference between the total individual invoice line items and the total InvoiceAmount plus UsageAdjustment. FeeSettlementReport Always The Usage Adjustment will equal the total unrounded usage fee amounts, multiplied by the tax rate. FeeSettlementReport Always Usage transactions with order information belong to this invoice. FeeSettlementReport Conditionally Usage transactions which can not find the order information belong to this invoice. FeeSettlementReport Conditionally Usage adjustment belong to this invoice. FeeSettlementReport Conditionally Non-usage transactions belong to this invoice. FeeSettlementReport Conditionally Discount transactions belong to this invoice. FeeSettlementReport Conditionally Request that you use to acknowlege that an order has been received. Use the OrderAck job to acknowledge each line item in a SoldReport by order or line item. After you send the first OrderAck call, future SoldReports will only contain unacknowledged orders or line items. Request that you use to acknowlege that an order has been received. An ID that uniquely identifies each order (item or items paid for within the same transaction). OrderAck Yes An ID that uniquely identifies each line item (specifics about a purchased item or SKU) within an order. OrderAck Yes Response to your request that acknowledges each line item of an order. OrderLineItemID is required upon input and always returned 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. OrderAck Always Enables a seller to take a single fixed-price item (or a single multi-item listing) that has ended and re-list it on a specified eBay site. Enables a seller to take a single fixed-price item (or a single multi-item listing) that has ended and re-list it on a specified eBay site. samples AddFixedPriceItem, RelistItem, ReviseFixedPriceItem, GetCategories Pictures UseTopicAlias UseTopicAlias RelistingItems Relisting Your Item (eBay Web site onine help) http://pages.ebay.com/help/sell/relist.html ConsideringBestMatch UseTopicAlias BestMatchReviseRelist UseTopicAlias Child elements hold the values for item properties that change for the relisted item. Item is a required input. At a minimum, the Item.ItemID property must be set to the ID of the original listing (a listing that ended in the past 90 days). By default, the new listing's Item object properties are the same as those of the original (ended) listing. By setting a new value in the Item object, the new listing uses the new value rather than the original value from the old listing. RelistFixedPriceItem Yes Specifies the name of the field to delete from a listing. See the eBay Trading API guide for rules on deleting values when relisting items. Also see the relevant field descriptions to determine when to use DeletedField (and potential consequences). The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted). DeletedField accepts the following path names, which delete the corresponding nodes:<br> <br> Some data (such as Variation nodes within Variations) can't be deleted by using DeletedFields. See the relevant field descriptions for how to delete such data.<br> <br> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.Charity<br> Item.ItemSpecifics<br> Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> Item.ListingDesigner.LayoutID<br> Item.ListingDesigner.ThemeID<br> Item.ListingDetails.LocalListingDistance<br> Item.ListingDetails.MinimumBestOfferMessage<br> Item.ListingDetails.MinimumBestOfferPrice<br> Item.ListingEnhancement[Value]<br> Item.PayPalEmailAddress<br> Item.PictureDetails.GalleryURL<br> Item.PictureDetails.PictureURL<br> Item.PostalCode<br> Item.ProductListingDetails<br> Item.SecondaryCategory<br> Item.SellerContactDetails<br> Item.SellerContactDetails.CompanyName<br> Item.SellerContactDetails.County<br> Item.SellerContactDetails.InternationalStreet<br> Item.SellerContactDetails.Phone2AreaOrCityCode<br> Item.SellerContactDetails.Phone2CountryCode<br> Item.SellerContactDetails.Phone2CountryPrefix<br> Item.SellerContactDetails.Phone2LocalNumber<br> Item.SellerContactDetails.PhoneAreaOrCityCode<br> Item.SellerContactDetails.PhoneCountryCode<br> Item.SellerContactDetails.PhoneCountryPrefix<br> Item.SellerContactDetails.PhoneLocalNumber<br> Item.SellerContactDetails.Street<br> Item.SellerContactDetails.Street2<br> Item.ShippingDetails.PaymentInstructions<br> Item.SKU<br> Item.SubTitle<br> These values are case-sensitive. Use values that match the case of the schema element names (Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL). However, do not change the case of letters in the middle of a field name. For example, item.picturedetails.galleryUrl is not allowed.<br><br> To delete a listing enhancement like Featured, specify the value you are deleting; for example, Item.ListingEnhancement[Featured]. RelistFixedPriceItem Conditionally Returns the item ID and the estimated fees for the re-listed item. Unique item ID for the relisted item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RelistFixedPriceItem Always Item-level SKU for the new listing, if the seller specified Item.SKU in the listing. Variation SKUs are not returned (see GetItem instead). RelistFixedPriceItem Conditionally Child elements contain the estimated listing fees for the relisted item. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. RelistFixedPriceItem Always Date and time the relisting became active on the eBay site. RelistFixedPriceItem Always Date and time when the relisted item ends. This is the starting time plus the listing duration. RelistFixedPriceItem Always ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. 10 RelistFixedPriceItem Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 RelistFixedPriceItem Conditionally The nature of the discount, if a discount applied. RelistFixedPriceItem Conditionally Enables a seller to change the properties of a currently active fixed-price listing (including multi-variation listings). Enables a seller to change the properties of a currently active fixed-price listing (including multi-variation listings). samples AddFixedPriceItem, RelistFixedPriceItem, ReviseItem UseTopicAlias RevisingItems Pictures UseTopicAlias ConsideringBestMatch UseTopicAlias BestMatchReviseRelist UseTopicAlias Child elements hold the values for item details that you want to change. The Item.ItemID must always be set to the ID of the listing being changed. Only specify Item fields for the details that are changing. Unless otherwise specified in the field descriptions below, the listing retains its existing values for fields that you don't pass in the ReviseFixedPriceItem request. Use DeletedField to remove a field from the listing. ReviseFixedPriceItem Yes Specifies the name of a field to delete from a listing. See the eBay Trading API guide for rules on deleting values when relisting items. Also see the relevant field descriptions to determine when to use DeletedField (and potential consequences). The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted). DeletedField accepts the following path names, which delete the corresponding nodes: <br><br> You cannot delete required fields from a listing. <br><br> Some data (such as Variation nodes within Variations) can't be deleted by using DeletedFields. See the relevant field descriptions for how to delete such data. <br><br> Some fields are optional when you first list an item (e.g., ListingEnhancement), but once they are set they cannot be deleted when you revise an item. Some optional fields cannot be deleted if the item has bids and/or ends within 12 hours. Some optional fields cannot be deleted if other fields depend on them. For example, if GalleryType was already set for the item you are revising, you cannot remove it. Therefore, you still need to include at least one picture URL, a gallery URL, or a catalog stock photo in your revised listing. See the eBay Trading API guide for rules on removing values when revising items. <br><br> The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted). DeletedField accepts the following path names, which delete the corresponding nodes: <br><br> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.ItemSpecifics<br> Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> Item.ListingDesigner.LayoutID<br> Item.ListingDesigner.ThemeID<br> Item.PayPalEmailAddress<br> Item.PictureDetails.GalleryURL<br> Item.PictureDetails.PictureURL<br> Item.PostalCode<br> Item.ProductListingDetails<br> Item.SellerContactDetails<br> Item.SellerContactDetails.CompanyName<br> Item.SellerContactDetails.County<br> Item.SellerContactDetails.InternationalStreet<br> Item.SellerContactDetails.Phone2AreaOrCityCode<br> Item.SellerContactDetails.Phone2CountryCode<br> Item.SellerContactDetails.Phone2CountryPrefix<br> Item.SellerContactDetails.Phone2LocalNumber<br> Item.SellerContactDetails.PhoneAreaOrCityCode<br> Item.SellerContactDetails.PhoneCountryCode<br> Item.SellerContactDetails.PhoneCountryPrefix<br> Item.SellerContactDetails.PhoneLocalNumber<br> Item.SellerContactDetails.Street<br> Item.SellerContactDetails.Street2<br> Item.ShippingDetails.PaymentInstructions<br> Item.SKU (unless InventoryTrackingMethod is SKU)<br> Item.SubTitle <br><br> These values are case-sensitive. Use values that match the case of the schema element names (Item.PictureDetails.GalleryURL) or make the initial letter of each field name lowercase (item.pictureDetails.galleryURL). However, do not change the case of letters in the middle of a field name. For example, item.picturedetails.galleryUrl is not allowed. ReviseFixedPriceItem Conditionally Returns the item ID and the estimated fees for the revised listing. Item ID that uniquely identifies the item listing that was revised. Provided for confirmation purposes. The value returned should be the same as the item ID specified in the ItemID property of the Item object specified as input for the call. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) ReviseFixedPriceItem Always Item-level SKU for the listing, if the seller specified Item.SKU for the listing. Variation SKUs are not returned (see GetItem instead). ReviseFixedPriceItem Conditionally Starting date and time for the listing. ReviseFixedPriceItem Always Date and time when the new listing ends. This equals the starting time plus the listing duration. ReviseFixedPriceItem Always Child elements contain the estimated listing fees for the revised item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. Revising an item does not itself incur a fee. However, certain item properties are fee-based and result in the return of fees in the call's response. ReviseFixedPriceItem Always eBay.com Fees http://pages.ebay.com/help/sell/fees.html FeesPerSite UseTopicAlias FinalValueFeesAndCredits UseTopicAlias Final Value Fees http://pages.ebay.com/help/sell/fvf.html ID of the primary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. 10 ReviseFixedPriceItem Conditionally ID of the secondary category in which the item was listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID passed in Item.SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 ReviseFixedPriceItem Conditionally The nature of the discount, if a discount applied. ReviseFixedPriceItem Conditionally Enables a seller to change the price and quantity of a currently- active, fixed-price listing. <br> <br> Be aware that changing the price or quantity of a currently- active, fixed-price listing does not reset the Best Match performance score. For Best Match information related to multi-variation listings, see the Best Match information at the following topic: <a href="http://pages.ebay.com/sell/variation/">Multi-quantity Fixed Price listings with variations</a>. <b>Note:</b> When you use ReviseInventoryStatus within a Merchant Data file, it must be enclosed within two BulkDataExchangeRequest tags. After release 637, a namespace is returned in the BulkDataExchangeResponseType (top level) of the response. The BulkDataExchange tags are not shown in the call input/output descriptions. Enables a seller to change the price and quantity of currently active fixed-price items. samples AddItems, GetSellerList, ReviseItem, RelistItem ConsideringBestMatch UseTopicAlias BestMatchReviseRelist UseTopicAlias Contains the updated quantity and/or price of a listing being revised. You should not modify the same listing twice (by using a duplicate ItemID or SKU) in the same request; otherwise, you may get an error or unexpected results. (For example, you should not use one InventoryStatus node to update the quantity and another InventoryStatus node to update the price of the same item.) You can pass up to 4 InventoryStatus nodes in a single request. ReviseInventoryStatus Yes 4 Returns the Item ID or SKU with changed Price and Quantity for the revised listing. Confirms the quantity and price associated with a listing or variation that was revised. ReviseInventoryStatus Always 4 Child elements contain the estimated listing fees for a listing that was revised. Use the ItemID to correlate the Fees data with the InventoryStatus data in the response. The fees do not include the Final Value Fee (FVF), which can't be determined until the listing has sales.<br> <br> If you revise a variation in a multi-variation listing, the fees are for the entire listing. The insertion fee and listing fee are affected by the highest priced variation in the listing (which is not necessarily the variation that you passed in the request).<br> <br> Also note that the call returns only one Fees node per listing. For example, if you revise 4 variations from the same multi-variation listing, the response includes 4 InventoryStatus nodes and 1 Fees node. ReviseInventoryStatus Always eBay.com Fees http://pages.ebay.com/help/sell/fees.html FeesPerSite UseTopicAlias FinalValueFeesAndCredits UseTopicAlias Final Value Fees http://pages.ebay.com/help/sell/fvf.html Includes information about a specific item and the shipping information associated with it. Carrier tracking information associated with a specific order line item. An ID that uniquely identifies each order (item or items paid for within the same transaction). SetShipmentTrackingInfo Yes An ID that uniquely identifies each line item within an order. SetShipmentTrackingInfo Yes Includes carrier name, tracking number, and shipped time. SetShipmentTrackingInfo Yes Response to a SetShipmentTrackingInfo request, that gives you information about whether the call reached the eBay servers with or without errors. OrderLineItemID is required upon input and always returned 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. SetShipmentTrackingInfo Always Lists all items that have been sold by this seller. If a buyer purchased multiple items from a single listing, the sale will result in a single Order ID for the total purchase with a separate Line Item ID for each of the purchased items. The SoldReport request returns the data for all of your new orders (newly-sold items) with Order ID and Order Line Item ID. The Sold Report includes all transactions for the past 30 days (from the transaction creation date). <br><br> The concept of an 'Order' is only used in the Trading API when a buyer makes combined payments. Each payment is a transaction. But in the Large Merchant Services solution, every sale is considered to be an Order. It is important to recognize these conceptual differences when you are working with multiple APIs. <br><br> OrderLineItemID is a based upon the combination of the eBay Trading API's ItemID and TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen is the Transaction ID. The Transaction field in the Trading API is a container that can include many types of transaction information. <br><br> See <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#Response.TransactionArray.Transaction.TransactionID" target="_blank">Trading API</a> for more information. <br><br> Sellers use the information in the SoldReport to make inventory updates and start order fulfillment. <br><br> <b>Note:</b> After release 637, a namespace is returned in the BulkDataExchangeResponseType (top level) of the response. This container is not shown in the call output description, but you can see it in the call samples at the end of this page. See <a href="http://developer.ebay.com/DevZone/large-merchant-services/Concepts/MakingACall.html" target="_blank">Making An API Call</a> for more information about the BulkDataExchange Response container. Contains information about the sold item, such as: order ID, buyer information, shipping information, order creation time, payment cleared time, tax amount, insurance cost, and total cost. Lists all items that have been sold by this seller. If a buyer purchased multiple items from a single listing, the sale will result in a single Order ID for the total purchase with a separate Line Item ID for each of the purchased items. The SoldReport request returns the data for all of your new orders (newly-sold items) with Order ID and Order Line Item ID. The Sold Report includes all transactions for the past 30 days (from the transaction creation date). <br><br> The concept of an 'Order' is only used in the Trading API when a buyer makes combined payments. Each payment is a transaction. But in the Large Merchant Services solution, every sale is considered to be an Order. It is important to recognize these conceptual differences when you are working with multiple APIs. <br><br> OrderLineItemID is a based upon the combination of the eBay Trading API's ItemID and TransactionID fields. The number before the hyphen is the Item ID and the number after the hyphen is the Transaction ID. The Transaction field in the Trading API is a container that can include many types of transaction information. <br><br> See <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html#Response.TransactionArray.Transaction.TransactionID" target="_blank">Trading API</a> for more information. <br><br> The Sold Report includes all transactions for the past 30 days (from the transaction creation date), but does not include items where the sale of the item has been acknowledged using the OrderAckRequest. See <a href="http://developer.ebay.com/DevZone/large-merchant-services/Concepts/LMS_APIGuide.html#soldrpt" target="_blank">Acknowledging Sales</a> for more information. <br><br> Sellers use the information in the SoldReport to make inventory updates and start order fulfillment. <br><br> Note: After release 637, a namespace is returned in the BulkDataExchangeResponseType (top level) of the response. This container is not shown in the call output description, but you can see it in the call samples at the end of this page. See <a href="http://developer.ebay.com/DevZone/large-merchant-services/Concepts/MakingACall.html" target="_blank">Making An API Call</a> for more information about the BulkDataExchange Response container. Contains information about the sold item, such as: order ID, order line item ID, buyer information, shipping information, order creataion time, payment cleared time, tax amount, insurance cost, and total cost. <br><br> See OrderLineItemType for more information about the OrderLineItemID field. SoldReport Always Uploads a picture for a listing and returns a URL for the picture. Uploads a picture for a listing and returns a URL for the picture. samples UseTopicAlias Pictures UseTopicAlias PictureDetails UseTopicAlias Gallery UseTopicAlias VariationPictures A name you provide for the picture. Returned as SiteHostedPictureDetails.PictureName in the call response. UploadSiteHostedPictures No Specifies the picture system version. Only version 2 is valid. Available to support future changes in the picture system version. 2 UploadSiteHostedPictures No The image sizes that will be generated. Standard Large UploadSiteHostedPictures No An optional reference ID to the binary attachment. The PictureData field does not contain the binary attachment. The binary attachment is image data, including headers, from a JPG, GIF, PNG, BMP, or TIF format image file. The binary attachment must be sent as a MIME attachment, in your POST request, after the XML input. <br> <br> <b>Note: Not applicable for eBay Large Merchant Services. Use the ExternalPictureURL field instead.</b> UploadSiteHostedPictures No When the My Picture Uploads feature is available (see the Trading API Release Notes), applications (including non-listing apps, such as photo-editors and digital-camera software) will be able to use the PictureUploadPolicy field to specify that an uploaded picture is available to a seller on the eBay site. When you use PictureUploadPolicy, you are specifying that the picture you uploaded (and its URL) is stored for 48 hours on the eBay site. (If, within 48 hours, the picture is associated with an item, then it persists on the eBay site for the same time length as other pictures uploaded using the UploadSiteHostedPictures call). As a result of the storage on the eBay site, the picture is available to the seller on the My Picture Uploads tab within the Sell Your Item (SYI) pages. A maximum of 25 URLs can be stored. UploadSiteHostedPictures No Include the URL for a picture that you want to include in your listing. You can only include one ExternalPictureURL field per call. <br> <br> This field allows the eBay server to retrieve a picture from a URL on an external web server. Once retrieved, the picture will be copied to eBay Picture Services (EPS), and retained for 90 days, plus the length of your listing duration. <br> <br> <b>Note: The ExternalPictureURL field is required when using eBay Large Merchant Services.</b> 1024 UploadSiteHostedPictures Conditionally 1 This is the type of watermark that should be applied to the pictures hosted by the eBay Picture Services. Please note that watermarks are applied only to pictures that are greater than an EPS configured size. The possible values are: None, Both, Icon, or SellerId. UploadSiteHostedPictures No The number of days to extend the expiration date for the specified image, after a listing has ended. This call is restricted to applications that have been granted permission to use it by eBay Developer Technical Support. <br><br> This call is not needed for active listings - it is meant to be used only when a photo needs to be hosted longer than the normal listing duration. <br><br> The maximum number of days allowed for this field is 30. 1 30 UploadSiteHostedPictures No Contains information about a picture upload (i.e., information about a picture upload containing a binary attachment of an image). Specifies the picture system version that was used to upload pictures. Only version 2 is valid. UploadSiteHostedPictures Always Contains information about an UploadSiteHostedPictures upload, including the URL of the uploaded picture. UploadSiteHostedPictures Always Enables a seller to test the definition of a new fixed-price listing by submitting the definition to eBay without creating a actual listing. Enables a seller to test the definition of a new fixed-price listing by submitting the definition to eBay without creating a actual listing. samples AddFixedPriceItem, VerifyAddItem UseTopicAlias ListingAnItem Pictures UseTopicAlias Child fields hold the values that define the new fixed-price listing. VerifyAddFixedPriceItem Yes Returns the estimated fees that would be applicable for a new listing (were the item actually listed to eBay with AddItem). Represents the item ID for the new fixed-price listing. VerifyAddFixedPriceItem does not actually list an item, so 0 is returned instead of a normal item ID. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) VerifyAddFixedPriceItem Always Item-level SKU for the new listing, if the seller specified tem.SKU in the request. Variation SKUs are not returned (see GetItem instead). AddFixedPriceItem Conditionally Child elements contain the estimated listing fees for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. VerifyAddFixedPriceItem Always Indicates whether the item would be listed on eBay Express. See ExpressItemRequirements for hints about why this value is true or false for a given item. 579 NoOp VerifyAddFixedPriceItem Conditionally Contains details about why an item does or doesn't qualify as an eBay Express listing. Only returned when IncludeExpressRequirements is true the request.<br> <br> The item requirements are assessed in this order:<br> - SellerExpressEligible<br> - ExpressOptOut<br> - ExpressApproved<br> - All other settings 579 NoOp VerifyAddFixedPriceItem Conditionally ID of the primary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in PrimaryCategory was mapped to a new ID by eBay. If the primary category has not changed or it has expired with no replacement, CategoryID does not return a value. 10 VerifyAddFixedPriceItem Conditionally ID of the secondary category in which the item would be listed. Only returned if you set Item.CategoryMappingAllowed to true in the request and the ID you passed in SecondaryCategory was mapped to a new ID by eBay. If the secondary category has not changed or it has expired with no replacement, Category2ID does not return a value. 10 VerifyAddFixedPriceItem Conditionally The nature of the discount, if a discount would have applied had this actually been listed at this time. VerifyAddFixedPriceItem Conditionally 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 (e.g., AddItemRequestType) 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 Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request.<br> <br> The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.)<br> <br>Note that DetailLevel is required input for GetMyMessages. <br> <br> With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Yes GetMyMessages ReturnSummary, ReturnHeaders, ReturnMessages No GetAdFormatLeads GetAttributesCS GetAttributesXSL GetBestOffers GetCategories GetCategory2CS GetCategoryMappings GetFeedback GetOrders GetProductFinder GetProductFinderXSL GetProductSearchPage GetSellerEvents GetTaxTable ReturnAll, none No GetCategoryFeatures GetMyeBayBuying GetMyeBaySelling GetUser GetUserDisputes ReturnAll, ReturnSummary, none No GetItemTransactions GetSellerList GetSellerTransactions GetOrderTransactions ItemReturnDescription, ReturnAll, none No GetSellingManagerTemplates GetItem ItemReturnAttributes, ItemReturnDescription, ReturnAll, none No GetSearchResults ItemReturnAttributes, ItemReturnCategories, ReturnAll, none No Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). <br> ID--- country<br> ----- -----<br> de_AT Austria<br> de_CH Switzerland<br> de_DE Germany <br> en_AU Australia <br> en_CA Canada <br> en_GB United Kingdom<br> en_SG Singapore<br> en_US United States <br> es_ES Spain <br> fr_BE Belgium (French)<br> fr_CA Canada (French) <br> fr_FR France <br> it_IT Italy <br> nl_BE Belgium (Dutch)<br> nl_NL Netherlands <br> zh_CN China<br> en_IN India<br> en_IE Ireland<br> zh_HK Hong Kong No http://www.ietf.org/rfc/rfc3066.txt Tags for the Identification of Languages In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. <br> <br> <span class="tablenote"><b>Note:</b> GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. </span> No The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects:<br> - It indicates the version of the code lists and other data that eBay should use to process your request.<br> - It indicates the schema version you are using.<br> You need to use a version that is greater than or equal to the lowest supported version.<br> <br> <b>For the SOAP API:</b> If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.<br> <br> <b>For the XML API:</b> If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) Conditionally HTTPHeaders UseTopicAlias eBay Schema Versioning Strategy ../../HowTo/eBayWS/eBaySchemaVersioning.html Lowest Supported Version ../../HowTo/eBayWS/eBaySchemaVersioning.html#VersionSupportSchedule The public IP address of the machine from which the request is sent. Your application captures that IP address and includes it in a call request. eBay evaluates requests for safety (also see the BotBlock container in the request and response of this call). PlaceOffer Yes Authentication information for the user on whose behalf the application is making the request. Only registered eBay users are allowed to make API calls. To verify that a user is registered, your application needs to pass a user-specific value called an "authentication token" in the request. This is equivalent to signing in on the eBay Web site. As API calls do not pass session information, you need to pass the user's authentication token every time you invoke a call on their behalf. All calls require an authentication token, except the calls you use to retrieve a token in the first place. (For such calls, you use the eBay member's username and password instead.) Yes UseTopicAlias GettingAToken Error tolerance level for the call. This is a preference that specifies how eBay should handle requests that contain invalid data or that could partially fail. This gives you some control over whether eBay returns warnings or blocking errors and how eBay processes the invalid data.<br> <br> For AddItem and related calls, this field is only applicable when the listing includes Item Specifics and Pre-filled Item Information (such as AttributeSetArray and ProductListingDetails). AddItem AddItems AddLiveAuctionItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem BestEffort No AttributeErrorHandling UseTopicAlias CompleteSale BestEffort, FailOnError FailOnError No A unique identifer for a particular call. If the same InvocationID is passed in after it has been passed in once on a call that succeeded for a particular application and user, then an error will be returned. The identifier can only contain digits from 0-9 and letters from A-F. The identifier must be 32 characters long. For example, 1FB02B2-9D27-3acb-ABA2-9D539C374228. 32 AddOrder AddToItemDescription PlaceOffer ReviseCheckoutStatus ReviseItem No You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. GetAccount GetAdFormatLeads GetAllBidders GetBestOffers GetBidderList GetCategories GetCategoryFeatures GetCategoryListings GetCrossPromotions GetFeedback GetHighBidders GetItem GetItemsAwaitingFeedback GetItemShipping GetItemTransactions GetMemberMessages GetMyeBayBuying GetMyeBaySelling GetMyMessages GetNotificationPreferences GetOrders GetOrderTransactions GetProducts GetSearchResults GetSellerEvents GetSellerList GetSellerPayments GetSellerTransactions No UseTopicAlias ConfiguringOutputRetrieveData Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.<br> <br> An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.<br> <br> WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.<br> <br> We recommend that you only use this during development and debugging. Do not use this in requests in your production code. No https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=499 Warning Level Container for a token and for user input. PlaceOffer Conditionally Base type definition of a response payload that can carry any type of payload content with following optional elements:<br> - timestamp of response message<br> - application-level acknowledgement<br> - 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 GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. <br> <br> <span class="tablenote"><b>Note:</b> GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.</span> OrderAck, SetShipmentTrackingInfo Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. CompleteSale, GetPopularKeywords PartialFailure Always CompleteSale GetPopularKeywords Always In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned.<br> <br> <span class="tablenote"><b>Note:</b> GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable. </span> OrderAck, SetShipmentTrackingInfo Conditionally A list of application-level errors (if any) that occurred when eBay processed the request. Conditionally UseTopicAlias ErrorHandling Supplemental information from eBay, if applicable. May elaborate on errors (such as how a listing violates eBay policies) or provide useful hints that may help a seller increase sales. This data can accompany the call's normal data result set or a result set that contains only errors. <br> <br> Applications must recognize when the Message field is returned and provide a means to display the listing hints and error message explanations to the user. <br> <br> The string can return HTML, including TABLE, IMG, and HREF elements. In this case, an HTML-based application should be able to include the HTML as-is in the HTML page that displays the results. A non-HTML application would need to parse the HTML and convert the table elements and image references into UI elements particular to the programming language used. As usual for string data types, the HTML markup elements are escaped with character entity references (e.g.,&lt;table&gt;&lt;tr&gt;...). AddFixedPriceItem AddItem AddItems AddToItemDescription EndItem PlaceOffer RelistFixedPriceItem RelistItem RespondToWantItNowPost ReviseFixedPriceItem ReviseItem VerifyAddFixedPriceItem VerifyAddItem Conditionally UseTopicAlias Message The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response. OrderAck, SetShipmentTrackingInfo Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues. OrderAck, SetShipmentTrackingInfo Always Event name of the notification. Only returned by Platform Notifications. Information that explains a failure due to a duplicate InvocationID being passed in. AddFixedPriceItem AddItem AddItems AddLiveAuctionItem AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistFixedPriceItem RelistItem ReviseCheckoutStatus ReviseFixedPriceItem ReviseItem Conditionally Recipient user ID of the notification. Only returned by Platform Notifications. Unique Identifier of Recipient user ID of the notification. Only returned by Platform Notifications (not for regular API call responses). A Base64-encoded MD5 hash that allows the recipient of a Platform Notification to verify this is a valid Platform Notification sent by eBay. Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. FetchToken, OrderAck, SetShipmentTrackingInfo, GetSessionID Conditionally Container of token, image URL and audio URL. PlaceOffer Conditionally An application subscribing to notifications can include an XML-compliant string, not to exceed 256 characters, which will be returned. The string can identify a particular user. Any sensitive information should be passed with due caution. SetNotificationPreferences Conditionally GetNotificationPreferences Conditionally 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. Container of token and user reply. An encrypted token that eBay generates and that applications need to pass as input to subsquent calls. One use of this might be to block users from the site due to multiple call requests. PlaceOffer Conditionally The user's response to being asked to type the message in the botblock challenge image (that is, the image corresponding to BotBlockUrl that has been returned in a previous call). PlaceOffer Conditionally Container of token and image URL and Audio URL. An encrypted token generated by eBay when the botblock mechanism is triggered. This token is mapped to BotBlockUrl and BotBlockAudioUrl. PlaceOffer Conditionally The URL of the image that your application should display to the user for a botblock challenge. PlaceOffer Conditionally The URL of the audio-clip that your application should provide for sight-impaired users. The BotBlockAudioUrl audio-clip corresponds to the BotBlockUrl image. PlaceOffer Conditionally 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. This payment method is obsolete (ignored) for the US, US eBay Motors, UK, and Canada sites. See "Field Differences for eBay Sites" in the eBay Web Services Guide for a list of sites that accept COD as a payment method. Not applicable to Real Estate listings. When revising an item (on sites that still support COD), you can add or change its value. 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 and is required for all categories on the IN site. Other forms of payment. Some custom methods are accepted by seller as the payment method in the transaction. 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 true in listing requests, Item.PayPalEmailAddress must also be specified.<br> <br> If you don't pass PayPal in the listing request but the seller's eBay preferences are set to accept PayPal on all listings, eBay will add PayPal as a payment method for you in most cases, and we may return a warning. <br> <br> PayPal must be accepted when the seller requires immediate payment (Item.AutoPay) or offers other PayPal-based features, such as a finance offer (Item.FinanceOfferID). PayPal must be accepted for charity listings. PayPal must be accepted for event ticket listings when the venue is in New York state or Illinois, so that eBay can offer buyer protection (per state law). (For some applications, it may be simplest to use errors returned from VerifyAddItem to flag the PayPal requirement for New York and Illinois ticket listings.) PayPal must be accepted for US eBay Motors listings that require a deposit (and it will not be set automatically based on the seller's preferences). Conversely, if PayPal is specified for US eBay Motors listings, deposit attributes must be specified.<br> <br> For additional information about features that depend on PayPal, see the eBay Web Services Guide. 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. Applicable only to certain global eBay sites. See the "International Differences Overview" in the eBay Web Services Guide. All other online payments. Not applicable to US/CA eBay Motors listings. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for internal or future use. 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 the Express Germany site, which has been shut down. 579 NoOp PaisaPayEscrow payment option. Applicable on selected categories on the India site only. PaisaPayEscrowEMI (Equal Monthly Installments) Payment option. Must be specified with PaisaPayEscrow. Applicable only to India site. This payment method can be added only if a seller has a payment gateway (Payflow) account. You can use GetUser.User.SellerInfo.IntegratedMerchantCreditCardInfo to determine if a seller has a payment gateway (Payflow) account. If a seller successfully uses AddItem with IntegratedMerchantCreditCard, then for the resulting item, IntegratedMerchantCreditCard replaces specific, credit-card methods such as VisaMC. In such a case, the listing displays (to potential buyers) the credit cards that the seller specified in the seller's preferences for their payment gateway account (in My eBay). Additionally, a buyer's credit-card payment is integrated into eBay checkout. Applicable only to the US site. The Moneybookers payment method. For more information, see http://www.moneybookers.com/partners/us/ebay. Only applicable to the US site (and to the Parts and Accessories category of the US eBay Motors site). The Paymate payment method. For more information, see http://www.paymate.com/eBay. Only applicable to the US site (and to the Parts and Accessories category of the US eBay Motors site). The ProPay payment method. US site only. For more information, see http://www.Propay.com/eBay. PayOnPickup payment method. PayOnPickup is the same as CashOnPickup. For listings on the eBay US site, the user interface refers to this feature as Pay on pickup. In the user interface of your application, please refer to the feature as Pay on pickup so that the name in your user interface corresponds to the name on the eBay US site. Security header used for SOAP API calls. Authentication token representing the user who is making the request. The user's token must be retrieved from eBay. To determine a user's authentication token, see the Authentication and Authorization information in the eBay Web Services guide. For calls that list or retrieve item or transaction data, the user usually needs to be the seller of the item in question or, in some cases, the buyer. Similarly, calls that retrieve user or account data may be restricted to the user whose data is being requested. The documentation for each call includes information about such restrictions. 2000 FetchToken Yes UseTopicAlias GettingAToken Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token. GetSessionID,FetchToken Conditionally Authentication information for the user on whose behalf the application is making the request, and authorization information for the application making the request. Only registered eBay users are allowed to make API calls. To verify that a user is registered, your application normally needs to pass a user-specific value called an "authentication token" in the request. This is equivalent to signing in on the eBay Web site. As API calls do not pass session information, you need to pass the user's authentication token every time you invoke a call on their behalf. All calls require an authentication token, except the calls you use to retrieve a token in the first place. For such calls, you use the eBay member's username and password instead. FetchToken Yes A Base64-encoded MD5 hash that allows the recepient of a Platform Notification to verify this is a valid Platform Notification sent by eBay. Specifies standard subsets of data to return for each result within the set of results in the response payload. If no detail level is specified, a base set of data is returned. The base set of data varies per call. (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (in) Returns Description, plus the ListingDesigner node and some additional information if applicable (in) For GetItem, returns Item Specifics and Pre-filled Item Information, if any. For GetSearchResults, only returns Item Specifics (if any) that are applicable to search results, and only under certain conditions. See the description of Item.AttributeSetArray for details about the effects for applicable calls. Also see the description of Item.ProductListingDetails for GetItem. (in) For the GetSearchResults call, returns the primary category and, if applicable, the secondary category (in) Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See "GetMyMessages" in the eBay Web Services Guide for a code sample that demonstrates this. (in) Returns message headers. For GetMyMessages, if you include MessageIDs or AlertIDs in the request, this detail level returns header information, without body text, for the specified message ID or alert ID values. If you include a FolderID, header information is returned only for the messages and alerts in the specified folder. If you do not include MessageIDs or AlertIDs, this detail level returns header information for Alerts and Messages as follows: - If all the Alerts have been read, they are sorted in date order, with the most recent first. - If one of the Alerts has not been read, the Read Alerts come first, sorted most recent first, followed by the Unread Alert(s). - All messages in ascending order by date received with the oldest messages first. Note that even when restricted by this detail level to return only header information, GetMyMessages may return a high volume of data. (in) Returns full message information. For GetMyMessages, if you include MessageIDs or AlertIDs in the request, this detail level returns message information for the specified message ID or alert ID values. If you include a FolderID, message information is returned only for the messages and alerts in the specified folder. Contains properties that provide information on duplicate uses of InvocationIDs. The duplicate InvocationID. AddItem AddItems AddLiveAuctionItem AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistItem ReviseLiveAuctionItem ReviseCheckoutStatus ReviseItem Conditionally The status of the previous call that used the InvocationID. AddItem AddItems AddLiveAuctionItem AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistItem ReviseCheckoutStatus ReviseItem ReviseLiveAuctionItem Conditionally The id that identifies the business item the previous API invocation created. For example, the ItemID of the item created by an AddItem call. AddItem AddItems AddLiveAuctionItem AddOrder AddSecondChanceItem AddToItemDescription PlaceOffer RelistItem ReviseCheckoutStatus ReviseItem ReviseLiveAuctionItem Conditionally 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. Preferences that specify how eBay should handle certain requests that contain invalid data or that could partially fail. These preferences give you some control over whether eBay returns warnings or errors in response to invalid data and how eBay handles listing requests when such data is passed in. For example, these preferences are applicable to AddItem and related calls when Item Specifics are specified, and to CompleteSale. See the eBay Web Services Guide for details about these preferences and their effects. (in) Apply validation rules that were in effect prior to the time the call started supporting ErrorHandling. (in) Drop the invalid data, continue processing the request with the valid data. If dropping the invalid data leaves the request in a state where required data is missing, reject the request.<br> <br> If BestEffort is specified for CompleteSale, the Ack field in the response could return PartialFailure if one change fails but another succeeds. For example, if the seller attempts to leave feedback twice for the same transaction, the feedback changes would fail but any paid or shipped status changes would succeed. (in) If any attribute data is invalid, drop the entire attribute set and proceed with listing the item. If the category has required attributes and the attribute set is dropped, reject the listing. (in) If any data is invalid, reject the request. 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 (e.g., the attribute set ID) Conditionally The index of the parameter in the list of parameter types returned within the error type. 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 A more detailed description of the condition that raised the error. Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms. See the "Errors by Number" document. other Conditionally 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. Only applicable to Item Specifics errors and warnings returned from listing requests. AddItem AddItems AddLiveAuctionItem RelistItem ReviseItem ReviseLiveAuctionItem VerifyAddItem Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned. Conditionally API errors are divided between two classes: system errors and request errors. Conditionally Basic type for specifying measures and the system of measurement. A decimal value (e.g., 10.25) is meaningful as a measure when accompanied by a definition of the unit of measure (e.g., Pounds), in which case the value specifies the quantity of that unit. A MeasureType expresses both the value (a decimal) and, optionally, the unit and the system of measurement. Details such as shipping weights are specified as measure types. The unit of measure (e.g., lbs, oz, in). Currently ignored and assumed to be "inches" when used as input for PackageDepth, PackageWidth, PackageLength, WeightMajor, WeightMinor. AddItem AddItems No GetItemShipping GetSellerTransactions GetShippingDiscountProfiles Conditionally GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The system of measurement (e.g., English). AddItem AddItems No GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetShippingDiscountProfiles Conditionally English system of measurement. Metric system of measurement. 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) Warning or informational error (out) Application-level error (out) Reserved for internal or future use Specifies a universally unique identifier. The identifier can only contain digits from 0-9 and letters from A-F. The identifier must be 32 characters long. For example, 9CEBD9A6825644EC8D06C436D6CF494B. The application ID that is unique to each application you (or your company) has registered with the eBay Developers Program. If you are executing a call in the Sandbox, this is the "AppId" value that eBay issued to you when you received your Sandbox keys. If you are executing a call in Production, this is the "AppId" value that eBay issued to you when you received your Production keys. FetchToken Yes The unique developer ID that the eBay Developers Program issued to you (or your company). If you are executing a call in the Sandbox, this is the "DevId" value that eBay issued to you when you received your Sandbox keys. Typically, you receive your Sandbox keys when you register as a new developer. If you are executing a call in Production, this is the "DevId" value that eBay issued to you when you received your Production keys. Typically, you receive your Production keys when you certify an application. FetchToken Yes Authentication certificate that authenticates the application when making API calls. If you are executing a call in the Sandbox, this is the "CertId" value that eBay issued to you when you received your Sandbox keys. If you are executing a call in Production, this is the "CertId" value that eBay issued to you when you received your Production keys. This is unrelated to auth tokens. FetchToken Yes eBay user ID (i.e., eBay.com Web site login name) for the user the application is retrieving a token for. This is typically the application's end-user (not the developer). 64 FetchToken Yes Password for the user specified in Username. Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. Return warnings when the application passes unrecognized or deprecated elements in a request. eBay user ID (i.e., eBay.com Web site login name) for the user the application is retrieving a token for. This is typically the application's end-user (not the developer). 64 FetchToken Yes Password for the user specified in Username. Authentication token representing the user who is making the request. The user's token must be retrieved from eBay. To determine a user's authentication token, see the Authentication and Authorization information in the eBay Web Services guide. For calls that list or retrieve item or transaction data, the user usually needs to be the seller of the item in question or, in some cases, the buyer. Similarly, calls that retrieve user or account data may be restricted to the user whose data is being requested. The documentation for each call includes information about such restrictions. 2000 FetchToken Yes UseTopicAlias GettingAToken Cost of insuring the delivery of this order with the courier. Description of the fee type. FeeSettlementReport Conditionally List of transactions for a certain fee type. FeeSettlementReport Conditionally Indicates who owns the user's address. PayPal owns the address. eBay owns the address. Reserved for internal or future use. Codes indicate the address type. (out) Reserved for internal or future use PayPal address status. (out) Reserved for internal or future use. Contains the data for one user address. This is the base type for a number of user addresses, including seller payment address, buyer shipping address and buyer and seller registration address. User's name for the address. Also applicable to Half.com (for GetOrders). 64 GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetUserContactDetails Always GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellingManagerSoldListings Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com. GetBidderList Conditionally ShippingAddress GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetSellingManagerSoldListings Conditionally AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No Line 1 of the user's street address. Also applicable to Half.com (for GetOrders). 100 GetBidderList Conditionally ShippingAddress ReviseSellingManagerSaleRecord No GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates SellerContactDetails
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders).<br> In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). 100 GetBidderList Conditionally ShippingAddress GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No The name of the user's city. Also applicable to Half.com (for GetOrders). 64 GetSellingManagerSaleRecord Always ShippingAddress GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally ReviseSellingManagerSaleRecord No GetBidderList Conditionally ShippingAddress GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetUserContactDetails Always GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally County information for the user. This field applies to Classified Ad format listings and to the UK only. Not applicable to Half.com. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally The region of the user's address. Also applicable to Half.com (for GetOrders). 64 GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally ReviseSellingManagerSaleRecord No GetBidderList Conditionally ShippingAddress GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally ShippingAddress GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetUserContactDetails Always GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally The country code of the user.<br> <br> If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.<br> <br> Also applicable to Half.com (for GetOrders). GetAllBidders GetHighBidders GetUserContactDetails Always GetBidderList GetUserPreferences Conditionally GetItem GetSellingManagerTemplates RegistrationAddress ShippingAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress Conditionally GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellerList Conditionally HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
 ReviseSellingManagerSaleRecord No GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 SetUserPreferences No The name of the user's country. Also applicable to Half.com (for GetOrders). GetBidderList Conditionally ShippingAddress GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number. Also applicable to Half.com (for GetOrders). GetItem GetSellingManagerTemplates RegistrationAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
ShippingAddress Conditionally GetBidderList ShippingAddress Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetUserContactDetails Always GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally Standard ISO code for the country of the user's primay telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Country Prefix of the secondary phone number. This value is derived from inputs supplied for PhoneCountryCode. This field applies to Classified Ad format listings only. GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Area or City Code of a user's primary phone number. This field applies to Classified Ad format listings only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally The local number portion of the user's primary phone number. This field applies to Classified Ad format listings only. <br> <b>Note:</b> The full primary phone number is constructed by combining PhoneLocalNumber with PhoneAreaOrCityCode and PhoneCountryPrefix. Starting with API release 497, the full phone number can be entered in PhoneLocalNumber. Refer to the release notes for additional information. 30 AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Standard ISO code for the country of a user's secondary telephone phone number. For Classifed Ad format listings, this code is used to look up the country's international calling prefix. Both the ISO code and country phone prefix are stored with listings of this type. This field applies to Classified Ad format listings only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Country prefix of a user's secondary phone number. This value is derived from inputs supplied for Phone2CountryCode. This field applies to Classified Ad format listings only. GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally Area or City Code of a user's secondary phone number. This field applies to Classified Ad format listings only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally The local number portion of the user's secondary phone number. This field applies to Classified Ad format listings only. <br> <b>Note:</b> The full secondary phone number is constructed by combining Phone2LocalNumber with Phone2AreaOrCityCode and Phone2CountryPrefix. Starting with API release 497, the full phone number can be entered in Phone2LocalNumber. Refer to the release notes for additional information. 30 AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally User's postal code.<br> <br> If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made.<br> <br> Also applicable to Half.com (for GetOrders). 12 GetBidderList Conditionally GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally GetSellerList HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Conditionally GetItem GetSellingManagerTemplates RegistrationAddress ShippingAddress
DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions ShippingAddress
DetailLevel: none, ReturnAll
Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetMyeBaySelling SoldList DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally GetAllBidders GetHighBidders Always GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellingManagerSoldListings Conditionally ID assigned to the address in the eBay database. For GetOrders, applies only to Half.com. GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally The realm to which the address belongs (e.g. eBay vs PayPal). For GetOrders, applies only to Half.com. GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrders
DetailLevel: none
Always PayPal address status. Not applicable to Half.com. ID assigned to the address by the owner of the address (fitting only if the address is owned by PayPal; see AddressOwner). Also applicable to Half.com (for GetOrders). 20 GetOrders
DetailLevel: none
Always GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com. GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetBidderList Conditionally ShippingAddress International state and city for the seller's payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com. GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetBidderList Conditionally ShippingAddress Seller's international street address that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com. GetUser Conditionally SellerPaymentAddress
DetailLevel: ReturnAll
 GetBidderList Conditionally ShippingAddress User's company name. Only returned if available. Not applicable to Half.com. GetUserContactDetails Always GetBidderList Conditionally ShippingAddress AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
SellerContactDetails Conditionally GetUser Conditionally RegistrationAddress
DetailLevel: ReturnAll, ReturnSummary, none
 Indicates the nature of the address (e.g., residential or business). Not applicable to Half.com. Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetAdFormatLeads Conditionally
DetailLevel: ReturnAll
 Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetAdFormatLeads Conditionally
DetailLevel: ReturnAll
 Secondary Phone number of the lead. Not returned if information is unavailable. GetAdFormatLeads
DetailLevel: ReturnAll
Conditionally 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.<br> <br> In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. DeleteSellingManagerItemAutomationRule DeleteSellingManagerTemplateAutomationRule GetBidderList GetSellingManagerTemplateAutomationRule GetSellingManagerTemplates GetSellingManagerItemAutomationRule GetItemRecommendations GetItemShipping GetMyeBaySelling SetSellingManagerItemAutomationRule SetSellingManagerTemplateAutomationRule Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally AddOrder Order.Total Yes GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetMyeBayBuying
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally RespondToBestOffer ReviseCheckoutStatus ReviseSellingManagerSaleRecord No InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected Always GetBestOffers
DetailLevel: none, ReturnAll
Always GetOrders InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected
DetailLevel: none
Always GetOrders InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected
DetailLevel: none
Conditionally GetSellerTransactions InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected
DetailLevel: none
Conditionally GetOrderTransactions InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally PlaceOffer ConvertedCurrentPrice CurrentPrice Always PlaceOffer MinimumToBid Conditionally AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem No Always AddLiveAuctionItem ReviseLiveAuctionItem No Always GetAllBidders GetStoreOptions Yes Always RelistItem No AddTransactionConfirmationItem Yes SendInvoice ShippingInsuranceCost, ShippingServiceCost, ShippingServiceAdditionalCost, SalesTaxAmount, InsuranceFee No GetSellingManagerSaleRecord AddItemFromSellingManagerTemplate Always Reserved for future use. Only applicable to Half.com. Not applicable to eBay listings. You can revise this field for Half.com listings. AddItem AddItems VerifyAddItem Yes ReviseItem No GetOrders
DetailLevel: none
Always Applicable for listings that include eBay's Item Specifics or Pre-filled Item Information features. A list of attribute sets. An attribute set contains a list of attributes that describe category-specific aspects or features of an item in a standardized way. See the Developer's Guide for more information. In item-listing requests, this property is required if attributes are identified as required in the characteristics set meta-data. See the Developer's Guide for information about characteristics meta-data and how to determine when attributes are required. Contains a list of attributes that describe category-specific aspects or features of an item in a standardized way.<br><br> For the AddItem family of calls and GetItem, an AttributeSetArray can contain a maximum of 2 full attribute sets (one for each category in which the item is listed) if the primary and secondary categories are mapped to different characteristic sets. If they are mapped to the same characteristic set, the AttributeSetArray can contain one full attribute set.<br> <br> An AttributeSetArray can also contain any number of additional site-wide attribute sets. In item-listing requests, AttributeSet is required if the category is mapped to a characteristic set with required attributes. On the US site, attributes are usually required for Tickets, eBay Motors vehicles, and Real Estate listings. See GetCategory2CS and GetAttributesCS. See the Developer's Guide for information about attribute meta-data and validation rules that are applicable when listing items.<br> <br> In GetItem, the Half.com item condition may be returned once in an AttributeSet node with Half.com IDs and values, and once in a separate AttributeSet node with a site-wide eBay item condition. The Half.com IDs are not necessarily returned in GetAttributesCS, so you can use the eBay.com data instead. Half.com listings may also return an AttributeSet node with other eBay attributes. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations RelistFixedPriceItem ReviseFixedPriceItem VerifyAddItem Conditionally GetSearchResults RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetCategoryListings GetSellingManagerTemplates GetItemRecommendations Conditionally GetSearchResults GetProducts
DetailLevel: none, ItemReturnAttributes, ItemReturnCategories, ReturnAll
GranularityLevel: Coarse
Conditionally GetItem
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally A set of salient aspects or features that describe an item in a standardized way. Most commonly used in the Item Specifics section of a listing. See the Developer's Guide information on working with Item Specifics and Pre-filled Item Information. See the Developer's Guide for information about characteristics meta-data and how to determine when attributes are required. A salient aspect or feature of an item in a given category. Attributes are known as "Item Specifics" in the eBay Web site. Use attributes to describe an item in a standard way so that buyers can find it more easily. For example, "Publication Year" is a standard attribute for books. In item-listing requests, multiple attributes can be specified. Some categories (e.g., Tickets) always require certain attributes to be specified. Therefore, in item-listing requests you need to at least specify "editable" attributes (EditType 0 and EditType 2 attributes) if they are identified as required in the attribute meta-data. See the eBay Web Services guide for information about attrribute meta-data, how to determine the valid attributes for a category, and how to determine whether attributes are required. <br><br> If you are revising or relisting an item, you don't need to pass in attributes that were already specified in the original listing. To remove an optional attribute, set all its value IDs to "-100". If the item has bids (or items have been sold) but there are more than 12 hours remaining until the listing ends, you can add Attribute nodes but you cannot remove or modify data in previously specified Attribute nodes. If the item has bids and the listing ends within 12 hours, you cannot add or remove Attribute nodes or modify the contents of previously specified Attribute nodes. <br><br> For GetCategoryListings, this returns the item condition only (and it is only returned if IncludeCondition = true in the request). Not applicable to Half.com. AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Conditionally GetSearchResults RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetCategoryListings GetItemRecommendations GetProducts GetSellingManagerTemplates Conditionally GetSearchResults
DetailLevel: none, ItemReturnAttributes, ItemReturnCategories, ReturnAll
GranularityLevel: Coarse
Conditionally GetItem
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally Constant value that identifies the attribute set in a language-independent way. Unique across all eBay sites. Corresponds to a characteristics set ID. Call GetCategory2CS to determine valid characteristics set IDs. For GetCategoryListings, you can ignore this value. Not applicable to Half.com. AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Conditionally GetSearchResults RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetCategoryListings GetItemRecommendations GetProducts GetSellingManagerTemplates Conditionally GetSearchResults
DetailLevel: none, ItemReturnAttributes, ItemReturnCategories, ReturnAll
GranularityLevel: Coarse
Conditionally GetItem
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally Version of the attribute set being specified (in requests) or that is currently on the site. This value changes each time changes are made to the category-to-characteristic set mappings or characteristic set data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed.<br><br> In listing requests, if you do not specify this value, eBay assumes you are using the current attribute set version. If you specify the version number of the attribute meta-data that you have stored locally, eBay will compare it to the current version on the site and return a warning if the versions do not match. If an error occurs due to invalid attribute data, this warning can be useful to help you determine if you might be sending outdated data. Not applicable to Half.com. AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetItemRecommendations GetProducts Conditionally GetItem
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally A salient aspect or feature of an item. On eBay.com, this information is used in the Item Specifics section of a listing to describe an item in a standard way so that buyers can find it more easily. A value the seller selected or entered for the attribute. At least one value is required for each Attribute that you specify. Some attributes can have multiple values. See the eBay Web Services guide sections on Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) for information about using GetAttributesCS to determine valid attribute values.<br><br> For eBay.com listings, use AttributeSetArray.AttributeSet.Attribute.Value. For Half.com, use AttributeArray.Attribute.Value. That is, the parent elements and usage for Half.com differs from eBay's standard Item Specifics format (and there is no relationship to GetAttributesCS). For Half.com, this does not use the same Attributes logic as eBay's Item Specifics. For Half.com, AttributeArray.Attribute.Value is required when you use AddItem. see the eBay Web Services Guide for valid values. You can revise AttributeArray.Attribute.Value for Half.com listings. AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations GetProducts VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetCategoryListings GetItemRecommendations Conditionally GetSearchResults
DetailLevel: none, ItemReturnAttributes, ItemReturnCategories, ReturnAll
GranularityLevel: Coarse
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally GetOrders
DetailLevel: none
Always Constant value that identifies the attribute in a language-independent way. Unique within the attribute set. See the Developer's Guide topics on Item Specifics and Pre-filled Item Information for information about determining valid attribute IDs. Not applicable to Half.com. AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem AttributeSetArray Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem AttributeSetArray No GetCategoryListings GetItemRecommendations Conditionally GetSearchResults
DetailLevel: none, ItemReturnAttributes, ItemReturnCategories, ReturnAll
GranularityLevel: Coarse
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: ItemReturnAttributes, ReturnAll
Conditionally Name of the attribute being specified. This is not part of eBay's standard Item Specifics format (i.e., there is no relationship to GetAttributesCS). For GetCategoryListings, this returns the value "Condition" to identify the item condition attribute. For GetOrders, this is always returned for Half.com orders. (It is not applicable to orders on the eBay.com site.) For Half.com, see the eBay Web Services Guide for valid input values. For Half.com, this field is required when you use AddItem. You can revise this value for Half.com listings. AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem AttributeArray Conditionally ReviseItem ReviseSellingManagerTemplate AttributeArray No GetCategoryListings Conditionally GetOrders
DetailLevel: none
Always Used for storing an optional reference ID to the binary attachment Stores an optional reference ID to the binary attachment. UploadSiteHostedPictures No Container for BestOffer properties associated with the item. The number of best offers made for this item, if any. In other words, if there are no offers made, this container will not appear in the response. GetBidderList GetSellerList Conditionally GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetMyeBaySelling ActiveList
DetailLevel: none, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally Whether best offer is enabled for this item. A seller of a fixed price format item (in a category for which Best Offer is also enabled) can opt that item into the Best Offer feature. This feature enables a buyer to make a lower priced binding offer on that item. If a listing has no active best offers, you can change this value (true to false, and vice versa). If a listing does have active best offers, you cannot change the value to false. AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseItem ReviseSellingManagerTemplate SetSellingManagerTemplateAutomationRule SetSellingManagerItemAutomationRule VerifyAddItem VerifyRelistItem No GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerEvents
DetailLevel: none, ReturnAll
Conditionally DeleteSellingManagerTemplateAutomationRule DeleteSellingManagerItemAutomationRule GetBidderList GetSellingManagerTemplateAutomationRule GetSellingManagerItemAutomationRule SetSellingManagerTemplateAutomationRule SetSellingManagerItemAutomationRule GetSellingManagerTemplates Conditionally (GetMyeBayBuying only) Indicates the latest BestOffer the user has provided for the item. If there are no offers made, this field will not appear in the response. GetMyeBayBuying BestOfferList
DetailLevel: none, ReturnAll
Conditionally (GetMyeBayBuying only) Indicates the status of the latest BestOffer the buyer has provided for the item. If there are no offers made, this field will not appear in the response. GetMyeBayBuying Conditionally BestOfferList
DetailLevel: none, ReturnAll
 Indicates the best offer type of the latest BestOffer the user has provided for the item. If there are no offers made, this field will not appear in the response. The status of the best offer. The best offer is awaiting seller response or will naturally expire after 48 hours. The best offer was accepted by the seller. The best offer was rejected by the seller. The best offer expired after 48 hours due to no action by the seller. The best offer was retracted by the buyer. The best offer was ended by an administrator. Retrieve active best offers only. Retrieve all counter best offers. Retrieve all best offers (including declined offers, etc.). (out) Reserved for internal or future use. The offer type of the best offer. The buyer has placed best offer on the item. The buyer has made a counter offer. The seller has made a counter offer. (out) Reserved for internal or future use. Contains detailed information about a bid. Converted value of the amount in MaxBidAmount, in the currency indicated by SiteCurrency. For active items, refresh the listing's data every 24 hours to pick up the current conversion rates. Under conditions where this value would be N/A on the eBay site, this element is not returned at all. GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally Indicates the maximum amount the user has agreed to pay for the item when the user last submitted a bid. Under conditions where this value would be N/A on the eBay site, this element is not returned at all. GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally Number of items from the listing the user agreed to purchase with a bid. For single-item listings, always 1. For multi-item (Dutch) listings, the value will be between 1 and the number of items offered in the auction, indicating the number of items purchased so far. <br><br> <span class="tablenote"><strong>Note:</strong> As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. </span> <br> GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally Used mainly for multi-item auctions (Dutch). For an active listing, indicates the number of items the user stands to win if their bid wins. For a listing that has ended, indicates the number of items the user actually won. In both cases, the number may be less than that returned in QuantityBid, the user with the lowest winning bid in a Dutch auction might not win all the items on which they bid. <br><br> <span class="tablenote"><strong>Note:</strong> As of version 619, Dutch-style (multi-item) competitive-bid auctions are deprecated. eBay throws an error if you submit a Dutch item listing with AddItem or VerifyAddItem. If you use RelistItem to update a Dutch auction listing, eBay generates a warning and resets the Quantity value to 1. </span> <br> GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally (GetMyeBay only) Indicates whether the user is the current high bidder in a currently active listing. Indicates whether the current bid was placed by BidAssistant. Only returns if true. GetMyeBayBuying BidList LostList WonList DeletedFromWonList DeletedFromLostList WatchList
DetailLevel: none, ReturnAll
Conditionally GetMyeBaySelling BidList
DetailLevel: none, ReturnAll
Conditionally Contains bidding summary information for the bidder of an item. The number of days included in the summary. Currently always set to 30 days. GetAllBidders Conditionally The total number of bids that the bidder has placed. GetAllBidders Conditionally Percentage of the bidder's total bids that the bidder placed on items that the seller is offering. GetAllBidders Conditionally Number of unique sellers whose items the bidder has placed bids on. GetAllBidders Conditionally For items that the bidder has bid on, the number of unique categories that they belong to. GetAllBidders Conditionally The total number of bids that the bidder has retracted. GetAllBidders Conditionally Detail bidding information on the items that the bidder has bid on. GetAllBidders Conditionally Defines supported fields for BrandMPN. The brand of the product. eBay searches against the names that are publicly available in eBay's catalogs. This means you can specify the well-known brand name that an average user would recognize. Specify this in combination with MPN.<br> <br> <span class="tablenote"><b>Note:</b> If you want examples of brand names that eBay is likely to recognize, you can examine product details returned in GetProductSearchResults and GetProductSellingPages. </span> 4000 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally The manufacturer part number of the product. Use the value specified by the manufacturer. (eBay removes special characters and spaces to normalize the values in order to find a match.) 4000 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally Displays the seller's information (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. Note that this option is only available for sites that have Business Seller options enabled. Displays the Address of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the fax number of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the email address of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the AdditionalContactInformation of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the TradeRegistrationNumber of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the LegalInvoice of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the TermsAndConditions of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Displays the VATDetails of the seller (in a business card format) as part of the data returned in the GetItem call if the seller's SellerBusinessCodeType is set to 'Commercial'. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 Indicates the status of the item's eligibility for the Buyer Protection Program. (out) Item is ineligible (e.g., category not applicable). (out) Item is eligible per standard criteria. (out) Item marked ineligible per special criteria (e.g., seller's account closed). (out) Item marked eligible per other criteria. (out) For the Australia site, indicates that there is no PayPal Buyer Protection coverage. Coverage details would be in the following sections of the View Item page: the Buy Safely section and the Payment Details section. (out) Reserved for internal or future use. Contains the data for different buyer protection schemes and the various status associated with each one of them. Indicates the type of Buyer Protection applicable for a particular item, such as eBay for the eBay Standard Purchase Protection Program or PayPal for the PayPal Protection Program. GetItemTransactions Conditionally GetOrderTransactions Conditionally GetSellerTransactions Conditionally GetItem GetSellingManagerTemplates Conditionally GetSearchResults Conditionally Indicates the status of the item's eligibility for a Buyer Protection Program. GetItemTransactions Conditionally GetOrderTransactions Conditionally GetSellerTransactions Conditionally GetItem GetSellingManagerTemplates Conditionally GetSearchResults Conditionally Indicates the source of the item's eligibility for the Buyer Protection Program. Buyer protection is covered by the eBay Standard Purchase Protection Program. Buyer protection is covered by the PayPal Protection Program. Reserved for internal or future use. New Container for all buyer requirements in listing calls. If true, blocks bidders who are registered in countries where the seller has specified that he will not ship. Ignored as input if the application uses version 451 or older. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally If true, blocks bidders with a feedback score of 0 who attempt to bid on Buy It Now items worth 100 RMB or more. Ignored as input if the application uses version 451 or older. This requirement is only enabled for the CN site. false AddFixedPriceItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally If true, blocks bidders with this feedback score or lower. Ignored as input if the application uses version 451 or older. Valid values: -3, -2, -1. AddFixedPriceItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally If this field is included in your call, you can limit unpaying or low feedback bidders, by setting the MaximumItemCount and MinimumFeedbackScore to define when a bidder is blocked from bidding. Ignored as input if the application uses version 451 or older. AddFixedPriceItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally If true, only bidders with PayPal accounts may bid. This field can be returned even if the caller is not the seller. For AddItem, the seller's My eBay preference is automatically used with request version 453 and greater. For lower request versions, you must send in explicit BuyerRequirement input even if you have your "global" My eBay preferences set to require PayPal. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally If provided, blocks bidders who do not pass a simple check (for example, for credit card on file). Ignored as input if the application uses version 451 or older. AddFixedPriceItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally If provided, blocks bidders who have received the maximum unpaid item strikes (in a specific time period) from bidding on this item. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally If provided, blocks bidders who have received the maximum allowed buyer policy violation reports (in a specific time period) from bidding on this item. false AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally Contains information about a user as a buyer. Contains the address of the buyer in the transaction, to which the seller would ship the item(s). See AddressType for its child elements. GetAllBidders is returning only Country and PostalCode currently. Output only. GetAllBidders GetHighBidders Always GetBidderList Conditionally GetMyeBaySelling SoldList DeletedFromSoldList
DetailLevel: none, ReturnAll
Conditionally GetOrderTransactions BuyerInfo
DetailLevel: none, ReturnAll
Conditionally GetSellerList Conditionally HighBidder
DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
 GetItem GetSellingManagerTemplates Conditionally HighBidder
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Details of an individual discount profile defined by the user for calculated shipping. The type of discount or "rule" that is being used by the profile. Only WeightOff is a "variable" rule, as defined in the documentation on shipping discount profiles. GetShippingDiscountProfiles IndividualItemWeight, CombinedItemWeight, WeightOff Conditionally SetShippingDiscountProfiles IndividualItemWeight, CombinedItemWeight, WeightOff Conditionally GetItem GetSellingManagerTemplates IndividualItemWeight, CombinedItemWeight, WeightOff
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally UseTopicAlias ShippingDiscountProfiles Details of this particular calculated shipping discount profile. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored. Restrictions of how many profiles you can have for a given discount rule are discussed in the documentation on shipping discount profiles. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles IndividualItemWeight, CombinedItemWeight, WeightOff Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally UseTopicAlias ShippingDiscountProfiles Details pertinent to one or more items for which calculated shipping has been offered by the seller, such as package dimension and weight and packaging/handling costs. Also returned with the data for an item's transaction. Postal code for the location from which the package will be shipped. Required for calculated shipping. Use Item.PostalCode to specify the location of the item used for searches by location. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Specifies the unit type of the weight and dimensions of a shipping package. If MeasurementUnit is used, it overrides the system specified by measurementSystem. If MeasurementUnit and measurementSystem are not specified, the following defaults will be used: <br><br> English: US<br> Metric: CA, CAFR, AU <br><br> CA and CAFR supports both English and Metric, while other sites only support the site's default. <br><br> Use MeasurementUnit with weight and package dimensions. For example, to represent a 5 lbs 2 oz package: <br> &lt;MeasurementUnit&gt;English&lt;/MeasurementUnit&gt; <br> &lt;WeightMajor&gt;5&lt;/WeightMajor&gt; <br> &lt;WeightMinor&gt;2&lt;/WeightMinor&gt; AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem VerifyRelistItem Conditionally UseTopicAlias PackageDetails Depth of the package, in whole number of inches, needed to ship the item. This is validated against the selected shipping service. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) <br><br> Developer impact: UPS requires dimensions for any Ground packages that are 3 cubic feet or larger and for all air packages, if they are to provide correct shipping cost. If package dimensions are not included for an item listed with calculated shipping, the shipping cost returned will be an estimate based on standard dimensions for the defined package type. eBay enforces a dimensions requirement on listings so that buyers receive accurate calculated shipping costs. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally UseTopicAlias PackageDetails Length of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally UseTopicAlias PackageDetails Width of the package, in whole number of inches, needed to ship the item. Upon mismatch, a message is returned, such as, "Package dimensions exceeds maximum allowable limit for service XXXXX," where XXXXX is the name of the shipping service. For calculated shipping only. Only returned if the seller specified the value for the item. (In many cases, the seller only specifies the weight fields.) AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally UseTopicAlias PackageDetails Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) When UPS is one of the shipping services offered by the seller, package dimensions are required on list/relist/revise. For calculated shipping only. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Whether a package is irregular and therefore cannot go through the stamping machine at the shipping service office and thus requires special or fragile handling. For calculated shipping only. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally The nature of the package used to ship the item(s). Required for calculated shipping only. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally WeightMajor and WeightMinor are used to specify the weight of a shipping package. Here is how you would represent a package weight of 5 lbs 2 oz: &lt;WeightMajor unit="lbs"&gt;5&lt;/WeightMajor&gt; &lt;WeightMinor unit="oz"&gt;2&lt;/WeightMinor&gt; See http://www.ups.com for the maximum weight allowed by UPS. Above this maximum, the shipping type becomes Freight, an option that can only be selected via the eBay Web site and not via API. The weight details are validated against the selected shipping service. For calculated shipping only. Required on input when calculated shipping is used. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetBidderList GetItemShipping Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally See the definition of WeightMajor. For calculated shipping only. Required on input when calculated shipping is used. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem Conditionally GetBidderList GetItemShipping Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Fees a seller might assess for the shipping of the item (in addition to whatever the shipping service might charge). Any packaging/handling cost specified on input is added to each shipping service on output. If domestic and international calculated shipping is offered for an item and if packaging/handling cost is specified only for domestic shipping, that cost will be applied by eBay as the international packaging/handling cost. (To specify a international packaging/handling cost, you must always specify a domestic packaging/handling cost, even if it is 0.) For international calculated shipping only. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList GetItemShipping GetSellerList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Container for data on one listing category. If true, the category supports best offers. If not present, the category does not support best offers. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Conditionally If true, indicates that the category supports immediate payment. If not present, the category does not support immediate payment. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Conditionally AutoPay UseTopicAlias If true, the category supports business-to-business (B2B) VAT listings. Applicable to the eBay Germany (DE), Austria (AT), and Switzerland CH) sites only. If not present, the category does not support this feature. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Conditionally B2BVAT UseTopicAlias If true, the category is associated with catalog content and the corresponding catalog is identified by the characteristic set ID. See CharacteristicsSets. As the Pre-filled Item Information feature uses the Item Specifics feature, the set of catalog-enabled categories is a subset of the categories that are mapped to characteristic sets. Not returned if false. GetCategory2CS MappedCategoryArray
DetailLevel: ReturnAll
Conditionally Distinct numeric ID for a category on eBay. In GetItem and related calls, see CategoryName for the text name of the category. Use GetCategories to look up the category parent ID.<br> <br> For GetPopularKeywords, -1 represents the root category.<br> <br> For GetItem, Half.com items return the Half.com category ID in PrimaryCategory. This ID is not necessarily returned in GetCategories. 10 AddItem AddItems GetItemRecommendations AddLiveAuctionItem VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Yes RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No AddSellingManagerTemplate PrimaryCategory Yes AddSellingManagerTemplate SecondaryCategory No GetBidderList PrimaryCategory Always GetBidderList Conditionally FreeAddedCategory SecondaryCategory GetCategories
DetailLevel: ReturnAll
Always GetCategoryListings GetContextualKeywords GetPopularKeywords Always GetCategory2CS MappedCategoryArray
DetailLevel: ReturnAll
Always GetCategory2CS UnmappedCategoryArray
DetailLevel: ReturnAll
Conditionally GetItem GetSellingManagerTemplates Always PrimaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItem Conditionally FreeAddedCategory SecondaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Always GetItemTransactions GetSellerTransactions
DetailLevel: ReturnAll
Conditionally GetSuggestedCategories GetProducts Conditionally GetSearchResults
DetailLevel: ItemReturnCategories
Conditionally GetSellerList Conditionally FreeAddedCategory SecondaryCategory
DetailLevel: ItemReturnDescription, ReturnAll
 GetSellerList Conditionally PrimaryCategory SecondaryCategory
DetailLevel: ItemReturnDescription, ReturnAll
 The level where the category fits in the site's category hierarchy. For example, if this field has a value of 2, then the category is two levels below the root category in the site's category hierarchy. For the GetSearchResults response, NumOfItems indicates the total quantity of matching items in a category. Matching categories at the same level (i.e., in sibling categories) are sorted by NumOfItems, descending order. GetCategories
DetailLevel: ReturnAll
Always GetSearchResults
DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
Conditionally CategoryArray Display name of the category as it would appear on the eBay Web site. In GetItem, this is a fully qualified category name (e.g., Collectibles:Decorative Collectibles:Hummel, Goebel).<br> <br> In GetItem, always returned for eBay.com listings. Not returned in PrimaryCategory for Half.com listings. 30 GetCategories
DetailLevel: ReturnAll
Always GetCategoryListings GetContextualKeywords Always GetBidderList Always PrimaryCategory GetBidderList Conditionally FreeAddedCategory SecondaryCategory GetItem GetSellingManagerTemplates Conditionally PrimaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetItem GetSellingManagerTemplates Conditionally FreeAddedCategory SecondaryCategory
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 GetSuggestedCategories Conditionally GetSearchResults
DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
Conditionally CategoryArray GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally Category ID identifying a category that is an ancestor of the category indicated in CategoryID. For GetCategories, returns the same value as CategoryID if the CategoryLevel is 1. For GetSuggestedCategories, multiple CategoryParentID fields can be returned in sequence, starting with the root category and ending with the category that is the direct parent of the category specified in CategoryID. Use these parent fields and the CategoryID field to build the fully qualified category browse path or "breadcrumbs" (e.g., 58058:3516:3517). For GetPopularKeywords, -1 represents the root category. 10 GetCategories
DetailLevel: ReturnAll
Always GetSearchResults
DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
Conditionally CategoryArray GetSuggestedCategories Conditionally Display name of the category indicated in CategoryParentID. For GetSuggestedCategories, multiple CategoryParentName fields can be returned in sequence, starting with the root category and ending with the category that is the direct parent of the category specified in CategoryName. Use these parent fields and the CategoryName field to build the fully qualified category browse path or "breadcrumbs" (e.g., Computers & Networking > Technology Books > Certification). GetSearchResults
DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
Conditionally CategoryArray GetSuggestedCategories Conditionally Returned from GetCategory2CS calls. Supports listing with Pre-filled Item Information. If the category supports single-attribute search, this field returns a value of true. Otherwise this field not returned or returned as false. GetCategory2CS MappedCategoryArray
DetailLevel: ReturnAll
Conditionally The category supports listing with Pre-filled Item Information. Specifies the buy-side and/or sell-side product finder IDs associated with this category, if any. GetCategory2CS MappedCategoryArray
DetailLevel: ReturnAll
Conditionally Returned from GetCategory2CS calls. A list of one or more characteristics sets mapped to the category. Use this information when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality. Output only. GetCategory2CS MappedCategoryArray SiteWideCharacteristicSets
DetailLevel: ReturnAll
Conditionally If true, indicates a category that has expired and to which items may not be listed. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Always If true, indicates that the category is a fixed-fee category. Use this information to identify categories are not eligible for eBay Stores Inventory format listings. You cannot list eBay Store Inventory format listings in fixed-fee categories on international sites. Output only. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
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). Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Always If true, indicates the category indicated in CategoryID is a virtual category, to which items may not be listed. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Always The total quantity of matching items in the category. In the GetSearchResults response, matching categories at the same level (i.e., sibling categories) are sorted by this value. That is, if the request specifies that fewer categories or subcategories should be returned, the ones with the most matching items are returned first. See the Developer's guide for more information. GetCategoryListings Conditionally CategoryArray GetSearchResults
DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
Conditionally CategoryArray GetCategoryListings Conditionally CategoryArray Indicates whether this category is eligible for Motors Seller Guarantee program. This tag is emitted for eligible categories only on the eBay Motors site. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Conditionally Indicates whether the category (and its subcategories) allows or disallows listing with a reserve price, depending on the prevailing site configuration indicated by ReservePriceAllowed. ORPA (override reserve price allowed) indicates when the category is an exception to the site's ReservePriceAllowed policy.<br> <br> If ORPA is true, the category overrides (toggles or reverses) the site's ReservePriceAllowed setting. In other words:<br> - If ReservePriceAllowed is true, reserve price is not allowed in this category.<br> - If ReservePriceAllowed is false, reserve price is allowed in this category.<br><br> If ORPA is not present, there is no override. That is, the category's setting is the same as the site's ReservePriceAllowed setting.<br> <br> This field will not be returned in the response if false. This toggling logic is designed to reduce the size of the GetCategories response by only returning ORPA when the category's policy is different from the site's policy. (If ORPA is true for a category, you can assume its subcategories inherit the same setting unless otherwise specified.) GetCategories
DetailLevel: ReturnAll
Always Indicates whether the category (and its subcategories) allows or disallows reducing a listing's reserve price, depending on the prevailing site configuration indicated by ReduceReserveAllowed. ORRA (override reduce reserve allowed) indicates when the category is an exception to the site's ReduceReserveAllowed policy.<br><br> If ORRA is true, the category overrides (toggles or reverses) the site's ReduceReserveAllowed setting. In other words:<br> - If ReduceReserveAllowed is true, reserve price reduction is not allowed in this category.<br> - If ReduceReserveAllowed is false (because it is not present in the response), reserve price reduction is allowed in this category.<br><br> If ORRA is not present, there is no override. Will not be returned in the response if false. That is, the category's setting is the same as the site's ReduceReserveAllowed setting.<br> <br> This toggling logic is designed to reduce the size of the GetCategories response by only returning ORRA when the category's policy is different from the site's policy. (If ORRA is true for a category, you can assume its subcategories inherit the same setting unless otherwise specified.) GetCategories
DetailLevel: ReturnAll
Conditionally Item.LotSize is not permitted when you list in this category. If true, indicates that lot sizes are disabled in the specified category. Will not be returned if false. GetCategories
DetailLevel: ReturnAll
Always The list of keywords returned by GetPopularKeywords. GetPopularKeywords Always A salient aspect or feature of an item. Used to describe an item in a standard way so that buyers can find it more easily. An individual, standardized characteristic that is common to all items within the specified characteristics set. Applicable when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality. See the eBay Web Services guide for more information. Constant value that identifies the characteristic in a language-independent way. Unique within the characteristic set. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults
DetailLevel: ReturnAll
Always Applicable when working with Pre-filled Item Information (Catalogs) functionality. Returned if the characteristic is a Date data type. Specifies the pattern to use when presenting the date to a user. Possible values: Day/Month/Year, Month/Year, Year Only. For example, the Year Only format would indicate that the date should be a value like 1999. Output only. GetProductSearchPage
DetailLevel: ReturnAll
Conditionally SortCharacteristics GetProductFamilyMembers GetProductSearchResults Conditionally The suggested order in which the characteristic should be presented to the user in a list. Indicates the relative position of the sort key in the list of characteristics. The characteristic with the lowest display sequence is considered the default sort key in calls to GetProductSearchResults. Aside from that, usage of this display sequence information is optional. For example, in an application with a graphical user interface, a characteristic with a display sequence of 2 could be presented before one with a display sequence of 3 in a drop-down list. If multiple sort characteristics are returned for a characteristic set, compare their display sequence values to determine the lowest available value (usually 0) and the overall sequence. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults
DetailLevel: ReturnAll
Always Applicable when working with Pre-filled Item Information (Catalogs) functionality. The unit of measure (e.g., Inch) to use when the characteristic is numeric indicates a measurement. Not returned if not applicable. Output only. GetProductSearchPage
DetailLevel: ReturnAll
Conditionally SortCharacteristics GetProductFamilyMembers GetProductSearchResults Conditionally Applicable when working with Pre-filled Item Information (Catalogs) functionality. The label to display when presenting the attribute to a user. Not necessarily the same as the attribute's label as defined in the characteristic set (i.e., the label could be overridden by the catalog). GetProductFamilyMembers GetProductSearchPage GetProductSearchResults
DetailLevel: ReturnAll
Always Applicable when working with Pre-filled Item Information (Catalogs) functionality. Indicates the order in which eBay's search engine will sort the results if you pass this characteristic as a sort attribute in GetProductSearchResults. You cannot change the sort order of a characteristic when you perform a search. (Of course, you can change the sort order when you present results in your own application.) In GetProductSearchPage, if SortOrder is not returned at all, it means the results will be returned in the order in which they are stored on eBay (which can be useful for international sites that use ideographic characters). Output only. GetProductSearchPage
DetailLevel: ReturnAll
Conditionally SortCharacteristics List of one or more valid values for the characteristic. GetProductFamilyMembers GetProductSearchResults Always A level in the eBay category hierarchy at which a particular group of items can share a common set of attributes. A set of characteristics that can be used to describe similar kinds of items in a standardized way. The well-known name of the characteristic set (e.g., "Tickets" or "Books"). GetCategory2CS MappedCategoryArray SiteWideCharacteristicSets
DetailLevel: ReturnAll
Conditionally Numeric value that identifies the characteristic set in a language-independent way. Identifies the characteristic set that is mapped to a catalog-enabled category associated with the product. Unique across all eBay sites. GetCategory2CS
DetailLevel: ReturnAll
Conditionally MappedCategoryArray SiteWideCharacteristicSets GetProductFamilyMembers GetProductSearchPage GetProductSearchResults
DetailLevel: ReturnAll
Always GetProductSellingPages Yes Version of the characteristics set. Not to be confused with AttributeSystemVersion, which can be used to retrieve changes to attribute meta-data. In item-listing requests, if you specify the version of the attribute set that you have stored locally, eBay will compare it to the current version on the site and return a warning if the versions do not match. If an error occurs due to invalid attribute data, this warning can be useful to help determine if you might be sending outdated data. The current value of version is not necessarily "greater than" the previous value. GetCategory2CS
DetailLevel: ReturnAll
Conditionally MappedCategoryArray SiteWideCharacteristicSets A salient aspect or feature of an item. Used to describe an item in a standard way so that buyers can find it more easily. An individual, standardized characteristic that is common to all items within the specified characteristic set. In the context of GetProductSearchPage, each characteristic identifies a single searchable attribute. A searchable attribute is a product aspect or feature that can be used as a criterion in a search for catalog content. For example, "Title" might be a criterion for searching the book catalog for Pre- filled Item Information related to books. See the eBay Web Services guide for more information. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults GetProducts
DetailLevel: ReturnAll
Always The information of nonprofit charity organization affiliation. The affiliation ID for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates the affiliation status of the nonprofit charity organization registered with the eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates the affiliation last used date of the nonprofit charity organization registered with the eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Lists the nonprofit charity organization affiliations for a specified user. Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Defines the affiliation status for a nonprofit charity organization registered with the dedicated eBay Giving Works provider. CharityAffiliationTypeCodeType - Type declaration to be used by other schema. Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. (out) The specified nonprofit charity organization has a community affiliation. (out) The specified nonprofit charity organization has direct affiliation. (out) The specified nonprofit charity organization is no longer affiliated. (out) Reserved for internal or future use. Lists the nonprofit charity organization affiliations for a specified user. Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. GetBidderList Conditionally GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally NoOp User.SellerInfo.CharityAffiliationDetails.CharityAffiliationDetail.CharityID GetItemTransactions GetSellerTransactions
DetailLevel: none, ReturnAll
Conditionally Defines the affiliation status for a nonprofit charity organization registered with the eBay Giving Works provider. Indicates the affiliation status of the nonprofit charity organization registered with the eBay Giving Works provider. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally CharitySellerStatusCodeType - Type declaration to be used by other schema. Indicates the status of the seller's charity seller account. The seller's charity seller account is suspended. The seller is a registered charity seller. The seller is no longer a registered charity seller. The account with the eBay Giving Works provider is closed. The credit card associated with a seller's charity seller account has expired. The token associated with a seller's charity seller account has expired. The credit card associated with a seller's charity seller account will expire in 15 (or fewer) days. (deprecated) The seller is a registered charity seller, but has no credit card associated with the charity seller account. This value will be deprecated after e557, please use RegisteredDirectSeller or RegisteredNoPaymentMethod. (in/out) The seller is no longer a registered charity seller and has lost direct seller status. (deprecated) The seller's direct debit card was rejected. The seller is a registered direct seller, but has no credit card associated with the charity seller account. The seller is a registered charity seller with no donation payment method on file. (out) Reserved for internal or future use. Contains information about one seller with a eBay Giving Works provider charity seller account. Indicates the status of the seller's charity seller account. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider. Indicates if the seller has accepted eBay GivingWorks Terms and Conditions. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally 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. The name of the benefiting nonprofit charity organization selected by the charity seller. 150 GetBidderList Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally 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. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistFixedPriceItem RelistItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally 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. AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseSellingManagerTemplate VerifyAddItem AddFixedPriceItem RelistFixedPriceItem VerifyRelistItem Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally A unique identification number assigned by eBay to registered nonprofit charity organizations. Required input when listing Giving Works items. AddItem AddItems AddSellingManagerTemplate GetItemRecommendations RelistItem ReviseSellingManagerTemplate VerifyAddItem AddFixedPriceItem RelistFixedPriceItem VerifyRelistItem Conditionally GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally The stated mission of the nonprofit charity organization. This mission is displayed in the Giving Works item listing. 511 GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally The URL of the nonprofit charity organization. This URL is displayed in the Giving Works item listing. GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetBidderList Conditionally The status of the nonprofit charity organization. GetBidderList Conditionally GetItem GetSellingManagerTemplates GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally 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. GetSellerList
DetailLevel: ItemReturnDescription, ReturnAll
Conditionally GetItemTransactions GetSellerTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally GetOrderTransactions
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Contains the data for primary and secondary contact hours for a given eBay user. Indicates the local time zone of the values provided for Hours1From/Hours1To and Hours2From/Hours2To. If you specify a contact hours time range with Hours1From and Hours1To, you must provide a local time zone. Use GeteBayDetails to retrieve a complete list of the TimeZoneID values supported by eBay. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the range of days for which the primary contact hours specified by Hours1AnyTime or Hours1From and Hours1To apply. If a value of None is provided for this field, the values provided for Hours1AnyTime, Hours1From, Hours1To are ignored. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours1Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours1From and Hours1To will be ignored. In the case of this field being false, the values provided Hours1From and Hours1To will be considered. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the range of days for which the secondary contact hours specified by Hours2AnyTime or Hours2From and Hours2To apply. If a value of None is provided for this field, the values provided for Hours2AnyTime, Hours2From, Hours2To are ignored. <br> <b>Note:</b> You cannot set Hours2Days to EveryDay. If Hours1Days is set to EveryDay, secondary contact hours do not apply. Hours2Days cannot be set to the same value as Hours1Days. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates whether or not a user is available to be contacted 24 hours a day during the range of days specified using the Hours2Days element. True indicates the user is available 24 hours a day, false indicates otherwise. In the case of this field being true, all values provided for Hours2From and Hours2To will be ignored. In the case of this field being false, the values provided Hours2From and Hours2To will be considered. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the starting time of day this eBay user is available for other eBay members to contact for the range of days specified using Hours2Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Indicates the ending time of day this eBay user is available for other eBay members to contact them for the range of days specified using Hours1Days. Enter times in 30 minute increments from the top of the hour. That is, enter values either on the hour (:00) or 30 minutes past the hour (:30). Other values will be will be rounded down to the next closest 30 minute increment. Times entered should be local to the value provided for TimeZoneID. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Defines the 2-letter country code set. <br><br> Use the GeteBayDetails call to see the list of currently supported codes, and the English names associated with each code (e.g., KY="Cayman Islands"): http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GeteBayDetails.html <br><br> Most of the codes that eBay uses conform to the ISO 3166 standard, but some of the codes in the ISO 3166 standard are not used by eBay. Plus, there are some non-ISO codes in the eBay list. (Additional codes appear at the end of this code list and are noted as non-ISO.) Afghanistan. Albania. Algeria. American Samoa. Andorra. Angola. Anguilla. Antarctica. Antigua and Barbuda. Argentina. Armenia. Aruba. Australia. Austria. Azerbaijan. Bahamas. Bahrain. Bangladesh. Barbados. Belarus. Belgium. Belize . Benin. Bermuda. Bhutan. Bolivia. Bosnia and Herzegovina. Botswana. Bouvet Island. Brazil. British Indian Ocean Territory. Brunei Darussalam. Bulgaria. Burkina Faso. Burundi. Cambodia. Cameroon. Canada. Cape Verde. Cayman Islands. Central African Republic. Chad. Chile. China. Christmas Island. Cocos (Keeling) Islands. Colombia. Comoros. Congo. Congo, The Democratic Republic of the. Cook Islands. Costa Rica. Cote d'Ivoire. Croatia. Cuba. Cyprus. Czech Republic. Denmark. Djibouti. Dominica. Dominican Republic. No longer in use. Ecuador. Egypt. El Salvador. Equatorial Guinea. Eritrea. Estonia. Ethiopia. Falkland Islands (Malvinas). Faroe Islands. Fiji. Finland. France. French Guiana. French Polynesia. Includes Tahiti. French Southern Territories. Gabon. Gambia. Georgia. Germany. Ghana. Gibraltar. Greece. Greenland. Grenada. Guadeloupe. Guam. Guatemala. Guinea. Guinea-Bissau. Guyana. Haiti. Heard Island and Mcdonald Islands. Holy See (Vatican City state). Honduras. Hong Kong. Hungary. Iceland. India. Indonesia. Iran, Islamic Republic of. Iraq. Ireland. Israel. Italy. Jamaica. Japan. Jordan. Kazakhstan. Kenya. Kiribati. Korea, Democratic People's Republic of. Korea, Republic of. Kuwait. Kyrgyzstan. Lao People's Democratic Republic. Latvia. Lebanon. Lesotho. Liberia. Libyan Arab Jamahiriya. Liechtenstein. Lithuania. Luxembourg. Macao. Macedonia, the Former Yugoslav Republic of. Madagascar. Malawi. Malaysia. Maldives. Mali. Malta. Marshall Islands. Martinique. Mauritania. Mauritius. Mayotte. Mexico. Micronesia, Federated States of. Moldova, Republic of. Monaco. Mongolia. Montserrat. Morocco. Mozambique. Myanmar. Namibia. Nauru. Nepal. Netherlands. Netherlands Antilles. New Caledonia. New Zealand. Nicaragua. Niger. Nigeria. Niue. Norfolk Island. Northern Mariana Islands. Norway. Oman. Pakistan. Palau. Palestinian territory, Occupied. Panama. Papua New Guinea. Paraguay. Peru. Philippines. Pitcairn. Poland. Portugal. Puerto Rico. Qatar. Reunion. Romania. Russian Federation. Rwanda. Saint Helena. Saint Kitts and Nevis. Saint Lucia. Saint Pierre and Miquelon. Saint Vincent and the Grenadines. Samoa. San Marino. Sao Tome and Principe. Saudi Arabia. Senegal. Seychelles. Sierra Leone. Singapore. Slovakia. Slovenia. Solomon Islands. Somalia. South Africa. South Georgia and the South Sandwich Islands. Spain. Sri Lanka. Sudan. Suriname. Svalbard and Jan Mayen. Swaziland. Sweden. Switzerland. Syrian Arab Republic. Taiwan, Province of China. Tajikistan. Tanzania, United Republic of. Thailand. Togo. Tokelau. Tonga. Trinidad and Tobago. Tunisia. Turkey. Turkmenistan. Turks and Caicos Islands. Tuvalu. Uganda. Ukraine. United Arab Emirates. United Kingdom. United States. NOTE: United States Minor Outlying Islands was defined in the eBay list previously but is no longer a viable option. This country will remain on eBay country list for backward compatibility. Use 'US' instead. Uruguay. Uzbekistan. Vanuatu. Venezuela. Viet Nam. Virgin Islands, British. Virgin Islands, U.S. Wallis and Futuna. Western Sahara. Yemen. No longer in use. See RS for Serbia and ME for Montenegro. Zambia. Zimbabwe. 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 Jersey Guernsey Unknown country Serbia Montenegro. (out) Reserved for internal or future use Contains one or more items cross-promoted with the display or purchase of a referring item. Unique item ID for the referring item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always The primary cross-promotion rule scheme that was applied to return the cross-promoted item. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always The type of promotion, CrossSell or UpSell. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always The eBay user ID of the seller offering the cross-promoted item. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always Whether a shipping discount is offered by the seller when the cross-promoted item is purchased. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Always The store name of the seller offering the cross-promoted item. GetCrossPromotions Conditionally Contains one cross-promoted item. GetBidderList Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetCrossPromotions Conditionally 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. Alternatively, use GeteBayDetails to retrieve the names programmatically. A reference: http://www.xe.com/iso4217.htm Indian Rupee. For eBay, you can only specify this currency for listings you submit to the India site (site ID 203). Canadian Dollar. For eBay, you can only specify this currency for listings you submit to the Canada site (site ID 2) (Items listed on the Canada site can also specify USD.) Hong Kong Dollar. For eBay, you can only specify this currency for listings you submit to the Hong Kong site (site ID 201). Australian Dollar. For eBay, you can only specify this currency for listings you submit to the Australia site (site ID 15). Swiss Franc. For eBay, you can only specify this currency for listings you submit to the Switzerland site (site ID 193). Malaysian Ringgit. For eBay, you can only specify this currency for listings you submit to the Malaysia site (site ID 207). Euro. For eBay, you can only specify this currency for listings you submit to these sites: 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. For eBay, you can only specify this currency for listings you submit to the Philippines site (site ID 211). Poland, Zloty. For eBay, you can only specify this currency for listings you submit to the Poland site (site ID 212). US Dollar. For eBay, you can only specify this currency for listings you submit to the US (site ID 0), eBayMotors (site 100), and Canada (site 2) sites. Singapore Dollar. For eBay, you can only specify this currency for listings you submit to the Singapore site (site 216). Swedish Krona. For eBay, you can only specify this currency for listings you submit to the Sweden site (site 218). New Taiwan Dollar. Note that there is no longer an eBay Taiwan site. Pound Sterling. For eBay, you can only specify this currency for listings you submit to the UK site (site ID 3). Reserved for internal or future use. Specifies the range of days the seller can be contacted. Seller does not want to be contacted. Contact hours will not be supported for any days. If contact hours are specified, they will be ignored. Seller can be contacted any day during the specified contact hours. Seller can be contacted Monday through Friday during the specified contact hours. Seller can be contacted Saturday or Sunday during the specified contact hours. (out) Reserved for internal or future use. (in) Specifies that you want to replace the description text of an item. (in) Specifies that you want to prepend text to the description text of an item. (in) Specifies that you want to append text to the description text of an item. Reserved for internal or future use. The type of shipping discount profile. The cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmount to $6. The cost to ship three items would normally be $24, but since the seller specified $6, the total shipping cost would be $8 + $6 + $6, or $20. For flat shipping discount profile only. The amount by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalAmountOff to $2. The cost to ship three items would normally be $24, but since the seller specified $2, the total shipping cost would be $24 - (two additional items x $2), or $20. For flat shipping discount profile only. The percentage by which to reduce the cost to ship each item beyond the first item (where the item with the highest shipping cost is selected by eBay as the first item). Let's say the buyer purchases three items, each set to ship for $8, and the seller set EachAdditionalPercentOff to 0.25. The cost to ship three items would normally be $24, but since the seller specified 0.25 ($2 out of 8), the total shipping cost would be $24 - (two additional items x $2), or $20. For flat rate shipping discount profile only. Shipping cost is the total of what it would cost to ship each item individually. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only. Shipping cost is based on the total weight of all individual items. This is simply a way to define how shipping is to be calculated--there is no discount for the buyer with this selection. For calculated shipping discount profile only. The amount of weight to subtract for each item beyond the first item before shipping costs are calculated. For example, there may be less packing material when the items are combined in one box than if they were shipped individually. Let's say the buyer purchases three items, each 10 oz. in weight, and the seller set WeightOff to 2 oz. The combined weight would be 30 oz., but since the seller specified 2 oz. off, the total weight for shipping cost calculation would be 30 oz. - (two additional items x 2 oz.), or 26 oz. For calculated shipping discount profile only. Shipping cost X applies if the total cost of items purchased is Y. For promotional discount only. Shipping cost X applies if the total number of items purchased is N. For promotional discount only. The shipping cost will not exceed this. For promotional discount only. Reserved for internal or future use. Details of a flat or calculated shipping discount profile. The unique eBay-created ID for the shipping discount, assigned when the profile is created. On input, if ModifyActionCode is Add, this is ignored if provided. If ModifyActionCode is Modify, all details of the new version of the profile must be provided. If ModifyActionCode is Delete, DiscountProfileID is required, MappingDiscountProfileID is optional, and all other fields of DiscountProfile are ignored. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The user's title for this profile. On input, if ModifyActionCode is Add, this is ignored (if provided) if this is the first profile being created and required if there is more than one profile of that type (flat rate versus calculated) already. To modify the name, set ModifyActionCode to Update and provide all details for the profile. On output, DiscountProfileName is only returned if the user defined more than one profile. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The amount, if the seller specified EachAdditionalAmount as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only. GetShippingDiscountProfiles FlatShippingDiscount Conditionally SetShippingDiscountProfiles FlatShippingDiscount Conditionally GetItem GetSellingManagerTemplates FlatShippingDiscount InternationalFlatShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The amount, if the seller specified EachAdditionalAmountOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only. GetShippingDiscountProfiles FlatShippingDiscount Conditionally SetShippingDiscountProfiles FlatShippingDiscount Conditionally GetItem GetSellingManagerTemplates FlatShippingDiscount InternationalFlatShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The percent (expressed in decimal, as in .5 for 50%), if the seller specified EachAdditionalPercentOff as the type of profile, as noted in FlatShippingDiscount.DiscountName. Flat rate shipping only. GetShippingDiscountProfiles FlatShippingDiscount Conditionally SetShippingDiscountProfiles FlatShippingDiscount Conditionally GetItem GetSellingManagerTemplates FlatShippingDiscount InternationalFlatShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The weight by which to reduce the combined item weight, if the seller specified WeightOff as the type of profile, as noted in CalculatedShippingDiscount.DiscountName. The smallest unit is used (e.g. ounces). Calculated shipping only. GetShippingDiscountProfiles CalculatedShippingDiscount Conditionally SetShippingDiscountProfiles CalculatedShippingDiscount Conditionally GetItem GetSellingManagerTemplates CalculatedShippingDiscount InternationalCalculatedShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally For SetShippingDiscountProfiles, if MappedDiscountProfileID is omitted when ModifyActionCode is Delete, any listings currently using the profile identified by DiscountProfileID will have that profile removed. For SetShippingDiscountProfiles and GetItem, this is the intended discount profile mapping. GetShippingDiscountProfiles CalculatedShippingDiscount Conditionally SetShippingDiscountProfiles CalculatedShippingDiscount Conditionally GetItem GetSellingManagerTemplates CalculatedShippingDiscount InternationalCalculatedShippingDiscount
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally The nature of the discount. An offer that applies to a limited number of listings during the offering period. Example: "There is no insertion fee for up to 5 auctions when listing between 12/1 and 12/10." An offer that applies to an unlimited number of listings during the offering period. Example: "Get subtitle for $0.10 in Tech category when listing between 12/25 and 12/28. No limit to the number of items listed during this period." Reserved for future use DistanceType used in proximity search The measurement used in a proximity search distance calculation. GetSearchResults
DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
Conditionally GetCategoryListings GetProducts Conditionally The unit used in a proximity search distance calculation. GetSearchResults
DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
Conditionally GetCategoryListings GetProducts Conditionally Allowed categories are Motorcycles, Powersports, and Other Vehicles. In addition to the categories allowed by LocalMarketSpecialty, allows Passenger Vehicles. Includes five sub-types. See LocalMarketRegularSubscriptionDefinitionType for details. Allows same categories as LocalMarketRegular. The status of a particular entry. The entry is enabled. The entry is disabled. Reserved for future use. Specifies the seller's reason for ending an item listing early. This is required if the seller ended the listing early and the item did not successfully sell of if the item has bids and the seller wants to sell to the high bidder. The item was lost or broken. The item is no longer available for sale. The start price or reserve price is incorrect. The listing contained an error (other than start price or reserve price). Reserved for internal or future use. The listing has qualifying bids (i.e., there is a current high bid that, when applicable, meets the minimum reserve price) and there are more than 12 hours before the listing ends. Sell the item to the highest eligible bidder. <br> In the last 12 hours of an item listing, you cannot end an item early if it has bids. The vehicle was sold. Applies to local classified listings for vehicles only. Contains details about why an item does or doesn't qualify as an eBay Express listing. 579 NoOp If false, indicates that an item is not Express-eligible because the seller is not Express-eligible. Only returned if false, and no other settings are returned in this case. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, this field indicates the item was opted out of Express; that is, ExpressOptOut was true in the listing request. Only returned if true, and no other settings are returned in this case. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, indicates eBay has marked the item as eligible for eBay Express based on direct evaluation. Only returned if true, and no other settings are returned in this case. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, indicates the item listing format is eligible for Express. If false, the listing format is ineligible (and the item is therefore ineligible). GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the item's primary category is enabled for Express. If false, the primary category is not enabled for Express (and the item is therefore ineligible). GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the seller has an Express-eligible PayPal account. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, domestic shipping costs are specified for the item. If false, they aren't specified (and the item is therefore ineligible). GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the item is covered by a return policy that meets the site's requirements for Express. Only returned for Express Germany. (A return policy is optional for Express US.) GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the item includes a picture. If false, the item doesn't include a picture. Only returned if the category requires a picture for Express. Some categories waive the picture requirement. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the item specifies an eligible item condition. If false, the item doesn't specify an eligible item condition. Only returned if the category requires an item condition for Express. Some categories waive the item condition requirement. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the price of the item is above the minimum price allowed on Express. That is, the StartPrice, BuyItNowPrice, or CurrentPrice is above the minimum.) GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the price of the item is below the maximum price allowed on Express. (That is, the StartPrice, BuyItNowPrice, or CurrentPrice is below the maximum.) GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, indicates the item meets the site's eBay Express requirements for checkout. (A common case when this could be false would be when ThirdPartyCheckout is true but ThirdPartyCheckoutIntegration is false.) GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the item has no pre-approved bidder list. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the item is not an eBay Giving Works item. Only returned if the site does not allow charity listings on Express. (In other words, if the site excludes charity listings from Express, then NoCharity=true means the item meets the eligibility requirement.) GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the item offers a combined shipping discount. Only returned if the Express site has an item-level combined shipping discount requirement. (Some Express sites only require you to accept combined payments at the seller level, in your My eBay preferences.) GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the country you specified for the item meets the specified site's shipping origin requirements for Express. GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally If true, the PayPal account for the item accepts payments from a buyer with an unconfirmed address. If false, the account blocks unconfirmed addresses (and the item is therefore ineligible). GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally VerifyAddItem Conditionally Contains extended contact information for an eBay user. All fields related to contact hours including time ranges and user-designated time zone. AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No GetItem GetSellingManagerTemplates
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetSellerList
DetailLevel: none, ItemReturnDescription, ReturnAll
Conditionally Returned for classified ads to indicate whether contact by email is enabled. In the pay-per-lead feature, which will be available in upcoming months on the US site, this field will specify whether potential buyers can email the seller after viewing a pay-per-lead listing. AddItem AddItems AddSellingManagerTemplate ReviseItem ReviseSellingManagerTemplate VerifyAddItem RelistItem VerifyRelistItem No GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 A phone number assigned by eBay and provided to potential buyers when they are viewing a pay-per-lead listing. If a potential buyer (a lead) makes a call to this number, eBay routes the call to the seller based on inputs made by the seller when the seller lists the item. GetItem GetSellingManagerTemplates Conditionally
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
 A product finder ID. GetCategory2CS always (and only) returns this when Category.ProductFinderIDs is returned. GetCategory2CS
DetailLevel: ReturnAll
Conditionally MappedCategoryArray If false or not present, the product finder can be used as input to GetProductSearchResults to search for catalog data (Pre-filled Item Information) that a seller might want to include in a listing.<br> <br> If true, the product finder can be used as input to GetSearchResults to search for listings with Item Specifics on the eBay site. However, if you have trouble using the specified product finder with GetSearchResults, or if you can't find a product finder ID that you saw on the Web site, here is a workaround: Use the pfid parameter from the URL of the Product Finder search page on the site you're interested in. See the Knowledge Base article referenced below for more details. GetCategory2CS
DetailLevel: ReturnAll
Conditionally MappedCategoryArray Knowledge Base: ProductFinderID for Buy-Side Searches https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=560 Indicates the type of external product ID being used to identify a stock product. 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.) 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.) ExternalProductID.Value contains an eBay catalog product ID. Required when you pass an eBay product ID as the external product ID. Not applicable with GetSearchResults or GetProducts. ExternalProductID.Value contains an EAN value. Required when you pass an EAN as the external product ID. 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 GetSearchResults or GetProducts. With GetSearchResults, use TicketFinder instead. Reserved for future use. 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).<br> <br> <b>For AddItem and related calls:</b> 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).<br> <br> Required for Half.com listing use cases, and this can only be an ISBN, UPC, or EAN value.<br> <br> <b>For GetSearchResults and GetProducts input only:</b> Only ISBN, EAN, and UPC values are currently supported as input.<br> <br> <b>For GetProducts and GetSellerPayments output only:</b> 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 AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddFixedPriceItem VerifyAddItem Item.ExternalProductID Conditionally GetProducts Conditionally Conditionally GetSearchResults Conditionally GetSellerPayments 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. AddFixedPriceItem AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddFixedPriceItem 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.<br> <br> GetProducts supports ISBN, UPC, and EAN. AddItem AddItems AddSellingManagerTemplate GetItemRecommendations VerifyAddItem AddFixedPriceItem VerifyAddFixedPriceItem Item.ExternalProductID MPN Conditionally GetProducts ISBN, UPC, EAN Conditionally Conditionally GetSearchResults ISBN, UPC, EAN Conditionally GetSellerPayments ISBN, UPC, EAN Conditionally 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 GetProducts GetSellerPayments Conditionally Indicates whether the seller making the request can list with certain features. A seller's eligibility is determined by their feedback rating. Indicates whether the seller is eligible to list items with the 'BuyItNow' option. A value of true means that the seller is eligible; a value of false indicates that they are not eligible. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates whether the seller is eligible to specify the 'BuyItNow' option for multiple-item listings. A value of true means that the seller is eligible; a value of false indicates that they are not eligible. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates whether the seller is eligible to list a fixed-price item with a one day listing duration. A value of true means that the seller is eligible; a value of false indicates that they are not eligible. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Conditionally Indicates whether or not the seller is eligible to list multi-variation items. GetUser
DetailLevel: none, ReturnSummary, ReturnAll
Always Identifies the name and cost of a listing feature that a member pays to eBay (or an eBay company). These listing feature names, fees, and possible discounts are intended only as an aid to help estimate the fees for a listing. Use GetAccount for an accurate final fee breakdown. Returned in AddItemResponseType and related response types. Name of the listing feature, for identification purposes. See the Trading API guide for a list of current listing features names and associated fees. ListingFees UseTopicAlias AddFixedPriceItem AddItem AddItems AddLiveAuctionItem RelistFixedPriceItem RelistItem ReviseInventoryStatus ReviseFixedPriceItem ReviseItem ReviseLiveAuctionItem VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem Always Amount of the fee that eBay will charge the member for the associated listing feature. See the eBay.com Web site online help for a current schedule of listing features and their associated fees. eBay.com Fees http://pages.ebay.com/help/sell/fees.html AddFixedPriceItem AddItem AddItems AddLiveAuctionItem RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseInventoryStatus ReviseItem ReviseLiveAuctionItem VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem Always This field exists in the response when the user has selected the features that participate in a promotional discount. See the eBay.com Web site online help for a current fee schedule. eBay.com Fees http://pages.ebay.com/help/sell/fees.html AddFixedPriceItem AddItem AddItems AddLiveAuctionItem RelistFixedPriceItem ReviseInventoryStatus RelistItem ReviseFixedPriceItem ReviseItem ReviseLiveAuctionItem VerifyAddFixedPriceItem VerifyAddItem VerifyRelistItem Always 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-499,999. Green Shooting Star, feedback score 500,000-999,999. Silver Shooting Star, feedback score 1,000,000 and above. Reserved for internal or future use. Used to determine whether the seller meets the minimum feedback requirements for Express. 587 NoOp GetItem
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally GetUser
DetailLevel: none, ReturnAll
Conditionally Identifies a set of one or more fees that a member pays to eBay (or an eBay company). Instances of this type can hold one or more fees. Contains the name, fee, and possible discount amount for an item listing feature. A Fee container is returned for each listing feature, even if the associated cost (Fee value) is 0. AddFixedPriceItem AddItem AddItems AddLiveAuctionItem RelistFixedPriceItem RelistItem ReviseFixedPriceItem ReviseItem ReviseLiveAuctionItem VerifyAddFixedPriceItem VerifyAddItem ReviseInventoryStatus VerifyRelistItem Always AddItemFromSellingManagerTemplate AddSellingManagerTemplate GetSellingManagerTemplateAutomationRule GetSellingManagerItemAutomationRule SetSellingManagerTemplateAutomationRule SetSellingManagerItemAutomationRule GetSellingManagerTemplateAutomationRule DeleteSellingManagerItemAutomationRule DeleteSellingManagerTemplateAutomationRule ReviseSellingManagerTemplate Conditionally Details of an individual discount profile defined by the user for flat rate shipping. The type of discount or "rule" that is being used by the profile. The value corresponding to the selected rule is set in the same-named field of FlatShippingDiscount.DiscountProfile. All are "variable" rules, as defined in the documentation on shipping discount profiles. GetShippingDiscountProfiles EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff Conditionally SetShippingDiscountProfiles EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff Conditionally GetItem GetSellingManagerTemplates EachAdditionalAmount, EachAdditionalAmountOff, EachAdditionalPercentOff
DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Conditionally UseTopicAlias ShippingDiscountProfiles