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 Enables a seller to create a new Unpaid Item dispute or to cancel a single line item order. Item Not Received and Significantly Not as Described buyer disputes can only be created through the Resolution Center, or through PayPal or other eBay site where a Resolution Center is not available.

Enables a seller to create a new Unpaid Item dispute or to cancel a single line item order.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes This value indicates the action (or lack of action) taken by the buyer which caused the seller to create an Unpaid Item dispute, or to cancel the order line item (tranaction). The allowed values for <b>DisputeExplanation</b> depends on the value of <b>DisputeReason</b> (see the link below). AddDispute Yes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UsingAddDispute The type of dispute being created. <b>BuyerHasNotPaid</b> and <b>TransactionMutuallyCanceled</b> are the only values that may be used with the <b>AddDispute</b> call. AddDispute Yes Unique identifier for an eBay item listing. A listing can have multiple orders, but only one <b>ItemID</b>. To identify a specific order line item, either an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value must be passed in the request. So, unless <b>OrderLineItemID</b> is used, this field is required. <br> 19 (Note: The eBay database specifies 38. ItemIDs usually consist of 9 to 12 digits) AddDispute Conditionally The unique identifier of an order line item. An order line item is created once there is a commitment from a buyer to purchase an item. To identify a specific order line item, either an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value must be passed in the request. So, unless <b>OrderLineItemID</b> is used, this field is required. <br> 19 (Note: The eBay database specifies 38. TransactionIDs usually consist of 9 to 12 digits.) AddDispute Conditionally <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. To identify a specific order line item, either an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value must be passed in the request. So, unless <b>ItemID</b>/<b>TransactionID</b> pair is used, this field is required. <br> 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) AddDispute Conditionally Returned after calling <b>AddDisputeRequest</b>. The response confirms that the Unpaid Item dispute was successfully created. The unique identifier of the Unpaid Item dispute. AddDispute Always Allows a seller to respond to or close an Item Not Received dispute. This can be used to add a comment to an Unpaid Item Dispute only if the request version was lower than 637 when the dispute was created.

Adds a response or comment to a dispute, or closes a dispute.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BuyerDisputes The unique identifier of the dispute, returned when the dispute was created. AddDisputeResponse Yes The text of a comment or response being posted to the dispute. Required when DisputeActivity is SellerAddInformation, SellerComment, or SellerPaymentNotReceived; otherwise, optional. AddDisputeResponse Conditionally The type of activity the seller is taking on the dispute. The allowed value is determined by the current value of DisputeState, returned by GetDispute or GetUserDisputes. Some values relate to Unpaid Item disputes and other values relate to buyer-created disputes known as Item Not Received or Significantly Not As Described disputes. AddDisputeResponse Yes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BuyerDisputes The shipping carrier used to ship the item in dispute. Non-alphanumeric characters are not allowed. This field (along with ShipmentTrackNumber) is required if DisputeActivity is SellerShippedItem. AddDisputeResponse Conditionally The tracking number associated with one package of a shipment. The seller is responsible for the accuracy of the shipment tracking number, as eBay only verifies that the tracking number is consistent with the numbering scheme used by the specified shipping carrier, but cannot verify the accuracy of the tracking number. This field (along with ShippingCarrierUsed) is required if DisputeActivity is SellerShippedItem. AddDisputeResponse Conditionally This timestamp indicates the date and time when the item under dispute was shipped. This field is required if DisputeActivity is SellerShippedItem. AddDisputeResponse Conditionally Response to a call of AddDisputeResponse. Defines and lists a new fixed-price listing (not auction-style listings). The main difference between AddFixedPriceItem and AddItem is that AddFixedPriceItem supports the creation of fixed-price listings only, whereas AddItem supports all listing formats.<br> <br> Also, only AddFixedPriceItem supports multi-variation listings and tracking inventory by SKU. AddItem does not support Variations or InventoryTrackingMethod.<br> <br> See the AddFixedPriceItem documentation for additional information.

Defines and lists a new fixed-price item. A fixed-price listing can include multiple identical items.

AddItem, AddItems, AddToItemDescription, EndFixedPriceItem, GetItem, GetCategories, GetItemRecommendations, RelistFixedPriceItem, ReviseFixedPriceItem, VerifyAddFixedPriceItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingItemsIntro http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Variations http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ConsideringBestMatch 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 identifier 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-level 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. http://pages.ebay.com/help/sell/fees.html AddFixedPriceItem Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits http://pages.ebay.com/help/sell/fvf.html http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UsingFeaturePacks 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 is applied. AddFixedPriceItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. AddFixedPriceItem Conditionally Defines a single new item and lists it on a specified eBay site.&nbsp;<b>Also for Half.com</b>. Returns the item ID for the new listing, and returns fees the seller will incur for the listing (not including the Final Value Fee, which cannot be calculated until the item is sold). AddFixedPriceItem, AddItems, AddToItemDescription, GetItem, GetItemRecommendations, GetSellerList, RelistItem, ReviseItem, VerifyAddItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingItemsIntro http://developer.ebay.com/DevZone/XML/docs/WebHelp/ManagingShipping-Specifying_Shipping_Costs_when_Creating_or_Revising_a_Listing.html http://pages.ebay.com/sell/April2009Update/Checklist/ http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ConsideringBestMatch half Child elements hold the values that define the new item. Item is a required input. <br> <br> Applicable to Half.com. AddItem Yes Returns the item ID and the estimated fees for the new listing, as well as the start and end times of the listing. Unique item ID for the new listing. <br> <br> Applicable to Half.com. <br> <br> <span class="tablenote"><b>Note:</b> Although eBay represents item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time, and your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see <a href=" http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468"> Common FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge Base. </span> 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddItem Always Starting date and time for the new listing. <br> <br> Applicable to Half.com (for Half.com, the start time is always the time the item was listed). AddItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. <br> <br> Applicable to Half.com (for Half.com the actual end time is GTC, not the end time returned in the response). AddItem 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. <br> <br> Applicable to Half.com, but the values are not applicable to Half.com listings. AddItem Always http://pages.ebay.com/help/sell/fees.html http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits http://pages.ebay.com/help/sell/fvf.html http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UsingFeaturePacks 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 it has expired with no replacement, CategoryID does not return a value. <br> <br> Not applicable to Half.com. 10 AddItem 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. <br> <br> Not applicable to Half.com. 10 AddItem Conditionally The nature of the discount, if a discount applied. AddItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. AddItem Conditionally Creates listings from Selling Manager templates. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro The ID of the template you are using to list an item. You can obtain a SaleTemplateID by calling GetSellingManagerInventory. AddItemFromSellingManagerTemplate No Start time for the listing. AddItemFromSellingManagerTemplate No <b>Currently, only the following can be specified as children of this container: payment methods, the PayPal email address, and CategoryMappingAllowed. </b> This container is intended for specifying item values that differ from values in the template specified in the SaleTemplateID field. However, currently, the only children that are allowed for this container are payment methods and a PayPal email address. AddItemFromSellingManagerTemplate No Returns values indicating information for a new listing. The unique identifier for the listing that was created by the AddItemFromSellingManagerTemplate request. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddItemFromSellingManagerTemplate Always Start time for the listing that was created by the AddItemFromSellingManagerTemplate request. AddItemFromSellingManagerTemplate Always End time for the listing that was created by the AddItemFromSellingManagerTemplate request. This value is equal to the start time plus the listing duration. AddItemFromSellingManagerTemplate 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. AddItemFromSellingManagerTemplate 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 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. Not applicable to Half.com. 10 AddItemFromSellingManagerTemplate 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. Not applicable to Half.com. 10 AddItemFromSellingManagerTemplate Conditionally Defines from one to five items and lists them on a specified eBay site. AddItem, AddToItemDescription, EndItems, GetItem, GetItemRecommendations, GetSellerList, RelistItem, ReviseItem, VerifyAddItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingItemsIntro http://pages.ebay.com/sell/April2009Update/Checklist http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ConsideringBestMatch Defines a single item to be listed on eBay. This container is similar to an AddItem request. Up to five (5) containers can be included per a given AddItems request. 5 AddItems Yes Returns the item IDs and the estimated fees for the new listings, as well as the start and end times of the listings. Returns the Single AddItem response with corresponding Item Id and estimated fees. AddItems Always Enables a buyer and seller in an order relationship to send messages to each other's My Messages Inboxes. AddMemberMessagesAAQToBidder, AddMemberMessageRTQ, DeleteMyMessages, GetMemberMessages, ReviseMyMessages, ReviseMyMessagesFolders The unique ID of the item about which the question was asked. AddMemberMessageAAQToPartner Yes Container for the message. Includes the message body, plus other values related to the message. AddMemberMessageAAQToPartner Yes Response to AddMemberMessageAAQToPartner request. Enables a seller to reply to a question about an active item listing. AddMemberMessagesAAQToBidder, AddMemberMessageAAQToPartner, DeleteMyMessages, GetMemberMessages, GetMyMessages, ReviseMyMessages, ReviseMyMessagesFolders http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers The unique ID of the item about which the question was asked. This field is not required in the request, if the request includes a RecipientID in the MemberMessage container. AddMemberMessageRTQ No Container for the message. Includes the message body (which should answer the question that an eBay user asks you (the seller) about an active listing), plus other values related to the message. AddMemberMessageRTQ Yes Response to AddMemberMessageRTQ request. Enables a seller to send up to 10 messages to bidders, or to users who have made offers via Best Offer, regarding an active item listing. AddMemberMessageAAQToPartner, AddMemberMessageRTQ, DeleteMyMessages, GetMemberMessages, GetMyMessages, GetUserContactDetails, ReviseMyMessages, ReviseMyMessagesFolders http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers Allows a seller to send up to 10 messages to bidders and users who have made offers (via Best Offer) during an active listing. AddMemberMessagesAAQToBidder Yes Contains the response information. Contains the response information. AddMemberMessagesAAQToBidder Always Combines two or more order line items into a single order, enabling a buyer to pay for all of those order line items with a single payment (and, if so arranged, ship all of the items together). GetItemTransactions, GetOrders http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CreatingaCombinedPaymentOrder additional insight into prerequisites http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WorkingWithCombinedPayment The order that is being created. AddOrder Yes Returns a unique identifier for the order. A buyer may make a single payment to purchase all of the order line items included in the order. The unique identifier for the Combined Payment order. This OrderID can be used as an input filter in GetOrders. AddOrder Always The date and time the Combined Payment order was created. AddOrder Always Creates a new Second Chance Offer (that is, an offer for an unsold item) for one of that item's non-winning bidders. GetAllBidders, VerifyAddSecondChanceItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MakingSecondChanceOffersForItems Specifies the bidder from the original, ended listing to whom the seller is extending the second chance offer. Specify only one RecipientBidderUserID per call. If multiple users are specified (each in a RecipientBidderUserID node), only the last one specified receives the offer. AddSecondChanceItem Yes The amount the offer recipient must pay to purchase the item from the second chance offer listing. Use only when the original item was listed in an eBay Motors vehicle category (or in some categories on U.S. and international sites for high-priced items, such as items in many U.S. and Canada Business and Industrial categories) and it ended unsold because the reserve price was not met. Otherwise, eBay establishes the price and no price should be submitted. AddSecondChanceItem No Specifies the length of time the second chance offer listing will be active. The recipient bidder has that much time to purchase the item or the listing expires. AddSecondChanceItem Yes Specifies the item ID for the original, ended listing from which the second chance offer item comes. A new ItemID is returned for the second chance offer item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddSecondChanceItem Yes Message content. Cannot contain HTML, asterisks, or quotes. This content is included in the second chance offer email sent to the recipient, which can be retrieved with GetMyMessages. 1000 AddSecondChanceItem No AddSecondChanceItem response for a new Second Chance Offer listing. Contains the item ID for the new second chance offer listing. Different from the original ItemID passed in the request. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddSecondChanceItem Always Indicates the date and time when the the new second chance offer listing became active and the recipient user could purchase the item. AddSecondChanceItem Always Indicates the date and time when the second chance offer listing expires, at which time the listing ends (if the recipient user does not purchase the item first). AddSecondChanceItem Always Adds a new product folder to a user's Selling Manager account. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Name of the new Selling Manager inventory folder. AddSellingManagerInventoryFolder No Unique Folder ID of parent folder. If no ParentFolderID is submitted, Folder is added to root level. AddSellingManagerInventoryFolder No Contains comments that will be associated with this folder. AddSellingManagerInventoryFolder No Returns the status of an add folder operation. New ID of the folder newly created in the user's Selling Manager account. AddSellingManagerInventoryFolder Always Creates a Selling Manager product. Sellers use Selling Manager products to store SYI forms for use as listing templates. This call is subject to change without notice; the deprecation process is inapplicable to this call.

Creates a Selling Manager product, which contains templates for repeat listings.

AddSellingManagerTemplate,GetSellingManagerTemplates,AddSellingManagerInventoryFolder http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Contains product information that the seller has recorded, such as a product description and inventory and restocking details. AddSellingManagerProduct Yes Unique identifier of the folder. This ID is created when the folder is added and is returned by the AddSellingManagerInventoryFolder call. AddSellingManagerProduct No Specifies an eBay category associated with the product, defines Item Specifics that are relevant to the product, and defines variations available for the product (which may be used to create mult-variation listings). AddSellingManagerProduct Yes Response for adding a Selling Manager product. The details of the product. AddSellingManagerProduct Always Adds a Selling Manager template. One product can have up to 20 templates associated with it. This call is subject to change without notice; the deprecation process is inapplicable to this call. GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Contains the data in your template, i.e. the data needed to list an item. The item data you specify will be used when you list items from the template you are adding. AddSellingManagerTemplate Yes The name you provide for the template. If you don't specify a name, then Item.Title is used as the name. AddSellingManagerTemplate No The ID of the product with which the template will be associated. Before calling AddSellingManagerTemplate, you can obtain a product ID from the response of an AddSellingManagerProduct call. That is, after you add a product using AddSellingManagerProduct, a product ID is returned in the SellingManagerProductDetails.ProductID field. The GetSellingManagerTemplates call also returns product IDs. Alternatively, you can obtain information about a user's existing products, including the product IDs, by calling GetSellingManagerInventory. AddSellingManagerTemplate Yes Contains values indicating template information for a newly-exported item. ID of the primary category in which the item would be listed. AddSellingManagerTemplate Always ID of the secondary category (if any) in which the item would be listed. AddSellingManagerTemplate Always The ID of the Selling Manager template. Store this value, for use in other Selling Manager calls. AddSellingManagerTemplate Always Ignore this value. For the output value that indicates the ID of the product associated with the template, use SellingManagerProductDetails.ProductID. AddSellingManagerTemplate Always The name of the template, as it will appear in Selling Manager Pro. This name is the input value you provided in the SaleTemplateName field. If you didn't specify a value for SaleTemplateName, then Item.Title is used as the name. AddSellingManagerTemplate Always The details of the product with which the template is associated. AddSellingManagerTemplate Always Child elements contain the estimated listing fees for the new listing template. Note that the fee will only be charged when an item is created from the template. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. AddSellingManagerTemplate Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UsingFeaturePacks Appends a horizontal rule, then a message about what time the addition was made by the seller, and then the seller-specified text. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ChangingItemDescriptions AddItem, ReviseItem Unique item ID that identifies the target item listing, the description of which is appended with the text specified in Description. 19 (Note: The eBay database specifies 38. Item IDs are usually 9 to 12 digits) AddToItemDescription Yes Specifies the text to append to the end of the listings description. Text appended to a listing's description must abide by the rules applicable to this data (such as no JavaScript) as is the case when first listing the item. AddToItemDescription Yes Indicates the success or failure of the attempt to add text to the end of the description section of an item listing. Adds one or more items to the user's My eBay watch list. GetMyeBayBuying, GetMyeBaySelling, RemoveFromWatchList The ItemID of the item that is to be added to the watch list. The item must be a currently active item, and the total number of items in the watchlist (after the items in the request have been added) cannot exceed the maximum allowed number of watch list items. One or more ItemID fields can be specified. A separate error node will be returned for each item that fails.<br> <br> Either ItemID or VariationKey is required (but do not pass in both). 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddToWatchList No A variation (or set of variations) that you want to watch. Use this to watch a particular variation (not the entire item). Either the top-level ItemID or VariationKey is required (but do not pass in both). AddToWatchList Conditionally Indicates the number of items currently in the user's Watch List and the maximum number of items allowed in the Watch List. The number of items in the user's watch list (after those specified in the call request have been added) AddToWatchList Always The maximum number of items allowed in watch lists. Currently this value is the same for all sites and all users. AddToWatchList Always Ends the eBay Motors listing specified by ItemID and creates a new Transaction Confirmation Request (TCR) for the item, thus enabling the TCR recipient to purchase the item. You can also use this call to see if a new TCR can be created for the specified item.

Ends the eBay Motors listing specified by ItemID and creates a new Transaction Confirmation Request (TCR) for the item, thus enabling the TCR recipient to purchase the item. You can also use this call to see if a new TCR can be created for the specified item.

GetBestOffers, GetBidderList, GetItem, GetSellerList http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LearningAboutBidders http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EnablingBestOffer http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers Specifies the user to whom the seller is offering the Transaction Confirmation Request. AddTransactionConfirmationItem Yes If true, specifies that the seller is verifying whether a new Transaction Confirmation Request (TCR) can be created. Thus, if this value is passed as true, then no Transaction Confirmation Request is actually made. If VerifyEligibilityOnly is not passed, or is false, a Transaction Confirmation Request is actually made. AddTransactionConfirmationItem No Specifies the postal code of the user to whom the seller is offering the Transaction Confirmation Request. Required only if the user does not meet the other options listed in RecipientRelationCodeType. An error is returned if RecipientUserID and RecipientPostalCode do not match for more than 3 times for a seller per day. AddTransactionConfirmationItem No Specifies the current relationship between the seller and the potential buyer. A seller can make a Transaction Confirmation Request (TCR) for an item to a potential buyer if the buyer meets one of several criteria. A TCR is sent by a seller to one of the following: a bidder, a best offer buyer, a member with an ASQ question, or any member with a postal code. See the values and annotations in RecipientRelationCodeType. AddTransactionConfirmationItem Yes The amount the offer recipient must pay to buy the item specified in the Transaction Confirmation Request (TCR). A negotiated amount between the buyer and the seller. AddTransactionConfirmationItem Yes Specifies the length of time the item in the Transaction Confirmation Request (TCR) will be available for purchase. AddTransactionConfirmationItem Yes The ItemID of the item that the seller wants to end in order to create a Transaction Confirmation Request (TCR). AddTransactionConfirmationItem Yes Comments the seller wants to send to the recipient (bidder, best offer buyer, member with an ASQ question, or member with a postal code). AddTransactionConfirmationItem No Returns an item ID for a new Transaction Confirmation Request (TCR). The new item ID for the item in the new Transaction Confirmation Request (TCR). This field is not returned if the request was only used to verify that a new TCR could be created. AddTransactionConfirmationItem Conditionally The date and time when the item in the new Transaction Confirmation Request (TCR) becomes available for purchase. AddTransactionConfirmationItem Always The date and time when the item in the new Transaction Confirmation Request (TCR) is no longer available for purchase. AddTransactionConfirmationItem Always Enables a seller to do various tasks after the creation of a single line item or multiple line item order. Typically, this call is used after the buyer has paid for the order, but it can be called by the seller beforehand. Typical post-payment tasks available to this call include marking the order as paid, marking the order as shipped, providing shipment tracking details, and leaving feedback for the buyer. Unique identifier for an eBay item listing. An <b>ItemID</b> can be paired up with a corresponding <b>TransactionID</b> and used in the <b>CompleteSale</b> request to identify a single line item order. <br><br> Unless an <b>OrderLineItemID</b> is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item order, the <b>ItemID</b>/<b>TransactionID</b> pair must be specified. For a multiple line item order, <b>OrderID</b> must be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) CompleteSale Conditionally Unique identifier for an eBay order line item (transaction). The <b>TransactionID</b> can be paired up with the corresponding <b>ItemID</b> and used in the <b>CompleteSale</b> request to identify a single line item order. <br><br> Unless an <b>OrderLineItemID</b> is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item order, the <b>ItemID</b>/<b>TransactionID</b> pair must be specified. For a multiple line item order, <b>OrderID</b> must be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) CompleteSale Conditionally Container consisting of the feedback text and the buyer's eBay user ID. Since there can only be one feedback entry per order line item, this container should not be used if feedback for the buyer has already been left for this item. Call <b class="con">GetFeedback</b> to determine whether feedback has already been left for the item. If this container is used, all of its child fields are required. CompleteSale No The seller includes and sets this field to true if the order has been shipped. If the call is successful, the order line item(s) are marked as Shipped in My eBay. <br><br> If the seller includes and sets this field to false, the order line item(s) are marked (or remain) as Not Shipped in My eBay. <br><br> If this field is not included, the shipped status of the order line item(s) remain unchanged in My eBay. <br><br> If shipment tracking information is provided for an order line item through the Shipment container in the same request, the order line item is marked as shipped automatically and the <b>Shipped</b> field is not required. <br><br> For orders going through the new payment process, DE and AT sellers mark an order as shipped to expedite the seller payout process. CompleteSale No The seller includes and sets this field to true if the buyer has paid for the order. If the call is successful, the order line item(s) are marked as Paid in My eBay. <br><br> If the seller includes and sets this field to false, the order line item(s) are marked (or remain) as Not Paid in My eBay. <br><br> If this field is not included, the paid status of the order line item(s) remain unchanged in My eBay. <br><br> If an order is going through the new eBay payment process, DE and AT sellers cannot use this field to mark the order as paid, as this can only be done by eBay. CompleteSale No This field is required if <b>CompleteSale</b> is being used for a Half.com order. The value should be set to <i>Half</i>, which is the only applicable <b>ListingType</b> value for this call. CompleteSale Half Conditionally Container consisting of shipment tracking information, shipped time, and an optional text field to provide additional details to the buyer. Setting the tracking number and shipping carrier automatically marks the item as shipped and the <b>Shipped</b> field is not required. <br><br> (If you supply <b>ShipmentTrackingNumber</b> you must also supply <b>ShippingCarrierUsed</b>, otherwise you will get an error. <br><br> To modify the shipping tracking number and/or carrier, supply the new number in <b>ShipmentTrackingNumber</b> or supply the value for <b>ShippingCarrierUsed</b> or both. The old number and carrier are deleted and the new ones are added. <br><br> To simply delete the current tracking details altogether, supply empty <b>Shipment</b> tags. CompleteSale No A unique identifier that identifies a single line item or multiple line item order. <br><br> For a single line item order, the <b>OrderID</b> value is identical to the <b>OrderLineItemID</b> value that is generated upon creation of the order line item. For multiple line item orders, the <b>OrderID</b> value is created by eBay when the buyer is purchasing multiple order line items from the same seller at the same time. For multiple line item orders not going through the eBay Cart flow, a Combined Payment order can be created by the seller through the <b>AddOrder</b> call. The <b>OrderID</b> can be used in the <b>CompleteSale</b> request to identify a single or multiple line item order. <br><br> <b>OrderID</b> overrides an <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair if these fields are also specified in the same request. CompleteSale No <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. For a single line item order, the <b>OrderLineItemID</b> value can be passed into the <b>OrderID</b> field in the <b>CompleteSale</b> request. <br><br> Unless an <b>ItemID</b>/<b>TransactionID</b> pair is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item order, the <b>OrderLineItemID</b> must be specified. For a multiple line item order, <b>OrderID</b> must be used. If <b>OrderLineItemID</b> is specified, the <b>ItemID</b>/<b>TransactionID</b> pair are ignored if present in the same request. 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) CompleteSale No Indicates the success or failure of the attempt to leave feedback for the buyer, change the paid status in My eBay, and/or change the shipped status in My eBay. <br><br> Applies to half.com. <br><br> <br><br> When CompleteSale is applied to a specified order (by specifying OrderID), it also applies to the child transactions associated with the order. An OrderID cannot be used with half.com items. Returns the ID of a user who has gone through an application's consent flow process for obtaining an authorization token. FetchToken, GetSessionID, GetTokenStatus, RevokeToken http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingAToken A string obtained by making a GetSessionID call, passed in redirect URL to the eBay signin page. ConfirmIdentity Yes Confirms the identity of the user by returning the UserID and the EIASToken belonging to the user. Unique eBay user ID for the user. ConfirmIdentity Always Removes selected messages for a given user. AddMemberMessagesAAQToBidder, AddMemberMessageRTQ, GetMemberMessages, GetMyMessages, ReviseMyMessages, ReviseMyMessagesFolders This field will be deprecated in an upcoming release. This field formerly contained a list of up to 10 AlertID values. DeleteMyMessages No Contains a list of up to 10 MessageID values. DeleteMyMessages No The response to DeleteMyMessagesRequestType. If the request was successful, DeleteMyMessages returns nothing. Removes an inventory folder when a user deletes it in My eBay. This call is subject to change without notice; the deprecation process is inapplicable to this call.

Removes a Selling Manager inventory folder.

AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Unique ID of the folder to be deleted. DeleteSellingManagerInventoryFolder No Returns the status of delete folder operation. Removes the association of Selling Manager automation rules to an item. Returns the remaining rules in the response. <br><br> This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro The ID of the item from which to delete automation rules. DeleteSellingManagerItemAutomationRule Yes If true, the automated relisting rules are removed from the item. DeleteSellingManagerItemAutomationRule No If true, the automated second chance offer rule is removed from the item. DeleteSellingManagerItemAutomationRule No Contains the set of automation rules associated with the specified item. Contains the remaining automated listing rules associated with this item. DeleteSellingManagerItemAutomationRule Conditionally Contains the remaining automated relisting rules associated with this item. DeleteSellingManagerItemAutomationRule Conditionally Contains the remaining automated second chance offer rule associated with this item. DeleteSellingManagerItemAutomationRule Conditionally Contains fees that may be incurred when items are listed using the automation rules (e.g., a scheduled listing fee). Use of an automation rule does not in itself have a fee, but use can result in a fee. DeleteSellingManagerItemAutomationRule Conditionally Deletes a Selling Manager product. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro ID of the product to be deleted. DeleteSellingManagerProduct Yes Response for deleting a Selling Manager product. The details of the product. DeleteSellingManagerProduct Always Deletes a Selling Manager template. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro ID of the template to be deleted. You can obtain a SaleTemplateID by calling GetSellingManagerInventory. DeleteSellingManagerTemplate Yes Response for deleting a Selling Manager template. The unique identifier of the template. DeleteSellingManagerTemplate Always The name of the Selling Manager template. DeleteSellingManagerTemplate Always Removes the association of Selling Manager automation rules to a template. Returns the remaining rules in the response. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates,SetSellingManagerTemplateAutomationRule http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro The ID of the template from which you want to remove automation rules. You can obtain a SaleTemplateID by calling GetSellingManagerInventory. DeleteSellingManagerTemplateAutomationRule Yes If true, the automated listing rules are removed from the template. DeleteSellingManagerTemplateAutomationRule No If true, the automated relisting rules are removed from the template. DeleteSellingManagerTemplateAutomationRule No If true, the automated second chance offer rule is removed from the template. DeleteSellingManagerTemplateAutomationRule No Contains the set of automation rules associated with the specified template. Contains the remaining automated listing rules associated with this template. DeleteSellingManagerTemplateAutomationRule Conditionally Contains the remaining automated relisting rules associated with this template. DeleteSellingManagerTemplateAutomationRule Conditionally Contains the remaining automated second chance offer rule associated with this template. DeleteSellingManagerTemplateAutomationRule Conditionally Contains fees that may be incurred when items are listed using the automation rules (e.g., a scheduled listing fee). Use of an automation rule does not in itself have a fee, but use can result in a fee. DeleteSellingManagerTemplateAutomationRule Conditionally Enables a seller to disable the Unpaid Item Assistant mechanism for a specific order line item. This call can be made regardless of whether an Unpaid Item dispute exists for the order line item. If a dispute has already been created by the Unpaid Item Assistant, the dispute is converted to a "manual" dispute for the seller to manage like any other manually-created dispute. http://pages.ebay.com/sell/UPI/upiassistant/index.html http://pages.ebay.com/sell/UPI/standardprocess/index.html Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one <b>ItemID</b>. To identify a specific order line item for which to disable the Unpaid Item Assistant mechanism, either an <b>ItemID</b>/<b>TransactionID</b> pair, an <b>OrderLineItemID</b>, or a <b>DisputeID</b> (if a dispute record already exists) is required in the request. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) DisableUnpaidItemAssistance Conditionally The unique identifier of an order line item (transaction). An order line item is created once there is a commitment from a buyer to purchase an item. To identify a specific order line item for which to disable the Unpaid Item Assistant mechanism, either an <b>ItemID</b>/<b>TransactionID</b> pair, an <b>OrderLineItemID</b>, or a <b>DisputeID</b> (if a dispute record already exists) is required in the request. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) DisableUnpaidItemAssistance Conditionally A unique identifier for an eBay dispute, and in this case, an Unpaid Item dispute. Any order line item can only have one dispute record, so <b>DisputeID</b> can be used in the request to identify a specific order line item. If an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> is used to identify an order line item, <b>DisputeID</b> will be ignored if it is included in the request. DisableUnpaidItemAssistance No <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. To identify a specific order line item for which to disable the Unpaid Item Assistant mechanism, either an <b>ItemID</b>/<b>TransactionID</b> pair, an <b>OrderLineItemID</b>, or a <b>DisputeID</b> is required in the request. 100 DisableUnpaidItemAssistance Conditionally Response to DisableUnpaidItemAssistance request. Ends the specified fixed-price listing before the date and time at which it would normally end (per the listing duration). EndItem, RelistFixedPriceItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EndingItemsEarly 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. Timestamp that indicates the date and time (GMT) that the specified item listing was ended. EndFixedPriceItem Always If a SKU (stock-keeping unit) exists for the item listing, it is returned in the response. 50 EndFixedPriceIteme> Conditionally Ends the specified item listing before the date and time at which it would normally end per the listing duration.&nbsp;<b>Also for Half.com</b>. AddItem, EndFixedPriceItem, EndItems, RelistItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EndingItemsEarly Unique item ID that identifies the item listing to end. <br><br> For Half.com listings, you can either specify ItemID or SellerInventoryID. <br><br> Applicable to Half.com. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) EndItem Yes 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. <br><br> Applicable to Half.com. EndItem Yes Unique identifier that the seller specified when they listed the Half.com item. For Half.com items, you can either specify ItemID or SellerInventoryID. If you specify both ItemID and SellerInventoryID, they must be for the same item (otherwise an error will occur). <br><br> Applicable only to Half.com. EndItem Conditionally Includes the acknowledgement of date and time the auction was ended due to the call to EndItem. Indicates the date and time (returned in GMT) the specified item listing was ended. Also applicable to Half.com. EndItem Always Ends up to 10 specified item listings before the date and time at which it would normally end per the listing duration.&nbsp;<b>Also for Half.com</b>. AddItems, EndItem, RelistItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EndingItemsEarly A single container for an end item request. Multiple containers should be used to end multiple items. Up to ten (10) containers can be included per a given EndItems request. 10 EndItems Yes Contains a response of the resulting status of ending each item. Returns a response for an individually ended item. Mutiple containers will be listed if multiple items are ended. EndItems Always This restricted call gives approved sellers the ability to extend the default and ongoing lifetime of pictures uploaded to eBay. UploadSiteHostedPictures The URL of the image hosted by eBay Picture Services. ExtendSiteHostedPictures No The number of days by which to extend the expiration date for the specified image. ExtendSiteHostedPictures No Returns the URL of an eBay Picture Services image whose expiration date was extended. The URL of the image in eBay Picture Services whose expiration date was extended. ExtendSiteHostedPictures No Retrieves an authentication token for a user.&nbsp;<b>Also for Half.com</b>. ConfirmIdentity, GetSessionID, GetTokenStatus, RevokeToken http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingAToken http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingATokenViaFetchToken A value associated with the token retrieval request. SecretID is defined by the application, and is passed in the redirect URL to the eBay sign-in page. eBay recommends using a UUID for the secret ID value. You must also set Username (part of the RequesterCredentials) for the particular user of interest. SecretID and Username are not required if SessionID is present. FetchToken No A value associated with the token retrieval request. eBay generates the session ID when the application makes a GetSessionID request. SessionID is passed in the redirect URL to the eBay sign-in page. The advantage of using SessionID is that it does not require UserID as part of the FetchToken request. SessionID is not required if SecretID is present. FetchToken No Includes the authentication token for the user and the date it expires. The authentication token for the user. FetchToken Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingAToken Date and time at which the token returned in eBayAuthToken expires and can no longer be used to authenticate the user for that application. FetchToken Always The REST authentication token for the user. FetchToken Conditionally Returns a seller's invoice data for their eBay account, including the account's summary data. GetSellerDashboard, GetUser http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingAccountInformation http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=TestingApps Specifies the report format in which to return account entries. GetAccount Conditionally Specifies the month and year of the invoice requested. The report includes only the entries that appear on the seller's invoice in the specified month and year. An entry can occur in one month and appear on the next month's invoice. Used with SpecifiedInvoice reports. GetAccount Conditionally Specifies the beginning of a date range during which a credit or debit occurred. Used when AccountHistorySelection is BetweenSpecifiedDates. Value must be less than or equal to the value specified in EndDate. The allowed date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss. You can retrieve information that is up to 4 months old. GetAccount Conditionally Specifies the end of a date range during which a credit or debit occurred. Used when AccountHistorySelection is BetweenSpecifiedDates. Value must be greater than or equal to the value specified in BeginDate. The allowed date formats are YYYY-MM-DD and YYYY-MM-DD HH:mm:ss. GetAccount Conditionally Controls pagination of the response. For this request, the valid values of Pagination.EntriesPerPage are 0 to 2000, with a default of 500. GetAccount No Specifies whether to calculate balances. Default is false, which calculates balances. The value true means do not calculate balances. If true, AccountEntry.Balance and AccountSummary.CurrentBalance are never returned in the response. GetAccount No Specifies whether to return account summary information in an AccountSummary node. Default is true, to return AccountSummary. GetAccount No Specifies whether to retrieve the rate used for the currency conversion for usage transactions. GetAccount No Specifies how account entries should be sorted in the response, by an element and then in ascending or descending order. GetAccount No Specifies the currency used in the account report. Do not specify Currency in the request unless the following conditions are met. First, the user has or had multiple accounts under the same UserID. Second, the account identified in the request uses the currency you specify in the request. An error is returned if no account is found that uses the currency you specify in the request. GetAccount No Specifies the item ID for which to return account entries. If ItemID is used, all other filters in the request are ignored. If the specified item does not exist or if the requesting user is not the seller of the item, an error is returned. GetAccount No Returns information about an eBay seller's own account. Specifies the seller's unique account number. GetAccount Always Contains summary data for the seller's account, such as the overall balance, bank account and credit card information, and amount and date of any past due balances. Can also contain data for one or more additional accounts, if the user has changed country of residence. GetAccount Conditionally Indicates the currency used for monetary amounts in the report. GetAccount Always Contains individual account entries, according to the report's scope and date range. Each account entry represents one credit, debit, or administrative account action. GetAccount Conditionally Contains the total number of pages (TotalNumberOfPages) and the total number of account entries (TotalNumberOfEntries) that can be returned on repeated calls with the same format and report criteria. GetAccount Always Indicates whether there are more items yet to be retrieved. Additional calls must be made to retrieve those items. GetAccount Conditionally Specifies the number of items that are being returned per virtual page of date. Value is the same as that specified in Pagination.EntriesPerPage. GetAccount Always Indicates which page of data was just returned. Value is the same as the value specified in Pagination.PageNumber. If PageNumber in the request is higher than the total number of pages, the call fails with an error.) GetAccount Always Retrieves sales lead information for a lead generation listing. DetailLevel The unique identifier of an item listed on the eBay site. Returned by eBay when the item is created. This ID must correspond to an ad format item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetAdFormatLeads No Filters the leads based on their status. GetAdFormatLeads No Boolean which indicates whether to return mail messages for this lead in a MemberMessage node. GetAdFormatLeads No Used with EndCreationTime to limit the returned leads for a user to only those with a creation date greater than or equal to the specified date and time. GetAdFormatLeads Conditionally Used with StartCreationTime to limit the returned leads for a user to only those with a creation date less than or equal to the specified date and time. GetAdFormatLeads Conditionally Returns number of leads and contact and other information for each lead. One AdFormatLead node is returned for each lead. Contains contact and other information for one lead. One node is returned for each lead. Only returned at a detail level of ReturnAll. At least one lead must be available for the specified item to return AdFormatLead. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally The total number of leads returned. Only returned if you do not specify a detail level. GetAdFormatLeads

DetailLevel: none

Always Provides three modes for retrieving a list of the users that bid on a listing. AddSecondChanceItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExtendingSecondChanceOffer detailed information on working with the result set. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MakingSecondChanceOffersForItems The ID of the item. The bidders who bid on this item are returned. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetAllBidders Yes Specifies which bidder information to return. GetAllBidders Yes Specifies whether return BiddingSummary container for each offer. GetAllBidders Conditionally Includes the list of bidders for the requested item as part of the general item listing data. Some bidder information is anonymous, to protect bidders from fraud. If the seller makes this API call, the actual ids of all bidders on the seller's item will be returned. If a bidder makes this API call, the bidder's actual id will be returned. Information for all competing bidders or outside watchers will be returned as anonymized userIDs. See See <a href="http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo">Working with Anonymous User Information</a>in the eBay Web Services Guide for more information. Contains a list of OfferType objects. Each OfferType object represents the data for one bidder and bid. GetAllBidders Always eBay user ID for the user with the highest bid (or the earliest timestamp, in the event of a tie); a second chance offer candidate. GetAllBidders Always Bid amount offered by the HighBidder. GetAllBidders Always Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., winning bidder) and other information. This processing can take several minutes. If you retrieve a sold item, use this listing status information to determine whether eBay has finished processing the listing so that you can be sure the winning bidder and other details are correct and complete. GetAllBidders Always Reports how many calls your application has made and is allowed to make per hour or day.&nbsp;<b>Also for Half.com</b>. http://developer.ebay.com/support/certification Responds to a call to GetApiAccessRules. Contains the description of an API access rule, including the call name, the application's current daily and hourly usage, and other values. GetApiAccessRules Always No longer recommended. This is an older format for describing item specifics using an ID-based model. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use GetCategorySpecifics for the newer Custom Item Specifics model.<br> <br> Retrieves an XML string that describes how to present Item Specifics to a seller who is creating a new listing. Use this information to present users with the equivalent of the Item Specifics portion of the eBay Title and Description pages and to validate selected eBay attributes on the client before including them in an AddItem call or related calls. The XML string contains a list of all the attributes that are applicable for one or more requested categories, along with related meta-data. The meta-data specifies all the possible values of each attribute, the logic for presenting the attributes to a user, and rules for validating the user's selections. <br> <br> See the eBay Web Services Guide for an overview of Item Specifics and details about the eBay attribute model.

No longer recommended. Retrieves an XML string that describes an older format for item specifics meta data.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttributesAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGACS http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrLWISCData A version of the Item Specifics definitions (attribute meta-data) for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the characteristic sets for which the attribute meta-data has changed since the specified version. If not specified, all characteristics sets are returned. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed. GetAttributesCS No An array of characteristic setIDs (which always correspond to attribute set IDs). Each characteristic setcorresponds to a level in the eBay category hierarchy at which all items share common characteristics. Multiple categories can be mapped to the same characteristic set. AttributeSetIDs is an optional input. When IDs are specified, the call only returns meta-data for the corresponding characteristic sets. When no IDs are specified, the call returns all the current attribute meta-data in the system. GetAttributesCS No If true, includes a list of CategoryMapping nodes in the response. Each CategoryMapping node specifies category information as well as attributes and values that your application can auto-fill for items listed in that category. See the eBay Web Services Guide for more information about options for maintaining category data and auto-filling Item Specifics. GetAttributesCS No Returns XML that describes how to present Item Specifics to a seller and how to validate selected eBay attributes on the client before including them in an AddItem call or related calls. See the Developer's Guide for an overview of Item Specifics and details about the eBay attribute model. Also returns the current version of the meta-data system. Current version of the Item Specifics meta-data system for the site. This value changes each time changes are made to the meta-data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetAttributesCS

DetailLevel: none

Always A string containing a list of all the attributes that are applicable to the site (or characteristic sets in the request), along with related meta-data. The meta-data specifies all the possible values of each attribute, the logic for presenting attributes to a user, and rules for validating the user's selections. Individual elements are not described in the eBay schema format. For information about each element in the AttributeData string, see the attribute model documentation in the eBay Web Services guide (see links below).<br> <br> Because this is returned as a string, the XML markup elements are escaped with character entity references (e.g., &amp;lt;eBay&amp;gt;&amp;lt;Attributes&amp;gt; ...). See the appendices in the eBay Web Services guide for general information about string data types. GetAttributesCS

DetailLevel: none, ReturnAll

Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DataTypes No longer recommended. This supports an older format for describing item specifics using an ID-based model. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use GetCategorySpecifics for the newer Custom Item Specifics model.<br> <br> Retrieves the Item Specifics SYI XSL stylesheet. Apply the stylesheet to the XML returned from a call to GetAttributesCS or GetProductSellingPages to render a form like the Item Specifics portion of eBay's Title and Description page. See the eBay Web Services Guide for an overview of Item Specifics and information on working with the XSL.

No longer recommended. Retrieves the Item Specifics SYI XSL stylesheet for use with the GetAttributesCS and GetProductSellingPages response. You use the stylesheet to render Item Specifics in a user interface, as applicable within a particular category.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGAXSL http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrXSL The name of the XSL file to retrieve. If not specified, the call returns the latest versions of all available XSL files. FileName is an optional input. Valid values<br> <br> syi_attributes.xsl GetAttributesXSL No The desired version of the XSL file. Required if FileName is specified. If not specified, the call returns the latest version of the file. (This is not a filter for retrieving changes to the XSL file.) GetAttributesXSL Conditionally Retrieves the Item Specifics SYI XSL stylesheet.Apply the stylesheet to the XML returned from a call to GetAttributesCS or GetProductSellingPages to render a form like the Item Specifics portion of eBay's Title and Description page. See the Developer's Guide for an overview of Item Specifics and information on working with the XSL. Child elements contain data related to one XSL file. Multiple XSLFile objects can be returned. However, currently only one is returned. GetAttributesXSL

DetailLevel: none, ReturnAll

Always Retrieves best offers. DetailLevel RespondToBestOffer, PlaceOffer http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EnablingBestOffer http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EmailPrivacyPolicy The ID of the listing for which Best Offer information is to be returned. See the description of GetBestOffers for details related to who makes the request and how ItemID and BestOfferID can be omitted. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetBestOffers No The ID of the best offer for which information is to be returned. See the description of GetBestOffers for details related to who makes the request and how ItemID and BestOfferID can be omitted. GetBestOffers No A filter that specifies which Best Offers to return for an item (such as countered, expired, or accepted). The type "All" can only be specified if an ItemID is also supplied in the request. Active GetBestOffers All, Active No Specifies how to create virtual pages in the returned list (such as total number of entries and total number of pages to return). GetBestOffers No All best offers for the item according to the filter or best offer id (or both) used in the input. For the notification client usage, this response includes a single Best Offer. All best offers for the item according to the filter or best offer id (or both) used in the input. The buyer and seller messages are returned only if the detail level is defined. Includes the buyer and seller message only if the ReturnAll detail level is used. Only returned if best offers have been made. GetBestOffers

DetailLevel: none, ReturnAll

Conditionally The item for which Best Offers are being returned. Only returned if best offers have been made. GetBestOffers

DetailLevel: none, ReturnAll

Conditionally A collection of details about the best offers received for a specific item. Empty if there are no best offers. GetBestOffers

DetailLevel: none, ReturnAll

Conditionally Specifies the number of the page of data to return in the response. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. For GetOrders, PageNumber is only applicable to Half.com (is not applicable to eBay.com). 1 1 GetBestOffers

DetailLevel: none, ReturnAll

Conditionally Provides information about the data returned, including the number of pages and the number of entries. GetBestOffers

DetailLevel: none, ReturnAll

Conditionally Retrieves all items the user is currently bidding on, and the ones they have won or purchased. AddItem, GetItem, GetSellerList, RelistItem, ReviseItem Retrieves all items the user is currently bidding on, and the ones they have won or purchased. Indicates whether or not to limit the result set to active items. If true, only active items are returned and the EndTimeFrom and EndTimeTo filters are ignored. If false (or not sent), both active and ended items are returned. GetBidderList No Used in conjunction with EndTimeTo. Limits returned items to only those for which the item's end date is on or after the date-time specified. Specify an end date within 30 days prior to today. Items that ended more than 30 days ago are omitted from the results. If specified, EndTimeTo must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. (For information on how to convert between your local time zone and GMT, see Time Values Note.) This field is ignored if ActiveItemsOnly is true. GetBidderList Conditionally Used in conjunction with EndTimeFrom. Limits returned items to only those for which the item's end date is on or before the date-time specified. If specified, EndTimeFrom must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. This field is ignored if ActiveItemsOnly is true. Note that for GTC items, whose end times automatically increment by 30 days every 30 days, an EndTimeTo within in the first 30 days of a listing will refer to the listing's initial end time. GetBidderList Conditionally The user for whom information should be returned. If provided, overrides user defined via RequesterCredentials in header. GetBidderList No You can control some of the fields returned in the response by specifying one of two values in the GranularityLevel field: Fine or Medium. Fine returns more fields than the default, while setting this field to Medium returns an abbreviated set of results. Yes GetBidderList No Response to a GetBidderList call, which retrieves all items the user is currently bidding on, or has won or purchased. Response to GetBidderListRequest. Data for one eBay bidder. GetBidderList Always Array of items the bidder has bid on, has won or has lost. GetBidderList Always Retrieves the latest eBay category hierarchy for a given eBay site. Information returned for each category includes the category name and the unique ID for the category (unique within the eBay site for which categories are retrieved). A category ID is a required input when you list most items.

Retrieves the latest eBay category hierarchy for a given eBay site. Information returned for each category includes the category name and the unique ID for the category (unique within the eBay site for which categories are retrieved). A category ID is a required input when you list most items.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryOverview GetCategory2CS, GetCategoryFeatures, GetCategoryMappings, GetCategorySpecifics, GetSuggestedCategories Specifies the eBay site for which to retrieve the category hierarchy. Use the numeric site code (e.g., 77 for eBay Germany). Only necessary if you want to retrieve category data for a site other than the site from which you are submitting the request. <br> <br> NOTE: If you are using the GetCategories call with eBay Motors, you must set the Site ID in the Request Header to 0, and then set the CategorySiteID to 100. These are both required fields when using GetCategories with eBay Motors. GetCategories No The site ID of the request Specifies the ID of the highest-level category to return, along with its subcategories. If no parent category is specified, all categories are returned for the specified site. (Please do not pass a value of 0; zero (0) is an invalid value for CategoryParent.) To determine available category IDs, call GetCategories with no filters and use a DetailLevel value of ReturnAll. If you specify multiple parent categories, the hierarchy for each one is returned. GetCategories No Specifies the maximum depth of the category hierarchy to retrieve, where the top-level categories (meta-categories) are at level 1. Retrieves all category nodes with a category level less than or equal to this value. If not specified, retrieves categories at all applicable levels. As with all calls, the actual data returned will vary depending on how you configure other fields in the request (including DetailLevel). GetCategories No 0 If false or omitted, retrieves only leaf categories. (You can only list in leaf categories.) If true, retrieves both leaf and internal (non-leaf) categories. As with all calls, the actual data returned will vary depending on how you configure other fields in the request. GetCategories No false Contains the category data for the eBay site specified as input. The category data is contained in a CategoryArrayType object, within which are zero, one, or multiple CategoryType objects. Each CategoryType object contains the detail data for one category. Other fields tell how many categories are returned in a call, when the category hierarchy was last updated, and the version of the category hierarchy (all three of which can differ from one eBay site to the next). List of the returned categories. The category array contains one CategoryType object for each returned category. Returns empty if no detail level is specified. GetCategories

DetailLevel: ReturnAll

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

DetailLevel: ReturnAll

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

DetailLevel: ReturnAll, none

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

DetailLevel: ReturnAll, none

Always If true, ReservePriceAllowed indicates that all categories on the site allow the seller to specify a reserve price for an item. If false, this field is not returned in the response and all categories on the site do not normally allow sellers to specify reserve prices. The Category.ORPA (override reserve price allowed) field can override (or toggle) the reserve price allowed setting for a given category. For example, if ReservePriceAllowed is false and Category.ORPA is true, the category overrides the site setting and supports reserve prices. If ReservePriceAllowed is true and Category.ORPA is true, the category overrides the site setting and does does not support reserve prices. GetCategories

DetailLevel: ReturnAll, none

Always Indicates the lowest possible reserve price allowed for any item listed in any category on the site. You can use the fields returned by GetCategoryFeatures to determine if a different Minimum Reserve Price is defined for the category you want to use. GetCategories

DetailLevel: ReturnAll, none

Always If true, ReduceReserveAllowed indicates that all categories on the site allow the seller to reduce an item's reserve price. If false, this field is not returned in the response and all categories on the site do not normally allow sellers to reduce an item's reserve price. The Category.ORRA (override reduce reserve price) field can override (or toggle) the reserve price reduction setting for a given category. For example, if ReduceReserveAllowed is false and Category.ORRA is true, the category overrides the site setting and supports reducing reserve prices. If ReduceReserveAllowed is true and Category.ORRA is true, the category overrides the site setting and does does not support reducing reserve prices. GetCategories

DetailLevel: ReturnAll, none

Always No longer recommended. This supports an older ID-based format for describing item specifics and product details. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use GetCategoryFeatures for the newer Custom Item Specifics model, and use FindProducts in eBay's Shopping API to search for product details.<br> <br> Retrieves mappings between categories and characteristic sets that are available for an eBay site.

No longer recommended. Retrieves information that supports finding the older ID-based attribute and catalog product information. Instead, use GetCategoryFeatures to determine which categories support custom item specifics, and use FindProducts in the Shopping API to search for catalog products.

DetailLevel GetAttributesCS, GetCategories, GetCategoryMappings, GetProductFinder, GetProducts, GetProductSearchPage http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGC2CS http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrLWAttributPD ID of a category for which to retrieve mappings. If not specified, the call retrieves a map for all categories. 10 GetCategory2CS No A version of the mappings for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the categories for which the mappings have changed since the specified version. If not specified, all category-to-characteristics set mappings are returned. This value changes each time changes are made to the mappings. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetCategory2CS No http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGC2CS Returns data that indicates the categories that are mapped to characteristics sets, for the eBay site to which the call was routed. Retrieves all mappings or just the one that matches the category ID passed as input. The data is returned in a CategoryArrayType object, which can contain multiple mappings. The response also contains information about categories for which the mappings have changed.<br> <br> <span class="tablenote"><b>Note:</b> The Pre-filled Item Information feature depends on the Item Specifics feature. This means the set of catalog-enabled categories is a subset of the categories that are mapped to characteristic sets. That is, there are no catalog-enabled categories that are not mapped to characteristic sets.</span> Contains data about categories that are mapped to characteristics sets. Use this data to determine:<br> - The names and IDs of the characteristics sets<br> - The availability of the Pre-filled Item Information feature for listings in that category (i.e., whether the category is catalog-enabled)<br> - For catalog-enabled categories, the available product search methods<br> - The current version information for the complete mapping<br> - The version information for each characteristics set GetCategory2CS

DetailLevel: ReturnAll

Conditionally http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGC2CS Contains data about categories (if any) whose characteristics set mappings have changed since the version specified in the request. When a characteristics set mapping changes, the data appears in both the UnmappedCategoryArray object (to indicate that the change occurred) and the MappedCategoryArray object. GetCategory2CS

DetailLevel: ReturnAll

Conditionally Current version of the mappings for the site. This value changes each time changes are made to the mappings. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetCategory2CS

DetailLevel: none, ReturnAll

Always A list of one or more characteristics sets mapped to the category, if any. Use this information when working with Item Specifics (Attributes) and Pre-filled Item Information (Catalogs) functionality. GetCategory2CS

DetailLevel: ReturnAll

Conditionally Returns information about the features that are applicable to different categories, such as listing durations, shipping term requirements, and Best Offer support. DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryOverview GetCategories, GetCategorySpecifics, GeteBayDetails Specifies the category for which you want to retrieve the feature settings. <br><br> Specify a CategoryID, set DetailLevel to ReturnAll, and set ViewAllNodes to true to return the default site settings, the overrides for the specified category, plus all the child categories that have overrides on the features they inherit. <br><br> If you also set AllFeaturesForCategory to true, eBay returns the site defaults, plus all the settings for the specified category. Child category information is not returned in this case. <br><br> If CategoryID is not specified, eBay returns the feature settings for the site. To return details on all categories that have overrides on the properties they inherit, set DetailLevel to ReturnAll, and set ViewAllNodes to true. If you also set AllFeaturesForCategory to true, eBay returns only the site defaults with no child category information. 10 GetCategoryFeatures No A level of depth in the category hierarchy. Retrieves all category nodes with a CategoryLevel less than or equal to the LevelLimit value. GetCategoryFeatures No You must set DetailLevel to ReturnAll in order to correctly populate the response when you set ViewAllNodes to true. In this case, eBay returns the site defaults along with all the categories that override the feature settings they inherit. Here, each Category container shows only the features that it has overridden from its parent node. <br><br> If you also specify a CategoryID, eBay returns the details for that category, along with containers for each of its child categories that have feature overrides. <br><br> Note that if ViewAllNodes is set to false (the default) and DetailLevel is set to ReturnAll, eBay returns only the leaf categories that have features that override the settings they inherit. In this case, the call will not return leaf categories that do not have overrides. GetCategoryFeatures No false Retrieves data related to the specified feature setting only. If no feature IDs are specified, the call retrieves data for all features, as applicable to the other call settings. GetCategoryFeatures No Use this switch to view all of the feature settings for a specific category. All feature settings are returned, regardless of the site default settings. This element works in conjunction with CategoryID--refer to the notes for that element for more details. <br><br> If you also set FeatureID, eBay returns the status of the specified features only, for the specified category. GetCategoryFeatures No false Returns the current version of the set of feature meta-data. Compare this value to the version of the last version you downloaded to determine whether the data may have changed. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Always Gives the time in GMT that the feature flags for the category hierarchy were last updated. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Always A category whose feature settings are different from the settings of its parent category.<br> <br> For example, suppose there is a branch of the category tree with 5 category levels (L1, L2, L3, L4, and L5). Suppose the feature settings for SiteDefaults, L1, L4, and L5 are all "A", and the settings for L2 and L3 are "B". In this case:<br> L1's settings (A) match the site default, so L1 is not returned.<br> L2's settings (B) are different from L1's, so L2 is returned.<br> L3's settings (B) are the same as L2's, so L3 is not returned<br> L4's settings (A) are different from L3's, so L4 is returned<br> L5's settings (A) are the same as L4's, so L5 is not returned.<br> <br> If you specified a particular FeatureID in the request, this field only returns feature settings for that feature. Only returned when the category is different from its parent. If the category has children and they aren't returned, it means the children inherit the category's feature settings. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Returns the feature settings defined for most categories on the site. Most categories share these settings. However, some categories can override some settings, as indicated in the Category nodes (if any). GetCategoryFeatures

DetailLevel: ReturnAll

Always Returns definitions of the various features on the site, or the features you requested in FeatureID (if any). Each feature has a node within FeatureDefinitions. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Always Retrieves a map of old category IDs and corresponding active category IDs defined for the site to which the request is sent. GetCategories, GetCategoryFeatures, GetCategory2CS DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryMapping http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryMappingDetails http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategorySync A version of the category mapping for the site. Filters out data from the call to return only the category mappings for which the data has changed since the specified version. If not specified, all category mappings are returned. Typically, an application passes the version value of the last set of category mappings that the application stored locally. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed. GetCategoryMappings No Returns a map of old category IDs and corresponding active category IDs defined for the site to which the request was sent. Typically used to update an older item definition with a new category ID prior to listing the item. Mapping between an old category ID and an active category ID. Returned when category mappings exist and the value of CategoryVersion is different from the current version on the site. GetCategoryMappings

DetailLevel: ReturnAll

Conditionally Version value assigned to the current category mapping data for the site. Compare this value to the version value the application stored with the mappings the last time the application executed the call. If the versions are the same, the data has not changed since the last time the data was retrieved and stored. GetCategoryMappings

DetailLevel: none, ReturnAll

Always Returns the most popular custom Item Specific names and values for each leaf category you request. AddItem, GetCategories, GetCategoryFeatures, GetAttributesCS, GetItemRecommendations samples http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemSpecifics http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSellP http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGACS http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RetrievingLeafCats A leaf-level eBay category ID. This call retrieves recommended Item Specifics (if any) for each leaf category you specify. (The call returns no results for a parent category.) To determine which leaf categories support listing with custom Item Specifics, use GetCategoryFeatures. <br><br> <span class="tablenote"><b>Note:</b> This call may return recommendations for categories that don't support listing with custom Item Specifics. That is, the presence of recommendations for a category does not necessarily mean that AddItem supports custom Item Specifics for that category and site. </span> <br><br> The request requires either CategoryID, CategorySpecfics.CategoryID, or CategorySpecificsFileInfo (or the call returns an error). CategoryID and CategorySpecific.CategoryID can both be used in the same request. (CategorySpecific offers more options to control the response.) Some input fields, such as IncludeConfidence, only work when CategoryID or CategorySpecfics.CategoryID is specified. <br><br> You can specify multiple leaf categories, but more categories can result in longer response times. If your request times out, specify fewer IDs. If you specify the same ID twice, we use the first instance. 100 GetCategorySpecifics Conditionally Causes the recommendation engine to check whether the list of popular Item Specifics for each specified category has changed since this date and time. If specified, this call returns no Item Specifics; it only returns whether the data has changed for any of the requested categories.<br> <br> Typically, you pass in the Timestamp that was returned the last time you refreshed the list of names and values for the same categories. If the Updated flag returns true for any categories in the response, call GetCategorySpecifics again for those categories to get the latest names and values. (As downloading all the data may affect your application's performance, it may help to only download Item Specifics for a category if they have changed since you last checked.) GetCategorySpecifics Conditionally Maximum number of Item Specifics to return per category (where each Item Specific is identified by a unique name within the category). Use this to retrieve fewer results per category. For example, if you only want up to 2 per category (the top 2 most popular names), specify 2. 1 see GeteBayDetails 10 GetCategorySpecifics No Maximum number of values to retrieve per item specific. The best practice for using this field depends on your use case. For example, if you want all possible values (such as all brands and sizes in a clothing category), then specify a very large number. (This is recommended in most cases.) If you only want the most popular value (like the most popular color), then specify a small number. 1 2147483647 25 (does not affect values with relationship validation rules) GetCategorySpecifics No The name of one Item Specific name to find values for. Use this if you want to find out whether a name that the seller provided has recommended values. If you specify multiple leaf categories in the request, the recommendation engine returns all matching names and values it finds for each of those categories. At the time of this writing, this value is case-sensitive. (Wildcards are not supported.)<br> <br> Name and CategorySpecific.ItemSpecific can be used in the request. (If you plan to only use one or the other in your application, you should use ItemSpecific, as it may offer more options in the future.) 30 (see GeteBayDetails) GetCategorySpecifics No Applicable with request version 609 and higher. (This does not retrieve data at all if your request version is lower than 609.) Contains a leaf category for which you want recommended Item Specifics, and (optionally) names and values to help you refine the recommendations. You can specify multiple categories (but more categories can result in longer response times). If you specify the same category twice, we use the first instance.<br> <br> Depending on how many recommendations are found, your request may time out if you specify too many categories. (Typically, you can download recommendations for about 275 categories at a time.)<br> <br> CategoryID and CategorySpecific.CategoryID can be used in the request. (If you plan to only use one or the other in your application, you should use CategorySpecific, as it may offer more options in the future.) 275 GetCategorySpecifics Conditionally If true, the Relationship node is not returned for any recommendations. Relationship recommendations tell you whether an Item Specific value has a logical dependency another Item Specific.<br> <br> For example, in a clothing category, Size Type could be recommended as a parent of Size, because Size=Small would mean something different to buyers depending on whether Size Type=Petite or Size Type=Plus.<br> <br> In general, it is a good idea to retrieve and use relationship recommendations, as this data can help buyers find the items they want more easily. GetCategorySpecifics false No If true, returns eBay's level of confidence in the popularity of each name and value for the specified category. Some sellers may find this useful when choosing whether to use eBay's recommendation or their own name or value.<br> <br> Requires CategoryID to also be passed in.<br> <br> If you try to use this with CategorySpecificsFileInfo but without CategoryID, the request fails and no TaskReferenceID or FileReferenceID is returned. GetCategorySpecifics false No If true, the response includes FileReferenceID and TaskReferenceID. Use these IDs as inputs to the downloadFile call in the eBay File Transfer API. That API lets you retrieve a single (bulk) GetCategorySpecifics response with all the Item Specifics recommendations available for the requested site ID. (The downloadFile call downloads a .zip file as an attachment.)<br> <br> Either CategorySpecificsFileInfo or a CategoryID is required (or you can specify both). <br> <br> <span class="tablenote"><b>Note:</b> You can use the File Transfer API without using or learning about the Bulk Data Exchange API or other Large Merchant Services APIs. </span> <br> GetCategorySpecifics Conditionally http://developer.ebay.com/DevZone/file-transfer/CallRef/downloadFile.html Calls made form seller or buyer find out what the most relevant tags and values are for a given category Returned with request version 609 and higher. <br> <br> Contains the most popular Item Specifics, if any, for a category specified in the request, or contains information about whether the recommendations have changed for that category since the LastUpdateTime you requested. <br> <br> The most relevant Item Specifics (as determined by eBay) are returned first. In many cases, the values are returned in alphabetical order.<br> <br> This node returns empty (or it's not returned) for a category if there is no applicable data (such as when you request a parent category, a category that has no popular Item Specifics yet, or a duplicate category that was already returned). If you pass in the CategoryID and Name fields together, but no matching values are found for the name, eBay returns the name with no values (even if the name is not recommended).<br> <br> If GetCategoryFeatures indicates that custom Item Specifics are enabled for a leaf category, but GetCategorySpecifics doesn't return any recommendations for that category, the seller can still specify their own custom Item Specifics in that category. 275 GetCategorySpecifics Conditionally Use TaskReferenceID and FileReferenceID as inputs to the downloadFile call in the eBay File Transfer API. That API lets you retrieve a single (bulk) GetCategorySpecifics response with all the Item Specifics recommendations available for the requested site ID. (The downloadFile call downloads a .zip file as an attachment.)<br> <br> Only returned when CategorySpecificsFileInfo is passed in the request. GetCategorySpecifics Conditionally http://developer.ebay.com/DevZone/file-transfer/CallRef/downloadFile.html Use TaskReferenceID and FileReferenceID as inputs to the downloadFile call in the eBay File Transfer API. That API lets you retrieve a single (bulk) GetCategorySpecifics response with all the Item Specifics recommendations available for the requested site ID. (The downloadFile call downloads a .zip file as an attachment.)<br> <br> Only returned when CategorySpecificsFileInfo is passed in the request. GetCategorySpecifics Conditionally http://developer.ebay.com/DevZone/file-transfer/CallRef/downloadFile.html Retrieves a botblock token and URLs for an image or audio clip that the user is to match. ValidateChallengeInput, PlaceOffer Response to GetChallengeToken request. Botblock token that is used to validate that the user is a human and not a bot. GetChallengeToken Always The URL of the image your application should display to the user for a botblock challenge. GetChallengeToken Always The URL of the audio clip your application should provide for sight-impaired users. The audio clip corresponds to the image. GetChallengeToken Always Searches for nonprofit charity organizations that meet the criteria specified in the request. It is recommended that you use at least one input filter, because this call no longer returns all charities when made without filters. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=IdentifyingListingsThatBenefitNonprofits A unique identification number assigned by eBay to registered nonprofit charity organizations. GetCharities No A name assigned to a specified nonprofit organization. Accepts full charity nonprofit name or partial name as input. For example, enter a CharityName of "heart" (case-insensitive) to return all charity nonprofits that start with "heart." Use with a MatchType value of "Contains" to return all charity nonprofits that contain the string "heart." 150 GetCharities No Accepts a case-insensitive string used to find a nonprofit charity organization. Default behavior is to search the CharityName field. Use with an IncludeDescription value of true to include the Mission field in the search. 350 (characters) GetCharities No Region that the nonprofit charity organization is associated with. A specific nonprofit charity organization may be associated with only one region. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityRegion input value must be valid for that SiteID. GetCharities No Domain (mission area) that a nonprofit charity organization belongs to. Nonprofit charity organizations may belong to multiple mission areas. Meaning of input values differs depending on the site. See GetCharities in the API Developer's Guide for the meaning of each input/output value. CharityDomain input value must be valid for that SiteID. GetCharities No Used with Query to search for charity nonprofit organizations. A value of true will search the Mission field as well as the CharityName field for a string specified in Query. GetCharities No Indicates the type of string matching to use when a value is submitted in CharityName. If no value is specified, default behavior is "StartsWith." Does not apply to Query. GetCharities No Used to decide if the search is only for featured charities. A value of true will search for only featured charities. GetCharities No Reserved for future use. Contains information about charity nonprofit organizations that meet the criteria specified in the request. Contains information about charity nonprofit organizations that meet the criteria specified in the request. One Charity node is returned for each applicable nonprofit charity organization. The CharityID value is returned as an id attribute of this node. If no nonprofit charity organization is applicable, this node is not returned. GetCharities Conditionally Retrieves a token required for the GetUserAlerts call in the Client Alerts API. SetNotificationPreferences http://developer.ebay.com/DevZone/client-alerts/docs/CallRef/index.html Returns a Client Alerts token. This token string is required for the Login call in the Client Alerts API. The Client Alerts GetUserAlerts call, which returns alerts about events associated with a specific user, requires Login. GetClientAlertsAuthToken Always A Client Alerts token expires after seven days. GetClientAlertsAuthToken Always Retrieves top-ranked contextual eBay keywords and categories for a specified web page. SG, HK The URL of the web page from which eBay is to extract keywords. GetContextualKeywords Yes Web page encoding by which the URL is to be handled, such as ISO-8859-1. GetContextualKeywords Yes The ID of the category to which keywords are to be limited. Zero or more category IDs can be specified. GetContextualKeywords No Response to a GetContextualKeywords request. An array of either keyword/category pairs or categories, with ranking and score. GetContextualKeywords Always Retrieves a list of upsell or cross-sell items associated with the specifeid item ID. GetPromotionRules, SetPromotionalSale http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CrossPromotionsChapter The unique ID of the referring item. The cross-promoted items will supplement this item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetCrossPromotions Yes The cross-promotion method you want to use for the returned list, either UpSell or CrossSell. GetCrossPromotions Yes The role of the person requesting to view the cross-promoted items, either seller or buyer. Default is buyer. GetCrossPromotions No Returns a list of either upsell or cross-sell items for a given item ID. The list can be filtered by the viewer's role, either buyer or seller. A list of cross-promoted items defined for a specific referring item. The list is either upsell or cross-sell items, according to the value of PromotionMethod in GetCrossPromotionsRequest. GetCrossPromotions Always Retrieves the DescriptionTemplates for a category. Retrieves Theme and Layout specifications for the display of an item's description. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UsingDescriptionTemplatesChapter The category for which to retrieve templates. Enter any category ID, including Motors vehicle categories. This is ignored if you also send MotorVehicles. 10 GetDescriptionTemplates No If specified, only those templates modified on or after the specified date are returned. If not specified, all templates are returned. GetDescriptionTemplates No Indicates whether to retrieve templates for motor vehicle categories for eBay Motors (site 100). If true, templates are returned for motor vehicle categories. If false, templates are returned for non-motor vehicle categories such as Parts and Accessories. If included as an input field (whether true or false), this overrides any value provided for CategoryID. GetDescriptionTemplates No Returns one or more DescriptionTemplate nodes. Each DescriptionTemplate node contains the information for one Theme or one Layout. DescriptionTemplate.DescriptionTemplateType indicates whether it contains data for a Theme or a Layout. Returned after calling GetDescriptionTemplatesRequest. The information for one Theme or one Layout. There can be multiple DescriptionTemplates. GetDescriptionTemplates Always The number of Layout templates returned (that is, the number of DescriptionTemplates for which Type is "Layout"). GetDescriptionTemplates Always The ID of a returned layout that is obsolete. There can be zero or more IDs. GetDescriptionTemplates Conditionally The ID of a returned theme that is obsolete. There can be zero or more IDs. GetDescriptionTemplates Conditionally Data for one theme group. There can be multiple ThemeGroups in the response. GetDescriptionTemplates Conditionally The number of Theme templates returned (that is, the number of DescriptionTemplates for which Type is "Theme"). GetDescriptionTemplates Always Retrieves the details of a specific eBay dispute corresponding to the supplied dispute ID. AddDispute, AddDisputeResponse, GetItemTransactions, GetSellerTransactions, GetUserDisputes, SellerReverseDispute http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BuyerDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingDetailsAboutADispute The unique identifier of an eBay dispute. The caller passes in this value to retrieve detailed information on a specific dispute. GetDispute Yes Returned after calling GetDisputeRequest. Returns the record of a dispute, including the dispute state and other information. <br><br>Both Sellers and Buyers can use the SellerClosedDispute in Platform Notifications to receive a notification when a dispute has been closed. The notification includes the same data that is returned in the GetDispute response. The dispute record, containing information about the buyer, seller, dispute state, dispute status, comments added to the dispute, or resolutions. GetDispute Always Retrieves the accumulated feedback left for a specified user or the summary feedback data for a specific order line item or item listing.&nbsp;<b>Also for Half.com</b>. DetailLevel LeaveFeedback, GetSellerDashboard, GetSellerTransactions http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Feedback http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeedbackIntro http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeedbackGet http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DetailedSellerRatings Specifies the user whose feedback data is to be returned. If not specified, then the feedback returned is for the requesting user. GetFeedback No An ID that uniquely identifies a feedback record to be retrieved. Used only by the Feedback notification. GetFeedback No Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one <b>ItemID</b>. If <b>ItemID</b> is specified in the <b>GetFeedback</b> request, the returned feedback records are restricted to the specified <b>ItemID</b>. The <b>FeedbackType</b> and <b>Pagination</b> fields (if included) are ignored. The maximum number of feedback records returned is 100. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) GetFeedback No Unique identifier for an eBay order line item (transaction). A <b>TransactionID</b> can be paired up with its corresponding <b>ItemID</b> and used as an input filter in the <b>GetFeedback</b> request. If an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value is used to retrieve a feedback record on a specific order line item, the <b>FeedbackType</b> and <b>Pagination</b> fields (if included) are ignored. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) GetFeedback No Returns feedback of a specified type (positive, negative, or neutral) in <b>FeedbackDetailArray</b>. You can include two comment types in your call if you want to exclude the third type from your results. If no <b>CommentType</b> is specified, all of the feedback types are returned. GetFeedback No Returns feedback that you received as a buyer or seller, or feedback you left for others (as either a buyer or a seller). You can include only one <b>FeedbackType</b> in your call. If no <b>FeedbackType</b> is specified, all of the available feedback is returned. GetFeedback No Controls the pagination of the result set. Child elements, <b>EntriesPerPage</b> and <b>PageNumber</b>, specify the maximum number of individual feedback records to return per call and which page of data to return. Only applicable if <b>DetailLevel</b> is set to <b>ReturnAll</b> and the call is returning feedback for a <b>UserID</b>. Feedback summary data is not paginated, but when pagination is used, it is returned after the last feedback detail entry. <br><br> Accepted values for <b>Pagination.EntriesPerPage</b> for GetFeedback is 25 (the default), 50, 100, and 200. If you specify a value of zero, or a value greater than 200, the call fails with an error. If you specify a value between one and twenty-four, the value is rounded up to 25. Values between 26 and 199 that are not one of the accepted values are rounded down to the nearest accepted value. GetFeedback No <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. An <b>OrderLineItemID</b> can be used as an input filter in the <b>GetFeedback</b> request. If an <b>OrderLineItemID</b> value is used to retrieve a feedback record on a specific order line item, the <b>FeedbackType</b> and <b>Pagination</b> fields (if included) are ignored. 100 GetFeedback No The GetFeedback response contains the feedback summary if a TransactionID or ItemID is specified, and contains the specified user's total feedback score and feedback summary data if a UserID is specified. If no value is supplied, the feedback score and feedback summary for the requesting user will be returned. <br> If a detail level value of ReturnAll is specified, an array of all feedback records will be returned. Contains the individual feedback records for the user or order line item specified in the request. There is one FeedbackDetailType object for each feedback record. Only populated with data when a detail level of ReturnAll is specified in the request. Not returned if you specify FeedbackID in the request. GetFeedback

DetailLevel: ReturnAll

Conditionally Indicates the number of FeedbackDetailType objects returned in the FeedbackDetailArray property. Only applicable if feedback details are returned. GetFeedback

DetailLevel: ReturnAll

Conditionally Summary feedback data for the user. Contains counts of positive, neutral, and negative feedback for pre-defined time periods. Only applicable if feedback details are returned. GetFeedback

DetailLevel: none, ReturnAll

Conditionally Indicates the total feedback score for the user. GetFeedback

DetailLevel: none, ReturnAll

Always Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. This is only applicable when a User ID or no ID (requester option) is specified. GetFeedback

DetailLevel: none, ReturnAll

Always Indicates the number of entries (feedback detail) that are being returned per page of data (i.e., per call). Only returned if entries are returned. GetFeedback

DetailLevel: none, ReturnAll

Conditionally Indicates which page of data was just returned. Will be the same as the value specified in Pagination.PageNumber. (If the input is higher than the total number of pages, the call fails with an error.) Only returned if items are returned. GetFeedback

DetailLevel: none, ReturnAll

Conditionally Retrieves a list of high bidders for the Dutch auction specified in the ItemId property of the request. A seller specifies a unique item ID in this call to determine which buyers are winning bidders and how many items each buyer can purchase. Note that bidder information is anonymous to everyone except the bidder and the seller during an active auction.

Retrieves a list of high bidders for the Dutch auction specified in the ItemId property of the request. A seller can use this list to determine which buyers are winning bidders and how many items each can purchase.

611 681 NoOp http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=LearningAboutBidders Unique item ID that identifies the Dutch auction listing for which to retrieve a list of the high bidders. <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> 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetHighBidders Yes Returns a list of high bidders for the Dutch auction specified in the ItemId property of the request. Contains a list of zero, one, or multiple OfferType objects. Each OfferType object represents the data for one high bidder. See the schema documentation for OfferType for details on its properties and their meanings. GetHighBidders Always 611 681 NoOp Specifies an active or ended listing's status in eBay's processing workflow. If a listing ends with a sale (or sales), eBay needs to update the sale details (e.g., winning bidder) and other information. This processing can take several minutes. If you retrieve a sold item, use this listing status information to determine whether eBay has finished processing the listing so that you can be sure the winning bidder and other details are correct and complete. <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> GetHighBidders Always 611 681 NoOp Returns item data such as title, description, price information, seller information, and so on, for the specified <b>ItemID</b>. &nbsp;<b>Also for Half.com</b>. DetailLevel half AddItem, AddFixedPriceItem, GetItems, GetSellerEvents, GetSellerList, RelistItem, ReviseItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RetrievingItems http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures Specifies the <b>ItemID</b> that uniquely identifies the item listing for which to retrieve the data. <br><br> <b>ItemID</b> is a required input in most cases. <b>SKU</b> can be used instead in certain cases (see the description of SKU). If both <b>ItemID</b> and <b>SKU</b> are specified for items where the inventory tracking method is <b>ItemID</b>, <b>ItemID</b> takes precedence. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) GetItem Conditionally Indicates if the caller wants to include watch count for that item in the response. You must be the seller of the item to retrieve the watch count. GetItem No Specifies whether or not to include cross-promotion information for the item in the call response. <br><br> With a request version of 485 or higher, the default is false (do not include cross-promotion details). Set to true to retrieve cross-promotion information for the item. Cross-promotion information is returned in <b>Item.CrossPromotion.PromotedItem.PromotionDetails</b>. A promoted item will now contain multiple <b>PromotionDetails</b> containers. <br><br> With a request version lower than 485, the default is true (include cross-promotions). Set the value to false if you do not want to retrieve cross-promotion information. Cross-promotion information, <b>PromotedPrice</b> and <b>PromotedPriceType</b>, are returned in <b>Item.CrossPromotion.PromotedItem</b>. If a promoted item has multiple <b>PromotedPriceType</b> and <b>PromotedPrice</b> value pairs, only the last pair is returned. GetItem No If true, the response returns the <b>ItemSpecifics</b> node (if the listing has custom Item Specifics).<br> <br> Item Specifics are well-known aspects of items in a given category. For example, items in a washer and dryer category might have an aspect like Type=Top-Loading; whereas items in a jewelry category might have an aspect like Gemstone=Amber.<br> <br> (This does not cause the response to include ID-based attributes. To also retrieve ID-based attributes, pass <b>DetailLevel</b> in the request with the value <b>ItemReturnAttributes</b> or <b>ReturnAll</b>.) GetItem No http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemSpecifics If true, an associated tax table is returned in the response. If no tax table is associated with the item, then no tax table is returned, even if <b>IncludeTaxTable</b> is set to true. GetItem No Retrieves an item that was listed by the user identified in AuthToken and that is being tracked by this SKU.<br> <br> A SKU (stock keeping unit) is an identifier defined by a seller. Some sellers use SKUs to track complex flows of products and information on the client side. eBay preserves the SKU on the item, enabling you to obtain it before and after an order line item is created. (SKU is recommended as an alternative to ApplicationData.)<br> <br> In <b>GetItem</b>, <b>SKU</b> can only be used to retrieve one of your own items, where you listed the item by using <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b>, and you set <b>Item.InventoryTrackingMethod</b> to <b>SKU</b> at the time the item was listed. (These criteria are necessary to uniquely identify the listing by a SKU.)<br> <br> Either <b>ItemID</b> or <b>SKU</b> is required in the request. If both are passed, they must refer to the same item, and that item must have <b>InventoryTrackingMethod</b> set to <b>/SKU<b>. 50 GetItem Conditionally Variation-level SKU that uniquely identifes a Variation within the listing identified by <b>ItemID</b>. Only applicable when the seller listed the item with Variation-level SKU (<b>Variation.SKU</b>) values. Retrieves all the usual <b>Item</b> fields, but limits the <b>Variations</b> content to the specified Variation. If not specified, the response includes all Variations. GetItem No Name-value pairs that identify one or more Variations within the listing identified by <b>ItemID</b>. Only applicable when the seller listed the item with Variations. Retrieves all the usual <b>Item</b> fields, but limits the Variations content to the specified Variation(s). If the specified pairs do not match any Variation, eBay returns all Variations.<br> <br> To retrieve only one variation, specify the full set of name/value pairs that match all the name-value pairs of one Variation. <br> <br> To retrieve multiple variations (using a wildcard), specify one or more name/value pairs that partially match the desired variations. For example, if the listing contains Variations for shirts in different colors and sizes, specify Color as Red (and no other name/value pairs) to retrieve all the red shirts in all sizes (but no other colors). GetItem No A unique identifier for an order line item (transaction). An order line item is created when a buyer commits to purchasing an item. <br><br> Since you can change active multiple-quantity fixed-price listings even after one of the items has been purchased, the <b>TransactionID</b> is associated with a snapshot of the item data at the time of the purchase. <br><br> After one item in a multi-quantity listing has been sold, sellers can not change the values in the Title, Primary Category, Secondary Category, Listing Duration, and Listing Type fields. However, all other fields are editable. <br><br> Specifying a <b>TransactionID</b> in the <b>GetItem</b> request allows you to retrieve a snapshot of the listing as it was when the order line item was created. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) GetItem Conditionally This field is used to specify whether or not to retrieve Parts Compatiblity information. If true, any compatible applications associated with the item will be returned in the response (<b class="con"> Item.ItemCompatibilityList</b>). If no compatible applications have been specified for the item, no item compatibilities will be returned. <br><br> If false or not specified, the response will return a compatibility count (<b class="con">ItemCompatibilityCoun</b>t) when parts compatibilities have been specified for the item. <br><br> Parts Compatibility is supported in limited Parts & Accessories categories for the eBay US Motors (site ID 100) and eBay Germany (site ID 77) sites only. false GetItem No #Response.Item.ItemCompatibilityCount #Response.Item.ItemCompatibilityList http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PartsCompatibility Contains the item data returned by the call. The data for the specified item listing is returned in an ItemType object. ItemType object that contains the data for the specified item. GetItem

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

Always Examines potential item data that a seller has specified and returns recommended changes or opportunities for improvement. The types of recommendations returned for a given item can be configured by choosing one or more recommendation engines in the request. This call supports batch requests. That is, you can retrieve recommendations for multiple items at once. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=getItemRecommendations http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EngineRecs http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemSpecifics AddItem, GetCategorySpecifics, GetProductSellingPages Specifies the data for a single item and configures the recommendation engines to use when processing the item. To retrieve recommendations for multiple items, pass a separate GetRecommendationsRequestContainer for each item. In this case, pass a user-defined correlation ID for each item to identify the matching response. GetItemRecommendations Yes GetItemRecommendations returns recommended changes or opportunities for improvement related to listing data that was passed in the request. This call supports batch requests. That is, it can retrieve recommendations for multiple items at once. Specifies recommended changes or opportunities for improving the data of a single item. If multiple items were processed, a separate GetRecommendationsResponseContainer is returned for each item. Each container includes a user-defined correlation ID to help you match items in the request to recommendations in the response. GetItemRecommendations Always Returns shipping cost estimates for an item for every calculated shipping service that the seller has offered with the listing. This is analogous to the Shipping Calculator seen in both the buyer and seller web pages. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts The item ID that uniquely identifies the item listing for which to retrieve the data. Required input. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetItemShipping Yes Number of items sold to a single buyer and to be shipped together. GetItemShipping No Destination country postal code (or zipcode, for US). Ignored if no country code is provided. Optional tag for some countries. More likely to be required for large countries. GetItemShipping Conditionally Destination country code. If DestinationCountryCode is US, a postal code is required and it represents the US zip code. US GetItemShipping Conditionally Contains the data returned by the call. The shipping details for the specified item are returned in a ShippingDetails object. Shipping-related details for the specified item. Any error about shipping services (returned by a vendor of eBay's who calculates shipping costs) is returned in ShippingRateErrorMessage. Errors from a shipping service are likely to be related to issues with shipping specifications, such as package size and the selected shipping method not supported by a particular shipping service. <br> <br> If a buyer buys multiple quantities of an item and the resultant total weight exceeds the weight limit of the shipping service, GetItemShipping returns the shipping cost and shipping service and internally groups the items in separate packages. A shipping service is removed from ShippingDetails only if the weight of a single item exceeds the weight limit of the shipping service. GetItemShipping Always Retrieves order line item (transaction) information for a specified <b>ItemID</b>. & nbsp;<b>Also for Half.com</b>. The call returns zero, one, or multiple order line items, depending on the number of items sold from the listing. <br><br> You can retrieve order line item data for a specific time range or number of days. If you don't specify a range or number of days, order line item data will be returned for the past 30 days. DetailLevel GetSellerTransactions, GetOrders, GetOrderTransactions http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EmailPrivacyPolicy the conditions under which buyer and seller email and address are returned. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RetrievingTransactionsForSingleItem Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one <b>ItemID</b>. When you use <b>ItemID</b> alone, eBay returns all order line items that are associated with the <b>ItemID</b> (listing). If you pair <b>ItemID</b> with a specific <b>TransactionID</b>, data on a specific order line item is returned. If <b>OrderLineItemID</b> is specified in the request, any <b>ItemID</b>/<b>TransactionID</b> pair specified in the same request will be ignored. <br> <br> <span class="tablenote"><b>Note:</b> <b>GetItemTransactions</b> doesn't support SKU as an input because this call requires an identifier that is unique across your active and ended listings. Even when <b>InventoryTrackingMethod</b> is set to <b>SKU</b> in a listing, the SKU is only unique across your active listings (not your ended listings). To retrieve order line items by SKU, use <b>GetSellerTransactions</b> or <b>GetOrderTransactions</b> instead. </span> 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) GetItemTransactions Yes The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving order line items associated with the specified <b>ItemID</b>. The <b>ModTimeFrom</b> field is the starting date range. All eBay order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This field is not applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in the request or if the <b>NumberOfDays</b> date filter is used. <br><br> If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b> time filter is used and it defaults to 30 (days). GetItemTransactions No The <b>ModTimeFrom</b> and <b>ModTimeTo</b> fields specify a date range for retrieving order line items associated with the specified <b>ItemID</b>. The <b>ModTimeTo</b> field is the ending date range. All eBay order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. If the <b>ModTimeFrom</b> field is used and the <b>ModTimeTo</b> field is omitted, the <b>ModTimeTo</b> value defaults to the present time or to 30 days past the <b>ModTimeFrom</b> value (if <b>ModTimeFrom</b> value is more than 30 days in the past). This field is not applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in the request or if the <b>NumberOfDays</b> date filter is used. <br><br> If you don't specify a <b>ModTimeFrom</b>/<b>ModTimeTo</b> filter, the <b>NumberOfDays</b> time filter is used and it defaults to 30 (days). GetItemTransactions No Include a <b>TransactionID</b> field in the request if you want to retrieve the data for a specific order line item (transaction). If a <b>TransactionID</b> is provided, any specified time filter is ignored. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) GetItemTransactions No Child elements control pagination of the output. Use the <b>EntriesPerPage</b> property to control the number of order line items to return per call and the <b>PageNumber</b> property to specify the specific page of data to return. If multiple pages of order line items are returned based on input criteria and Pagination properties, <b>GetItemTransactions</b> will need to be called multiple times (with the <b>PageNumber</b> value being increased by 1 each time) to scroll through all results. GetItemTransactions No Indicates whether to include the Final Value Fee (FVF) for all order line items in the response. The Final Value Fee is returned in the <b>Transaction.FinalValueFee</b> field. The Final Value Fee is assessed right after the creation of an order line item. <br> GetItemTransactions No Include this field and set it to True if you want the <b>ContainingOrder</b> container to be returned in the response under each <b>Transaction</b> node. For single line item orders, the <b>ContainingOrder.OrderID</b> value takes the value of the <b>OrderLineItemID</b> value for the order line item. For Combined Payment orders, the <b>ContainingOrder.OrderID</b> value will be shared by at least two order line items (transactions) that are part of the same order. false GetItemTransactions No Name of the eBay co-branded site upon which the order line item was created. This filter can be used to limit the number of results that are returned. GetItemTransactions No This time filter specifies the number of days (24-hour periods) in the past to search for order line items. All eBay order line items that were either created or modified within this period are returned in the response. If specified, <b>NumberOfDays</b> will override any date range specified with the <b>ModTimeFrom</b>/<b>ModTimeTo</b> time filters. This field is not applicable if a specific <b>TransactionID</b> or <b>OrderLineItemID</b> is included in the request. 30 1 30 GetItemTransactions No If included in the request and set to True, all variations defined for the item are returned at the root level, including variations that have no sales. If not included in the request or set to false, the variations with sales are still returned in separate <b>Transaction</b> nodes. This information is intended to help sellers to reconcile their local inventory with eBay's records, while processing order line items (without requiring a separate call to <b>GetItem</b>). GetItemTransactions false No A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. If you want to retrieve data on a specific order line item, you can use an <b>OrderLineItemID</b> value in the request instead of the <b>ItemID</b>/<b>TransactionID</b> pair. If an <b>OrderLineItemID</b> is provided, any specified time filter is ignored. 100 GetItemTransactions No Returns an array of order line item (transaction) data for the item specified in the request. The results can be used to create a report of data that is commonly necessary for order processing. Zero, one, or many <b>Transaction</b> objects can be returned in the <b>TransactionArray</b>. The set of order line items returned is limited to those that were modified between the times specified in the request's <b>ModTimeFrom</b> and <b>ModTime</b> filters. Also returns the <b>Item</b> object that spawned the order line items. If pagination filters were specified in the request, returns meta-data describing the effects of those filters on the current response and the estimated effects if the same filters are used in subsequent calls. <br><br> Data from the <b>TransactionArray</b> may be used to trigger the following Platform Notifications: EndOfAuction, AuctionCheckoutComplete, FixedPriceEndOfTransaction, CheckoutBuyerRequestTotal, FixedPriceTransaction, Checkout, FixedPriceTransactionForSeller, FixedPriceTransactionForBuyer, ItemMarkedAsShipped, and ItemMarkedAsPaid. Each notification will be based on the state of the item (a 'snapshot' of the item) at the time the order line item was created. Contains the total number of pages (<b>TotalNumberOfPages</b>) and the total number of entries (<b>TotalNumberOfEntries</b>) that could be returned given repeated calls that use the same selection criteria as the call that returned this response. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Indicates whether there are additional order line items (transactions) to retrieve. That is, indicates whether more pages of data are available to be returned, given the filters that were specified in the request. Returns false for the last page of data. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Number of order line items (transactions) returned per page (per call). May be a higher value than <b>ReturnedTransactionCountActual</b> if the page returned is the last page and more than one page of data exists. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Page number for the page of order line items the response returned. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Number of order line items retrieved in the current page of results just returned. May be a lower value than <b>TransactionsPerPage</b> if the page returned is the last page and more than one page of data exists. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always <b>Item</b> object that spawned the order line item. It is a purchase from this item's listing that the order line item represents. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always List of <b>Transaction</b> objects representing the order line items resulting from the listing. Each <b>Transaction</b> object contains the data for one purchase (of one or more items in the same listing). The <b>Transaction.Item</b> field is not returned because the <b>Item</b> object is returned at the root level of the response. See the reference guide for more information about the fields that are returned. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Conditionally Indicates whether the item's seller has the preference enabled that shows that the seller prefers PayPal as the method of payment for an item. This preference is indicated on an item's View Item page and is intended to influence a buyer to use PayPal to pay for the item. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Returns orders in which the user was involved and for which feedback is still needed from either the buyer or seller. GetMyeBayBuying, GetMyeBaySelling, GetMyeBayReminders Specifies how the returned feedback items should be sorted. Valid values are Title, EndTime, QuestionCount, FeedbackLeft, FeedbackReceivedDescending, UserIDDescending, TitleDescending, and EndTimeDescending. GetItemsAwaitingFeedback No Specifies the number of entries per page and the page number to return in the result set. GetItemsAwaitingFeedback No Response to GetItemsAwaitingFeedback. Contains the items awaiting feedback. Returned only if there are items that do not yet have feedback. GetItemsAwaitingFeedback Always Retrieves a list of the messages buyers have posted about your active item listings. AddMemberMessagesAAQToBidder, AddMemberMessageAAQToPartner, AddMemberMessageRTQ, DeleteMyMessages, GetMyMessages, ReviseMyMessages, ReviseMyMessagesFolders http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers The ID of the item the message is about. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included. ItemID is otherwise ignored. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetMemberMessages Conditionally The type of message. Note that GetMemberMessages does not return messages when this field is set to AskSellerQuestion. GetMemberMessages AskSellerQuestion, All Yes The status of the message. GetMemberMessages Conditionally If included in the request and set to True, only public messages (viewable in the Item listing) are returned. If omitted or set to False in the request, all messages (that match other filters in the request) are returned in the response. GetMemberMessages No Used as beginning of date range filter. If specified, filters the returned messages to only those with a creation date greater than or equal to the specified date and time. <br><br> For CEM messages, StartCreationTime and EndCreationTime must be provided. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included. GetMemberMessages Conditionally Used as end of date range filter. If specified, filters the returned messages to only those with a creation date less than or equal to the specified date and time. <br><br> For CEM messages, StartCreationTime and EndCreationTime must be provided. <br><br> For ASQ messages, either the ItemID, or a date range (specified with StartCreationTime and EndCreationTime), or both must be included. GetMemberMessages Conditionally Standard pagination argument used to reduce response. GetMemberMessages No An ID that uniquely identifies the message for a given user to be retrieved. Used for the AskSellerQuestion notification only. GetMemberMessages No An eBay ID that uniquely identifies a user. For GetMemberMessages, this is the sender of the message. If included in the request, returns only messages from the specified sender. GetMemberMessages No The returned member messages. Returned if messages that meet the request criteria exist. Note that GetMemberMessages does not return messages when, in the request, the MailMessageType is AskSellerQuestion. GetMemberMessages Conditionally Shows the pagination of data returned by requests. GetMemberMessages Always Specifies whether the response has more items. GetMemberMessages Always Returns a seller's Ask Seller a Question (ASQ) subjects, each in its own Subject node. SetMessagePreferences The ID of the user to retrieve ASQ subjects for. This value must be specified in the request, but does not need to be the same user as the user making the request. GetMessagePreferences Yes If true, indicates that the ASQ subjects for the specified user should be returned. GetMessagePreferences No Contains the ASQ subjects for the user specified in the request. Returns a seller's ASQ subjects, each in its own Subject node. If the seller has not customized the ASQ subjects using SetMessagePreferences, the call will return the current default values. Returned if IncludeASQPreferences = true was specified in the request. GetMessagePreferences Conditionally Retrieves information about the messages sent to a given user.

Retrieves information about the messages sent to a user.

DetailLevel AddMemberMessageAAQToPartner, AddMemberMessageRTQ, AddMemberMessagesAAQToBidder, DeleteMyMessages, GetMemberMessages, ReviseMyMessages, ReviseMyMessagesFolders http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=NotificationsForBuyersAndSellers This container was deprecated with 685 release. Alerts are now synonymous with Flagged messages. GetMyMessages Conditionally Container consisting of one to 10 MessageID fields. GetMyMessages Conditionally A unique identifier for a My Messages folder. If a FolderID is provided, only messages from the specified folder are returned in the response. GetMyMessages No The beginning of the date-range filter. Filtering takes into account the entire timestamp of when messages were sent. Messages expire after one year. GetMyMessages No The end of the date-range filter. See StartTime (which is the beginning of the date-range filter). GetMyMessages Conditionally This field is currently available on the US site. A container for IDs that uniquely identify messages for a given user. If provided at the time of message creation, this ID can be used to retrieve messages and will take precedence over message ID. GetMyMessages No Specifies how to create virtual pages in the returned list (such as total number of entries and total number of pages to return). Default for EntriesPerPage with GetMyMessages is 25. GetMyMessages No If this field is included in the requst and set to True, only High Priority messages are returned in the response. GetMyMessages No Conains information about the messages sent to a user. Depending on the detail level, this information can include message counts, resolution and flagged status, message headers, and message text. Summary data for a given user's messages. This includes the numbers of new messages, flagged messages, and total messages. The amount and type of data returned is the same whether or not the request includes specific MessageIDs. Always/Conditionally returned logic assumes a detail level of ReturnMessages. GetMyMessages

DetailLevel: ReturnSummary

Conditionally This container was deprecated in 685 version. Alerts are now considered Flagged messages. GetMyMessages

DetailLevel: ReturnHeaders, ReturnMessages

Conditionally Contains the message information for each message specified in MessageIDs. The amount and type of information returned varies based on the requested detail level. Contains one MyMessagesMessageType object per message. Returned as an empty node if user has no messages. GetMyMessages

DetailLevel: ReturnHeaders, ReturnMessages

Conditionally Returns items from the Buying section of the user's My eBay account, including items that the user is watching, bidding on, has won, has not won, and has made best offers on. GetItemsAwaitingFeedback, GetMyeBayReminders, GetMyeBaySelling http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=My_eBay DetailLevel Returns the list of items being watched by the user. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Returns the list of items on which the user has bid. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Returns the list of items on which the user has placed best offers. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Returns the list of items on which the use has bid. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Returns the list of items on which the user has bid on and lost. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Returns the list of searches that the user has saved in My eBay. Returned only if the user has saved searches. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Returns the list of favorite sellers that the user has saved in My eBay. Returned only if the user has saved a list of favorite sellers. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Returns the list of second chance offers made by the user. Returned only if the user has made second chance offers. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Indicates whether or not the Bid Assistant feature is being used. GetMyeBayBuying No Returns the list of items the user has won, and subsequently deleted from their My eBay page. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Returns the list of items (auctions) the user did not win and were subsequently deleted from their My eBay page. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No Returns a summary of the user's buying activity. <br><br> With a request version of 605 or higher, the buying summary container is not included in the response by default. Add a BuyingSummary element in the request with an Include field set to true to receive a BuyingSummary container in your response. <br><br> With a request version lower than 605, the BuyingSummary is always returned by default. Add a BuyingSummary element with an Include field set to false to exclude the BuyingSummary from your response. GetMyeBayBuying No Returns the user defined lists, which are lists created by the user in the eBay UI and filled with items, or sellers, or searches using the "Add to List" feature. <br><br> Set Include to true to return the default response set. GetMyeBayBuying No If true, the Variations node is omitted for all multi-variation listings in the response. If false, the Variations node is returned for all multi-variation listings in the response. <br> <br> Please note that if the seller includes a large number of variations in many listings, retrieving variations (setting this flag to false) may degrade the call's performance. Therefore, when this is false, you may need to reduce the total number of items you're requesting at once (by using other input fields, such as Pagination). GetMyeBayBuying No false Returns items from All Buying or All Favorites in the user's My eBay account. Contains a summary of the items the user has bid on. Returned at all detail levels. GetMyeBayBuying

DetailLevel: ReturnAll

Always Contains the items the user is watching. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains all the items the buyer has bid on. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains the items the user has placed best offers on. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains the items the user has bid on and won. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains the items the user has bid on and lost. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains a list of the user's favorite searches. Only returned if the user has Favorite Searches. The search name, search query, and search elements, such as QueryKeywords, SortOrder, and Condition are returned. <br><br> You can paste the Search Query response, that comes back as a URL, into a browser to re-play the Favorite Search. <br><br> The search elements that are returned by this call can be used as input for the Shopping Web Service FindItemsAdvanced request. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains a list of the user's favorite sellers. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains the list of second chance offers the user has received. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains the items that were bid on using the Bid Assistant feature. GetMyeBayBuying Conditionally Contains the items the buyer has bid on, won, and deleted from My eBay. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains the items the buyer has bid on, lost, and deleted from My eBay. Only returned if items exist that meet the request criteria. GetMyeBayBuying

DetailLevel: ReturnAll

Conditionally Contains the items, searches, or sellers that the user has saved to this list using the "Add to list" feature. The name of the list is given by the "Name" element. Returned only if UserDefineLists is specified in the request. GetMyeBayBuying Conditionally Requests totals for the Buying and Selling reminders from the user's My eBay account. GetItemsAwaitingFeedback, GetMyeBayBuying, GetMyeBaySelling http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=My_eBay Specifies the type of buying reminders for which you want information. GetMyeBayReminders No Specifies the type of selling reminders for which you want information. GetMyeBayReminders No Returns totals of various reminder types from the user's My eBay account. Returns totals of various reminder types from the user's My eBay account. Contains the buying reminders in the user's My eBay account that match the request criteria. GetMyeBayReminders Conditionally Contains the selling reminders in the user's My eBay account that match the request criteria. GetMyeBayReminders Conditionally Returns items from the Selling section of the user's My eBay account, including items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items. DetailLevel GetItemsAwaitingFeedback, GetMyeBayBuying, GetMyeBayReminders http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=My_eBay http://pages.ebay.com/help/myebay/manage-selling.html Returns the list of items the user has scheduled to sell but whose listings have not yet opened. <br><br> Set Include to true to return the default response set. GetMyeBaySelling No Returns the list of items the user is actively selling (the currently active listings). <br><br> Set Include to true to return the default response set. GetMyeBaySelling No Returns the list of items the user has sold. <br><br> Set Include to true to return the default response set. GetMyeBaySelling No Returns the list of items the user has listed, but whose listings have ended without being sold. <br><br> Set Include to true to return the default response set. GetMyeBaySelling No Return the list of active items on which there are bids. <br><br> Set Include to true to return the default response set. GetMyeBaySelling No Returns the list of items the user sold, and then deleted from their My eBay page. Allowed values for DurationInDays are 0-90. <br><br> Set Include to true to return the default response set. Return the list of active items on which there are bids. <br><br> Set Include to true to return the default response set. GetMyeBaySelling No Returns the list of items the user either ended or did not sell, and subsequently were deleted them from their My eBay page. Allowed values for DurationInDays are 0-90. <br><br> Set Include to true to return the default response set. GetMyeBaySelling No Returns a summary of the user's buying activity. <br><br> With a request version of 605 or higher, the selling summary container is not included in the response by default. Add a SellingSummary element in the request with an Include field set to true to receive a SellingSummary container in your response. <br><br> With a request version lower than 605, the SellingSummary is always returned by default. Add a SellingSummary element with an Include field set to false to exclude the SellingSummary from your response. GetMyeBaySelling No If true, the Variations node is omitted for all multi-variation listings in the response. If false, the Variations node is returned for all multi-variation listings in the response. <br> <br> Please note that if the seller includes a large number of variations in many listings, retrieving variations (setting this flag to false) may degrade the call's performance. Therefore, when this is false, you may need to reduce the total number of items you're requesting at once (by using other input fields, such as Pagination). GetMyeBaySelling No false Returns summary and detail information about items the user is selling, items scheduled to sell, currently listed, sold, and closed but not sold. Contains summary information about the items the user is selling. GetMyeBaySelling

DetailLevel: none, ReturnAll

Always Contains the items the user has scheduled for sale, but whose listings have not yet started. GetMyeBaySelling

DetailLevel: none, ReturnAll

Conditionally Contains the items the user is selling that have active listings. GetMyeBaySelling

DetailLevel: none, ReturnAll

Conditionally Contains the items the user has sold. GetMyeBaySelling

DetailLevel: none, ReturnAll

Conditionally Contains the items whose listings have ended but that have not sold. GetMyeBaySelling

DetailLevel: none, ReturnAll

Conditionally Contains summary information about the items the user is selling. GetMyeBaySelling

DetailLevel: none, ReturnAll

Always Contains the seller's active listings with bids. Only returned if items exist that meet the request criteria. GetMyeBaySelling

DetailLevel: none, ReturnAll

Conditionally Contains the items the seller has sold and deleted from My eBay. GetMyeBaySelling

DetailLevel: none, ReturnAll

Conditionally Contains the items with listings that were ended or did not sell and have been deleted from My eBay. GetMyeBaySelling

DetailLevel: none, ReturnAll

Conditionally Retrieves the requesting application's notification preferences. Details are only returned for events for which a preference has been set. For example, if you enabled notification for the EndOfAuction event and later disabled it, the GetNotificationPreferences response would cite the EndOfAuction event preference as Disabled. Otherwise, no details would be returned regarding EndOfAuction. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PlatformNotifications Specifies the type of preferences to retrieve. For example, preferences can be associated with a user, with an application, or with events. GetNotificationPreferences Yes Contains the requesting application's notification preferences. GetNotificationPreferences retrieves preferences that you have deliberately set. For example, if you enable the EndOfAuction event and then later disable it, the response shows the EndOfAuction event preference as Disabled. But if you have never set a preference for the EndOfAuction event, no EndOfAuction preference is returned at all. Specifies application-based event preferences that have been enabled. GetNotificationPreferences Conditionally Specifies application delivery URL Name associated with this user. GetNotificationPreferences Conditionally Specifies user-based event preferences that have been enabled or disabled. GetNotificationPreferences Conditionally Returns user data for notification settings, such as set mobile phone. GetNotificationPreferences Conditionally Contains names and values assigned to a notification event. Currently can only be set for wireless applications. GetNotificationPreferences Conditionally Retrieves usage information about platform notifications for a given application. You can use this notification information to troubleshoot issues with platform notifications. You can call this up to 50 times per hour for a given application. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PlatformNotifications Specifies the start date and time for which notification information will be retrieved. StartTime is optional. If no StartTime is specified, the default value of 24 hours prior to the call time is used. If no StartTime is specified or if an invalid StartTime is specified, date range errors are returned in the response. For a StartTime to be valid, it must be no more than 72 hours before the time of the call, it cannot be more recent than the EndTime, and it cannot be later than the time of the call. If an invalid StartTime is specified, the default value is used. GetNotificationsUsage Conditionally Specifies the end date and time for which notification information will be retrieved. EndTime is optional. If no EndTime is specified, the current time (the time the call is made) is used. If no EndTime is specified or if an invalid EndTime is specified, date range errors are returned in the response. For an EndTime to be valid, it must be no more than 72 hours before the time the of the call, it cannot be before the StartTime, and it cannot be later than the time of the call. If an invalid EndTime is specified, the current time is used. GetNotificationsUsage Conditionally Specifies an item ID for which detailed notification information will be retrieved. ItemID is optional. If no ItemID is specified, the response will not include any individual notification details. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetNotificationsUsage Conditionally Returns an array of notifications sent to a given application identified by the appID (comes in the credentials). The result can be used by third-party developers troubleshoot issues with notifications. Zero, one or many notifications can be returned in the array. The set of notifications returned is limited to those that were sent between the StartTime and EndTime specified in the request. If StartTime or EndTime filters were not found in the request, then the response will contain the data for only one day (Now-1day). By default, maximum duration is limited to 3 days (Now-3days). These min (1day) and max(3days) applies to Notifications,MarkDownMarkUpHistory and NotificationStatistics. Notifications are sent only if the ItemID is included in the request. If there is no ItemID, then only Statistics and MarkDownMarkUpHistory information is included. Returns the start date and time for the notification information that is returned by this call. The oldest date allowed for this field is Now-3days. Default is Now-1day. GetNotificationsUsage Always Returns the end date and time for the notification information that is returned by this call. The default is Now. GetNotificationsUsage Always List of notification objects representing the notifications sent to an application for the given time period. It will only be returned if ItemID was specified in the input request. GetNotificationsUsage Conditionally List of objects representing MarkUp or MarkDown history for a given appID and for given StartTime and EndTime. This node will always be returned. GetNotificationsUsage Always Summary information about number of notifications that were successfully delivered, queued, failed, connection attempts made, connection timeouts, http errors for the given appID and given time period. By default, statistics for only one day (Now-1day) is included. Maximum time duration allowed is 3 days (Now-3days). GetNotificationsUsage Always Use this call to retrieve information about one or more orders based on OrderIDs, ItemIDs, or SKU values. &nbsp;<b>Also for Half.com</b>. DetailLevel GetOrders, GetItemTransactions, GetSellerTransactions http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=TransactionsEndOfAuction An array of ItemTransactionIDs. GetOrderTransactions Conditionally An array of OrderIDs. You can specify, at most, twenty OrderIDs. GetOrderTransactions Conditionally Name of the eBay co-branded site upon which the order line item was created. This will serve as a filter for the orders to get emitted in the response. GetOrderTransactions No Indicates whether to include Final Value Fee (FVF) in the response. For most listing types, the Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee is returned on a transaction-by-transaction basis for FixedPriceItem and StoresFixedPrice listing types. For all other listing types, the Final Value Fee is returned when the listing status is Completed. This value is not returned if the auction ended with Buy It Now. <br><br> For Dutch Buy It Now listings, the Final Value Fee is returned on a transaction-by-transaction basis. <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> GetOrderTransactions No Response to GetOrderTransactions request. An array of Orders. GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

Always Retrieves the orders for which the authenticated user is a participant, either as the buyer or the seller.&nbsp;<b>Also for Half.com</b>. The call returns all the orders that meet the request specifications. DetailLevel AddOrder, GetItemTransactions, GetOrderTransactions http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WorkingWithCombinedPayment A container for eBay order IDs. If one or more order IDs are specified in this container, no other call-specific input fields are applicable. <br><br> Not applicable to Half.com. GetOrders Conditionally The CreateTimeFrom and CreateTimeTo fields specify a date range for retrieving orders. The CreateTimeFrom field is the starting date range. All eBay orders that were created within this date range are returned in the output. The maximum date range that may be specified is 30 days. This field is not applicable if one or more order IDs are passed in the request. <br> Applicable to Half.com. GetOrders Conditionally The CreateTimeFrom and CreateTimeTo fields specify a date range for retrieving orders. The CreateTimeTo field is the ending date range. All eBay orders that were created within this date range are returned in the output. The maximum date range that may be specified is 30 days. If the CreateTimeFrom field is used and the CreateTimeTo field is omitted, the "TimeTo" value defaults to the present time or to 30 days past the CreateTimeFrom value (if CreateTimeFrom value is more than 30 days in the past). This field is not applicable if one or more order IDs are passed in the request. <br><br> <span class="tablenote"><strong>Note:</strong> When a GetOrders call is made within a few seconds of a multiple line item order creation, the response may contain incomplete information, such as an erroneous <b>CheckoutStatus.Status</b> value of <b>Incomplete</b>, or missing <b>Transaction</b> nodes. For this reason, it is recommended that sellers include the <b>CreateTimeTo</b> field in the call, and set its value to: <i>Current Time</i> - 2 minutes. <br><br> Applicable to Half.com. GetOrders Conditionally Filters the returned orders based on the role of the user. The user's role is either buyer or seller. If this field is used with a date filter, returned orders must satisfy both the date range and the OrderRole value. <br> Applicable to eBay.com and Half.com. GetOrders Conditionally Filters the returned orders by order status. For eBay orders, only the Active and Completed values are applicable. The Shipping value can be used for Half.com orders. If this field is used with a date filter, returned orders must satisfy both the date range and the OrderStatus value. <br><br> To retrieve orders with a status of Inactive or Cancelled, you must specify the order IDs (OrderIDArray.OrderID). When you specify order IDs, no other filters may be used. <br><br> For Half.com, you can get some, but not all orders. Orders on Half.com have different order status values from eBay orders. When you set ListingType to Half, set OrderStatus to Shipped. Otherwise, GetOrders may return incomplete information or have indeterminate results. GetOrders Active, Completed, Shipped Conditionally Specify Half to retrieve Half.com orders. <br><br> <span class="tablenote"><strong>Note:</strong> Do not use this field if you are retrieving eBay orders. <br><br> This field cannnot be used as a listing type filter on eBay.com. If not provided, or if you specify any value other than Half, this field has no useful effect and the call retrieves eBay orders of all types. Also, you can't retrieve both eBay and Half.com orders in the same response. </span> GetOrders Half Conditionally If many orders are available to retrieve, you may need to call GetOrders multiple times to retrieve all the data. Each result set is returned as a page of entries. Use the Pagination filters to control the maximum number of entries to retrieve per page (i.e., per call), the page number to retrieve, and other data. GetOrders No The ModTimeFrom and ModTimeTo fields specify a date range for retrieving orders. The ModTimeFrom field is the starting date range. All eBay orders that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This field is not applicable if one or more order IDs are passed in the request, or if the CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the request. <br><br> Applicable to Half.com. GetOrders Conditionally The ModTimeFrom and ModTimeTo fields specify a date range for retrieving orders. The ModTimeTo field is the ending date range. All eBay orders that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. If the ModTimeFrom field is used and the ModTimeTo field is omitted, the "TimeTo" value defaults to the present time or to 30 days past the ModTimeFrom value (if ModTimeFrom value is more than 30 days in the past). This field is not applicable if one or more order IDs are passed in the request, or if the CreateTimeFrom/CreateTimeTo or NumberOfDays date filters are used in the request. <br><br> Applicable to Half.com. GetOrders Conditionally This filter specifies the number of days (24-hour periods) in the past to search for orders. All eBay orders that were either created or modified within this period are returned in the output. This field cannot be used in conjunction with the CreateTimeFrom/CreateTimeTo or ModTimeFrom/ModTimeTo date filters. <br><br> Applicable to Half.com. 1 30 GetOrders Conditionally Indicates whether to include the Final Value Fee (FVF) for all Transaction objects in the response. The Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee is assessed right after the creation of an eBay order line item. <br> GetOrders Conditionally Returns the set of orders that match the order IDs or filter criteria specified. Contains information regarding the pagination of data, including the total number of pages and the total number of orders. GetOrders

DetailLevel: none, ReturnAll

Always A true value indicates that there are more orders to be retrieved. Additional GetOrders calls with higher page numbers or more entries per page must be made to retrieve these orders. If false, no more orders are available or no orders match the request (based on the input filters). GetOrders

DetailLevel: none, ReturnAll

Always The set of orders that match the order IDs or filter criteria specified. Also applicable to Half.com (only returns orders that have not been marked as shipped). GetOrders

DetailLevel: none, ReturnAll

Always Indicates the number of orders that can be returned per page of data (i.e., per call). This is the same value specified in the Pagination.EntriesPerPage input (or the default value, if EntriesPerPage was not specified). This is not necessarily the actual number of orders returned per page (see ReturnedOrderCountActual). GetOrders

DetailLevel: none, ReturnAll

Always Indicates the page number of data returned in the response. This is the same value specified in the Pagination.PageNumber input. If orders are returned, the first page is 1. GetOrders

DetailLevel: none, ReturnAll

Always Indicates the total number of orders returned. GetOrders

DetailLevel: none, ReturnAll

Always <table> <tr> <td class="notebox"> <b>Note:</b> This call will soon be deprecated. Use accordingly. </td> </tr> </table> <br> Requests information about folders or pictures in a Picture Manager account or the account settings.

Requests information about folders or pictures in a Picture Manager account or the account settings. This call will soon be deprecated.

PictureManagerDetailLevel The ID of a folder in the user's Picture Manager album for which you want information. If you specify both FolderID and PictureURL, the picture must exist in the folder. GetPictureManagerDetails No The URL of a picture in the user's Picture Manager album. If you specify both FolderID and PictureURL, the picture must exist in the folder. GetPictureManagerDetails No The type of information you want returned, about pictures and folders, the account subscription, or both. Use this element rather than the generic DetailLevel element defined in AbstractRequestType. You can use the following values: ReturnAll, ReturnSubscription, or ReturnPicture. Yes GetPictureManagerDetails No Responds with information about content in a Picture Manager album or the account settings. Contains details of the account settings, folders or pictures in the user's album, or both. GetPictureManagerDetails

PictureManagerDetailLevel: none, ReturnSubscription, ReturnPicture, ReturnAll

Always <table> <tr> <td class="notebox"> <b>Note:</b> This call will soon be deprecated. Use accordingly. </td> </tr> </table> <br> Requests a list of Picture Manager options and allowed values, such as subscription type and picture display.

Requests a list of Picture Manager options and allowed values. This call will soon be deprecated.

Returns a list of Picture Manager options and allowed values. A type of Picture Manager subscription, with a subscription level, fee, and allowed storage size. GetPictureManagerOptions Always A global definition for displaying pictures, with a maximum size. GetPictureManagerOptions Always Retrieves the words that are most frequently submitted by eBay users when searching for listings. FR, HK, MY, PH, PL, SG, SE A category ID for which you want keywords returned. When IncludeChildCategories is true, one and only one CategoryID is allowed. Otherwise, up to 100 CategoryIds are allowed. <br><br> To retrieve the keywords for root category, set one of the CategoryIDs to -1 or submit no CategoryIDs at all. 10 GetPopularKeywords No If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories. If false, keywords are returned only for the categories identified by CategoryID. Default is false. GetPopularKeywords No The maximum number of keywords to be retrieved per category for this call. GetPopularKeywords No 1 1000 20 Details about how many categories to return per page and which page to view. GetPopularKeywords No Contains the keyword data for the requested categories. A category's data are contained in a CategoryArrayType object if there is no error (one or more CategoryType objects). Each CategoryType contains its ID, parent ID and keyword list. Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. GetPopularKeywords Conditionally Organization of keywords by category. For each category, its ID and its parent's ID and keywords are listed. GetPopularKeywords Always Indicates whether there are more categories beyond the subset returned in the last call to GetPopularKeywords. Returned only when IncludeChildCategories is true. GetPopularKeywords Conditionally No longer recommended. This supports an older ID-based format for describing item specifics and product details. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use FindProducts in eBay's Shopping API to search for product details.<br> <br> GetProductFamilyMembers is intended to be used combination with GetProductSearchResults. If a search result returned from GetProductSearchResults does not return all product versions in a family, and if the user wants to see more versions (editions) of the product, you can use GetProductFamilyMembers to retrieve all versions of the product. That is, if GetProductSearchResultsonly returns the product family header (ParentProduct), use this call to zoom in on a particular family of product versions. (This situation usually occurs when you call GetProductSearchResults and more more matches are found than the MaxChildrenPerFamily value you specified.)<br> <br> The structure of tGetProductFamilyMembers is similar to that of GetProductSearchResults. Instead of passing in a query, you pass in a product ID. This product ID is used to find all the members of the product family that the specified product is a member of. The results are compatible with the results from GetProductSearchResults, so similar application logic can be used to handle both requests and responses. This call supports batch requests. This means you can retrieve products in multiple families by using a single request. To perform a batch request, pass an array of ProductSearch objects in the call.<br> <br> For each ProductSearch object, GetProductFamilyMembers returns a list of all the products in the specified product family. Each product is represented as a list of attributes (Item Specifics) plus other identifying information, such as a product ID and a stock photo.<br> <br> Once the user selects a product from the results, pass its ID in a GetProductSellingPages request to retrieve more detailed information about the product, including a set of optional Item Specifics that the seller can use in addition to the pre-filled Item Specifics (see GetProductSellingPages). <br> <br> To use this data in a listing, pass the product ID and the optional Item Specifics in the seller's listing request (AddItem).

No longer recommended. Retrieves information that supports finding catalog product information. Use FindProducts in the Shopping API instead.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPFM GetProductSearchResults, GetProductSellingPages Specifies the ID of a product in the family to be retrieved, along with pagination and sorting instructions. ProductSearch is a required input. GetProductFamilyMembers Yes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPFM GetProductFamilyMembers performs a product search and returns results comprising all the children in the product family identified by a product ID that was specified in the request. Use this call when more matches are found than the max amount specified per family in a call to GetProductSearchResults. This call supports batch requests. This means you can retrieve products in multiple families by using a single request. The results are compatible with the results from GetProductSearchResults, so similar application logic can be used to handle both requests and responses. Container for one or more DataElement fields containing supplemental helpful data. A DataElement field is an HTML snippet that specifies hints for the user, help links, help graphics, and other supplemental information that varies per characteristics set. Usage of this information is optional and may require developers to inspect the information to determine how it can be applied in an application. GetProductFamilyMembers Always Contains the attributes and summary product details for all products that match the product ID (or IDs) passed in the request. GetProductFamilyMembers Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPFM No longer recommended. This supports an older ID-based format for describing item specifics and product details. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use FindProducts in eBay's Shopping API to search for product details.<br> <br> Retrieves data that you use to construct valid "product finder" queries (queries against multiple attributes) against catalog products or (in some cases) listed items. The attributes describe search criteria (e.g., Manufacturer), as appropriate for the category. Use the results in combination with GetProductFinderXSL to render the Product Finder in a graphical user interface.<br> <br> GetProductFinder does not conduct the actual product or listing search. It only returns data about what you can search on. Use the data as input to GetProductSearchResults to conduct the actual search for product information. <br> <br> To retrieve single-attribute search criteria (querying against a single attribute, like UPC), use GetProductSearchPage instead (only applicable for catalog searches).<br> <br> See the eBay Web Services Guide for an overview of Pre-filled Item Information and details about searching for catalog products and for information about searching for listed items.

No longer recommended. Retrieves information that supports finding catalog product information. Use FindProducts in the Shopping API instead.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPF http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFModel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFSearch http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByItemSpecifics GetProductFinderXSL, GetProductSearchResults, GetProductSellingPages A version of the product finder attribute definitions for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the Product Finders for which the attribute meta-data has changed since the specified version. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed. GetProductFinder No A number that uniquely identifies a product finder. <br> <br> For sell-side searches, you can determine the product finder IDs for a category by calling GetCategory2CS.<br> <br> For buy-side searches, you can't use GetCategory2CS to reliably determine the product finder IDs for an eBay category. GetProductFinder may work for some attributes. Alternatively, you can 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.<br> <br> Multiple categories can be mapped to the same product finder ID. You can pass zero or multiple IDs in the request. When IDs are specified, the call only returns product finder meta-data for the specified product finders. When no IDs are specified, the call returns all the current product finder meta-data available on the site. GetProductFinder No http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPF http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByItemSpecifics https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=560 For a category that supports product finders, GetProductFinder returns an XML string that decribes the attributes a seller can use to form a query when searching for Pre-filled Item Information, or attributes that can be used to search for listed items. Specifically, it retrieves data that you use to construct valid "product finder" queries (queries against multiple attributes). Use the results in combination with GetProductFinderXSL to render the Product Finder in a graphical user interface. See the Developer's Guide for an overview of Pre-filled Item Information and details about searching for catalog products and for information about searching for listed items. Current version of the product search page data for the site. This value changes each time changes are made to the search page data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetProductFinder

DetailLevel: none, ReturnAll

Conditionally A string containing a list of search attributes that can be used in a "Product Finder" style query, along with related meta-data. The meta-data specifies possible values of each attribute, the logic for presenting attributes to a user, and rules for validating the user's selections. For backward compatibility, this data is in the same XML format that was used in the Legacy XML API so that you can apply the same Product Finder XSL stylesheet to it. That is, individual elements are not described using the new eBay XML schema format. For information about each element in the ProductFinderData string, see the product finder model documentation in the eBay Web Services guide (see links below).<br> <br> Because this is returned as a string, the XML markup is escaped with character entity references (e.g., &amp;lt;eBay&amp;gt;&amp;lt;ProductFinders&amp;gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductFinder

DetailLevel: ReturnAll

Conditionally http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPF http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFModel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DataTypes No longer recommended. This supports an older ID-based format for describing item specifics and product details. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use FindProducts in eBay's Shopping API to search for product details.<br> <br> Retrieves the Product Finder XSL stylesheet. Apply the stylesheet to the XML returned from a call to GetProductFinder to render a form that lets a user form a multi-attribute query against eBay catalog data. See the Developer's Guide for an overview of Pre- filled Item Information and information on searching for catalog products.

No longer recommended. Retrieves information that supports finding catalog product information. Use FindProducts in the Shopping API instead.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFXSL http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPFXSL GetProductFinderXSL, GetProductSearchResults The name of the XSL file to retrieve. If not specified, the call returns the latest versions of all available XSL files. Currently, this call only retrieves the product_finder.xsl file. FileName is an optional input. GetProductFinderXSL No The desired version of the XSL file. Required if FileName is specified. If not specified, the call returns the latest versions of all available XSL files that could be returned by the call. (Currently, this call only retrieves the product_finder.xsl file.) This is not a filter for retrieving changes to the XSL file. GetProductFinderXSL No Retrieves the Product Finder XSL stylesheet. Apply the stylesheet to the XML returned from a call to GetProductFinder to render a form that lets a user form a multi-attribute query against eBay catalog data. See the Developer's Guide for an overview of Pre-filled Item Information and information on searching for catalog products. Child elements specify data related to one XSL file. In theory, multiple XSLFile objects can be returned. Currently, this call only retrieves the product_finder.xsl file. GetProductFinderXSL

DetailLevel: none, ReturnAll

Always No longer recommended. This supports an older ID-based format for describing item specifics and product details. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use FindProducts in eBay's Shopping API to search for product details.<br> <br> Retrieves the attributes a seller can use to form a query when searching for Pre-filled Item Information to use in a listing for a category that is catalog-enabled. This call is applicable for use cases related to listing items with Pre-filled Item Information. Specifically, it retrieves data that you use to construct valid "single-attribute" queries. The attributes describe search criteria (e.g., Author) and sorting criteria (e.g., Publication Year), as appropriate for the category. GetProductSearchPage does not conduct the actual product search. It only returns data about what you can search on. Use the data as input to GetProductSearchResults to conduct the actual search for product information. To retrieve Product Finder search criteria (querying against multiple attributes), use GetProductFinder instead. See the eBay Web Services guide for an overview of Pre-filled Item Information and details about searching for catalog products.

No longer recommended. Retrieves information that describes how to find catalog product information. Use FindProducts in the Shopping API instead.

DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSrchP http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPSPSearch GetCategory2CS, GetProductSearchResults A version of the search page definitions for the site. Typically, an application passes the version value that was returned the last time the application executed this call. Filter that causes the call to return only the search pages for which the attribute meta-data has changed since the specified version. The latest version value is not necessarily greater than the previous value that was returned. Therefore, when comparing versions, only compare whether the value has changed. GetProductSearchPage No A characteristic set ID that is associated with a catalog-enabled category that supports product search pages. You can pass an array of these IDs in the request. Each characteristic set corresponds to a level in the eBay category hierarchy at which all items share common characteristics. Multiple categories can be mapped to the same characteristic set. Each ID is used as a filter to limit the response content to fewer characteristic sets. When IDs are specified, the call only returns search page data for the corresponding characteristic sets. When no IDs are specified, the call returns all the current search page data in the system. GetProductSearchPage No For a category that is catalog-enabled, GetProductSearchPage retrieves the attributes a seller can use to form a query when searching for Pre-filled Item Information. See the Developer's Guide for an overview of Pre-filled Item Information and details about searching for catalog products. Current version of the product search page data for the site. This value changes each time changes are made to the search page data. The current version value is not necessarily greater than the previous value. Therefore, when comparing versions, only compare whether the value has changed. GetProductSearchPage

DetailLevel: none, ReturnAll

Always A list of catalog search criteria and sort keys associated with a catalog-enabled category, plus supplemental information to help the seller understand how to make selections. GetProductSearchPage

DetailLevel: ReturnAll

Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSrchP No longer recommended. This supports an older ID-based format for describing item specifics and product details. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use FindProducts in eBay's Shopping API to search for product details.<br> <br> Searches for Pre-filled Item Information within one or more characteristic sets. This kind of search is only applicable in the context of the Sell Your Item use case. Use the response to present the seller with a list of products found in a catalog. (For buy-side searches, use the <a href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html" >Finding API</a>.)<br> <br> See the Attributes and Catalogs section of the eBay Web Services guide for background information and terminology definitions, as well as information about how to use this call in the Sell Your Item flow.<br> <br> You can use this call to search for different products at the same time. That is, this call can perform batch searches.<br> <br> Given an array of ProductSearch properties that are configured with a list of search attributes or keywords (and other information), GetProductSearchResults searches an eBay catalog for products that match each query. Some queries can be configured to also specify a sort order for the results.<br> <br> To configure a ProductSearch object to search by attributes, you need a valid combination of search attributes. If you want to use a sort order other than the default order, you also need a valid sort attribute. We offer two calls that return product search and sort attributes. Use GetCategory2CS to determine which one of these calls you can use for a given category. At least one approach is offered for each catalog-enabled category, and some cases, both are offered.<br> <br> <b>GetProductSearchPage</b>: Use this call when you want to configure a simple query that consists of a single search attribute (with a value). This retrieves a single product or a very short list of search results to choose from. Some products are fairly easy to find based on a single attribute. For example, in Consumer Electronics categories (Digital Cameras, Cell Phones, and PDAs), you can specify a unique (or nearly unique) identifier, like a part number. In Media categories (Books, DVDs & Movies, Music, and Video Games), you can specify a descriptive name, like a title. <br> <br> <b>GetProductFinder</b>: Use this call when you want to configure a complex query. In the Sell Your Item flow, this is a complex query against the eBay product catalog. Currently, this type of search is available in Consumer Electronics categories only. In this type of search, you specify values for multiple attributes, like Brand and Resolution (i.e., number of megapixels). This retrieves a list of matching products. This approach is useful when the user does not know the part number, or a product does not have a single, distinguishing feature that is easy to search on. For example, searching for a digital camera based solely on the brand would likely yield far too many results to be useful. Searching on the brand, product line, and resolution will retrieve a much shorter list of results. <br> <br> Alternatively, you can search on a particular keyword that appears in a product's title or Item Specifics. For this, you use GetProductSearchResults and and pass in one or more text strings (with optional wildcards) in ProductSearch.QueryKeywords. <br> <br> When you use a keyword query, the search criteria are not restricted to the results of a product search page or product finder, so the criteria are not tied to a particular characteristic set. This means you can search across multiple characteristic sets using the same query. This is useful when the user wants to broaden their search across multiple categories. For example, a seller who sells Jazz books, Jazz CDs, and Jazz movies may want to search for "Bird" across multiple categories. Specify the characteristic set IDs of interest by using CharacteristicSetIDs. <br> <br> GetProductSearchResults returns a list of matching products, if any. Each product is represented as a list of attributes (Item Specifics) plus other identifying information, such as a product ID and a stock photo. <br> <br> Once the user selects a product from the list (this may require a call to GetProductFamilyMembers to retrieve additional products to choose from), pass its ID in a GetProductSellingPages request to retrieve more detailed information about each product, including a set of optional Item Specifics that the seller can use in addition to the pre-filled Item Specifics (see GetProductSellingPages). <br> <br> To use this data in a listing, pass the product ID and the optional Item Specifics in the seller's listing request (AddItem).

No longer recommended. Retrieves information that describes how to present catalog product information to a seller. Use FindProducts in the Shopping API instead.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductSearch http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSR GetProductSearchPage, GetProductFinder, GetProductFamilyMembers, GetProductSellingPages Specifies the keywords or attributes that make up the product query, with pagination instructions. ProductSearch is a required input. To search for multiple different products at the same time (i.e., to perform a batch search), pass in multiple ProductSearch properties. GetProductSearchResults Yes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductSearch GetProductSearchResults performs a product search and collects the results. Result attributes for each product/product family are grouped and identified with a product ID. If more matches are found than the max amount specified per family, only the product family information is returned. In this case, call GetProductFamilyMembers to retrieve more products within the same family. Container for one or more DataElement fields containing supplemental helpful data. A DataElement field is an HTML snippet that specifies hints for the user, help links, help graphics, and other supplemental information that varies per characteristic set. Usage of this information is optional and may require you to inspect the information to determine how it can be applied in an application. Also returned with warnings when no matches are found. GetProductSearchResults Always Contains the attributes and product details that match the attributes or query keywords passed in the request. Always returned when product search results are found. GetProductSearchResults Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductSearch No longer recommended. This supports an older ID-based format for describing item specifics and product details. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use FindProducts in eBay's Shopping API to search for product details.<br> <br> Retrieves information that describes how to present catalog product information to a seller. Use this information to present users with the equivalent of the Item Specifics portion of the eBay Title and Description pages and to validate user-specified values for eBay attributes on the client before including them in an AddItem call or related calls. The data contains a list of all the attributes that are applicable for one or more requested products, along with related meta-data. The meta-data specifies the pre-filled values of each attribute, the possible values of attributes that are not pre-filled, the logic for presenting the attributes to a user, and rules for validating the user's selections. Use the results in combination with GetAttributesXSL to render the Item Specifics in a graphical user interface. See the eBay Web Services Guide for an overview of Pre-filled Item Information, details about searching for catalog products, and information about the ProductSellingPages content model.

No longer recommended. Retrieves information that describes how to present catalog product information to a seller. Use FindProducts in the Shopping API instead.

http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSellP http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrLWISCData GetProductSearchResults, GetProductFamilyMembers, GetAttributesCS, AddItem Specifies the context in which the call is being executed, which will imply certain validation rules. Use this property to make sure you retrieve the appropriate version of product information and attribute meta-data when you are listing, revising, or relisting an item with Pre-filled Item Information. GetProductSellingPages Yes A catalog product identifies a prototype description of a well-known type of item, such as a popular book. As this call supports batch requests, you can pass in an array of products to retrieve data for several products at the same time. GetProductSellingPages Yes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSellP Retrieves an XML string that describes how to present catalog product information to a seller. Use this information to present users with the equivalent of the Item Specifics portion of the eBay Title and Description pages and to validate user- specified values for eBay attributes on the client before including them in an AddItem call or related calls. Use the results in combination with GetAttributesXSL to render the Item Specifics in a graphical user interface. See the Developer's Guide for an overview of Pre-filled Item Information and details about searching for catalog products. A string containing a list of all the attributes that are applicable to the products specified in the request, along with related meta-data. The meta-data specifies the pre-filled values of each attribute, the possible values of attributes that are not pre-filled, the logic for presenting the attributes to a user, and rules for validating the user's selections. <br><br> For backward compatibility, this data is in the same XML format that was used in the Legacy XML API so that you can apply the same Item Specifics XSL stylesheet to it. That is, individual elements are not described using the unified schema format. <br><br> The data is based on the GetAttributesCS response (AttributeData), with additional information that is specific to catalog products. Product and attribute information is nested within a set of Product tags. The product-specific data is merged into the attribute data so that the same XSL stylesheet used to render the results of GetAttributeCS can be used to render catalog product data. See GetAttributesXSL. <br><br> See the Attribute Meta-Data Model section of the eBay Web Services guide for information about each element in the ProductSellingPagesData string. <br><br> Because the content is returned as a string, the XML markup elements are escaped with character entity references (e.g.,&amp;lt;eBay&amp;gt;&amp;lt;Attributes&amp;gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductSellingPages Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DataTypes No longer recommended. This supports an older ID-based format for describing item specifics and product details. Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now. Instead, use FindProducts in eBay's Shopping API to search for product details.<br> <br> Searches for stock information and reviews for certain kinds of products, such as a particular digital camera model. <p> GetProducts is designed to be useful to applications that support shopping comparison, product reviews, or basic supply and demand data. </p> <p> GetProducts also supports tracking so that members of the eBay Affiliates Program can get commissions for driving traffic to eBay. </p> <p class="tablenote"><b>Note:</b> For selling use cases, use GetProductSearchResults and GetProductSellingPages instead. </p> <p> To use this call, you typically pass in keywords, and GetProducts finds products with matching words in the product title, description, and/or Item Specifics. <p> For each product of interest, you call GetProducts again to retrieve additional details that would be useful to buyers: </p> <ul> <li>Top reviews of the product by eBay members, including part of the review text, plus links to the full text on the eBay Web site.</li> <li>Relevant buying guides (shopping advice) written by eBay members and by eBay staff, including part of the guide text, plus links to the full text on the eBay Web site.</li> <li>Up to 200 matching items on eBay (if any). (To find more matching items, use the <a href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html">Finding API</a>.)</li> </ul> <p> <span class="tablenote"><b>Note:</b> As catalog queries can take longer than item queries. Also, due to the way product data is cached, you may get a faster response when you run the same query a second time.</span>

No longer recommended. Searches for catalog product information in an older format. Use FindProducts in the Shopping API instead.

GetCategories Contains the fields that form the search query. You can query against keywords, an eBay product reference ID (not to be confused with an eBay product ID), or external product ID (like an ISBN). GetProducts Yes Sorts the list of products returned. This is mostly only useful with QueryKeywords. (When you use ExternalProductID or ProductReferenceID, eBay usually only returns one product.) GetProducts No If true, the response includes items (if any) that match the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords. GetProducts No false If true, the response includes up to 20 reviews (if any) for the product specified in ExternalProductID or ProductReferenceID. The reviews are sorted by most helpful (most votes) first. When you include review details, please note that response times may be longer than 60 seconds. Not applicable with QueryKeywords. GetProducts No false If true, the response includes up to 5 buying guides (if any) for the product specified in ExternalProductID or ProductReferenceID. Not applicable with QueryKeywords. GetProducts No false If true, the response includes a histogram that lists the number of matching products found and the domains in which they were found. (A domain is like a high-level category.) Including the histogram can affect the call's performance. You may see significantly slower response times when many matching products are found. GetProducts No false See the <a href="https://www.ebaypartnernetwork.com/" target="_blank">eBay Partner Network</a>. eBay uses the values in AffiliateTrackingDetails to build a View Item URL string, in order to include that string in the response. When a user clicks through the URL to eBay, you may get a commission (see the URL above). Only applicable when IncludeItemArray is specified (because the View Item URL is only returned in item information, not in product information). http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AffiliateTrackingConcepts GetProducts No Specifies whether or not to remove duplicate items from search results. When set to true, and there are duplicate items for an item in the search results, the subsequent duplicates will not appear in the results. Item listings are considered duplicates in the following conditions: <br> <ul> <li>Items are listed by the same seller</li> <li>Items have exactly the same item title</li> <li>Items have similar listing formats</li> <ul> <li>Auctions: Auction Items, Auction BIN items, Multi-Quantity Auctions, and Multi-Quantity Auctions BIN items</li> <li>Fixed Price: Fixed Price, Multi-quantity Fixed Price, Fixed Price with Best Offer, and Store Inventory Format items</li> <li>Classified Ads</li> </ul> </ul><br> For Auctions, items must also have the same price and number of bids to be considered duplicates. <br> Filtering of duplicate item listings is not supported on all sites. For GetProducts, this filter only works when IncludeItemArray is set to true. false GetProducts No Returns stock product information in eBay catalogs, such as information about a particular DVD or camera. Optionally, also returns product reviews, buying guides, and items that match the product. A histogram that lists the number of matching products found and the domains in which they were found. A <i>domain</i> is essentially a set of categories that share certain common features (as determined by eBay). Each domain has its own name and ID. GetProducts Always The number of the page of data returned. If many products are found and multiple pages of results are available, use this in combination with ApproximatePages and HasMore to decide which page to retrieve next. As GetProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request). 1 2000 GetProducts Always The total number of pages that can be returned, given the same query and filters in the request. As GetProducts only returns up to 2000 products, the maximum possible value is theoretically 2000 (if you were to set EntriesPerPage to 1 in the request). 1 2000 GetProducts Always If true, more pages of results are available. That is, PageNumber is less than ApproximatePages. GetProducts Always The total number of matching products found. (If more than 2000 products are found, the call fails with an error.) 0 2000 GetProducts Always An eBay catalog product. This contains stock information about a particular DVD, camera, set of golf clubs, or other product. When you use QueryKeywords in the request, GetProducts returns a maximum of 20 products per page. When you use ExternalProductID or ProductReferenceID in the request, GetProducts usually only returns 1 product. (If more than one product matches the same ExternalProductID, GetProducts will return all of those products. As of the time of this writing, we expect this to be a rare case.) 20 GetProducts Always A list of items (if any) that match the product identified in ExternalProductID or ProductReferenceID in the request. Only returned when you set IncludeItemArray to true. The items are sorted by end time (ending soonest), and this order is not configurable in the request. Up to 200 items can be returned. All items are returned on the first page (page 1). Not returned when you use QueryKeywords.<br> <br> If ItemCount is greater than 200, use the <a href="http://www.developer.ebay.com/DevZone/finding/CallRef/index.html" >Finding API</a> if you want to retrieve more matching items. GetProducts Conditionally Contains information for up to 5 buying guides that match the query. Only returned when you set IncludeBuyingGuideDetails to true. Buying guides provide useful information about shopping in a particular domain, like Digital Cameras. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. If no buying guides are associated with the product, this only returns a link to the buying guide hub (the main Guides page). GetProducts Conditionally Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request. GetProducts Conditionally Retrieves all promotion rules associated with the specified item or store category. GetCrossPromotions http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CrossPromotionsChapter The unique ID of the item for which to retrieve promotion rules. Mutually exclusive with StoreCategoryID. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetPromotionRules Conditionally The unique ID of the store category for which to retrieve promotion rules. Mutually exclusive with ItemID. GetPromotionRules Conditionally The type of promotion. (CrossSell: items that are related to or useful in combination with this item. UpSell: items that are more expensive than or of higher quality than this item.) GetPromotionRules Yes Returns all promotion rules associated with the specified item or store category. An array of promotion rules associated with the item or store category specified in the request. GetPromotionRules Always Obtains information about promotional sales set up by an eBay store owner (the authenticated caller). GetPromotionRules, SetPromotionalSale, SetPromotionalSaleListings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PuttingItemsOnSale The ID of the promotional sale about which you want information. If you do not specify this field, then all promotional sales for the seller making the call are returned or only those promotional sales matching the specified promotional sale status filter, PromotionalSaleStatus. <br><br> If PromotionalSaleID and PromotionalSaleStatus are both specified, the single promotional sale specified by ID is returned only if its status matches the specified status filter. GetPromotionalSaleDetails No Specifies the promotional sales to return, based upon their status. For example, specify "Scheduled" to retrieve only promotional sales with a Status of Scheduled. If you want to retrieve promotional sales for more than one status, you can repeat the field with an additional status value, such as Active. <br><br> If this field is used together with PromotionalSaleID, the single promotional sale specified by ID is returned only if its status matches the specified status filter. <br><br> If neither field is used, all of the seller's promotional sales are returned, regardless of status. No filtering GetPromotionalSaleDetails No Contains information about promotional sales. This call is part of the Promotional Price Display feature. Contains information about a promotional sale or sales. If you did not specify a PromotionalSaleID in the request, then all promotional sales for the seller are returned. Promotional sales enable sellers to add discounts and/or free shipping to items. GetPromotionalSaleDetails Conditionally Retrieves a brief summary of the requester's status as an eBay seller. GetAccount, GetFeedback, GetUser http://pages.ebay.com/help/myebay/seller-dashboard.html http://pages.ebay.de/help/myebay/seller-dashboard.html Returns a brief summary of the requester's status as an eBay seller. The status information can help an eBay seller monitor their selling performance and keep their account in good standing. Provides information about the visibility level you have earned for your listings. The higher your search standing rating, the higher your items will be placed in search results sorted by Best Match. Because your search standing rating is directly tied to your customer service record, this rating is an important way that eBay rewards you as a good seller--it encourages you to give buyers the best possible shopping experience. <br><br> This element is not returned for all sites. Beginning at the end of 2009, eBay stopped returning it for sellers registered on several large sites, including the US, German, and UK sites. GetSellerDashboard Conditionally http://pages.ebay.com/help/myebay/seller-dashboard.html#standing http://pages.ebay.de/help/myebay/seller-dashboard.html#standing Provides information about the PowerSeller discount level you have earned, if any. As a PowerSeller, you can earn discounts on your monthly invoice Final Value Fees based on how well you're rated as a seller. Only returned for members of the eBay US or Canada PowerSeller program. GetSellerDashboard Conditionally http://pages.ebay.com/help/myebay/seller-dashboard.html#discount http://pages.ebay.de/help/myebay/seller-dashboard.html#discount Provides information about your PowerSeller status, such as whether or not you meet the PowerSeller requirements. Your PowerSeller status directly affects your discount (SellerFeeDiscount). <br><br> For eBay Germany and France, you must be a registered business seller to see your PowerSeller status. GetSellerDashboard Conditionally http://pages.ebay.com/help/myebay/seller-dashboard.html#status http://pages.ebay.com/services/buyandsell/welcome.html http://pages.ebay.de/help/myebay/seller-dashboard.html#status Rating on how well you are following eBay rules and policies in your selling practices, and alerts you if your account or listings have any policy violations. <br><br> eBay's policies and rules are guidelines that help to create a safe, fair, and enjoyable trading environment for all eBay members. If you violate certain policies, your account can be restricted without notice. This is true even if your status shows a good level of policy compliance. Because of this, understanding and following eBay's policies can help you to avoid restrictions on your account. Policy compliance directly affects your PowerSeller status. GetSellerDashboard Always http://pages.ebay.com/help/myebay/seller-dashboard.html#compliance http://pages.ebay.com/help/policies/seller-rules-overview.html http://pages.ebay.de/help/myebay/seller-dashboard.html#compliance Rates your level of customer service. This information helps you to keep track of how well you are providing members with positive buying experiences. <br><br> This element is not returned for all sites. Beginning at the end of 2009, eBay stopped returning it for sellers registered on several large sites, including the US, German, and UK sites. GetSellerDashboard Conditionally http://pages.ebay.com/help/myebay/seller-dashboard.html#buyer http://pages.ebay.de/help/myebay/seller-dashboard.html#buyer The status of your latest eBay invoice. Includes any alerts issued to your account to help you identify possible problems. GetSellerDashboard Always http://pages.ebay.com/help/myebay/seller-dashboard.html#account http://pages.ebay.de/help/myebay/seller-dashboard.html#account Provides information about the seller's performance within different eBay regions. A seller's performance rating can be Top-Rated, Above Standard, Standard, and Below Standard. GetSellerDashboard Always http://pages.ebay.com/sell/July2009Update/Details/index.html#1-2 http://pages.ebay.com/help/myebay/seller-dashboard.html#performance http://pages.ebay.de/help/myebay/seller-dashboard.html#performance Retrieves price changes, item revisions, description revisions, and other changes that have occurred within the last 48 hours related to a seller's eBay listings. DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WorkingWithSellerEvents eBay user ID for the seller whose events are to be returned. If not specified, retrieves events for the user identified by the authentication token passed in the request. Note that since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about their own listings and bidders who know the user IDs of their sellers will be able to make this API call successfully. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo GetSellerEvents No Describes the earliest (oldest) time to use in a time range filter based on item start time. Must be specified if StartTimeTo is specified. Either the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. If you do not specify the correspoding To filter, it is set to the time you make the call. For better results, the time period you use should be less than 48 hours. If 3000 or more items are found, use a smaller time range.<br> <br> Include a 2-minute, overlapping buffer between requests. For example, if StartTimeTo was 6:58 in a prior request, the current request should use 6:56 in StartTimeFrom (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58). http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=222 GetSellerEvents Conditionally Describes the latest (most recent) date to use in a time range filter based on item start time. If you specify the corresponding From filter, but you do not include StartTimeTo, the StartTimeTo is set to the time you make the call. GetSellerEvents No Describes the earliest (oldest) date to use in a time range filter based on item end time. Must be specified if EndTimeTo is specified. Either the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. If you do not specify the correspoding To filter, it is set to the time you make the call.<br> <br> For better results, the time range you use should be less than 48 hours. If 3000 or more items are found, use a smaller time range.<br> <br> Include a 2-minute, overlapping buffer between requests. For example, if EndTimeTo was 6:58 in a prior request, the current request should use 6:56 in EndTimeFrom (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58). http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=222 GetSellerEvents Conditionally Describes the latest (most recent) date to use in a time range filter based on item end time. If you specify the corresponding From filter, but you do not include EndTimeTo, then EndTimeTo is set to the time you make the call. GetSellerEvents No Describes the earliest (oldest) date to use in a time range filter based on item modification time. Must be specified if ModTimeTo is specified. Either the StartTimeFrom, EndTimeFrom, or ModTimeFrom filter must be specified. If you do not specify the correspoding To filter, it is set to the time you make the call.<br> <br> Include a 2-minute, overlapping buffer between requests. For example, if ModTimeTo was 6:58 in a prior request, the current request should use 6:56 in ModTimeFrom (e.g., use ranges like 5:56-6:58, 6:56-7:58, 7:56-8:58). <br><br> For better results, the time range you use should be less than 48 hours. If 3000 or more items are found, use a smaller time range. <br><br> If an unexpected item is returned (including an old item or an unchanged active item), please ignore the item. Although a maintenance process may have triggered a change in the modification time, item characteristics are unchanged. http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=222 GetSellerEvents Conditionally Describes the latest (most recent) date and time to use in a time range filter based on the time an item's record was modified. If you specify the corresponding From filter, but you do not include ModTimeTo, then ModTimeTo is set to the time you make the call. Include a 2-minute buffer between the current time and the ModTimeTo filter. GetSellerEvents No Default is true. If true, response includes only items that have been modified within the ModTime range. If false, response includes all items. GetSellerEvents No Specifies whether to include WatchCount in Item nodes returned. WatchCount is the number of watches buyers have placed on the item from their My eBay accounts. GetSellerEvents No Specifies whether to force the response to include variation specifics for multi-variation listings. <br> <br> If false (or not specified), eBay keeps the response as small as possible by not returning Variation.VariationSpecifics. It only returns Variation.SKU as an identifier (along with the variation price and other selling details). If the variation has no SKU, then Variation.VariationSpecifics is returned as the variation's unique identifier.<br> <br> If true, Variation.VariationSpecifics is returned. (Variation.SKU is also returned, if the variation has a SKU.) This may be useful for applications that don't track variations by SKU.<br> <br> Ignored when HideVariations=true.<br> <br> Please note that if the seller includes a large number of variations in many listings, using this flag may degrade the call's performance. Therefore, when you use this flag, you may need to reduce the total number of items you're requesting at once. For example, you may need to use shorter time ranges in the EndTime, StartTime, or ModTime filters. false GetSellerEvents No Specifies whether to force the response to hide variation details for multi-variation listings.<br> <br> If false (or not specified), eBay returns variation details (if any). In this case, the amount of detail can be controlled by using IncludeVariationSpecifics.<br> <br> If true, variation details are not returned (and IncludeVariationSpecifics has no effect). This may be useful for applications that use other calls, notifications, alerts, or reports to track price and quantity details. false GetSellerEvents No Contains the items returned by the call. Items for which a seller event has occurred (and that meet any filters specified as input) are returned in an ItemArrayType object, within which are zero, one, or multiple ItemType objects. Each ItemType object contains the detail data for one item listing. Indicates the latest (most recent) date for any date-based filtering specified as input. Specifically, this field contains the value you specified in the StartTimeTo, EndTimeTo, or ModTimeTo filter, if you used a time filter in the request. If no time filter was specified, TimeTo returns the current time. GetSellerEvents

DetailLevel: none, ReturnAll

Always Collection of items whose last modified time matches the filters specified in the request. Returns empty if no items were modified within the time range of the request. If 1 to 2999 items are returned, then the results are complete. If 3000 or more items are returned, it usually means additional items exist within the time range you requested, but they were not all returned. To retrieve complete results, use a smaller time range in the request so that fewer than 3000 are returned per response. http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=222 GetSellerEvents

DetailLevel: none, ReturnAll

Always Returns a list of the items posted by the authenticated user, including the related item data. DetailLevel, GranularityLevel AddItem, GetBidderList, GetItem, RelistItem, ReviseItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetSellerList_BP http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BrowsingSellerItems GetBidderList Specifies the seller whose items will be returned. UserID is an optional input. If not specified, retrieves listings for the user identified by the authentication token passed in the request. Note that since user information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers looking for information about their own listings and bidders who know the user IDs of their sellers will be able to make this API call successfully. See <a href= "http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo" >Working with Anonymous User Information</a>in the eBay Web Services Guide for more information. GetSellerList No Specifies the list of Motors Dealer sellers for which a special set of metrics can be requested. Applies to eBay Motors Pro applications only. GetSellerList No Specifies the earliest (oldest) date to use in a date range filter based on item end time. Specify either an end-time range or a start-time range filter in every call request. Each of the time ranges must be a value less than 120 days. GetSellerList Conditionally Specifies the latest (most recent) date to use in a date range filter based on item end time. Must be specified if EndTimeFrom is specified. GetSellerList Conditionally Specifies the order in which returned items are sorted (based on the end dates of the item listings). Valid values: <br> 0 = No sorting<br> 1 = Sort in descending order<br> 2 = Sort in ascending order<br> GetSellerList No Specifies the earliest (oldest) date to use in a date range filter based on item start time. Each of the time ranges must be a value less than 120 days. In all calls, at least one date-range filter must be specified (i.e., you must specify either the end time range or start time range in every request). GetSellerList Conditionally Specifies the latest (most recent) date to use in a date range filter based on item start time. Must be specified if StartTimeFrom is specified. GetSellerList Conditionally Contains the data controlling the pagination of the returned values. If you set a DetailLevel in this call, you must set pagination values. The Pagination field contains the number of items to be returned per page of data (per call), and the page number to return with the current call. GetSellerList Yes Specifies the subset of item and user fields to return. See GetSellerList in the eBay Web Services guide for a list of the fields that are returned for each granularity level. For GetSellerList, use DetailLevel or GranularityLevel in a request, but not both. For GetSellerList, if GranularityLevel is specified, DetailLevel is ignored. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetSellerList_BP Yes GetSellerList No Container for a set of SKUs. Filters (reduces) the response to only include active listings that the seller listed with any of the specified SKUs. If multiple listings include the same SKU, they are all returned (assuming they also match the other criteria in the GetSellerList request).<br> <br> SKUArray can be used to retrieve items listed by the user identified in AuthToken or in UserID.<br> <br> <span class="tablenote"><b>Note:</b> Listings with matching SKUs are returned regardless of their Item.InventoryTrackingMethod settings. </span> GetSellerList No Specifies whether to include WatchCount in Item nodes returned. WatchCount is only returned with DetailLevel ReturnAll. GetSellerList No Specifies whether to return only items that were administratively ended based on a policy violation. GetSellerList No The category ID for the items retrieved. If you specify CategoryID in a GetSellerList call, the response contains only items in the category you specify. GetSellerList No If true, the Variations node is returned for all multi-variation listings in the response.<br> <br> Please note that if the seller includes a large number of variations in many listings, using this flag may degrade the call's performance. Therefore, when you use this flag, you may need to reduce the total number of items you're requesting at once. For example, you may need to use shorter time ranges in the EndTime or StartTime filters, fewer entries per page in Pagination, and/or SKUArray. GetSellerList No Contains a list of the items listed by the seller specified as input. The list of items is returned in an ItemArrayType object, in which are returned zero, one, or multiple ItemType objects. Each ItemType object contains the detail data for one item listing. Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. GetSellerList

DetailLevel: none, ItemReturnDescription, ReturnAll

Always If true, there are more items yet to be retrieved. Additional GetSellerList calls with higher page numbers or more items per page must be made to retrieve these items. Not returned if no items match the request. GetSellerList

DetailLevel: none, ItemReturnDescription, ReturnAll

Conditionally Contains the list of the seller's items, one ItemType object per item. Returns empty if no items are available that match the request. GetSellerList

DetailLevel: none, ItemReturnDescription, ReturnAll

Always Indicates the number of items that are being returned per page of data (i.e., per call). Will be the same as the value specified in the Pagination.EntriesPerPage input. Only returned if items are returned. GetSellerList

DetailLevel: none, ItemReturnDescription, ReturnAll

Conditionally Indicates which page of data was just returned. Will be the same as the value specified in the Pagination.PageNumber input. (If the input is higher than the total number of pages, the call fails with an error.) Only returned if items are returned. GetSellerList

DetailLevel: none, ItemReturnDescription, ReturnAll

Conditionally Indicates the total number of items returned (i.e., the number of ItemType objects in ItemArray). GetSellerList

DetailLevel: none, ItemReturnDescription, ReturnAll

Always Indicates the seller whose items are returned. The seller is the eBay member whose UserID was passed in the request. If UserID was not specified, the seller is the user who made the request (identified by eBayAuthToken). GetSellerList

DetailLevel: none, ItemReturnDescription, ReturnAll

GranularityLevel: Fine

Always <b>Half.com only.</b>&nbsp;Retrieves a summary of pending or paid payments that Half.com created for the seller identified by the authentication token in the request. Only retrieves payments that occurred within a particular pay period. Each payment is for one order line item in one order. An order can contain order line items for multiple items from multiple sellers, but this call only retrieves payments that are relevant to one seller. The financial value of a payment is typically based on an amount that a buyer paid to Half.com for an order line item, with adjustments for shipping costs and Half.com's commission. For most sellers, each month contains two pay periods: One from the 1st to the 15th of the month, and one from the 16th to the last day of the month. Sellers can refer to their account information on the Half.com site to determine their pay periods. (You cannot retrieve a seller's pay periods by using eBay Web Services.) When a buyer makes a purchase and an order is created, Half.com creates a payment for the seller and marks it as Pending in the seller's Half.com account. Within a certain number of days after the pay period ends, Half.com settles payments for that period and marks each completed payment as Paid. See the Half.com Web site online help for more information about how payments are managed. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=HalfOverview Filter to retrieve only items with the specified payment status (Paid or Pending). "Pending payments" are payments that Half.com has created but that have not yet been sent to the seller's financial institution. Pending payments are typically available once a buyer pays for an order. As Half.com processes payments by using periodic batch jobs, the GetSellerPayments response might not include an order line item's payment for up to 20 minutes after the buyer has paid. You can retrieve pending payments for the current pay period. Pending payments that have not been settled yet can also be retrieved for previous pay periods. "Paid payments" are payments that Half.com processed during previous pay periods. Paid payments might not appear in the seller's financial institution account balance until a certain number of days after the current pay period ends (see the Half.com online help for details). You can only retrieve paid payments for one previous pay period at a time. GetSellerPayments Canceled Yes Time range filter that retrieves Half.com payments that were created within a single pay period. Sellers can refer to the Half.com site to determine their pay periods. PaymentTimeFrom is the earliest (oldest) time and PaymentTimeTo is the latest (most recent) time in the range. Half.com pay periods start and end at midnight Pacific time, but the time values are stored in the database in GMT (not Pacific time). See "Time Values" in the eBay Web Services guide for information about converting between GMT and Pacific time. <br> <br> If you specify a PaymentStatus of Pending, add a buffer of one hour (or one day) to both ends of the time range to retrieve more data than you need, and then filter the results on the client side as needed. If any pending payments match the request, the response may include all payments since the beginning of the period. <br> <br> If you specify a PaymentStatus of Paid, the time range must contain one full pay period. That is, PaymentTimeFrom must be earlier or equal the start time of the pay period, and PaymentTimeTo must be later than or equal to the end time of the pay period. Otherwise, no paid payments are returned. For example, if the pay period starts on 2005-09-16 and ends on 2005-09-30, you could specify an earlier PaymentTimeFrom value of 2005-09-16T00:00:00.000Z and a later PaymentTimeTo value of 2005-10-01T12:00:00.000Z. <br> <br> If you specify a time range that covers two pay periods, only the payments from the most recent pay period are returned. The earliest time you can specify is 18 months ago. GetSellerPayments Yes Time range filter that retrieves Half.com payments for a single pay period. See the description of PaymentTimeTo for details about using this time range filter. For paid payments, this value should be equal to or later than the end of the last day of the pay period, where the time is converted to GMT. For example, if the period ends on 2005-09-30, you could specify 2005-10-01T09:00:00.000Z, which is later than the end of the last day. GetSellerPayments Yes If many payments are available, you may need to call GetSellerPayments multiple times to retrieve all the data. Each result set is returned as a page of entries. Use this Pagination information to indicate the maximum number of entries to retrieve per page (i.e., per call), the page number to retrieve, and other data. GetSellerPayments No Returns a summary of pending or paid payments that Half.com created for the seller identified by the authentication token in the request. Only returns payments that occurred within a particular pay period. Each payment is for one transaction for one item in one order. An order can contain transactions for multiple items from multiple sellers, but this call only retrieves payments that are relevant to one seller. Payments are only issued for items and transactions that the seller has confirmed (see the Half.com online help for details). The financial value of a payment is typically based on an amount that a buyer paid to Half.com for a transaction, plus the shipping cost the buyer paid to Half.com for the item, minus Half.com's commission. For most sellers, each month contains two pay periods: One from the 1st to the 15th of the month, and one from the 16th to the last day of the month. Payments are submitted to the seller's financial institution a certain number of days after the current pay period ends (see the Half.com online help for details). Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. GetSellerPayments Always If true, there are more payments yet to be retrieved. Additional GetSellerPayments calls with higher page numbers or more entries per page must be made to retrieve these payments. If false, no more payments are available or no payments match the request (based on the payment status and time filter). GetSellerPayments Always Information about a single payment that matches the criteria in the request. A payment is between Half.com and a seller. Each payment is for one transaction for one item in one order. An order can contain transactions for multiple items from multiple sellers, but this call only retrieves payments that are relevant to one seller. The financial value of a payment is typically based on an amount that a buyer paid to Half.com for a transaction, plus the shipping cost the buyer paid for the item, minus Half.com's commission. Payments can also describe refunds that the seller has issued. Multiple SellerPayment entries can be returned per page of results. Typically, they are returned in reverse chronological order (most recent PaidTime first). Only returned if payments exist that match the request. GetSellerPayments Conditionally Indicates the number of payments that can be returned per page of data (i.e., per call). This is the same as the value specified in the Pagination.EntriesPerPage input (or the default value, if EntriesPerPage was not specified). This is not necessarily the actual number of payments returned per page (see ReturnedPaymentCountActual). GetSellerPayments Always Indicates which page of data holds the current result set. Will be the same as the value specified in the Pagination.PageNumber input. (If the input is higher than the total number of pages, the call fails with an error.) If no payments are returned, the value is 0. If payments are returned, the first page number is 1. GetSellerPayments Always Indicates the total number of payments returned (i.e., the number of SellerPayment entries returned. GetSellerPayments Always Retrieves order line item (transaction) information for the user for which the call is made, and not for any other user.&nbsp;<b>Also for Half.com</b>. (To retrieve order line items for another seller's listings, use GetItemTransactions.)

Retrieves order line item (transaction) information for the user for which the call is made, and not for any other user.&nbsp;<b>Also for Half.com</b>. (To retrieve order line items for another seller's listings, use GetItemTransactions.)

DetailLevel GetItemTransactions, GetOrderTransactions http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EmailPrivacyPolicy the conditions under which buyer and seller email and address are returned http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RetrievingTransactionsForSpecificSeller The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the seller. The ModTimeFrom field is the starting date range. All of the seller's order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. This field is not applicable if the NumberOfDays date filter is used. <br><br> If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays time filter is used and it defaults to 30 (days). GetSellerTransactions No The ModTimeFrom and ModTimeTo fields specify a date range for retrieving order line items associated with the seller. The ModTimeTo field is the ending date range. All of the seller's order line items that were last modified within this date range are returned in the output. The maximum date range that may be specified is 30 days. If the ModTimeFrom field is used and the ModTimeTo field is omitted, the ModTimeTo value defaults to the present time or to 30 days past the ModTimeFrom value (if ModTimeFrom value is more than 30 days in the past). This field is not applicable if the NumberOfDays date filter is used. <br><br> If you don't specify a ModTimeFrom/ModTimeTo filter, the NumberOfDays time filter is used and it defaults to 30 (days). GetSellerTransactions No Child elements control pagination of the output. Use EntriesPerPage property to control the number of transactions to return per call and PageNumber property to specify the page of data to return. GetSellerTransactions No Indicates whether to include Final Value Fee (FVF) in the response. For most listing types, the Final Value Fee is returned in Transaction.FinalValueFee. The Final Value Fee is returned for each order line item. <br> GetSellerTransactions No Include this field and set it to True if you want the ContainingOrder container to be returned in the response under each Transaction node. For single line item orders, the ContainingOrder.OrderID value takes the value of the OrderLineItemID value for the order line item. For Combined Payment orders, the ContainingOrder.OrderID value will be shared by at least two order line items (transactions) that are part of the same order. false GetSellerTransactions No Container for a set of SKUs. Filters (reduces) the response to only include order line items for listings that include any of the specified SKUs. If multiple listings include the same SKU, order line items for all of them are returned (assuming they also match the other criteria in the GetSellerTransactions request).<br> <br> You can combine SKUArray with InventoryTrackingMethod. For example, if you also pass in InventoryTrackingMethod=SKU, the response only includes order line items for listings that include InventoryTrackingMethod=SKU and one of the requested SKUs. GetSellerTransactions No Name of the eBay co-branded site upon which the order line item was made. This will serve as a filter for the order line items to get emitted in the response. GetSellerTransactions No NumberOfDays enables you to specify the number of days' worth of new and modified order line items that you want to retrieve. The call response contains the order line items whose status was modified within the specified number of days since the API call was made. NumberOfDays is often preferable to using the ModTimeFrom and ModTimeTo filters because you only need to specify one value. If you use NumberOfDays, then ModTimeFrom and ModTimeTo are ignored. For this field, one day is defined as 24 hours. 30 GetSellerTransactions No Filters the response to only include order line items for listings that match this InventoryTrackingMethod setting. <br> <br> For example, if you set this to SKU, the call returns order line items for your listings that are tracked by SKU. If you set this to ItemID, the call omits order line items for your listings that are tracked by SKU. If you don't pass this in, the call returns all order line items, regardless of whether they are tracked by SKU or ItemID.<br> <br> <span class="tablenote"><b>Note:</b> To specify InventoryTrackingMethod when you create a listing, use AddFixedPriceItem or RelistFixedPriceItem. AddFixedPriceItem and RelistFixedPriceItem are defined in the Merchant Data API (part of Large Merchant Services). </span> <br> <br> You can combine SKUArray with InventoryTrackingMethod. For example, if you set this to SKU and you also pass in SKUArray, the response only includes order line items for listings that include InventoryTrackingMethod=SKU and one of the requested SKUs. GetSellerTransactions No Returns an array of order line item (transaction) data for the seller specified in the request. The results can be used to create a report of data that is commonly necessary for order processing. Zero, one, or many <b>Transaction</b> objects can be returned in the <b>TransactionArray</b>. The set of order line items returned is limited to those that were modified between the times specified in the request's <b>ModTimeFrom</b> and <b>ModTimeTo</b> filters. The order line items returned are sorted by <b>Transaction.Status.LastTimeModified</b>, ascending order (that is, order line items that more recently were modified are returned last). Also returns information about the seller whose order line items were requested. If pagination filters were specified in the request, returns meta-data describing the effects of those filters on the current response and the estimated effects if the same filters are used in subsequent calls. Contains the total number of pages (<b>TotalNumberOfPages</b>) and the total number of entries (<b>TotalNumberOfEntries</b>) that could be returned given repeated calls that use the same selection criteria as the call that returned this response. GetSellerTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Indicates whether there are additional order line items (transactions) to retrieve. That is, indicates whether more pages of data are available to be returned, given the filters that were specified in the request. Returns false for the last page of data. GetSellerTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Number of order line items returned per page (per call). May be a higher value than <b>ReturnedTransactionCountActual</b> if the page returned is the last page and more than one page of data exists. GetSellerTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Page number for the page of order line items the response returned. GetSellerTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Number of order line items retrieved in the current page of results just returned. May be a lower value than <b>TransactionsPerPage</b> if the page returned is the last page and more than one page of data exists. GetSellerTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Contains information about the seller whose order line items are being returned. See the reference guide for information about the <b>Seller</b> object fields that are returned. GetSellerTransactions

DetailLevel: none, ReturnAll

Always List of <b>Transaction</b> objects representing the seller's recent sales. Each <b>Transaction</b> object contains the data for one purchase (of one or more items in the same listing). See the reference guide for more information about the fields that are returned for each order line item. GetSellerTransactions

DetailLevel: none, ReturnAll

Conditionally Indicates whether the seller has the preference enabled that shows that the seller prefers PayPal as the method of payment for an item. This preference is indicated on an item's View Item page and is intended to influence a buyer to use PayPal to pay for the item. GetSellerTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Retrieves Selling Manager alerts. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Returns alerts for a Selling Manager user. Contains the list of alerts issued for Selling Manager. GetSellingManagerAlerts Conditionally Retrieves a log of emails sent, or scheduled to be sent, to buyers. <br><br> The standard Trading API deprecation process is not applicable to this call.

Retrieves a log of emails sent, or scheduled to be sent, to buyers. Includes success or failure status.

AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Unique identifier for the eBay item listing associated with the Selling Manager email log. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> value is specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields must be used to identify the Selling Manager email log to retrieve. You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are returned under the <b>SellingManagerSoldTransaction</b> container of the <b>GetSellingManagerSoldListings</b> request. GetSellingManagerEmailLog Conditionally Unique identifier for the order line item (transaction) associated with the Selling Manager email log. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> value is specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields must be used to identify the Selling Manager email log to retrieve. You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are returned under the <b>SellingManagerSoldTransaction</b> container of the <b>GetSellingManagerSoldListings</b> request. GetSellingManagerEmailLog No A unique identifier that identifies a single line item or multiple line item (Combined Payment) order associated with the Selling Manager email log. <br><br> For a single line item order, the <b>OrderID</b> value is identical to the <b>OrderLineItemID</b> value that is generated upon creation of the order line item. For a Combined Payment order, the <b>OrderID</b> value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Payment order through the eBay site (or when the seller creates Combined Payment order through <b>AddOrder</b>). If an <b>OrderID</b> is used in the request, the <b>OrderLineItemID</b> and <b>ItemID</b>/<b>TransactionID</b> pair are not required. 50 GetSellingManagerEmailLog No Specifies the earliest (oldest) and latest (most recent) dates to use in a date range filter based on email sent date. Each of the time ranges can be up to 90 days. GetSellingManagerEmailLog No A unique identifier for an eBay order line item that is associated with the Selling Manager email log. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are returned under the <b>SellingManagerSoldTransaction</b> container of the <b>GetSellingManagerSoldListings</b> request. Unless an <b>OrderID</b> or an <b>ItemID</b>/<b>TransactionID</b> pair is specified in the <b>GetSellingManagerSaleRecord</b> request, the <b>OrderLineItemID</b> is required. <br> 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) GetSellingManagerEmailLog Conditionally Returns the log of emails not sent. Email logs associated with this order. GetSellingManagerEmailLog Always Retrieves a paginated list containing details of a user's Selling Manager inventory. This call is subject to change without notice; the deprecation process is inapplicable to this call.

Retrieves a paginated listing of a user's Selling Manager inventory.

AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Sets the sorting method for the results. GetSellingManagerInventory No Specifies the inventory folder containing the requested inventory information. GetSellingManagerInventory No Details about how many Products to return per page and which page to view. GetSellingManagerInventory No Order to be used for sorting retrieved product lists. GetSellingManagerInventory No Specifies types and values to search for in the seller's listings. GetSellingManagerInventory No Specifies a store category whose products will be returned. GetSellingManagerInventory No Container for the list of filters that can be applied to the inventory information requested. GetSellingManagerInventory No Contains a list of the products created by the seller. The list of products is returned as a set of tags, in which are returned zero, one, or multiple SellingManagerProductType objects. Each SellingManagerProductType object contains the information about for one Selling Manager product and any Selling Manager templates the product contains. Returns the date the inventory counts were last calculated. GetSellingManagerInventory Conditionally Container for information about the requested products and templates. GetSellingManagerInventory Conditionally Contains the total number of pages (TotalNumberOfPages) and the total number of products entries (TotalNumberOfEntries) that can be returned on repeated calls with the same format and report criteria. GetSellingManagerInventory Conditionally Retrieves Selling Manager inventory folders. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro If a FolderID is submitted, all child-folders below this folder will be returned. GetSellingManagerInventoryFolder No Specifies the number of levels of subfolders to be returned. If 0, the parent folder is returned. If 1, the parent and child folders are returned. If 2, the parent and two levels of child folders are returned. Ignored if FullRecursion is set to True. 1 GetSellingManagerInventoryFolder No Displays the entire tree of a user's folders. If this is provided, FolderID and MaxDepth need not be given. GetSellingManagerInventoryFolder No Returns the folder structure of the input folderID. Details of the requested folder. GetSellingManagerInventoryFolder Always Retrieves the set of Selling Manager automation rules associated with an item. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro SetSellingManagerItemAutomationRule The ID of the item whose Selling Manager automation rules you want to retrieve. GetSellingManagerItemAutomationRule Yes Contains the set of automation rules associated with the specified item. The information for the automated listing rule associated with the item. This field is only returned if the item was listed from a template. The value in this field refers to that template's automated listing rule. GetSellingManagerItemAutomationRule Conditionally The information for the automated relisting rule associated with the item. GetSellingManagerItemAutomationRule Conditionally The information for the automated second chance offer rule associated with the item. GetSellingManagerItemAutomationRule Conditionally Contains fees that may be incurred when items are listed using the automation rule (e.g., a scheduled listing fee). Use of an automation rule does not in itself have a fee, but use can result in a fee. GetSellingManagerItemAutomationRule Conditionally Retrieves the data for one or more Selling Manager sale records. <br><br> The standard Trading API deprecation process is not applicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Unique identifier for the eBay item listing associated with the Selling Manager sale record. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> value is specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields must be used to identify the Selling Manager sale record to retrieve. You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are returned under the <b>SellingManagerSoldTransaction</b> container of the <b>GetSellingManagerSoldListings</b> request. GetSellingManagerSaleRecord Conditionally Unique identifier for the order line item (transaction) associated with the Selling Manager sale record. Unless the <b>OrderID</b> or <b>OrderLineItemID</b> value is specified in the request, the <b>ItemID</b> and <b>TransactionID</b> fields must be used to identify the Selling Manager sale record to retrieve. You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are returned under the <b>SellingManagerSoldTransaction</b> container of the <b>GetSellingManagerSoldListings</b> request. GetSellingManagerSaleRecord Conditionally A unique identifier that identifies a single line item or multiple line item (Combined Payment) order associated with the Selling Manager sale record(s). <br><br> For a single line item order, the <b>OrderID</b> value is identical to the <b>OrderLineItemID</b> value that is generated upon creation of the order line item. For a Combined Payment order, the <b>OrderID</b>value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Payment order through the eBay site (or when the seller creates Combined Payment order through <b>AddOrder</b>). If an <b>OrderID</b> is used in the request, the <b>OrderLineItemID</b> and <b>ItemID</b>/<b>TransactionID</b> pair are not required. GetSellingManagerSaleRecord Conditionally A unique identifier for an eBay order line item that is associated with the Selling Manager sale record. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. You can use <b>GetSellingManagerSoldListings</b> to retrieve the <b>ItemID</b>, <b>TransactionID</b> or <b>OrderLineItemID</b> values that correspond to the Selling Manager sale record (<b>SaleRecordID</b>). All four of these fields are returned under the <b>SellingManagerSoldTransaction</b> container of the <b>GetSellingManagerSoldListings</b> request. Unless an <b>OrderID</b> or an <b>ItemID</b>/<b>Transaction</b> pair is specified in the <b>GetSellingManagerSaleRecord</b> request, the <b>OrderLineItemID</b> is required. <br> 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) GetSellingManagerSaleRecord Conditionally Response to a GetSellingManagerSaleRecord call. Contains the data in a Selling Manager sale record. GetSellingManagerSaleRecord Always Returns a Selling Manager user's sold listings. <br><br> This call is subject to change without notice; the deprecation process is inapplicable to this call.

Retrieves information about items that a seller has sold.

AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Search filters for sold listings. GetSellingManagerSoldListings No Listings with this store category ID will be listed. GetSellingManagerSoldListings No This holds the list of filters that can be applicable for sold listings. GetSellingManagerSoldListings No Requests listing records that are more than 90 days old. Records are archived between 90 and 120 days after being created, and thereafter can only be retrieved using this tag. GetSellingManagerSoldListings No Field to be used to sort the response. GetSellingManagerSoldListings No Order to be used for sorting the requested listings. GetSellingManagerSoldListings No Details about how many listings to return per page and which page to view. GetSellingManagerSoldListings No Specifies the earliest (oldest) and latest (most recent) dates to use in a date range filter based on item start time. A time range can be up to 120 days. GetSellingManagerSoldListings No Returns a Selling Manager user's sold listings. Response can be filtered by date, search values, and stores. Returns a Selling Manager user's sold listings. GetSellingManagerSoldListings Always Contains the total number of pages (TotalNumberOfPages) and the total number of products entries (TotalNumberOfEntries) that can be returned on repeated calls with the same format and report criteria. GetSellingManagerSoldListings Always Retrieves the set of Selling Manager automation rules associated with a Selling Manager template. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates,SetSellingManagerTemplateAutomationRule http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro SetSellingManagerTemplateAutomationRule The ID of the Selling Manager template whose Selling Manager automation rules you want to retrieve. You can obtain a SaleTemplateID by calling GetSellingManagerInventory. GetSellingManagerTemplateAutomationRule Yes Contains the set of automation rules associated with the specified template. The information for the automated listing rule associated with the template. GetSellingManagerTemplateAutomationRule Conditionally The information for the automated relisting rule associated with the template. GetSellingManagerTemplateAutomationRule Conditionally The information for the automated second chance offer rule associated with the template. GetSellingManagerTemplateAutomationRule Conditionally Contains fees that may be incurred when items are listed using the automation rule (e.g., a scheduled listing fee). Use of an automation rule does not in itself have a fee, but use can result in a fee. GetSellingManagerTemplateAutomationRule Conditionally Retrieves Selling Manager templates. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro The ID of the template whose data will be returned. A SaleTemplateID is the ID of a Selling Manager template. A Selling Manager template contains the data needed to list an item. One or more template IDs can be specified, each in its own container. You can obtain a SaleTemplateID by calling GetSellingManagerInventory. GetSellingManagerTemplates Yes Contains the templates requested on input. Each SellingManagerTemplateType object in the response contains the data for one Selling Manager template. Contains the data of the templates requested on input. A Selling Manager template contains the data needed to list an item. Empty if no items are available that match the request. GetSellingManagerTemplates Always Retrieves a session ID that identifies a user and your application when you make a FetchToken request. ConfirmIdentity, FetchToken, GetTokenStatus, RevokeToken http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingAToken http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingATokenViaFetchToken http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RuName The runame provided must match the one that will be used for validation during the creation of a user token. GetSessionID Yes Contains the generated SessionID, which is a unique identifier for authenticating data entry during the process that creates a user token. A 40-character identifier supplied by eBay to an application. Used to confirm the identities of the user and the application in a URL redirect during the process in which the user agrees to let the application wield a user token that grants the application the right to access eBay data on behalf of the user. Subsequently also used as input for the FetchToken API call. The SessionID is valid for five minutes after it is retrieved. GetSessionID Always Returns the shipping discount profiles defined by the user, along with other combined payment-related details such as packaging and handling costs. AddItem, GetItem, RelistItem, RevisteItem, SetShippingDiscountProfiles, VerifyAddItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles Response to call of GetShippingDiscountProfiles. The ID of the currency to be used for shipping cost discounts and insurance for combined payment. A discount profile can only be associated with a listing if the currency ID of the profile matches the currency ID of the listing. GetShippingDiscountProfiles Always Details of an individual discount profile defined by the user for flat rate shipping--one for each profile defined by the user. Empty if no shipping discount profiles were defined. GetShippingDiscountProfiles Always Details of an individual discount profile defined by the user for calculated shipping--one for each profile defined by the user. Empty if no shipping discount profiles were defined. GetShippingDiscountProfiles Always Indicates whether the user defined a promotional discount (the discount is active as soon as it exists). GetShippingDiscountProfiles Always The data for the specific packaging/handling details for combined payment. Returned only if it has been defined. GetShippingDiscountProfiles Conditionally The data for the specific promotional shipping discount. Returned only if it has been defined. GetShippingDiscountProfiles Conditionally The data for the domestic insurance for combined payment. Returned only if it has been defined. GetShippingDiscountProfiles Conditionally The data for the international insurance for combined payment. Returned only if it has been defined. GetShippingDiscountProfiles Conditionally This field indicates the number of days after the sale of an item in which the buyer or seller can combine multiple and mutual order line items into one Combined Payment order. In a Combined Payment order, the buyer makes one payment for all order line items, hence only unpaid order line items can be combined into a Combined Payment order. GetShippingDiscountProfiles Always Retrieves configuration information for the eBay store owned by the specified UserID, or by the caller. GetStoreCategoryUpdateStatus, GetStoreCustomPage, GetStoreOptions, SetStore, SetStoreCategories, SetStoreCustomPage http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingeBayStores http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EditingStoreSettings If this is set to True, only the category structure of the store is returned. If this is not specified or set to False, the complete store configuration is returned. GetStore Conditionally Specifies the category ID for the topmost category to return (along with the subcategories under it, the value of the LevelLimit property determining how deep). This tag is optional. If RootCategoryID is not specified, then the category tree starting at that root Category is returned. GetStore Conditionally Specifies the limit for the number of levels of the category hierarchy to return, where the given root category is level 1 and its children are level 2. Only categories at or above the level specified are returned. This tag is optional. If LevelLimit is not set, the complete category hierarchy is returned. Stores support category hierarchies up to 3 levels only. GetStore Conditionally Specifies the user whose store data is to be returned. If not specified, then the store returned is that for the requesting user. GetStore No Returns the data describing a seller's eBay store, including name, description, URL, and other information. The caller making the request must be the owner of an eBay store. If the authenticated caller does not have an eBay store, the response is an error. A successful response contains either the complete store configuration or information about the category hierarchy for the store only. The data describing the store configuration. GetStore Always Returns the status of the processing for category-structure changes specified with a call to SetStoreCategories. GetStore, SetStore, SetStoreCategories http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingeBayStores The task ID returned by the SetStoreCategories call. If the SetStoreCategories call was processed asynchronously, the TaskID will be a positive number. If SetStoreCategories returned a TaskID with a value of 0, the change was completed at the time the call was made (and there is no need to check status). GetStoreCategoryUpdateStatus Yes Returns the store category structure update status, when a prior SetStoreCategories call was processed asynchronously. If a SetStoreCategories request affects many listings, then the category structure changes will be processed asynchronously. If not many listings are affected by category structure changes, the status is returned in the SetStoreCategories response. The status (Pending, InProgress, Complete, or Failed) of an update to the store category structure. GetStoreCategoryUpdateStatus Always Retrieves the custom page or pages for the authenticated user's Store. GetStoreOptions, GetStore, SetStore, SetStoreCustomPage http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingCustomPages http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingeBayStores If a PageID is specified, then that page is returned, and the returned page contains the page Content. If no PageID is specified, then all pages are returned, without the page Content. GetStoreCustomPage No Contains the custom page or pages for the user's Store. The custom page or custom pages. GetStoreCustomPage Always Retrieves the current list of eBay store configuration settings. GetStore http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EditingStoreSettings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingeBayStores Contains the current list of options for Store configurations. The current set of basic themes. Each basic theme definition specifies a valid color scheme for the theme. GetStoreOptions Always The current set of advances themes. Unlike basic themes, you can use any color scheme with an advanced theme. These themes are suitable for more advanced customization. GetStoreOptions Always The current set of Store logos. These logos are used in the Store header. GetStoreOptions Always The current set of eBay Store subscription tiers and corresponding subscription prices. GetStoreOptions Always The maximum number of categories in this store. GetStoreOptions Always The maximum number of category levels in this store. GetStoreOptions Always Retrieves a user's Store preferences. SetStore, SetStorePreferences http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingeBayStores Contains the Store preferences retrieved for a user. The user's Store preferences. GetStorePreferences Always Returns a list of up to 10 categories that have the highest percentage of listings whose titles or descriptions contain the keywords you specify. AddItem, GetCategories, GetCategoryMappings, GetItemRecommendations http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByKeywords http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SuggestedCategories Specifies the search string, consisting of one or more words to search for in the listing title. The words "and" and "or" are treated like any other word. 350 (characters) GetSuggestedCategories Yes Returns a list of categories with the highest number of listings whose titles or descriptions contain the keywords specified in a GetSuggestedCategoriesRequest. Contains the categories that contain listings that match the query string in the request. The array can have up to 10 categories. Not returned if no categories match the query in the request. GetSuggestedCategories Conditionally Indicates the number of categories in the array. GetSuggestedCategories Always Retrieves the tax table for a user on a given site or retrieves the valid jurisdictions (if any) for a given site. SetTaxTable DetailLevel http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SalesTax Response to GetTaxTableRequest. The last time (in GMT) that the tax table was updated. Only returned if the user previously created a tax table and if the site has jurisdictions. LastUpdateTime is useful for synchronization. If you cache the user's tax table, you can use GetTaxTable to check if it has changed and whether you need to update the cached tax table. GetTaxTable

DetailLevel: ReturnAll, none

Conditionally A container of tax jurisdiction information unique to a user/site combination. Empty if not set for user. If DetailLevel is not specified, information is only returned for the jurisdictions for which the user provided tax information. If DetailLevel is ReturnAll, tax information is returned for all possible jurisdictions, whether specified by the user or not. ShippingIncludedInTax and SalesTaxPercent are returned but are empty. GetTaxTable

DetailLevel: ReturnAll, none

Always Requests current status of user token. FetchToken, RevokeToken Returns token status. Returns token status and details. For example, if revoked, whether by eBay, the user, or the application, and also when revoked. GetTokenStatus Always Retrieves data pertaining to a single eBay user. Callers can use this call to return their own user data or the data of another eBay user. Unless the caller passes in an ItemID that identifies a current or past common order, not all data (like email addresses) will be returned in the User object. DetailLevel GetAccount, GetFeedback, GetSellerDashboard,GetSellerEvents, GetSellerList, GetSellerTransactions, GetUserPreferences http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingUserInformationChapter Specify the item ID for a successfully concluded listing in which the requestor and target user were participants (one as seller and the other as buyer). Necessary to return certain data (like an email address). Not necessary if the requestor is retrieving their own data. ItemID is an optional input. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetUser No Specify the user whose data you want returned by the call. UserID is optional. If not specified, eBay returns data pertaining to the requesting user (as specified with the eBayAuthToken). GetUser No Indicates if the response should include detailed information relating to whether a user qualifies to list an item on Express. To list an item on Express, a user must qualify based on conditions described in the eBay Web Services Guide. 579 NoOp false GetUser No If IncludeFeatureEligibility is true, the response includes a FeatureEligibility node. (The FeatureEligibility node indicates whether the seller can list with certain features.) GetUser No Contains the data retrieved by the call. User data is returned in a User object. Contains the returned user data for the specified eBay user. GetUser

DetailLevel: none, ReturnSummary, ReturnAll

Always Returns contact information for a specified user, given that a bidding relationship (as either a buyer or seller) exists between the caller and the user. AddMemberMessagesAAQToBidder, DeleteMyMessages, GetMemberMessages, ReviseMyMessages, ReviseMyMessagesFolders An eBay item ID that uniquely identifies a currently active item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetUserContactDetails Yes An eBay ID that uniquely identifies a given user for whom the caller is seeking information. This is the user's eBay username. Either a seller's or bidder's username can be specified here, as long as a bidding relationship exists between the requester and the user specified by this field. That is, a bidder must be bidding on the seller's active item, or have made an offer on the item via Best Offer. GetUserContactDetails Yes An eBay ID that uniquely identifies the person who is making the call. This is the requester's eBay username. Either a seller's or bidder's username can be specified here, as long as a bidding relationship exists between the requester and the user for whom information is being requested. GetUserContactDetails Yes Returns contact information to a seller for both bidders and users who have made offers (via Best Offer) during an active listing. An eBay ID that uniquely identifies a given user. The eBay username of the requested contact. GetUserContactDetails Always Contact information for the requested contact. Note that the email address is NOT returned. GetUserContactDetails Always The date and time that the requested contact registered with eBay. GetUserContactDetails Always Requests a list of disputes the requester is involved in as buyer or seller. eBay Buyer Protection Item Not Received and Significantly Not As Described cases are not returned with this call. To retrieve eBay Buyer Protection cases, the getUserCases call of the Resolution Case Management API must be used instead.

Requests a list of disputes the requester is involved in as buyer or seller. eBay Buyer Protection Item Not Received and Significantly Not As Described cases are not returned with this call.

DetailLevel AddDispute, AddDisputeResponse, GetDispute, SellerReverseDispute http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BuyerDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingDetailsAboutADispute An inclusive filter that isolates the returned disputes to a certain type such as Item Not Received or Unpaid Item disputes. eBay Buyer Protection cases are not retrieved with this call, even if the ItemNotReceivedDisputes filter is included in the request. GetUserDisputes No The value and sequence to use to sort the returned disputes. GetUserDisputes No A filter that retrieves disputes whose DisputeModifiedTime is later than or equal to this value. Specify the time value in GMT. See the eBay Web Services documentation for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify ModTimeTo. Otherwise, the end of the date range is the present time. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned. GetUserDisputes No A filter that retrieves disputes whose DisputeModifiedTime is earlier than or equal to this value. Specify the time value in GMT. See the eBay Web Services documentation for information about specifying time values. For more precise control of the date range filter, it is a good practice to also specify ModTimeFrom. Otherwise, all available disputes modified prior to the ModTimeTo value are returned. Filtering by date range is optional. You can use date range filters in combination with other filters like DisputeFilterType to control the amount of data returned. GetUserDisputes No The virtual page number of the result set to display. A result set has a number of disputes divided into virtual pages, with 200 disputes per page. The response can only display one page. The first page in the result set is number 1. Required. If not specified, a warning is returned and Pagination.PageNumber is set to 1 by default. GetUserDisputes Yes Returns a list of disputes that involve the calling user as buyer or seller, in response to a GetUserDisputesRequest. The index of the first dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns a StartingDisputeID value of 1 and the second page returns a StartingDisputeID value of 201. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always The index of the last dispute in the current result set, relative to the total number of disputes available. Primarily useful for interpreting paginated results. For example, if 228 disputes are available and 200 results are returned per page: The first page returns an EndingDisputeID value of 200 and the second page returns an EndingDisputeID value of 228. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always The array of disputes returned. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always The number of disputes on each virtual page in the result set. The virtual page returned is determined by PageNumber. Default is 200. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always The page of the total result set returned in the call. The entire result set is virtual and the call returns only one page of it. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always The number of disputes that involve the requester as buyer or seller and match a given filter type. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always The result of the pagination, including the total number of virtual pages in the result set and the total number of disputes returned. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always Retrieves the specified user preferences for the authenticated caller. SetUserPreferences http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingUserPreferences If included and set to true, the seller's preference for receiving contact information for unsuccessful bidders is returned in the response. false GetUserPreferences No If included and set to true, the seller's combined payment preferences are returned in the response. <br><br> <span class="tablenote"><strong>Note:</strong> The CombinedPaymentPreferences.CombinedPaymentOption field is the only preference that should be managed with the GetUserPreferences and SetUserPreferences calls. All other Combined Payment preferences should be managed with the SetDiscountProfiles and GetDiscountProfiles calls. </span> false GetUserPreferences No If included and set to true, the seller's cross-promotion preferences are returned in the response. These preferences are only applicable for eBay Store owners. false GetUserPreferences No If included and set to true, the seller's payment preferences are returned in the response. false GetUserPreferences No If included and set to true, the seller's preferences for the end-of-auction email sent to the winning bidder is returned in the response. These preferences are only applicable for auction listings. false GetUserPreferences No If included and set to true, the seller's favorite item preferences are returned in the response. false GetUserPreferences No If included and set to true, the seller's ProStores preferences are returned in the response. false GetUserPreferences No If included and set to true, the seller's preference for sending an email to the buyer with the shipping tracking number is returned in the response. false GetUserPreferences No If included and set to true, the seller's preference for requiring that the buyer supply a shipping phone number upon checkout is returned in the response. Some shipping carriers require the receiver's phone number. false GetUserPreferences No If included and set to true, all of the seller's excluded shipping locations are returned in the response. The returned list mirrors the seller's current Exclude shipping locations list in My eBay's Shipping Preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq). Sellers can override these default settings for an individual listing by using the Item.ShippingDetails.ExcludeShipToLocation field in the AddItem family of calls. false GetUserPreferences No If included and set to true, the seller's Unpaid Item Assistant preferences are returned in the response. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller. <br><br> <span class="tablenote"><strong>Note:</strong> To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the ShowUnpaidItemAssistanceExclusionList field must also be included and set to true in the request. Excluded buyers can be viewed in the UnpaidItemAssistancePreferences.ExcludedUser field. </span> false GetUserPreferences No If included and set to true, the seller's preference for sending a purchase reminder email to buyers is returned in the response. false GetUserPreferences No If included and set to true, the list of eBay user IDs on the Unpaid Item Assistant Excluded User list is returned through the UnpaidItemAssistancePreferences.ExcludedUser field in the response. For excluded users, an Unpaid Item dispute is not automatically filed through the UPI Assistance mechanism. The Excluded User list is managed through the SetUserPreferences call. <br><br> <span class="tablenote"><strong>Note:</strong> To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the ShowUnpaidItemAssistancePreference field must also be included and set to true in the request. </span> false GetUserPreferences No If included and set to true, the seller's Business Policies profile information is returned in the response. <br><br> <span class="tablenote"><strong>Note:</strong> Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings. </span> false GetUserPreferences No Contains some or all of the authenticated user's preferences. The preferences are grouped in sets and are returned according to the flag settings in the request. Container consisting of the seller's preference for receiving contact information for unsuccessful bidders. This container is returned when ShowBidderNoticePreferences is included and set to true in the request. This preference is only applicable for auction listings. GetUserPreferences Conditionally Container consisting of the seller's Combined Payment preferences. This container is returned when ShowCombinedPaymentPreferences is included and set to true in the request. <br> <span class="tablenote"><strong>Note:</strong> The CombinedPaymentPreferences.CombinedPaymentOption field is the only preference that should be managed with the GetUserPreferences and SetUserPreferences calls. All other Combined Payment preferences should be managed with the SetDiscountProfiles and GetDiscountProfiles calls. </span> GetUserPreferences Conditionally Container consisting of the seller's cross-promotion preferences. This container is returned when ShowCrossPromotionPreferences is included and set to true in the request. These preferences are only applicable for eBay Store owners. GetUserPreferences Conditionally Container consisting of the seller's payment preferences. This container is returned when ShowSellerPaymentPreferences is included and set to true in the request. GetUserPreferences Conditionally Container consisting of the seller's preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. This container is returned when ShowSellerFavoriteItemPreferences is included and set to true in the request. GetUserPreferences Conditionally Container consisting of the seller's preferences for the end-of-auction email sent to the winning bidder. This container is returned when ShowEndOfAuctionEmailPreferences is included and set to true in the request. These preferences are only applicable for auction listings. GetUserPreferences Conditionally Container consisting of the seller's preference for sending an email to the buyer with the shipping tracking number. This container is returned when ShowEmailShipmentTrackingNumberPreference is included and set to true in the request. GetUserPreferences Conditionally Container consisting of the seller's preference for requiring that the buyer supply a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number. This container is returned when ShowRequiredShipPhoneNumberPreference is included and set to true in the request. GetUserPreferences Conditionally Container consisting of the seller's ProStores preferences. This container is returned when ShowProStoresPreference is included and set to true in the request. GetUserPreferences Conditionally Container consisting of a seller's Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller. This container is returned if ShowUnpaidItemAssistancePreference is included and set to true in the request. <br> <span class="tablenote"><strong>Note:</strong> To return the list of buyers excluded from the Unpaid Item Assistant mechanism, the ShowUnpaidItemAssistanceExclusionList field must also be included and set to true in the request. Excluded buyers can be viewed in the UnpaidItemAssistancePreferences.ExcludedUser field. </span> GetUserPreferences Conditionally Container consisting of a list of the seller's excluded shipping locations. The returned list mirrors the seller's current Exclude shipping locations list in My eBay's Shipping Preferences. An excluded shipping location in My eBay can be an entire geographical region (such as Middle East) or only an individual country (such as Iraq). Sellers can override these default settings for an individual listing by using the Item.ShippingDetails.ExcludeShipToLocation field in the AddItem family of calls. This container is returned if the ShowSellerExcludeShipToLocationPreference field is included and set to true in the request. GetUserPreferences Conditionally Container consisting of a seller's preference for sending a purchase reminder email to buyers. This container is returned if the ShowPurchaseReminderEmailPreferences field is included and set to true in the request. GetUserPreferences Conditionally This flag is set with the <b>SellerThirdPartyCheckoutDisabled</b> field of the <b>SetUserPreferences</b> call, and is used to disable the use of a third-party application to handle the checkout flow for a seller. If true, Third-Party Checkout is disabled and any checkout flow initiated on the seller's application is redirected to the eBay checkout flow. This field is only returned if the <b>SellerThirdPartyCheckoutDisabled</b> field has been set with the <b>SetUserPreferences</b> call. GetUserPreferences Conditionally Parent response container for all policy-related information for a seller. Returned if ShowSellerProfilePreferences is included and set to true in the GetUserPreferences request. <br><br> <span class="tablenote"><strong>Note:</strong> Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings. </span> GetUserPreferences Conditionally Retrieves details for VeRO reason codes and their descriptions. You can specify a reason code ID to get details for a specific reason on the site specified in the request header. If ReasonCodeID is not passed in the request, all reason codes are returned. Set ReturnAllSites to true to retrieve reason codes for all sites. You must be a member of the Verified Rights Owner (VeRO) Program to use this call.

Retrieves details about VeRO reason codes for a given site or all sites. You must be a member of the Verified Rights Owner (VeRO) Program to use this call.

Unique identifier for a reason code. If this ReasonCodeID is passed then only details of this ReasonCodeID will be returned. If no reason code is specified, all reason codes are returned. GetVeROReasonCodeDetails Conditionally Set to true to retrieve reason codes for all sites. If not specified, reason codes are returned for the site specified in the request header only. If ReasonCodeID is specified, this parameter is ignored. false GetVeROReasonCodeDetails No Contains the reason codes for all sites. Contains the list of the status codes for a site. GetVeROReasonCodeDetails Always Retrieves status information about VeRO reported items you have submitted. You can receive the status of individual items you have reported or, by specifying VeROReportPacketID, you can retrieve status for all items reported with a given VeROReportItems request. You can also retrieve items that were reported during a given time period. If no input parameters are specified, status is returned on all items you have reported in the last two years. You must be a member of the Verified Rights Owner (VeRO) Program to use this call.

Retrieves status information about VeRO reported items. You must be a member of the Verified Rights Owner (VeRO) Program to use this call.

Packet identifier associated with the reported items for which you want to retrieve status. By default, reported item details are not returned when you specify the packet ID in the request. Applies only to items reported with VeROReportItems. GetVeROReportStatus No Item ID for an item reported for alleged infringement. Applies to items reported with VeROReportItems or by other means (e.g., through the web flow). 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetVeROReportStatus No Set to true to return reported item details when you specify VeROReportPacketID in the request. false GetVeROReportStatus No Limits returned items to only those that were submited on or after the date-time specified. If specified, TimeTo must also be specified. Express the date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. (For information on how to convert between your local time zone and GMT, see Time Values Note.) Applies to items reported with VeROReportItems or by other means (e.g., through the web flow). Infringement reporting data is maintained for two years after the date of submission. This field is ignored if VeROReportPacketID or ItemID is specified. GetVeROReportStatus No Limits returned items to only those that were submited on or before the date-time specified. If specified, TimeFrom must also be specified. Express date-time in the format YYYY-MM-DD HH:MM:SS, and in GMT. (For information on how to convert between your local time zone and GMT, see Time Values Note.) Applies to items reported with VeROReportItems or by other means (e.g., through the web flow). Infringement reporting data is maintained for two years after the date of submission. This field is ignored if VeROReportPacketID or ItemID is specified. GetVeROReportStatus No Contains the data controlling the pagination of the returned values: how many items are returned per page of data (per call) and the number of the page to return with the current call. GetVeROReportStatus No Contains status information for items reported by the VeRO Program member. Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. GetVeROReportStatus Conditionally If true, there are more items yet to be retrieved. Additional calls with higher page numbers or more items per page must be made to retrieve these items. Not returned if no items match the request. GetVeROReportStatus Conditionally Indicates the maximum number of ItemType objects that can be returned in ReportedItemDetails for any given call. 1 200 GetVeROReportStatus Conditionally Indicates the page of data returned by the current call. For instance, for the first set of items can be returned, this field has a value of one. 1 GetVeROReportStatus Conditionally The packet ID for status being returned. GetVeROReportStatus Conditionally Status of the packet. GetVeROReportStatus Conditionally Contains the list of the reported item details. Returns empty if no items are available that match the request. GetVeROReportStatus Conditionally Retrieves data for a specific, active Want It Now post identified by a post ID. The response includes the following fields: CategoryID, Description, PostID, Site, StartTime, ResponseCount, and Title. Although GetWantItNowSearchResults returns most of this information, only GetWantItNowPost returns Description for a post. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WantItNowChapter Specifies the post ID that uniquely identifies the Want It Now post for which to retrieve the data. PostID is a required input. PostID is unique across all eBay sites. GetWantItNowPost Yes Contains the Want It Now post data returned by the call. The data for the specified post listing is returned in a WantItNowPostType object. Contains the data defining a single Want It Now post. GetWantItNowPost Always Retrieves a list of active Want It Now posts that match specified keywords and/or a specific category ID. The response contains the following data: CategoryID, PostID, StartTime, ResponseCount, Site, and Title. To get the post description (Description), you must use GetWantItNowPost to retrieve individual posts. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WantItNowChapter Limits the result set to just those Want It Now posts listed in the specified category. Defaults to all categories if no category ID is specified. If the specified category ID does not match an existing category for the site, an invalid-category error message is returned. Controls the set of listings to return (not the details to return for each listing). You must specify a Query and/or a CategoryID in the request. 10 GetWantItNowSearchResults No Specifies a search string. The search string consists of one or more keywords to search for in the listing title. Note that the post description will also be searched if SearchInDescription is enabled. By default, requests return a list of Want It Now posts that include all of the keywords specified in the Query. All words used in the query, including "and," "or," and "the," will be treated as keywords. You can, however, use modifiers and wildcards (e.g., +, -, and *) in the Query field to create more complex searches. Be careful when using spaces before or after modifiers and wildcards (+, -, or *), as the spaces can affect the query logic. See the eBay Web Services Guide for a list of valid search keyword query operators and examples. 350 (characters) GetWantItNowSearchResults No If true, include the description field of Want It Now posts in the keyword search. Want It Now posts returned are those where specified search keywords appear in either the description or the title. This is the default behavior if SearchInDescription is not specified. If false, only the title will be searched. SearchInDescription is an optional input. GetWantItNowSearchResults No If true, the search applies to all eBay sites. If false, the search is limited to the site specified in the URL query string when the call is made. GetWantItNowSearchResults No Controls the pagination of the result set. Child elements specify the maximum number of item listings to return per call and which page of data to return. GetWantItNowSearchResults No Response contains the Want It Now posts that have the specified keyword(s) in the title and (optionally) the description. Response contains the Want It Now posts that have the specified keyword(s) in the title and (optionally) the description. Contains the returned Want It Now posts, if any. The data for each post is returned in a WantItNowPostType object. GetWantItNowSearchResults Always Indicates whether there are additional Want It Now posts that meet the search criteria. GetWantItNowSearchResults Always Indicates the maximum number of Want It Now posts that can be returned in a WantItNowPostArray for a request. This value can be specified in the request by EntriesPerPage in Pagination in the request. GetWantItNowSearchResults Always Indicates the page of data returned by the current call. GetWantItNowSearchResults Always Indicates the results of the pagination, including the total number of pages of data there are to be returned and the total number of posts there are to be returned. GetWantItNowSearchResults Always Retrieves eBay IDs and codes (e.g., site IDs and shipping service codes), enumerated data (e.g., payment methods), and other common eBay meta-data. This call enables you to keep certain data up to date in your applications without referring to the schema, the documentation, or the eBay online help. Other data is returned for your reference, but you may need to refer to the schema or the documentation for information about valid values and usage. <br><br> In some cases, the data returned in the response will vary according to the site that you use for the request. <br><br> If you use GeteBayDetails in preparation for listing in the US Motors Parts and Accessories categories, use site ID 0 (which is the site ID of the US site) when you call GeteBayDetails. <br><br> Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the recoupment terms before adding items to the site. This agreement allows eBay to reimburse a buyer during a dispute and then recoup the cost from the seller. Information about whether a site is a recoupment site is returned in the GeteBayDetailsResponse.RecoupmentPolicyDetails container. A designation of what kind of information you wish returned for the specified eBay site. If omitted, all details are returned. The possible values for input (the enumeration values of DetailNameCodeType) are the same name as fields returned by the response. See the documentation for the GeteBayDetails response to better understand the DetailName options. GeteBayDetails No Details about a specified site in response to GeteBayDetailsRequest. If no DetailName field is identified in the request, all elements of GeteBayDetailsResponse are returned. Otherwise, eBay returns only the elements corresponding to the specified DetailName fields. UpdateTime gives the time of modification of the most recently modified DetailName. Details about a specified site in response to GeteBayDetailsRequest. If no DetailName field is identified in the request, all elements of GeteBayDetailsResponse are returned. Otherwise, eBay returns only the elements corresponding to the specified DetailName fields. UpdateTime gives the time of modification of the most recently modified DetailName. Lists the country code and associated name of the countries supported by the eBay system, regardless of the site specified in the request. GeteBayDetails Conditionally Lists the currencies supported by the eBay system, regardless of the site specified in the request. GeteBayDetails Conditionally A dispatch time specifies the maximum number of business days a seller commits to for shipping an item to domestic buyers after receiving a cleared payment. Returns all dispatch times in the system, regardless of the site specified in the request. GeteBayDetails Conditionally The values returned in this field detail different payment options. <br /> This feature is no longer in use. If you need valid payment option information, use GetCategoryFeatures instead. GeteBayDetails Conditionally No longer returned. GeteBayDetails Conditionally Lists the regions and locations supported by eBay's shipping services. Returns all shipping locations supported by eBay, regardless of the site specified in the request. GeteBayDetails Conditionally Lists the shipping services supported by the specified eBay site. Returns only the shipping services that are applicable to the site specified in the request. GeteBayDetails Conditionally Lists all available eBay sites and their associated SiteID numbers. GeteBayDetails Conditionally Details the different tax jurisdictions or tax regions applicable to the site specified in the request. <br><br> Related fields:<br> TaxTable.TaxJurisdiction in SetTaxTable<br> Item.UseTaxTable in Additem GeteBayDetails Conditionally Lists eBay URLs that are applicable to the site specified in the request. GeteBayDetails Conditionally Lists the details of the time zones supported by the eBay system. GeteBayDetails Conditionally The site's validation rules (e.g., string lengths) for custom Item Specifics. GeteBayDetails Conditionally Lists the suggested unit-of-measurement strings to use with Item Specifics descriptions. GeteBayDetails Conditionally No longer returned. GeteBayDetails Conditionally Lists the various shipping packages supported by the specified site. GeteBayDetails Conditionally Lists the shipping carriers supported by the specified site. GeteBayDetails Conditionally Lists the return policies supported by the eBay site specified in the request. GeteBayDetails Conditionally Lists the minimum starting prices for the supported types of eBay listings. GeteBayDetails Conditionally Details various eBay-buyer requirements. GeteBayDetails Conditionally Details the listing features available for the site specified in the request. GeteBayDetails Conditionally Site-level validation rules for multi-variation listings (for example, the maximum number of variations per listing). Use GetCategoryFeatures to determine which categories on a site support variations. Use GetCategorySpecifics for rules related to recommended or required variation specifics. GetCategoryFeatures.html#Response.Category.VariationsEnabled GetCategorySpecifics.html GeteBayDetails Conditionally Lists the locations supported by the ExcludeShipToLocation feature. These are locations that a seller can list as areas where they will not ship an item. <br /> The codes reflect the <a href= "http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm" >ISO 3166</a> location codes. GeteBayDetails Conditionally The time of the most recent modification to any feature detail. If specific feature details are passed in the request, gives the most recent modification time of those feature details. GeteBayDetails Always Details the recoupment policies for the site specified in the request. GeteBayDetails Conditionally A shipping service category supported for the site. <br><br> Each shipping service supported for a site is automatically categorized by eBay into one of the shipping categories available for that site depending on how the shipping service shipping time aligns with the shipping times specified by eBay for each category. <br><br> Notice that you cannot specify a ShippingCategory as an input to any API call--eBay does this categorizing automatically. ShippingCategory is read-only data that is returned in the ShippingServiceDetails container. One possible use of this data is to segregate shipping services by ShippingCategory in a pick list. (For an example of this, see the Services pulldown menu in the Give buyers shipping details form in the eBay Sell Your Item flow.) <br><br> One way to populate the picklist would be to call GeteBayDetails supplying ShippingServiceDetails in a DetailName element; you would then sort these results yourself by ShippingCategory and populate the picklist. GeteBayDetails Conditionally Gets the official eBay system time in GMT. The Timestamp field indicates the official eBay system time in GMT. For information about converting between GMT and other time zones, see "Time Values" in the Data Types appendix in the eBay Web Services guide. <b>Half.com only.</b>&nbsp;Issues a refund for a specific Half.com order line item. This can only be called by a seller. Sellers do not have the ability to issue a general refund (a refund not tied to an order line item) to a buyer. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=HalfOverview Unique identifier for the Half.com item listing. Unless an <b>OrderLineItemID</b> is specified in the <b>IssueRefund</b> request, the <b>ItemID</b> is required along with the corresponding <b>TransactionID</b> to identify the order line item that will be refunded. You can use <b>GetSellerPayments</b> to retrieve the <b>ItemID</b> and/or <b>TransactionID</b> associated with the order line item. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) IssueRefund Yes Unique identifier for a Half.com order line item (transaction). An order line item is created once there is a commitment from a buyer to purchase an item. Along with its corresponding <b>ItemID</b>, a <b>TransactionID</b> is used to identify the order line item that will be refunded. Unless an <b>OrderLineItemID</b> is specified in the <b>IssueRefund</b> request, the <b>TransactionID</b> is required along with the corresponding <b>ItemID</b>. You can use <b>GetSellerPayments</b> to retrieve the <b>ItemID</b> and/or <b>TransactionID</b> associated with the order line item. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) IssueRefund Yes Explanation of the reason that the refund is being issued. IssueRefund Yes Explanation of the costs that the refund amount covers. IssueRefund Yes The amount the seller wants to refund to the buyer, in US Dollars (USD). Must be greater than 0.00. Half.com allows a maximum of the original item sale price (order line item price plus original shipping reimbursement) plus return shipping costs (the amount the buyer paid to return the item). Typically, the return shipping cost is based on the current cost of shipping the individual item (not the discounted cost calculated during the original checkout for a Combined Payment order). You can also issue a partial refund for the amount you want the buyer to receive. If RefundType=Full or RefundType=FullPlusShipping and you do not pass <b>RefundAmount</b> in the request, Half.com will calculate the refund amount for you. If you pass <b>RefundAmount</b> in the request, the amount you specify will override Half.com's calculated value. Required if RefundType= CustomOrPartial. IssueRefund Conditionally Note to the buyer. Cannot include HTML. 400 IssueRefund No A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. The <b>OrderLineItemID</b> value is used to identify the order line item that will be refunded. Unless an <b>ItemID</b>/<b>TransactionID</b> pair is specified in the <b>IssueRefund</b> request, the <b>OrderLineItemID</b> is required. You can use <b>GetSellerPayments</b> to retrieve the <b>OrderLineItemID</b> associated with the order line item. <br> 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) IssueRefund No Indicates the refund amount that a seller issued to a buyer for a single Half.com order line item. Refunds may only be issued for a specific order line item. Sellers do not have the ability to issue a general refund (not tied to an order line item) to a buyer. Total amount that the seller asked Half.com to refund to a buyer for a Half.com order line item. IssueRefund Always Total amount that Half.com refunded to the buyer (which could include the refund amount from the seller plus a refund amount from Half.com). IssueRefund Always Enables a buyer and seller to leave feedback for their order partner at the conclusion of a successful order. &nbsp;<b> Also for Half.com</b>. GetFeedback, GetSellerDashboard, GetSellerTransactions http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Feedback http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeedbackIntro http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeedbackLeave http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DetailedSellerRatings Unique identifier for an eBay item listing. A listing can have multiple order line items, but only one <b>ItemID</b>. Unless an <b>OrderLineItemID</b> is specified in the <b>LeaveFeedback</b> request, the <b>ItemID</b> is required along with the <b>TargetUser</b> to identify an order line item existing between the caller and the <b>TargetUser</b> that requires feedback. A Feedback comment will be posted for this order line item. If there are multiple order line items between the two order partners that still require feedback, the <b>TransactionID</b> will also be required to isolate the targeted order line item. Feedback cannot be left for order line items with creation dates more than 60 days in the past. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) LeaveFeedback Conditionally Textual comment that explains, clarifies, or justifies the feedback score specified in <b>CommentType</b>. 80 LeaveFeedback Yes Score for the feedback being left. May be Positive, Neutral, or Negative. <br><br> <span class="tablenote"><b>Note:</b> Sellers can not leave neutral or negative feedback for buyers. In addition, buyers can not leave neutral or negative feedback within 7 days from the completion of the order for active PowerSellers who have been on eBay for 12 months. </span> LeaveFeedback Withdrawn, IndependentlyWithdrawn Yes Unique identifier for an eBay order line item (transaction). If there are multiple order line items between the two order partners that still require feedback, the <b>TransactionID</b> is required along with the corresponding <b>ItemID</b> and <b>TargetUser</b> to isolate the targeted order line item. If an <b>OrderLineItemID</b> is included in the response to identify a specific order line item, none of the preceding fields (<b>ItemID</b>, <b>TransactionID</b>, <b>TargetUser</b>) are needed. Feedback cannot be left for order line items with creation dates more than 60 days in the past. </span> 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) LeaveFeedback Conditionally Specifies the recipient user about whom the feedback is being left. LeaveFeedback Yes Container for detailed seller ratings (DSRs). If a buyer is providing DSRs, they are specified in this container. Sellers have access to the number of ratings they've received, as well as to the averages of the DSRs they've received in each DSR area (i.e., to the average of ratings in the item-description area, etc.). http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DetailedSellerRatings LeaveFeedback No <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. If an <b>OrderLineItemID</b> is included in the request, the <b>ItemID</b>, <b>TransactionID</b>, and <b>TargetUser</b> fields are not required. Feedback cannot be left for order line items with creation dates more than 60 days in the past. 100 LeaveFeedback Conditionally LeaveFeedback response message includes an acknowledgement if the feedback was successfully left. The ID of the feedback that has been left. LeaveFeedback Always Moves a Selling Manager inventory folder. <br><br> This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Unique ID of the folder that will be moved. User can retrieve the FolderId using GetSellingManagerInventoryFolder. MoveSellingManagerInventoryFolder Yes Unique folder ID for the new parent folder. If no NewParentFolderID is submitted, the folder is moved to the root level. MoveSellingManagerInventoryFolder No Returns the status of move folder operation. Enables the authenticated user to to make a bid, a best offer, or a purchase on the item specified by the ItemID input field. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EnablingBestOffer http://developer.ebay.com/join/licenses/Default.aspx http://pages.ebay.com/help/policies/user-agreement.html http://developer.ebay.com/terms/PlaceOffer_API_License_Addendum_uv.pdf http://developer.ebay.com/join/licenses/apilogousage http://developer.ebay.com/support/developersupport/request https://www.ebaypartnernetwork.com/ GetChallengeToken, GetBestOffers Specifies the type of offer being made. If the item is a competitive-bidding listing, the offer is a bid. If the item is a fixed-price listing, then the offer purchases the item. If the item is a competitive-bidding listing and the offer is of type with an active, unexercised Buy It Now option, then the offer can either purchase the item or be a bid. See the schema documentation for OfferType for details on its properties and their meanings. PlaceOffer Yes Unique item ID that identifies the item listing for which the action is being submitted. <br><br> If the item was listed with Variations, you must also specify VariationSpecifics in the request to uniquely identify the variant being purchased. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) PlaceOffer Yes If a warning message exists and BlockOnWarning is true, the warning message is returned and the bid is blocked. If no warning message exists and BlockOnWarning is true, the bid is placed. If BlockOnWarning is false, the bid is placed, regardless of warning. PlaceOffer No Container for affiliate-related tags, which enable the tracking of user activity. If you include AffiliateTrackingDetails in your PlaceOffer call, then it is possible to receive affiliate commissions based on calls made by your application. (See the <a href= "http://www.ebaypartnernetwork.com/" target="_blank">eBay Partner Network</a> for information about commissions.) Please note that affiliate tracking is not available in the Sandbox environment, and that affiliate tracking is not available when you make a best offer. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AffiliateTrackingConcepts PlaceOffer No Name-value pairs that identify a single variation within the listing identified by ItemID. Required when the seller listed the item with Item Variations.<br> <br> If you want to buy items from multiple variations in the same listing, use a separate PlaceOffer request for each variation. For example, if you want to buy 3 red shirts and 2 black shirts from the same listing, use one PlaceOffer request for the 3 red shirts, and another PlaceOffer request for the 2 black shirts. PlaceOffer Conditionally The <b>PlaceOffer</b> response notifies you about the success and result of the call. Indicates the current bidding/purchase state of the item listing regarding the offer extended using <b>PlaceOffer</b>. See the schema documentation for the <b>SellingStatus</b> object, the properties of which contain such post-offer information as the current high bidder, the current price for the item, and the bid increment. PlaceOffer Always Unique identifier for an eBay order line item (transaction). The <b>TransactionID</b> field is only returned if the <b>Offer.Action</b> field was set to <b>Purchase</b> in the input and the purchase was successful. A Purchase action in <b>PlaceOffer</b> can be used for a fixed-price listing, or for an auction listing where the Buy It Now option is available. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) PlaceOffer Conditionally Container consisting of the status for a Best Offer. This container is only returned if applicable based on the listing and the value set for <b>Offer.Action</b> field in the request. PlaceOffer Conditionally <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. The <b>OrderLineItemID</b> field is only returned if the <b>Offer.Action</b> field is set to <b>Purchase</b> in the input and the purchase is successful. A Purchase action in <b>PlaceOffer</b> can be used for a fixed-price listing, or for an auction listing where the Buy It Now option is available. <br> 50 (Note: The eBay database specifies 38. ItemIDs and TransactionIDs are usually 9 to 12 digits.) PlaceOffer Conditionally 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. AddFixedPriceItem, RelistItem, ReviseFixedPriceItem, GetCategories http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RelistingItems http://pages.ebay.com/help/sell/relist.html http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ConsideringBestMatch http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BestMatchReviseRelist 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.ConditionID<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 Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. RelistFixedPriceItem Conditionally Enables a seller to take a single item (or a single multi-item listing) and re-list it on a specified eBay site. AddItem, AddToItemDescription, GetItem, GetItemRecommendations, GetSellerList, RelistFixedPriceItem, ReviseItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RelistingItems http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=1542 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ConsideringBestMatch http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BestMatchReviseRelist Child elements hold the values for item properties that change for the item re-list. Item is a required input. At a minimum, the Item.ItemID property must be set to the ID of the listing being re-listed (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 corresponding value from the old listing. RelistItem Yes Specifies the name of the field to delete from a listing. See the eBay Web Services 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> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.BuyItNowPrice<br> Item.Charity<br> Item.ConditionID<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]. RelistItem Conditionally Returns the item ID and the estimated fees for the re-listed listing. Unique item ID for the new listing. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RelistItem 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. RelistItem Always Date and time the new listing became active on the eBay site. RelistItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. RelistItem 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 RelistItem 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 RelistItem Conditionally The nature of the discount, if a discount applied. RelistItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. RelistItem Conditionally Enables a user to remove one or more items from their My eBay watch list. AddToWatchList, GetMyeBayBuying, GetMyeBaySelling The ID of the item to be removed from the watch list. Either ItemID, RemoveAllItems, or VariationKey must be specified, but NOT more than one of these. Multiple ItemID fields can be specified in the same request. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RemoveFromWatchList Conditionally If true, then all the items in the user's watch list are removed. Either ItemID, RemoveAllItems, or VariationKey must be specified, but NOT more than one of these. RemoveFromWatchList Conditionally A variation (or set of variations) that you want to remove from the watch list. Either ItemID, RemoveAllItems, or VariationKey must be specified, but NOT more than one of these. RemoveFromWatchList Conditionally Returns information about the user's My eBay watch list. The current number of items in the user's watch list (after those specified in the call request have been removed) RemoveFromWatchList Always The maximum number of items allowed in watch lists. Currently this value is 200, and is the same for all sites and all users. RemoveFromWatchList Always Enables the seller of a Best Offer item to accept, decline, or counter offers made by bidders. Best offers can be declined in bulk, using the same message from the seller to the bidders of all rejected offers. GetBestOffers http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EnablingBestOffer Specifies the item for which the BestOffer data is to be returned. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RespondToBestOffer Yes The ID of a Best Offer for the item. RespondToBestOffer Yes The action taken on the best offer by the seller (e.g., Accept, Decline, or Counter). Bulk Accept and Bulk Counter are not supported. That is, you cannot accept or counter multiple offers in a single call. You can, however, decline multiple offers in a single call. RespondToBestOffer Yes A comment from the seller to the buyer. 250 RespondToBestOffer Conditionally The counter offer price. When Action is set to Counter, you must specify the amount for the counter offer with CounterOfferPrice. The value of CounterOfferPrice cannot exceed the Buy It Now price for a single quantity item. The value of CounterOfferPrice may exceed the Buy It Now price if the value for CounterOfferQuantity is greater than 1. RespondToBestOffer Conditionally The quantity of items in the counter offer. When Action is set to Counter you must specify the quantity of items for the counter offer with CounterOfferQuantity. RespondToBestOffer Conditionally Contains a list of BestOffers that were either accepted or declined. A list of BestOffers that were either accepted or declined. RespondToBestOffer Always Used to reply to feedback that has been left for a user, or to post a follow-up comment to a feedback comment the user has left for someone else. GetFeedback, LeaveFeedback A unique identifier for a Feedback record. Buying and selling partners leave feedback for one another after the completion of an order. Feedback is left at the order line item (transaction) level, so a Feedback comment for each line item in a Combined Payment order is expected from the buyer and seller. A unique <b>FeedbackID</b> is created whenever a buyer leaves feedback for a seller, and vice versa. A <b>FeedbackID</b> is created by eBay when feedback is left through the eBay site, or through the <b>LeaveFeedback</b> call. <b>FeedbackIDs</b> can be retrieved with the <b>GetFeedback</b> call. In the <b>RespondToFeedback</b> call, <b>FeedbackID</b> can be used as an input filter to respond to a specific Feedback comment. Since Feedback is always linked to a unique order line item, an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> can also be used to respond to a Feedback comment. RespondToFeedback Conditionally Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one <b>ItemID</b>. An <b>ItemID</b> can be paired up with a corresponding <b>TransactionID</b> and used as an input filter to respond to a Feedback comment in the <b>RespondToFeedback</b> call. Unless the specific Feedback record is identified by a <b>FeedbackID</b> or an <b>OrderLineItemID</b> in the request, an <b>ItemID</b>/<b>TransactionID</b> pair is required. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) RespondToFeedback Conditionally Unique identifier for an eBay order line item (transaction). A <b>TransactionID</b> can be paired up with its corresponding <b>ItemID</b> and used as an input filter to respond to a Feedback comment in the <b>RespondToFeedback</b> call. Unless the specific Feedback record is identified by a <b>FeedbackID</b> or an <b>OrderLineItemID</b> in the request, an <b>ItemID</b>/<b>TransactionID</b> pair is required. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) RespondToFeedback No The eBay user ID of the caller's order partner. The caller is either replyting to or following up on this user's Feedback comment. RespondToFeedback Yes Specifies whether the response is a reply or a follow-up to a Feedback comment left by the user identified in the <b>TargetUserID</b> field. RespondToFeedback Yes Textual comment that the user who is subject of feedback may leave in response or rebuttal to the Feedback comment. Alternatively, when the <b>ResponseType</b> is <b>FollowUp</b>, this value contains the text of the follow-up comment. 80 (125 for the Taiwan site) RespondToFeedback Yes <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. Since Feedback is always linked to a unique order line item, an <b>OrderLineItemID</b> can be used to respond to a Feedback comment. <br><br> Unless an <b>ItemID</b>/<b>TransactionID</b> pair or a <b>FeedbackID</b> is used to identify a Feedback record, the <b>OrderLineItemID</b> must be specified. <br> 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) RespondToFeedback Conditionally Indicates the success or failure of the attempt to reply to feedback that has been left for a user, or to post a follow-up comment to a feedback comment a user has left for someone else. Enables a seller to respond to a Want It Now post with an item listed on the eBay site. Responses appear on the Want It Now post page, with the item title, the price of the item, the number of bids on the item, and the time left before the listing ends. If the item has a picture, the picture is also included on the Want It Now post page. GetWantItNowSearchResults, GetWantItNowPost http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WantItNowChapter The unique identifier of an item listed on the eBay site. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) RespondToWantItNowPost Yes The unique identifier of a Want It Now post on the eBay site. RespondToWantItNowPost Yes Indicates the success or failure of the attempt to respond to a Want It Now post. A seller can use this call to update the payment details, the shipping details, and the status of an order. ReviseItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Checkout http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WorkingWithCombinedPayment Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one <b>ItemID</b>. An <b>ItemID</b> can be paired up with a corresponding <b>TransactionID</b> and used as an input filter for <b>ReviseCheckoutStatus</b>. <br><br> Unless an <b>OrderLineItemID</b> is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item (Combined Payment) order, the <b>ItemID</b>/<b>TransactionID</b> pair must be specified. For a multiple line item (Combined Payment) order, <b>OrderID</b> should be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. <br /> <br /> It is also possible to identify a single line item order with a <b>ItemID</b>/<b>BuyerID</b> combination, but this is not the most ideal approach since an error is returned if there are multiple order line items for that combination. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) ReviseCheckoutStatus Conditionally Unique identifier for an eBay order line item (transaction). An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the <b>TransactionID</b> for auction listings is always 0. Along with its corresponding <b>ItemID</b>, a <b>TransactionID</b> is used and referenced during an order checkout flow and after checkout has been completed. The <b>ItemID</b>/<b>TransactionID</b> pair can be used as an input filter for <b>ReviseCheckoutStatus</b>. <br><br> Unless an <b>OrderLineItemID</b> is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item (Combined Payment) order, the <b>ItemID</b>/<b>TransactionID</b> pair must be specified. For a multiple line item (Combined Payment) order, <b>OrderID</b> must be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) ReviseCheckoutStatus Conditionally A unique identifier that identifies a single line item or multiple line item (Combined Payment) order. <br><br> For a single line item order, the <b>OrderID</b> value is identical to the <b>OrderLineItemID</b> value that is generated upon creation of the order line item. For a Combined Payment order, the <b>OrderID</b> value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Payment order through the eBay site. A Combined Payment order can also be created by the seller through the <b>AddOrder</b> call. The <b>OrderID</b> can be used as an input filter for <b>ReviseCheckoutStatus</b>. <br><br> <b>OrderID</b> overrides an <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair if these fields are also specified in the same request. ReviseCheckoutStatus Conditionally The total amount paid by the buyer. For a US eBay Motors item, <b>AmountPaid</b> is the total amount paid by the buyer for the deposit. <b>AmountPaid</b> is optional if <b>CheckoutStatus</b> is Incomplete and required if it is Complete. ReviseCheckoutStatus Conditionally Payment method used by the buyer. This field is required if <b> CheckoutStatus</b> is Complete and the payment method is a trusted payment method other than PayPal. See eBay's <a href="http://pages.ebay.com/help/policies/accepted-payments-policy.html">Accepted Payments Policy</a>. If the payment method is PayPal, this field should not be used since only PayPal can set this field's value to "PayPal". ReviseCheckoutStatus cannot be used for a non-trusted payment method. <br> <br> <span class="tablenote"><b>Note:</b> Required or allowed payment methods vary by site and category. Refer to <a href="http://developer.ebay.com/DevZone/XML/docs/WebHelp/wwhelp/wwhimpl/js/html/wwhelp.htm?context=eBay_XML_API&topic=PaymentMethodDifferences"> Payment Method Differences (PaymentMethod)</a> in the eBay Trading API Guide for information to help you determine which payment methods you are required or allowed to specify. </span> ReviseCheckoutStatus PayPal Conditionally The current checkout status of the order. Often, the seller or application will mark this value as Complete if payment has been made. The <b>CheckoutStatus</b> value cannot be updated by DE and AT sellers who are subject to the new payment process, and an attempt to do so in a <b>ReviseCheckoutStatus</b> call will result in a call error. ReviseCheckoutStatus Yes The shipping service selected by the buyer from among the shipping services offered by the seller (such as UPS Ground). For a list of valid values, call GeteBayDetails with DetailName set to ShippingServiceDetails. The ShippingServiceDetails.ValidForSellingFlow flag must also be present. Otherwise, that particular shipping service option is no longer valid and cannot be offered to buyers through a listing. ShippingServiceCodeType ReviseCheckoutStatus No An indicator of whether shipping costs were included in the taxable amount. . ReviseCheckoutStatus No false This field is not supported. ReviseCheckoutStatus No Enumeration value that indicates whether shipping insurance was offered to and selected by the buyer. ReviseCheckoutStatus No Marks the order as paid or awaiting payment in My eBay. If you specify Paid, My eBay displays an icon for each item in the order to indicate that the order status is Paid. If you specify Pending, this indicates that the order is awaiting payment. (Some applications may use Pending when the buyer has paid but the funds have not yet been sent to the seller's financial institution.) <br> <br> <b>ReviseCheckoutStatus</b> cannot be used to update payment and checkout status for a non-trusted payment method. See eBay's <a href=" http://pages.ebay.com/help/policies/accepted-payments-policy.html"> Accepted Payments Policy</a> for more information on trusted payment methods. If the payment method is PayPal, this field should not be used since PayPal automatically set this field's value to "Paid" upon receiving the buyer's payment. <br> <br> The <b>PaymentStatus</b> value cannot be updated by DE and AT sellers who are subject to the new payment process, and an attempt to do so in a <b>ReviseCheckoutStatus</b> call will result in a call error. ReviseCheckoutStatus No Paid, Pending Discount or charge agreed to by the buyer and seller. A positive value indicates that the amount is an extra charge being paid to the seller by the buyer. A negative value indicates that the amount is a discount given to the buyer by the seller. ReviseCheckoutStatus No For internal use. ReviseCheckoutStatus No eBay user ID for the order's buyer. A single line item order can actually be identified by a <b>BuyerID</b>/<b>ItemID</b> pair, but this approach is not recommended since an error is returned if there are multiple order line items for that combination. <b>BuyerID</b> is ignored if any other valid filter or filter combination is used in the same request. ReviseCheckoutStatus Conditionally The amount of money paid for shipping insurance. ReviseCheckoutStatus No The sales tax amount for the order. This field should be used if sales tax was applied to the order. ReviseCheckoutStatus No The amount of money paid for shipping. ReviseCheckoutStatus No Not supported. 20 ReviseCheckoutStatus No Container consisting of a unique identifier and timestamp for the electronic payment of a single or multiple line item order. An <b> ExternalTransactionID</b> is not exposed to a new DE or AT seller who is subject to the new payment process. Starting in late August 2011, new DE and AT sellers are subject to the new payment process. ReviseCheckoutStatus No Not supported. ReviseCheckoutStatus No Italy site (site ID 101) only. Enables you to specify the cash-on-delivery (COD) cost, for COD shipping. ReviseCheckoutStatus No http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CODInShippingDetails <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. For a single line item order, the <b>OrderLineItemID</b> value can be passed into the <b>OrderID</b> field to revise the checkout status of the order. <br><br> Unless an <b>ItemID</b>/<b>TransactionID</b> pair is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item (Combined Payment) order, the <b>OrderLineItemID</b> must be specified. For a multiple line item (Combined Payment) order, <b>OrderID</b> should be used. If <b>OrderLineItemID</b> is specified, the <b>ItemID</b>/<b>TransactionID</b> pair are ignored if present in the same request. 100 ReviseCheckoutStatus Conditionally Indicates success or failure of the attempt to revise the listing's checkout status. Enables a seller to change the properties of a currently active fixed-price listing (including multi-variation listings). AddFixedPriceItem, RelistFixedPriceItem, ReviseItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RevisingItems http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ConsideringBestMatch http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BestMatchReviseRelist 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. The request can contain zero, one, or many instances of DeletedField (one for each field to be deleted). See the relevant field descriptions to determine when to use DeletedField (and potential consequences). <br><br> You cannot delete required fields from a listing. <br><br> Some fields are optional when you first list an item (e.g., SecondaryCategory), 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. See the eBay Trading API guide for rules on removing values when revising items. <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> DeletedField accepts the following path names, which delete the corresponding nodes: <br><br> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.ConditionID<br> Item.ItemSpecifics<br> Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> Item.ListingDesigner.LayoutID<br> Item.ListingDesigner.ThemeID<br> Item.ListingEnhancement[Value]<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. <br><br> To delete a listing enhancement like BoldTitle, specify the value you are deleting in square brackets ("[ ]"); for example, Item.ListingEnhancement[BoldTitle]. 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 http://pages.ebay.com/help/sell/fees.html http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits 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 Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. ReviseFixedPriceItem Conditionally Enables a seller to change the price and quantity of a currently- active, fixed-price listing. Using ReviseInventoryStatus to modify data qualifies as revising the listing. <br> <br> Inputs are the item IDs or SKUs of the listings being revised, and the price and quantity that are being changed for each revision. Only applicable to fixed-price listings.<br> <br> 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>.<br> <br> As with all listing calls, the site you specify in the request URL (for SOAP) or the X-EBAY-API-SITEID HTTP header (for XML) should match the original listing's <b>Item.Site</b> value. In particular, this is a best practice when you submit new and revised listings.<br> <br> <b>For Large Merchant Services users:</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.

AddItems, GetSellerList, ReviseItem, RelistItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=TargetSite http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ConsideringBestMatch http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BestMatchReviseRelist 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 http://pages.ebay.com/help/sell/fees.html http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits http://pages.ebay.com/help/sell/fvf.html Enables a seller to change the properties of a currently active listing.&nbsp;<b>Also for Half.com</b>. <br> <br> After one item in a multi-quantity fixed-price listing has been sold, you can not the values in the Title, Primary Category, Secondary Category, Listing Duration, and Listing Type fields for that listing. However, all other fields in the multi-quantity, fixed-price listing are editable. <br> <br> Inputs are the Item ID of the listing you are revising, and the field or fields that you are updating. AddItem, AddToItemDescription, GetItem, GetItemRecommendations, GetSellerList, RelistItem, ReviseFixedPriceItem, GetCategories, GetCategoryMappings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RevisingItems http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ConsideringBestMatch http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=BestMatchReviseRelist Child elements hold the values for properties that are changing. The Item.ItemID property must always be set to the ID of the item listing being changed. Set values in the Item object only for those properties that are changing. Use DeletedField to remove a property. <br><br> Applicable to Half.com. ReviseItem Yes Specifies the name of a field to delete from a listing. See the eBay Trading API guide for rules on deleting values when revising 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). <br><br> You cannot delete required fields from a listing. <br><br> Some fields are optional when you first list an item (e.g., SecondaryCategory), but once they are set they cannot be deleted when you revise an item. Some optional fields cannot be deleted from auction listings if the item has bids and/or ends within 12 hours. Some optional fields cannot be deleted if other fields depend on them. <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. See the eBay Web Services guide for rules on removing values when revising items. Also see the relevant field descriptions for details on when to use DeletedField (and potential consequences). <br><br> DeletedField accepts the following path names, which delete the corresponding nodes: <br><br> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.BuyItNowPrice<br> Item.ConditionID<br> Item.ExtendedSellerContactDetails<br> Item.ClassifiedAdContactByEmailEnabled<br> Item.ItemSpecifics<br> Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> Item.ListingDesigner.LayoutID<br> Item.ListingDesigner.ThemeID<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.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. <br><br> To delete a listing enhancement like BoldTitle, specify the value you are deleting in square brackets ("[ ]"); for example, Item.ListingEnhancement[BoldTitle]. ReviseItem Conditionally When the VerifyOnly boolean tag value is supplied as 'true', the response will include the calculated listing price change if there is an increase in the BIN/Start price, but does not persist the values in DB. This call is similar to VerifyAddItem in revise mode. ReviseItem 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. Also applicable to Half.com. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) ReviseItem Always Starting date and time for the revised listing. Also returned for Half.com (for Half.com, the start time is always the time the item was originally listed). ReviseItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. Also returned for Half.com, but for Half.com the actual end time is GTC (not the end time returned in the response). ReviseItem 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. Not applicable to Half.com. ReviseItem 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. Not applicable to Half.com. 10 ReviseItem 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. Not applicable to Half.com. 10 ReviseItem Conditionally Supporting VerifyOnly for ReviseItem call as part of project 24083 (API - Critical enhancements). When the VerifyOnly boolean tag value is supplied as 'true', the response will include the calculated listing price change if there is an increase in the BIN/Start price, but does not persist the values in DB. This call is simialr to VerifyAddItem in revise mode. ReviseItem Conditionally The nature of the discount, if a discount applied. ReviseItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. ReviseItem Conditionally Sets the read state for messages, sets the flagged state of messages, and moves messages into and out of folders. AddMemberMessagesAAQToBidder, DeleteMyMessages, GetMessagePreferences, GetMemberMessages, GetMyMessages, ReviseMyMessagesFolders Contains a list of up to 10 MessageID values. <br><br> MessageIDs must be included in the request. Messages in the Sent box cannot be moved, marked as Read, or Flagged. ReviseMyMessages Conditionally This field will be deprecated in an upcoming release. This field formerly contained a list of up to 10 AlertID values. <br><br> Alerts cannot be flagged. Alerts cannot be moved into a new folder until they have been resolved. <br><br> Resolve alerts by marking Read (if no action is required), or by using ActionURL (if action is required). ReviseMyMessages Conditionally Changes the read states of all messages specified in a request. At least one of the following must be specified in the request: Read, Flagged, or FolderID. Messages in the Sent box cannot be moved, marked as Read, or Flagged. <br><br> Note that messages retrieved with the API are not automatically marked Read, and must be marked Read with this call. ReviseMyMessages Conditionally Changes the flagged states of all messages specified in a request by their MessageID values. At least one of Read, Flagged, or FolderID must be specified in the request. Messages in the Sent box cannot be moved, marked as Read, or Flagged. ReviseMyMessages Conditionally An ID that uniquely identifies the My Messages folder to move messages into. At least one of Read, Flagged, or FolderID must be specified in the request. <br><br> Messages in the Sent box cannot be moved, marked as Read, or Flagged. ReviseMyMessages Conditionally The response to ReviseMyMessagesRequestType. If the request was successful, ReviseMyMessages returns nothing. Renames, removes, or restores the specified My Messages folders for a given user. AddMemberMessagesAAQToBidder, DeleteMyMessages, GetMessagePreferences, GetMemberMessages, GetMyMessages, ReviseMyMessages Indicates the type of operation to perform on a specified My Messages folder. Operations include creating, renaming, removing, and restoring folders. Operations cannot be performed on the Inbox and Sent folders. ReviseMyMessagesFolders Yes An ID that uniquely identifies the My Messages folder to perform the operation on. This value is set by eBay and cannot be changed. Retrieve FolderIDs by calling GetMyMessages with a DetailLevel of ReturnSummary. Inbox is FolderID = 0, and Sent is FolderID = 1. ReviseMyMessagesFolders Yes The name of a specified My Messages folder. Depending on the specified Operation, the value is an existing folder name or a new folder name. Retrieve existing FolderNames by calling GetMyMessages with a DetailLevel of ReturnSummary. Inbox is FolderID = 0, and Sent is FolderID = 1. ReviseMyMessagesFolders Conditionally The response to ReviseMyMessagesFoldersRequestType. If the request was successful, ReviseMyMessagesFolders returns nothing. Renames a Selling Manager inventory folder. This call is subject to change without notice; the deprecation process is inapplicable to this call.

Revises the name of a Selling Manager inventory folder.

AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Identifier of the folder to be modified. Valid inputs are folder ID, folder name, and comments. ReviseSellingManagerInventoryFolder Yes Returns the status of a revise folder operation. Contains information about the folder that has been renamed. ReviseSellingManagerInventoryFolder Always Revises a Selling Manager product. <br><br> This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro The details of the product that is being revised. ReviseSellingManagerProduct Yes The details of the folder for this product. ReviseSellingManagerProduct Conditionally Specifies the name of a field to remove from a Selling Manager product. The request can contain zero, one, or many instances of DeletedField (one for each field to be removed). DeletedField accepts the following path names, which remove the corresponding fields:<br><br> SellingManagerProductDetails.CustomLabel<br> SellingManagerProductDetails.QuantityAvailable<br> SellingManagerProductDetails.UnitCost<br> These values are case-sensitive. Use values that match the case of the schema element names. ReviseSellingManagerProduct Conditionally Specifies an eBay category associated with the product, defines Item Specifics that are relevant to the product, and defines variations available for the product (which may be used to create mult-variation listings). ReviseSellingManagerProduct Yes Response for revising a Selling Manager product. The details of the product. ReviseSellingManagerProduct Always Request type containing the input fields for the <b>ReviseSellingManagerSaleRecord</b> call. The standard Trading API deprecation process is not applicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro Unique identifier for an eBay item listing. A listing can have multiple order line items (transactions), but only one <b>ItemID</b>. An <b>ItemID</b> can be paired up with a corresponding <b>TransactionID</b> and used as an input filter for <b>ReviseSellingManagerSaleRecord</b>. The <b>ItemID</b>/<b>TransactionID</b> pair corresponds to a Selling Manager <b>SaleRecordID</b>, which can be retrieved with the <b>GetSellingManagerSaleRecord</b> call. <br><br> Unless an <b>OrderLineItemID</b> is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item (Combined Payment) order, the <b>ItemID</b>/<b>TransactionID</b> pair must be specified. For a multiple line item (Combined Payment) order, <b>OrderID</b> should be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. ReviseSellingManagerSaleRecord Conditionally Unique identifier for an eBay order line item (transaction). An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the <b>TransactionID</b> for auction listings is always 0. Along with its corresponding <b>ItemID</b>, a <b>TransactionID</b> is used and referenced during an order checkout flow and after checkout has been completed. The <b>ItemID</b>/<b>TransactionID</b> pair can be used as an input filter for <b>ReviseSellingManagerSaleRecord</b>. The <b>ItemID</b>/<b>TransactionID</b> pair corresponds to a Selling Manager <b>SaleRecordID</b>, which can be retrieved with the <b>GetSellingManagerSaleRecord</b> call. <br><br> Unless an <b>OrderLineItemID</b> is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item (Combined Payment) order, the <b>ItemID</b>/<b>TransactionID</b> pair must be specified. For a multiple line item (Combined Payment) order, <b>OrderID</b> must be used. If <b>OrderID</b> or <b>OrderLineItemID</b> are specified, the <b>ItemID</b>/<b>TransactionID</b> pair is ignored if present in the same request. ReviseSellingManagerSaleRecord Conditionally A unique identifier that identifies a single line item or multiple line item (Combined Payment) order. <br><br> For a single line item order, the <b>OrderID</b> value is identical to the <b>OrderLineItemID</b> value that is generated upon creation of the order line item. For a Combined Payment order, the <b>OrderID</b> value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Payment order through the eBay site. A Combined Payment order can also be created by the seller through the <b>AddOrder</b> call. The <b>OrderID</b> can be used as an input filter for <b>ReviseSellingManagerSaleRecord</b>. The <b>OrderID</b> is linked to a Selling Manager <b>SaleRecordID</b>, and can be retrieved with the <b>GetSellingManagerSaleRecord</b> call. <br><br> <b>OrderID</b> overrides an <b>OrderLineItemID</b> or <b>ItemID</b>/<b>TransactionID</b> pair if these fields are also specified in the same request. ReviseSellingManagerSaleRecord Conditionally Container consisting of order costs, shipping details, order status, and other information. The changes made under this container will update the order in Selling Manager. ReviseSellingManagerSaleRecord Conditionally <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. For a single line item order, the <b>OrderLineItemID</b> value can be passed into the <b>OrderID</b> field to revise the order in Selling Manager. <br><br> Unless an <b>ItemID</b>/<b>TransactionID</b> pair is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item (Combined Payment) order, the <b>OrderLineItemID</b> must be specified. For a multiple line item (Combined Payment) order, <b>OrderID</b> should be used. If <b>OrderLineItemID</b> is specified, the <b>ItemID</b>/<b>TransactionID</b> pair are ignored if present in the same request. 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) ReviseSellingManagerSaleRecord Conditionally Response to a ReviseSellingManagerSaleRecord call. Revises a Selling Manager template. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro The ID of the sale template. You can obtain a SaleTemplateID by calling GetSellingManagerInventory or AddSellingManagerTemplate. ReviseSellingManagerTemplate Yes Reserved for future use. The name of the sale template. ReviseSellingManagerTemplate No Required. In Item.ItemID, specify the same value as the value you specified in SaleTemplateID. Other child elements hold the values for properties that are being changed. Set values in the Item object only for those properties that are changing. Use DeletedField to remove a property. ReviseSellingManagerTemplate Yes Specifies the name of a field to remove from a template. See the eBay Web Services guide for rules on removing values when revising 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 removed). DeletedField accepts the following path names, which remove the corresponding fields: <br><br> Item.ApplicationData<br> Item.AttributeSetArray<br> Item.ConditionID<br> Item.ItemSpecifics<br> Item.ListingCheckoutRedirectPreference.ProStoresStoreName<br> Item.ListingCheckoutRedirectPreference.SellerThirdPartyUsername<br> Item.ListingDesigner.LayoutID<br> Item.ListingDesigner.ThemeID<br> Item.ListingEnhancement[Value]<br> Item.PayPalEmailAddress<br> Item.PictureDetails.GalleryURL<br> Item.PictureDetails.PictureURL<br> Item.PostalCode<br> Item.ProductListingDetails<br> item.ShippingDetails.PaymentInstructions<br> item.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 (e.g., item.picturedetails.galleryUrl is not allowed). <br><br> Depending on how you have configured your pictures, you cannot necessarily delete both GalleryURL and PictureURL from an existing listing. If GalleryType was already set for the item you are revising, you cannot remove it. This means you still need to include either a first picture or a gallery URL in your revised listing. ReviseSellingManagerTemplate Conditionally Use this field to verify the template instead of revising it. ReviseSellingManagerTemplate No Returns the template ID and the estimated fees for the revised listing. This sale template ID uniquely identifies the template that was revised in the request. This sale template ID should match the template ID specified in the request. specified for the call. ReviseSellingManagerTemplate 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. Not applicable to Half.com. ReviseSellingManagerTemplate 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. Not applicable to Half.com. ReviseSellingManagerTemplate 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. Not applicable to Half.com. ReviseSellingManagerTemplate Conditionally Instead of revising, only verifies the template. ReviseSellingManagerTemplate Always The name of the sale template. ReviseSellingManagerTemplate Always The details of the product that this template belongs to. ReviseSellingManagerTemplate Always Voluntarily revokes a token before it would otherwise expire. FetchToken, GetSessionID, GetTokenStatus Cancels notification subscriptions for the user/application if set to true. Default value is false. RevokeToken No Response when an application has voluntarily revoked a user token. Creates a Selling Manager listing template that is similar to an item. This call is subject to change without notice; the deprecation process is inapplicable to this call. AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro ItemID which should be created as a template and saved to inventory. SaveItemToSellingManagerTemplate Yes Associates the new template with a product. SaveItemToSellingManagerTemplate Yes Name associated with the template. If no name is submitted, the template will be named automatically. SaveItemToSellingManagerTemplate Yes Returns the status of save to template operation. Template ID that is newly created. SaveItemToSellingManagerTemplate Always Enables a seller to "reverse" an Unpaid Item dispute that has been closed, for example, if buyer and seller reach an agreement. The seller's Final Value Fee credit and the buyer's strike are both reversed, if applicable. The dispute might have resulted in a strike to the buyer and a Final Value Fee credit to the seller. A buyer and seller sometimes come to agreement after a dispute has been closed. In particular, the seller might discover that the buyer actually paid, or the buyer might agree to pay the seller's fees in exchange for having the strike removed. <br><br> A dispute can only be reversed if it was closed with DisputeActivity set to SellerEndCommunication, CameToAgreementNeedFVFCredit, or MutualAgreementOrNoBuyerResponse.

Enables a seller to "reverse" an Unpaid Item dispute that has been closed, for example, if buyer and seller reach an agreement. The seller's Final Value Fee credit and the buyer's strike are both reversed. if applicable.

AddDispute, AddDisputeResponse, GetDispute, GetUserDisputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ReverseClosedUPIDispute http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes The unique identifier of the dispute that was returned when the dispute was created. The dispute must be an Unpaid Item dispute that the seller opened. SellerReverseDispute Yes The reason the dispute is being reversed. SellerReverseDispute Yes Returned after calling SellerReverseDisputeRequest. Contains the status of the call and any errors or warnings. Enables a seller to send an order invoice to a buyer. Where applicable, updates to shipping, payment methods, and sales tax made in this request are applied to the specified order as a whole and to the individual order line items whose data are stored in individual <b>Transaction</b> objects. AddItem, GetItemTransactions, GetSellerTransactions Unique identifier for an eBay item listing. Unless <b>OrderID</b> or <b>OrderLineItemID</b> is provided in the request, the <b>ItemID</b> (or <b>SKU</b>) is required and must be paired with the corresponding <b>TransactionID</b> to identify a single line item order. For a multiple line item (Combined Payment) order, <b>OrderID</b> should be used. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) SendInvoice Conditionally Unique identifier for an eBay order line item (transaction). An order line item is created once there is a commitment from a buyer to purchase an item. Since an auction listing can only have one order line item during the duration of the listing, the <b>TransactionID</b> for auction listings is always 0. Unless <b>OrderID</b> or <b>OrderLineItemID</b> is provided in the request, the <b>TransactionID</b> is required and must be paired with the corresponding <b>ItemID</b> to identify a single line item order. For a multiple line item (Combined Payment) order, <b>OrderID</b> should be used. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) SendInvoice Conditionally A unique identifier that identifies a single line item or multiple line item (Combined Payment) orders. <br><br> For a single line item order, the <b>OrderID</b> value is identical to the <b>OrderLineItemID</b> value that is generated upon creation of the order line item. For a Combined Payment order, the <b>OrderID</b> value is created by eBay when the buyer or seller (sharing multiple, common order line items) combines multiple order line items into a Combined Payment order. A Combined Payment order can also be created by the seller through the <b>AddOrder</b> call. <br><br> Unless the <b>ItemID</b> (or SKU) and corresponding <b>TransactionID</b>, or the <b>OrderLineItemID</b> is provided in the request to identify a single line item order, the <b>OrderID</b> must be specified. If <b>OrderID</b> is specified, <b>OrderLineItemID</b>, <b>ItemID</b>, <b>TransactionID</b>, and <b>SKU</b> are ignored if present in the same request. SendInvoice Conditionally If the buyer has an International shipping address, use this container to offer up to three International shipping services. If International shipping services are offered, (domestic) <b>ShippingServiceOptions</b> should not be included in the request. <br><br> <span class="tablenote"><b>Note:</b> Beginning with Version 719, the number of domestic and international shipping services that a seller may offer the buyer is increasing. The number of domestic shipping services that may be offered is increasing from 3 to 4, and the number of international shipping service options is increasing from 3 to 5. </span> <br> This field cannot be used if sending an invoice for digital listings. SendInvoice No If the buyer has a domestic shipping address, use this container to offer up to three domestic shipping services. If domestic shipping services are offered, <b>InternationalShippingServiceOptions</b> should not be included in the request. <br><br> <span class="tablenote"><b>Note:</b> Beginning with Version 719, the number of domestic and international shipping services that a seller may offer the buyer is increasing. The number of domestic shipping services that may be offered is increasing from 3 to 4, and the number of international shipping service options is increasing from 3 to 5. </span> <br> This field cannot be used if sending an invoice for digital listings. SendInvoice No Container consisting of sales tax details. The amount of sales tax to add to the price of an order is dependent on the sales tax rate in the buyer's state and whether sales tax is being applied to the cost of the order only or the cost of the order plus shipping. SendInvoice No Specifies whether an insurance fee is required. An <b>InsuranceOption</b> value of <b>IncludedInShippingHandling</b> cannot be used if the item will use calculated shipping. Some shipping carriers automatically include shipping insurance for qualifying items.<br> <br> Not applicable to invoices for digital listings. SendInvoice NotOfferedOnSite No http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts Insurance cost, as set by seller, if ShippingType = 1. Specify if <b>InsuranceOption</b> is optional or required. Must be greater than zero value if a value of Optional or Required is passed in <b>InsuranceOption</b>. Value specified should be the total cost of insuring the item.<br> <br> Not applicable to invoices for digital listings. 0.0 SendInvoice No http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingGettingCosts This optional field allows a US or German seller to add specific payment methods that were not in the original item listing. The only valid values for this field are 'PayPal' for a US listing, or 'MoneyXferAcceptedInCheckout' (CIP+) for a DE listing. SendInvoice No If the <b>PaymentMethods</b> field is used and set to PayPal, the seller provides his/her PayPal email address in this field. For digital listings, this PayPal email address must be associated with a verified PayPal Premier or Business account. SendInvoice No This field allows the seller to provide a message or instructions regarding checkout/payment or the return policy. 500 SendInvoice No Flag indicating whether or not the seller wishes to receive an email copy of the invoice sent to the buyer. true SendInvoice No Italy site (site ID 101) only. Enables you to specify the cash-on-delivery (COD) cost for COD shipping. SendInvoice No http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CODInShippingDetails The seller's unique identifier for an item that is being tracked by this SKU. If <b>OrderID</b> or <b>OrderLineItemID</b> are not provided, both <b>SKU</b> (or <b>ItemID</b>) and corresponding <b>TransactionID</b> must be provided to uniquely identify a single line item order. For a multiple line item (Combined Payment) order, <b>OrderID</b> must be used. <br> <br> This field can only be used if the <b>Item.InventoryTrackingMethod</b> field (set with the <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b> calls) is set to SKU. 50 SendInvoice Conditionally A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. <br> <br> Unless the <b>ItemID</b> (or <b>SKU</b>) and corresponding <b>TransactionID</b> is used to identify a single line item order, or the <b>OrderID</b> is used to identify a single or multiple line item (Combined Payment) order, the <b>OrderLineItemID</b> must be specified. For a multiple line item (Combined Payment) order, <b>OrderID</b> should be used. If <b>OrderLineItemID</b> is specified, <b>ItemID</b>, <b>TransactionID</b>, and <b>SKU</b> are ignored if present in the same request. 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) SendInvoice Conditionally Returns the status of calling SendInvoice. Enables a seller to add custom Ask Seller a Question (ASQ) subjects to their Ask a Question page, or to reset any custom subjects to their default values. GetMessagePreferences Contains custom ASQ subjects or a flag to reset those subjects to their default values. SetMessagePreferences No Returns the success or failure of the SetMessagePreferencesRequest, and any applicable errors. Manages notification and alert preferences for applications and users. GetNotificationPreferences, GetNotificationsUsage http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PlatformNotifications Specifies application-level event preferences that have been enabled, including the URL to which notifications should be delivered and whether notifications should be enabled or disabled (although the UserDeliveryPreferenceArray input property specifies specific notification subscriptions). SetNotificationPreferences No Specifies events and whether or not they are enabled. SetNotificationPreferences No Specifies user data for notification settings, such as mobile phone number. SetNotificationPreferences No Characteristics or details of an event such as type, name and value. Currently can only be set for wireless applications. SetNotificationPreferences No Specifies up to 25 ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName to associate with a user token sent in a SetNotificationPreferences request. To specify multiple DeliveryURLNames, create separate instances of ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName, and then enable up to 25 DeliveryURLNames by including them in comma-separated format in this field. SetNotificationPreferences No (out) Returns the success or failure of a SetNotificationPreferences request. <table> <tr> <td class="notebox"> <b>Note:</b> This call will soon be deprecated. Use accordingly. </td> </tr> </table> <br> Creates, updates, or deletes Picture Manager account settings, folders, or pictures.

Creates, updates, or deletes Picture Manager account settings, folders, or pictures. This call will soon be deprecated.

GetPictureManagerDetails, GetPictureManagerOptions Specifies the setting or folder to create, update, or delete, or the picture to update. You cannot upload or delete pictures using SetPictureManagerDetails; you must use the eBay site. SetPictureManagerDetails Yes Specifies the action to take on the setting, folder, or picture. The values Add and Delete apply only to folders. SetPictureManagerDetails Yes Returns the status of an action on a setting, folder, or picture in a Picture Manager account. Creates or modifies a promotional sale. Promotional sales enable sellers to apply discounts and/or free shipping across many listings.

Creates or modifies a promotional sale. Promotional sales enable sellers to apply discounts and/or free shipping across many listings.

SetPromotionalSaleListings, GetPromotionalSaleDetails http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PuttingItemsOnSale Specifies adding, removing, or modifying promotional sales. SetPromotionalSale Yes Specifies details about the promotional sale. SetPromotionalSale Yes Contains the ID and status of a promotional sale. The Promotional Price Display feature enables sellers to apply discounts and/or free shipping across many listings. Contains the status of a promotional sale. SetPromotionalSale Always Contains the ID of a promotional sale. SetPromotionalSale Always Changes which item listings are affected by a promotional sale. SetPromotionalSale, GetPromotionalSaleDetails http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PuttingItemsOnSale The ID of the promotional sale that you want to add listings to or delete listings from. SetPromotionalSaleListings Yes You must specify either Add or Delete. <br><br> This field determines whether you are adding listings to, or deleting listings from, the promotional sale you specify in the PromotionalSaleID field. <br><br> If you specify Delete, you must specify PromotionalSaleItemIDArray. Delete is applicable only in cases where you specify PromotionalSaleItemIDArray. Auction or auction/BIN format listings cannot be added to or deleted from a promotional sale if the item has bids. SetPromotionalSaleListings Add, Delete Yes The IDs of the item listings to be affected by the action you specify in the Action field. SetPromotionalSaleListings Conditionally Adds to the promotional sale all the seller's item listings with the StoreCategoryID specified in this field. Requires that you specify Add in the Action field. SetPromotionalSaleListings No Adds to the promotional sale all the seller's item listings with the CategoryID specified in this field. Requires that you specify Add in the Action field. SetPromotionalSaleListings No Adds to the promotional sale all the seller's item listings that are fixed price items. Requires that you specify Add in the Action field. SetPromotionalSaleListings No Adds to the promotional sale all the seller's item listings that are store inventory items. Requires that you specify Add in the Action field. SetPromotionalSaleListings No Adds to the promotional sale all the seller's item listings that are auction items. Auction and auction/BIN format listings can be added to free shipping sales only. Requires that you specify Add in the Action field. SetPromotionalSaleListings No Contains the status of a promotional sale. Contains the status of a promotional sale. SetPromotionalSaleListings Always Enables Selling Manager subscribers to store standard feedback comments that can be left for their buyers. Selling Manager Pro subscribers can also specify what events, if any, will trigger an automated feedback to buyers.

Enables Selling Manager and Selling Manager Pro subscribers to store feedback comments for buyers and set automated feedback preferences (Selling Manager Pro subscribers only).

AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Feedback Specifies the event that will trigger automated feedback to the buyer. Applies to Selling Manager Pro subscribers only. SetSellingManagerFeedbackOptions No Contains a set of comments from which one can be selected to leave feedback for a buyer. If automated feedback is used, a comment is selected from the set randomly. Automated feedback applies to Selling Manager Pro subscribers only. Stored comments cannot be replaced or edited individually. Submitting a stored comments array replaces all existing stored comments. <br> SetSellingManagerFeedbackOptions No Provides confirmation that feedback comments and (optionally) automated feedback preferences were added successfully. Revises, or adds to, the set of Selling Manager automation rules associated with an item. <br> <br> This call is subject to change without notice; the deprecation process is inapplicable to this call. <br> <br> Using this call, you can add an autolist rule. You also can add a second chance offer rule (restricted to auction items and auction templates). Note that autorelist rules can only be set on templates. An autorelist rule for an item is inherited from a template. <br> <br> This call also enables you to specify particular information about automation rules. <br> <br> If a node is not passed in the call, the setting for the corresponding automation rule remains unchanged. <br> <br> Although this call can revise (overwrite) an existing rule, this call cannot delete an automation rule. (Instead, use DeleteSellingManagerItemAutomationRule.)

Revises or adds to the set of Selling Manager automation rules associated with a specific item.

AddSellingManagerTemplate,GetSellingManagerTemplates http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro The item ID whose automation rules you want to change. SetSellingManagerItemAutomationRule Yes The information for the automated relisting rule to be associated with the item. SetSellingManagerItemAutomationRule No The information for the automated second chance offer rule to be associated with the item. SetSellingManagerItemAutomationRule No Contains the set of automation rules associated with the specified item. Contains the automated listing rule associated with this item. SetSellingManagerItemAutomationRule Conditionally Contains the automated relisting rule associated with this item. SetSellingManagerItemAutomationRule Conditionally Contains the automated second chance offer rule associated with this item. SetSellingManagerItemAutomationRule Conditionally Contains fees that may be incurred when items are listed using the automation rules (e.g., a scheduled listing fee). Use of an automation rule does not in itself have a fee, but use can result in a fee. SetSellingManagerItemAutomationRule Conditionally Revises, or adds to, the Selling Manager automation rules associated with a template. <br> <br> This call is subject to change without notice; the deprecation process is inapplicable to this call. <br> <br> Using this call, you can add either an autorelist rule or an autolist rule, but not both. You also can add a second chance offer rule (restricted to auction items and auction templates). <br> <br> This call also enables you to specify particular information about automation rules. <br> <br> If a node is not passed in the call, the setting for the corresponding automation rule remains unchanged. <br> <br> Although this call can revise (overwrite) an existing rule, this call cannot delete an automation rule. (Instead, use DeleteSellingManagerTemplateAutomationRule.)

Revises or adds to the Selling Manager automation rules associated with a specific template.

AddSellingManagerTemplate,GetSellingManagerTemplates,GetSellingManagerTemplateAutomationRule,DeleteSellingManagerTemplateAutomationRule http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps http://pages.ebay.com/selling_manager/ http://pages.ebay.com/selling_manager_pro The ID of the Selling Manager template whose automation rules you want to change. You can obtain a SaleTemplateID by calling GetSellingManagerInventory. SetSellingManagerTemplateAutomationRule Yes The information for the automated listing rule to be associated with the template. SetSellingManagerTemplateAutomationRule No The information for the automated relisting rule to be associated with the template. SetSellingManagerTemplateAutomationRule No The information for the automated second chance offer rule to be associated with the template. SetSellingManagerTemplateAutomationRule No Contains the set of automation rules associated with the specified template. Contains the automated listing rule associated with this template. SetSellingManagerTemplateAutomationRule Conditionally Contains the automated relisting rule associated with this template. SetSellingManagerTemplateAutomationRule Conditionally Contains the automated second chance offer rule associated with this template. SetSellingManagerTemplateAutomationRule Conditionally Contains fees that may be incurred when items are listed using the automation rules (e.g., a scheduled listing fee). Use of an automation rule does not in itself have a fee, but use can result in a fee. SetSellingManagerTemplateAutomationRule Conditionally Enables a seller to define shipping cost discount profiles for things such as combined payments for shipping and handling costs. AddItem, GetItem, GetShippingDiscountProfiles, RelistItem, ReviseItem, VerifyAddItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles The ID of the currency to be used for shipping cost discounts and insurance for combined payment. A discount profile can only be associated with a listing if the currency ID of the profile matches the currency ID of the listing. <br><br> Required if the user creates flat rate shipping discount profiles, a promotional discount, a packaging/handling cost profile based on a variable discount rule, or if the user defines shipping insurance range/fee pairs. <br><br> Note: There is a currencyID attribute on many elements of SetShippingDiscountProfiles. To avoid an error, be sure to use the same value of CurrencyCodeType in each occurrence within the same request. SetShippingDiscountProfiles Conditionally This field is used to specify the number of days after the sale of an item in which the buyer or seller can combine multiple and mutual order line items into one Combined Payment order. In a Combined Payment order, the buyer makes one payment for all order line items, hence only unpaid order line items can be combined into a Combined Payment order. SetShippingDiscountProfiles Yes Indicates what action to take on the specified flat shipping discount, calculated shipping discount or promotional discount. If the action is Delete and if a flat rate or calculated shipping discount profile is specified, the discount profile identified by DiscountProfile.DiscountProfileID is deleted (see DiscountProfile.MappedDiscountProfileID for related details). SetShippingDiscountProfiles Yes Details of a shipping cost discount profile for flat rate shipping. If this is provided, CalculatedShippingDiscount and PromotionalShippingDiscountDetails should be omitted. SetShippingDiscountProfiles No Details of a shipping cost discount profile for calculated shipping. If this is provided, FlatShippingDiscount and PromotionalShippingDiscountDetails should be omitted. SetShippingDiscountProfiles No The data for the specific packaging/handling cost details for combined payment. SetShippingDiscountProfiles No The data for the promotional shipping discount. If this is provided, FlatShippingDiscount and CalculatedShippingDiscount should be omitted. SetShippingDiscountProfiles No Information establishing what fee to apply for domestic shipping insurance for combined payment depending on which range the order item-total price falls into. SetShippingDiscountProfiles No Information establishing what fee to apply for international shipping insurance for combined payment depending on which range the order item-total price falls into. SetShippingDiscountProfiles No The response to a call of SetShippingDiscountProfiles. Sets the configuration of the eBay store owned by the caller. GetStoreOptions, GetStore, GetStoreCustomPage, SetStoreCustomPage, SetStoreCategories, GetStoreCategoryUpdateStatus http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EditingStoreSettings Specifies the Store configuration that is being set for the user. SetStore Yes Returned after calling SetStoreRequest. This serves as confirmation that the Store configuration was successfully submitted. Changes the category structure of an eBay store. GetStore, GetStoreCategoryUpdateStatus, SetStore http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingeBayStores Specifies the type of action (Add, Move, Delete, or Rename) to carry out for the specified categories. SetStoreCategories Yes Items can only be contained within child categories. A parent category cannot contain items. If adding, moving, or deleting categories displaces items, you must specify a destination child category under which the displaced items will be moved. The destination category must have no child categories. SetStoreCategories Conditionally When adding or moving store categories, specifies the category under which the listed categories will be located. To add or move categories to the top level, set the value to -999. SetStoreCategories Conditionally Specifies the store categories on which to act. SetStoreCategories Yes Returns the status of the processing progress for changes to the category structure for a store. The task ID associated with the category structure change request. For a simple change, the SetStoreCategories call is processed synchronously. That is, simple changes are made immediately and then the response is returned. For synchronous processing, the task ID in the response is 0. If the category structure changes affect many listings, the changes will be processed asynchronously and the task ID will be a positive number. Use the non-zero task ID with GetStoreCategoryUpdateStatus to monitor the status of asynchronously processed changes. SetStoreCategories Always When a category structure change is processed synchronously, the status is returned as Complete or Failed. For asynchronously processed changes, the status is reported as Pending. Use GetStoreCategoryUpdateStatus to monitor the status of asynchronously processed changes. SetStoreCategories Always Contains data for store categories that you have created. SetStoreCategories Always Creates or updates a custom page on a user's eBay Store. GetStoreOptions, GetStore, SetStore, GetStoreCustomPage http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingCustomPages The custom page being submitted. SetStoreCustomPage Yes Returned after calling SetStoreCustomPageRequest. This serves as confirmation that the custom page was successfully submitted. The custom page that was submitted. SetStoreCustomPage Always Sets the preferences for a user's eBay Store. GetStore, GetStorePreferences, SetStore http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingeBayStores Specifies the store preferences. SetStorePreferences No Returned after calling SetStorePreferencesRequest. This serves as confirmation that the Store preferences were successfully submitted. Sets the tax table for a seller on a given site. GetTaxTable http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SalesTax http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SettingUserPreferences http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SalesTax A container of tax jurisdiction information unique to a user/site combination. SetTaxTable Yes Response to SetTaxTableRequest. Enables users to add, replace, and delete My eBay notes for items that are being tracked in the My eBay All Selling and All Buying areas. ID of the item to which the My eBay note will be attached. Notes can only be added to items that are currently being tracked in My eBay. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) SetUserNotes Conditionally Specifies whether to add/update the note or delete. SetUserNotes Yes Text of the note. Maximum 250 characters. Required only if the Action is <b>AddOrUpdate</b>. This note text will completely replace any existing My eBay note for the specified item. 250 SetUserNotes Conditionally Unique identifier for the order line item (transaction) to which the My eBay note will be attached. Notes can only be added to order line items that are currently being tracked in My eBay. Buyers can view user notes made on order line items in the <b>PrivateNotes</b> field of the <b>WonList</b> container in <b>GetMyeBayBuying</b>, and sellers can view user notes made on order line items in the <b>PrivateNotes</b> field of the <b>SoldList</b> and <b>DeletedFromSoldList</b> containers in <b>GetMyeBaySellinging</b>. SetUserNotes No Container consisting of name-value pairs that identify (match) one variation within a fixed-price, multi-variation listing. The specified name-value pair(s) must exist in the listing specified by either the <b>ItemID</b> or <b>SKU</b> values specified in the request. If a specific order line item is targeted in the request with an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value, any specified <b>VariationSpecifics</b> container is ignored by the call. SetUserNotes No SKU value of the item variation to which the My eBay note will be attached. Notes can only be added to items that are currently being tracked in My eBay. A SKU (stock keeping unit) value is defined by and used by the seller to identify a variation within a fixed-price, multi- variation listing. The SKU value is assigned to a variation of an item through the <b>Variations.Variation.SKU</b> element. <br> <br> This field can only be used if the <b>Item.InventoryTrackingMethod</b> field (set with the <b>AddFixedPriceItem</b> or <b>RelistFixedPriceItem</b> calls) is set to SKU. <br> <br> If a specific order line item is targeted in the request with an <b>ItemID</b>/<b>TransactionID</b> pair or an <b>OrderLineItemID</b> value, any specified <b>SKU</b> is ignored by the call. SetUserNotes No A unique identifier for an eBay order line item. This field is created as soon as there is a commitment to buy from the seller, and its value is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. <b>OrderLineItemID</b> can be used in the input instead of an <b>ItemID</b>/<b>TransactionID</b> pair to identify an order line item. <br> <br> Notes can only be added to order line items that are currently being tracked in My eBay. Buyers can view user notes made on order line items in the <b>PrivateNotes</b> field of the <b>WonList</b> container in <b>GetMyeBayBuying</b>, and sellers can view user notes made on order line items in the <b>PrivateNotes</b> field of the <b>SoldList</b> and <b>DeletedFromSoldList</b> containers in <b>GetMyeBaySellinging</b>. 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) SetUserNotes Conditionally Returns the status of the call. Sets the authenticated user's preferences to those specified in the request. GetUserPreferences http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ManagingUserPreferences Container consisting of the seller's preference for receiving contact information for unsuccessful bidders. This preference is only applicable for auction listings. SetUserPreferences No Container consisting of the seller's Combined Payment preferences. <br> <span class="tablenote"><strong>Note:</strong> This container's CalculatedShippingPreferences and FlatShippingPreferences child containers should no longer be used. Instead, use the SetShippingDiscountProfiles call to set the shipping rates for combined payment orders. </span> <br> <span class="tablenote"><strong>Note:</strong> A seller's Combined Payment preferences can take up to 7 days to have any logical or functional effect on eBay. </span> SetUserPreferences No Container consisting of the seller's cross-promotion preferences. These preferences are only applicable for eBay Store owners. One or more preferences may be set or modified under this field. SetUserPreferences No Container consisting of the seller's payment preferences. One or more preferences may be set or modified under this field. SetUserPreferences No Container consisting of the seller's preferences for displaying items on a buyer's Favorite Sellers' Items page or Favorite Sellers' Items digest. One or more preferences may be set or modified under this field. SetUserPreferences No Container consisting of the seller's preferences for the end-of-auction email sent to the winning bidder. These preferences allow the seller to customize the Email that is sent to buyer at the end of the auction. One or more preferences may be set or modified under this field. These preferences are only applicable for auction listings. SetUserPreferences No Flag that controls whether the shipment's tracking number is sent by Email from the seller to the buyer. false SetUserPreferences No Flag that controls whether the buyer is required to provide a shipping phone number upon checkout. Some shipping carriers require the receiver's phone number. false SetUserPreferences No Container consisting of a seller's Unpaid Item Assistant preferences. The Unpaid Item Assistant automatically opens an Unpaid Item dispute on the behalf of the seller. One or more preferences may be set or modified under this field. SetUserPreferences No http://pages.ebay.com/sell/UPI/upiassistant/index.html http://pages.ebay.com/sell/UPI/standardprocess/index.html Container consisting of a seller's preference for sending a purchase reminder email to buyers. SetUserPreferences No A flag used to disable the use of a third-party application to handle the checkout flow for a seller. If set to true, Third-Party Checkout is disabled and any checkout flow initiated on the seller's application is redirected to the eBay checkout flow. false SetUserPreferences No Returned after a call to SetUserPreferences to indicate that the call succeeded. Uploads a picture for a listing and returns a URL for the picture. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PictureDetails http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Gallery http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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> <span class="tablenote"><b>Note:</b> If a URI contains spaces, replace them with <code>%20</code>. For example, <code>http://example.com/my image.jpg</code> must be submitted as <code>http://example.com/my%20image.jpg</code> to replace the space in the image file name. </span> <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 1 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 Validates the user response to a <b class="con">GetChallengeToken</b> botblock challenge.

Validates the user response to a GetChallengeToken botblock challenge.

GetChallengeToken Botblock token that was returned by GetChallengeToken. ValidateChallengeInput Yes User response to a botblock challenge. ValidateChallengeInput Yes Whether the challenge token should remain valid for up to two minutes. false ValidateChallengeInput No Validate the user response to botblock challenge. Indicates whether the token is valid. ValidateChallengeInput Always Requests to enable a test user to sell items in the Sandbox environment. GetUser Value for the feedback score of a user. If no value is passed in the request, or if the value is zero, the feedback score is unchanged. This element is not intended for regularly testing feedback because the feedback value can change after the request. ValidateTestUserRegistration No 0 1000 Value for the date and time that a user's registration begins. ValidateTestUserRegistration No Indicates if a user subscribes to Seller's Assistant. You cannot request to subscribe a user to both Seller's Assistant and Seller's Assistant Pro. You cannot request to unsubscribe a user. ValidateTestUserRegistration No Indicates if a user subscribes to Seller's Assistant Pro. You cannot request to subscribe a user to both Seller's Assistant and Seller's Assistant Pro. You cannot request to unsubscribe a user. ValidateTestUserRegistration No Indicates if a user subscribes to Selling Manager. You cannot request to subscribe a user to both Selling Manager and Selling Manager Pro. You cannot request to unsubscribe a user. ValidateTestUserRegistration No Indicates if a user subscribes to Selling Manager Pro. You cannot request to subscribe a user to both Selling Manager and Selling Manager Pro. You cannot request to unsubscribe a user. ValidateTestUserRegistration No Returned after calling ValidateTestUserRegistrationRequest; confirms a successful call. Reports items that allegedly infringe your copyright, trademark, or other intellectual property rights. You can report one or more items at a time with this call. You must be a member of the Verified Rights Owner (VeRO) Program to use this call.

Reports items that allegedly infringe your copyright, trademark, or other intellectual property rights. You must be a member of the Verified Rights Owner (VeRO) Program to use this call.

GetVeROReasonCodeDetails, GetVeROReportStatus User ID of the VeRO member reporting the items. VeROReportItems Yes Container (packet) for items being reported. You can report the same item more than once in a packet if a different reason code is used each time. VeROReportItems No Contains a packet ID and status for the items reported by the VeRO Program member. A unique packet identifier for the items reported. VeROReportItems Conditionally The processing status of the packet. VeROReportItems Conditionally Enables a seller to test the definition of a new fixed-price listing by submitting the definition to eBay without creating a actual listing. AddFixedPriceItem, VerifyAddItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures 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 Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing.&nbsp;<b>Also for Half.com</b>. <br><br> Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the recoupment terms before adding or verifying items. This agreement allows eBay to reimburse a buyer during a dispute and then recoup the cost from the seller. The US site is a recoupment site, and the agreement is located <a href="https://scgi.ebay.com/ws/eBayISAPI.dll?CBTRecoupAgreement">here</a>. The list of the sites where a user has agreed to the recoupment terms is returned by the GetUser response. AddItem, GetItemRecommendations, VerifyAddFixedPriceItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures ItemType object, the properties of which define the new item listing. VerifyAddItem Yes Indicates if the response should include detailed data relating to whether an item would qualify as an Express listing. For information about the Express-related data that can be returned when IncludeExpressRequirements is set to true, see the response of VerifyAddItem and see the eBay Web Services Guide. 579 NoOp false VerifyAddItem No <b>Deprecated.</b> This field will be removed from the schema in a future release. Recommended usage as of release 439 varies for eBay.com listings and Half.com listings. <br><br> For eBay.com listings: As of release 439, this field can still be passed in, but we recommend that you update your applications to use the ExternalProductID field defined on the item instead (i.e., Item.ExternalProductID). If you specify both Item.ExternalProductID and this field in the same request, eBay uses the value in Item.ExternalProductID and ignores the value in this field. See Item.ExternalProductID for information on using an external ID for eBay.com listings. <br><br> For Half.com listings: As of release 439, this field is required for Half.com listings. Causes Half.com to list the item with Pre-filled Item Information based on an ISBN value or other supported external ID, plus other meta-data that you specify. See the eBay Web Services guide for information about listing to Half.com. VerifyAddItem Conditionally 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 listing. VerifyAddItem does not actually list an item, so 0 is returned instead of a normal item ID. <br><br> <span class="tablenote"><b>Note:</b> Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see <a href= "http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468"> Common FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge Base. </span> 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) VerifyAddItem Always Child Fee containers provide the listing feature names, fees, and possible discounts for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. <br /> <br /> There is no guarantee that a PromotionalDiscount returned with VerifyAddItem will be realized when the seller uses AddItem to list the same item. This is the result of the timing of certain promotions. <br /> <br /> <span class="tablenote"><strong>Note:</strong> Starting with version 619, the behavior of VerifyAddItem changed to match that of AddItem. With a request version of 619 or higher, the value of Fees.Fee.Fee for VerifyAddItem represents the actual cost of the respective feature, with any discounts subtracted from the posted feature price. With a request version lower than 619, VerifyAddItem returns the full price of the feature in the Fee element, regardless of whether or not a discount was applied. </span> VerifyAddItem 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 VerifyAddItem 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 VerifyAddItem 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 VerifyAddItem 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 VerifyAddItem Conditionally The nature of the discount, if a discount would have applied had this actually been listed at this time. VerifyAddItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. VerifyAddItem Conditionally Simulates the creation of a new Second Chance Offer listing of an item without actually creating a listing. GetAllBidders, AddSecondChanceItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MakingSecondChanceOffersForItems Specifies the bidder from the original, ended listing to whom the seller is extending the second chance offer. Specify only one RecipientBidderUserID per call. If multiple users are specified (each in a RecipientBidderUserID node), only the last one specified receives the offer. VerifyAddSecondChanceItem Yes Specifies the amount the offer recipient must pay to purchase the item from the second chance offer listing. Use only when the original item was an eBay Motors (or in some categories on U.S. and international sites for high-priced items, such as items in many U.S. and Canada Business and Industrial categories) and it ended unsold because the reserve price was not met. Call fails with an error for any other item conditions. VerifyAddSecondChanceItem No Specifies the length of time the second chance offer listing will be active. The recipient bidder has that much time to purchase the item or the listing expires. VerifyAddSecondChanceItem Yes Specifies the item ID for the original, ended listing from which the second chance offer item comes. A new ItemID is returned for the second chance offer item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) VerifyAddSecondChanceItem Yes Message content. Cannot contain HTML, asterisks, or quotes. This content is included in the second chance offer email sent to the recipient, which can be retrieved with GetMyMessages. 1000 VerifyAddSecondChanceItem No VerifyAddSecondChanceItem request to emulate creation of a new Second Chance Offer for an item to one of that item's bidders. Indicates the date and time when the the new second chance offer listing became active and the recipient user could purchase the item. VerifyAddSecondChanceItem Always Indicates the date and time when the second chance offer listing expires, at which time the listing ends (if the recipient user does not purchase the item first). VerifyAddSecondChanceItem Always Checks the arguments that you plan to use for a RelistItem call, looking for errors and listing fees, without actually relisting the item. RelistItem Child elements hold the values for item properties that change for the item re-list. Item is a required input. At a minimum, the Item.ItemID property must be set to the ID of the listing being re-listed (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 corresponding value from the old listing. VerifyRelistItem Yes Specifies the name of the field to remove from a listing. See the Developer's Guide for rules on removing values when relisting items. DeletedField accepts the same values as DeletedField in RelistItem. DeletedField is case sensitive. The request can contain zero, one, or many instances of DeletedField. VerifyRelistItem Conditionally Returns the estimated fees for the listing that is being verified for a re-list. Unique item ID for the new listing. As VerifyRelistItem does not actually re-list an item, returns 0 instead of a normal item ID. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) VerifyRelistItem 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. VerifyRelistItem Always Date and time the new listing became active on the eBay site. VerifyRelistItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. VerifyRelistItem Always The nature of the discount, if a discount would have applied had this actually been listed at this time. VerifyRelistItem Conditionally Provides a list of products recommended by eBay which match the item information provided by the seller. Not applicable to Half.com. VerifyRelistItem 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 Yes 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 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=HTTPHeaders ../../HowTo/eBayWS/eBaySchemaVersioning.html ../../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 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttributeErrorHandling 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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. <br><br> To subscribe to and receive eBay Buyer Protection notifications, this field is required, and you must pass in 'eBP notification' as a string. 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 account. You can use GetUser.User.SellerInfo.IntegratedMerchantCreditCardInfo to determine if a seller has a payment gateway account. If a seller successfully uses AddItem with IntegratedMerchantCreditCard, then for the resulting item, the IntegratedMerchantCreditCard value is a replacement for a credit-card payment method 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. 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. This payment method can be added only if a seller has a IMCC payment gateway account and Diners Club card is selected in credit card preference. Currently Dines card is enabled for CyberSource Gateway sellers. Unless the buyer and seller agree to COD (Cash On Delivery) or POP (Pay on Pickup) as the form of payment for an order, StandardPayment is always the buyer payment method returned to the seller when the order is part of the new payment process on the German and Austrian sites. Beginning August 22, 2011, sellers new to listing on the German and Austrian sites are subject to the new payment process. 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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. Defines the action taken on a dispute with AddDisputeResponse. The value you can use at a given time depends on the current value of DisputeState (see the Developer Guide for more information). Some values are for Unpaid Item disputes and some are for Item Not Received disputes. (in) The seller wants to add a response to the dispute. For Unpaid Item disputes. The seller is limited to 25 responses. (in) The buyer has paid or the seller otherwise does not need to pursue the dispute any longer. For Unpaid Item disputes. (in) The seller has made an agreement with the buyer and requires a credit for a Final Value Fee already paid. For Unpaid Item disputes. (in) The seller wants to end communication or stop waiting for the buyer. For Unpaid Item disputes. (in) The seller wants to end communication or stop waiting for the buyer. Mutual agreement has been reached or the buyer has not responded within 7 days. For Unpaid Item disputes. (in) The seller offers a full refund if the buyer did not receive the item or a partial refund if the item is significantly not as described. For Item Not Received or Significantly Not As Described disputes. Can be used when DisputeState is:<br> NotReceivedNoSellerResponse<br> NotAsDescribedNoSellerResponse<br> NotReceivedMutualCommunication<br> NotAsDescribedMutualCommunication (in) The seller has shipped the item or a replacement and provides shipping information. For Item Not Received and Significantly Not As Described disputes. Can be used when DisputeState is:<br> NotReceivedNoSellerResponse<br> NotReceivedMutualCommunication (in) The seller communicates with the buyer, offering a response or comment. The seller is limited to 25 responses. For Item Not Received and Significantly Not As Described disputes. Can be used when DisputeState is:<br> NotReceivedNoSellerResponse<br> NotAsDescribedNoSellerResponse<br> NotReceivedMutualCommunication<br> NotAsDescribedMutualCommunication (in) The buyer has not received an expected full or partial refund from the seller in an Item Not Received or Significantly Not As Described buyer dispute. This value can be used when DisputeState is:<br> NotReceivedNoSellerResponse <br> NotReceivedMutualCommunication <br> (out) Reserved for internal or future use. Indicates whether the seller is eligible for a Final Value Fee credit if the dispute is resolved by the buyer and seller, or if eBay customer support makes a decision on the dispute in the seller's favor. Note that even if the item is eligible for a Final Value Fee credit, the credit is not guaranteed in any way. (out) The seller is not currently eligible for a Final Value Fee credit. (out) The seller is eligible for a Final Value Fee credit. (out) Reserved for internal or future use. Contains the dispute explanation, entered when the dispute was created. Provides additional information to supplement the dispute reason. The values allowed depend on the value of DisputeReason. The buyer has not responded within the 7-day waiting period. Allowed when DisputeReason is BuyerHasNotPaid. The buyer has refused to pay. Allowed when DisputeReason is BuyerHasNotPaid. The buyer is not cleared to pay. Allowed when DisputeReason is BuyerHasNotPaid. The buyer returned the item for a refund. Allowed when DisputeReason is TransactionMutuallyCanceled. The buyer and seller were unable to resolve a disagreement over terms. Allowed when DisputeReason is TransactionMutuallyCanceled. The buyer no longer wants the item. Allowed when DisputeReason is TransactionMutuallyCanceled. The buyer made a mistake. Allowed when DisputeReason is TransactionMutuallyCanceled. The buyer requests shipment to a country that the seller does not ship to. Allowed when DisputeReason is BuyerHasNotPaid. Deprecated. The buyer requests shipment to an unconfirmed address. Allowed when DisputeReason is BuyerHasNotPaid or TransactionMutuallyCanceled. The buyer requests a payment method that the seller does not accept. Allowed when DisputeReason is BuyerHasNotPaid or TransactionMutuallyCanceled. Deprecated. The buyer is no longer a registered user. Allowed when DisputeReason is BuyerHasNotPaid. Some other reason not specified in this code list. Allowed when DisputeReason is either BuyerHasNotPaid OR TransactionMutuallyCanceled. Used when DisputeReason is ItemNotReceived or SignificantlyNotAsDescribed. The dispute was opened by the Unpaid Item Assistance mechanism. This can only be set by eBay. Payment was not received or didn't clear. Seller doesn't ship to the country requested by buyer. Buyer has not paid for the item. The dispute was opened by the Unpaid Item Assistance mechanism and was subsequently converted to a manual dispute, either by the seller or by eBay. This can only be set by eBay. This dispute explanation can be used by the seller when the seller has to cancel an order due to one or more order line items being out of stock. This value is only valid if using Version 741 (or later) of the Trading WSDL. Reserved for internal or future use. The number of disputes that match a given filter. A filter used to reduce the number of disputes returned. The filter uses criteria such as whether the dispute is awaiting a response, is closed, or is eligible for credit. Both Unpaid Item and Item Not Received disputes can be returned for the same filter value. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always The number of disputes that match the filter. In the GetUserDisputes response, not returned for the filter type that was used in the request. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always Enumeration type that specifies the dispute filters that can be used in the DisputeFilterType field of the GetUserDisputes call. Note that eBay Buyer Protection cases are not returned with the GetUserDisputes call, regardless of the filter that is used. If used, this filter returns all open and closed disputes that involve the caller as a buyer or seller. If used, this filter returns all open disputes that involve the caller as a buyer or seller and are awaiting a response from the caller. This is the default DisputeFilterType value. In other words, if no DisputeFilterType is specified in the request, only those disputes where the caller's response is due are returned. If used, this filter returns all open disputes that involve the caller as a buyer or seller and are awaiting a response from the other party. If used, this filter returns all closed disputes that involve the caller as a buyer or seller. If used, this filter returns all disputes that involve the caller as a buyer or seller and are eligible for a Final Value Fee credit, regardless of whether or not the credit has been granted. If used, this filter returns all open and closed Unpaid Item disputes that involve the caller as a buyer or seller. If used, this filter returns all open and closed Item Not Received disputes that involve the caller as a buyer or seller. Reserved for future use. An identifier of a dispute. Defines who added a message to a dispute. Used for both Unpaid Item and Item Not Received disputes. (out) The buyer of the item under dispute. (out) The seller of the item under dispute. (out) eBay, either an administrator or the site itself. (out) Reserved for internal or future use. Contains a message posted to a dispute. The message can be posted by the buyer, the seller, or an eBay representative. An ID that uniquely identifies the message. GetDispute Always GetUserDisputes

DetailLevel: ReturnAll, none

Conditionally The party who posted the message: the buyer, the seller, or an eBay representative. GetDispute Always GetUserDisputes

DetailLevel: ReturnAll, none

Conditionally The date and time the message was created, in GMT. GetDispute Always GetUserDisputes

DetailLevel: ReturnAll, none

Conditionally The text of the message. GetDispute Always GetUserDisputes

DetailLevel: ReturnAll, none

Conditionally Specifies the top-level reason for the dispute and determines the values you can use for DisputeExplanation. Some values are for Item Not Received disputes and others are for Unpaid Item Process disputes. The buyer has not paid for the item. For Unpaid Item Process disputes. The seller claims that the buyer agrees to not complete the order. This triggers a waiting period for buyer agreement, disagreement or no buyer response. For Unpaid Item disputes. The buyer did not receive the item. For Item Not Received disputes. An option for Item Not Received disputes. The item was returned but no refund was given. Item was returned and seller was not paid. Reserved for future use. Describes the type of dispute, either Unpaid Item or Item Not Received. (out) An Unpaid Item dispute. (out) An Item Not Received dispute. One type come from Half.com. (out) Reserved for internal or future use. Defines the reason a dispute was resolved. The dispute was not resolved. The buyer provided proof of payment in feedback. The buyer or seller had a technical problem with a computer. The buyer and seller have not made contact. The buyer or seller had a family emergency. The buyer provided proof of payment in feedback. The dispute was the buyer's first infraction. The buyer and seller came to agreement. The buyer returned the item. The buyer reimbursed the seller's auction fees. The seller received payment. Some other resolution occurred. After eBay approved payment of the claim, the claim was paid. Reserved for future use. Specifies the action taken by eBay as a result of the dispute resolution. The buyer received an Unpaid Item Strike. The buyer is suspended and unable to use the eBay site. The buyer is restricted and unable to bid or purchase items. The seller received a Final Value Fee credit. The seller's listing fee was credited. The buyer's Unpaid Item Strike was appealed. The restriction on the buyer was lifted. The restriction on the buyer was lifted. The seller's Final Value Fee credit was reversed. The seller's listing fee was reversed. The buyer is given a ticket. The seller did not receive a Final Value Fee credit. The buyer did not received the item, and the buyer filed a claim. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. Reserved for future use. Credit amount for feature fees. Amount not returned or credited for feature fees. Item price. Amount reversed on credit card for feature fees. Reserved for internal or future use. Contains all information about a dispute resolution. A dispute can have a resolution even if the seller does not receive payment. The resolution can have various results, including a Final Value Fee credit to the seller or a strike to the buyer. The action resulting from the resolution, affecting either the buyer or the seller. GetUserDisputes

DetailLevel: ReturnAll, none

Conditionally CSGetDisputeSummary Always The reason for the resolution. The DisputeResolutionReason results in the action described by the DisputeResolutionRecordType. GetUserDisputes

DetailLevel: ReturnAll, none

Conditionally CSGetDisputeSummary Always The date and time the dispute was resolved, in GMT. GetUserDisputes

DetailLevel: ReturnAll, none

Conditionally CSGetDisputeSummary Always Specifies how a list of returned disputes should be sorted. (in) Sort by the time the dispute was created, in descending order. (in) Sort by the time the dispute was created, in ascending order. (in) Sort by the time the dispute was created, in descending order. (in) Sort by the dispute status, in ascending order. (in) Sort by the dispute status, in descending order. (in) Sort by whether the dispute is eligible for Final Value Fee credit, in ascending order. Ineligible disputes are listed before eligible disputes. (in) Sort by whether the dispute is eleigible for Final Value Fee credit, in descending order. Eligible disputes are listed before i(ineligible disputes. (out) Reserved for internal or future use. Defines the current state of the dispute, which determines the values that are valid for DisputeActivity. DisputeState is an internal value returned in the response. A value can apply to an Unpaid Item or Item Not Received dispute. A dispute filed when an item is significantly not as described in the product listing is a variation of an Item Not Received dispute. The dispute is locked and cannot be updated. For any type of dispute. No values of DisputeActivity are valid. The dispute is closed. In some cases, it can be reversed with SellerReverseDispute. For any type of dispute. No values of DisputeActivity are valid. eBay sent the buyer an Unpaid Item Reminder with a Pay Now option. Waiting for the buyer's first response. It is within the 7-day grace period. For Unpaid Item Disputes. DisputeActivity can be SellerAddInformation or SellerCompletedTransaction. eBay sent the buyer an Unpaid Item Reminder with no Pay Now option. Waiting for the buyer's first response. It is within the 7-day grace period. For Unpaid Item Disputes. DisputeActivity can be SellerAddInformation or SellerCompletedTransaction. eBay sent the buyer an Unpaid Item Reminder with a Pay Now option. Waiting for the buyer's first response. The 7-day grace period has expired. For Unpaid Item Disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, or SellerEndCommunication. eBay sent the buyer an Unpaid Item Reminder with no Pay Now option. Waiting for the buyer's first response. The 7-day grace period has expired. For Unpaid Item Disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, or SellerEndCommunication. The buyer and seller have communicated, and eBay offered the buyer a Pay Now option. For Unpaid Item Disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, SellerEndCommunication, or CameToAgreementNeedFVFCredit. The buyer and seller have communicated. eBay did not offer the buyer a Pay Now option. For Unpaid Item Disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, SellerEndCommunication, or CameToAgreementNeedFVFCredit. The dispute is pending resolution. A dispute cannot be closed when it is in this state. For Unpaid Item Disputes. No values of DisputeActivity are valid. The buyer and seller have agreed within the grace period not to complete the transaction. For Unpaid Item Disputes. DisputeActivity can be SellerAddInformation. The buyer and seller have agreed not to complete the transaction, after the grace period. For Unpaid Item Disputes. DisputeActivity can be SellerAddInformation, SellerCompletedTransaction, or SellerEndCommunication. The buyer filed an Item Not Received dispute, and the seller has not responded. For Item Not Received disputes. DisputeActivity can be SellerOffersRefund, SellerShippedItem, or SellerComment. The buyer filed an Item Not Received dispute for an item significantly not as described, and the seller has not responded. DisputeActivity can be SellerOffersRefund or SellerComment. The buyer filed an Item Not Received dispute and is communicating with the seller. DisputeActivity can be SellerOffersRefund, SellerShippedItem, or SellerComment. The buyer filed an Item Not Received dispute for an item significantly not as described and is communicating with the seller. DisputeActivity can be SellerOffersRefund. The seller says mutual agreement has been reached and is waiting for the buyer to confirm, or the buyer is returning the item to the seller. DisputeActivity can be SellerAddInformation. For Unpaid Item Disputes. The claim was assigned to an adjuster. The buyer was contacted by eBay and asked to submit paperwork to support the claim. The buyer did not respond to verification or was missing paperwork. The buyer is not eligible for reimbursement. Paperwork was received from the buyer and the claim is being investigated. The buyer's claim was approved for reimbursement and was sent to accounts payable for payment. The buyer was reimbursed. The issue has been resolved: the seller sent the item or a refund. A claim was submitted (via Web). The unpaid item dispute is open. An unpaid item dispute filed by the Unpaid Item Assistance mechanism was disabled by eBay (for example, eBay detected that payment was initiated and the seller needs to manually handle this dispute). An unpaid item dispute filed by the Unpaid Item Assistance mechanism was disabled by the seller (e.g. the buyer and seller have communicated about payment and the seller wishes to extend the time for payment and not let the automatic process close the dispute 4 days after the dispute was automatically opened). Reserved for internal or future use. Describes the status of the dispute, which supplements the DisputeState. Some values apply to Unpaid Item disputes and some to Item Not Received disputes. Disputes can be sorted by DisputeStatus. Ascending order is:<br> 1 - WaitingForSellerResponse<br> 2 - WaitingForBuyerResponse<br> 3 - ClosedFVFCreditStrike<br> 4 - ClosedNoFVFCreditStrike<br> 5 - ClosedFVFCreditNoStrike<br> 6 - ClosedNoFVFCreditNoStrike<br> 7 - Closed<br> 8 - StrikeAppealedAfterClosing<br> 9 - FVFCreditReversedAfterClosing<br> 10 - StrikeAppealedAndFVFCreditReversed<br> Descending order is the reverse. The dispute is closed. For Item Not Received disputes. The dispute is waiting for the seller's response. For both Unpaid Item and Item Not Received disputes. The dispute is waiting for the buyer's response. For both Unpaid Item and Item Not Received disputes. The dispute is closed, the seller received a Final Value Fee credit, and the buyer received a strike. For Unpaid Item disputes. The dispute is closed, the seller did not receive a Final Value Fee credit, and the buyer received a strike. For Unpaid Item disputes. The dispute is closed, the seller received a Final Value Fee credit, and the buyer did not receive a strike. For Unpaid Item disputes. The dispute is closed, the seller did not receive a Final Value Fee credit, and the buyer did not receive a strike. For Unpaid Item disputes. The buyer's strike was appealed after the dispute was closed. For Unpaid Item disputes. The seller's Final Value Fee credit was reversed after the dispute was closed. For Unpaid Item disputes. Both the seller's Final Value Fee credit and the buyer's strike were reversed after the dispute was closed. For Unpaid Item disputes. Claim assigned to an adjuster. Also maps for filed claim in Half.com Buyer contacted and asked to submit paperwork Buyer did not respond to verification or missing some paperwork. Also maps for filed claim in Half.com Not eligible for reimbursement Paperwork received, claim being investigated. Also maps for filed claim in Half.com Claim approved for reimbursement; sent to accounts payable for payment Reimbursement completed Issue resolved: seller sent Item or Refund Claim Submitted via Web flow Unpaid Item dispute opened Reserved for internal or future use. 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 order line item, 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 SOAP faults are used to indicate that an infrastructure error has occurred, such as a problem on eBay's side with database or server going down, or a problem with the client or server-side SOAP framework. Error code can be used by a receiving application to debug a SOAP response message that contains one or more SOAP fault details. Each error code is uniquely defined for each fault scenario. See the eBay documentation for more information. Your application can use error codes as identifiers in your customized error-handling algorithms. Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning). Description of the condition that caused the SOAP fault. 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. Unit of measure. This attribute is shared by various fields, representing units such as lbs, oz, kg, g, in, cm. <br><br> For weight, English major/minor units are pounds and ounces, and metric major/minor units are kilograms and grams. For length, the English unit is inches, and metric unit is centimeters. 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. Contains data for controlling pagination in API requests. Pagination of returned data is required for some calls and not needed in or not supported for some calls. See the documentation for individual calls to determine whether pagination is supported, required, or desirable. This integer value is used to specify the maximum number of entries to return in a single "page" of data. This value, along with the number of entries that match the input criteria, will determine the total pages (see PaginationResult.TotalNumberOfPages) in the result set. For most Trading API calls, the maximum value is 200 and the default value is 25 entries per page. <br><br> For GetOrders, the maximum value is 100 and the default value is 25 orders per page. <br><br> For GetUserDisputes, this value is hard-coded at 200, and any pagination input is ignored. <br><br> For GetProducts, the maximum value is 20, and any higher values are ignored. GetAccount GetCategoryListings GetFeedback GetItemsAwaitingFeedback GetItemTransactions GetLiveAuctionBidders GetMyeBayBuying GetMyeBaySelling GetOrders GetSellerTransactions GetWantItNowSearchResults GetLiveAuctionBidders GetVeROReportStatus GetSellingManagerInventory GetSellingManagerSoldListings GetMyMessages GetMemberMessages No 1 200 25 GetOrders No GetBestOffers No 20 1 50000 50 GetProductSearchResults GetProductFamilyMembers No 1 20 GetProducts No 1 400 GetSearchResults No 1 200 200 GetSellerPayments No 200 200 200 GetUserDisputes No GetSellerList Yes 100 GetPopularKeywords No Specifies the number of the page of data to return in the current call. Default is 1 for most calls. For some calls, the default is 0. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request). See the documentation for other individual calls to determine the correct default value. 1 1 GetAccount GetCategoryListings GetFeedback GetItemsAwaitingFeedback GetItemTransactions GetLiveAuctionBidders GetMyeBayBuying GetMyeBaySelling GetOrders GetSearchResults GetSellerTransactions GetWantItNowSearchResults GetLiveAuctionBidders GetVeROReportStatus GetSellingManagerInventory GetSellingManagerSoldListings GetBestOffers GetMyMessages GetMemberMessages No GetUserDisputes Yes 0 2147483647 0 GetProductSearchResults GetProductFamilyMembers No GetSellerList Yes 1 2147483647 1 GetSellerPayments No 1 2000 1 GetProducts No 1 GetPopularKeywords No Basic type for specifying quantities. 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingAToken Enables a seller to add custom Ask Seller a Question (ASQ) subjects to display on the seller's Ask a Question page, or reset the custom subjects to the default values. Used to reset custom subjects to their default values. For SetMessagePreferences, either ResetDefaultSubjects or Subject is required in the request, but not both. SetMessagePreferences Conditionally Contains the ASQ subjects to display on the seller's Ask a Question page, with one subject per Subject node up to a maximum of nine. The tenth subject, "General question about this item," cannot be edited. An error wil be returned if subjects are duplicated. <br><br> For SetMessagePreferences, either ResetDefaultSubjects or Subject is required in the request, but not both. Subjects are displayed on the ASQ drop-down list in same order as the request. <br><br> Note that the default ASQ subjects will display in the site's language if retrieved from a site other than the seller's own. For example, if if a US seller sells on the DE and the FR sites, the default subjects will display in German and French respectively. However, if the seller adds custom questions, all questions will display only in the seller's language. In the example case, FR and DE buyers would see custom subjects in English only. Use ResetDefaultSubjects to restore the default subjects and the default language display behavior. 60 GetMessagePreferences Conditionally SetMessagePreferences Conditionally Describes the current status of your application with regard to rules governing the number of times your application can execute API calls. (out) The rule is not set and usage limits do not apply. (out) Your application has exceeded its hourly hard limit. (out) Your application has exceeded its daily hard limit. (out) Your application has exceeded its periodic hard limit. (out) Your application has exceeded its hourly soft limit. (out) Your application has exceeded its daily soft limit. (out) Your application has exceeded its periodic soft limit. (out) Reserved for internal or future use. Defines values that describe an application's current status with respect to an API access rule. The rules specify daily, hourly, and periodic usage limits for various eBay Web Services calls. (out) The rule is turned off, and no rule validation was performed. (out) The rule is turned on, and rule validation was performed. (out) The application is blocked from making requests to the call named in this rule. (out) Reserved for internal or future use. Specifies values that describe a transaction on an account. Details of the transaction are returned in AccountEntry. The transaction can be a debit or credit to the account. (out) The reason for the charge is unknown. (out) The fee for listing an item for sale on eBay. (out) The fee for a listing title in boldface font. (out) The fee for adding an optional feature to a listing, such as a reserve fee or a listing upgrade fee. (out) (out) The fee charged when a listed item sells. The fee is a percentage of the final sale price. (out) A payment by check made by a seller to eBay. (out) A payment by credit card made by a seller to eBay. (out) (out) (out) (out) A refund made by eBay to the seller's credit card. (out) A refund made by eBay to the seller by check. (out) A finance charge made to the seller's account, for example, the monthly finance charge added to an account whose balance has not been paid. (out) (out) (out) (out) A credit made by eBay for a duplicate listing. (out) A fee charged by eBay for a partial sale. (out) A reversal of an electronic transfer payment. (out) A one-time payment to the account made by credit card. (out) A fee charged by eBay for a returned check. (out) A fee charged by eBay when a check must be redeposited to collect funds. (out) A cash payment made on the seller's account. (out) A credit issued by eBay for an insertion fee. If a listed item does not sell or results in an Unpaid Item (UPI) dispute, the seller can relist the item. If the item sells the second time, eBay credits the insertion fee. (out) A credit issued by eBay for the Bold listing fee. (out) A credit issued by eBay for the Featured listing fee. (out) (out) A credit issued by eBay for the Final Value Fee. Issued as a result of an Unpaid Item dispute, under some circumstances. (out) A fee charged by eBay when the seller's check does not clear due to insufficient funds. (out) A fee charged by eBay when the seller's check does not clear because the account has been closed. (out) (out) A payment made to the account by money order. (out) An automatic monthly charge of the seller's invoice amount made by eBay to a credit card the seller has placed on file. (out) A one-time payment made by a credit card that is not on file with eBay for automatic monthly payments. (out) (out) (out) A transfer from another account to this account, resulting in a credit to this account. (out) A transfer from this account to another account, resulting in a debit to this account. (out) A credit balance for an account's invoice period, meaning that the seller should not pay. (out) An all-purpose code for debits that are manually applied to auctions, for example, when the credit cannot be applied to an item number (out) An all-purpose code for credits that are manually applied to auctions, for example, when the credit cannot be applied to an item number (out) (out) A note that the credit card is not on file at the customer's request. (out) A credit issued by eBay for an insertion fee when an item is relisted. (out) (out) A fee charged by eBay for adding a gift icon to a listing. The gift icon highlights the item as a good gift and might offer gift services, such as wrapping or shipping. (out) A credit issued by eBay for the gift item fee. (out) A fee charged by eBay for listing an item in the Picture Gallery. A buyer sees a picture of the item when browsing a category, before moving to the item's listing page. (out) A fee charged by eBay for listing an item in the Featured section at the top of the Picture Gallery page. (out) A credit issued by eBay for the Gallery fee charged when the item was listed. (out) A credit issued by eBay for the Featured Gallery fee charged when the item was listed. (out) (out) A credit issued by eBay when listings are not available due to system downtime. The downtime can be a title search outage or a hard outage. See the online help for details. (out) (out) (out) A fee charged by eBay when an item is listed with a reserve price. The fee is credited when the auction completes successfully. (out) A credit issued by eBay for a reserve price auction when the auction completes successfully. (out) (out) (out) (out) A credit issued by eBay to a Store owner who has promoted items outside of eBay. (out) (out) A switch from one billing currency to another. The billing currency can be USD, EUR, CAD, GBP, AUD, JPY, or TWD. (out) A payment made to the account by gift certificate. (out) A payment made to the account by wire transfer. (out) (out) A one-time payment made to the account by electronic transfer. (out) A credit (addition) made by eBay to the seller's account when a payment needs to be adjusted. (out) A debit (deduction) made by eBay to the seller's account when a payment needs to be adjusted. (out) (out) (out) A writeoff of the account charge by eBay because the seller has declared bankruptcy. (out) (out) A writeoff of the account charge by eBay because the seller is deceased. (out) (out) (out) A reversal of a finance charge, made by eBay. The finance charge is added if the seller does not pay the monthly account balance on time. (out) A reversal of a Final Value Fee credit, resulting in the fee being charged to the seller. The Final Value Fee can be credited as a result of an Unpaid Item Dispute. If the buyer later pays, the seller can request a reversal. (out) A fee charged for currency conversion. (out) (out) (out) (out) (out) (out) A monthly payment made by automatic direct debit to the seller's checking account, when the account information is on file. (out) A one-time payment made by direct debit to the seller's checking account, when the account information is not on file, but is provided for this payment. (out) A payment made by direct debit from the seller's checking account when the seller has requested automatic monthly invoice payments. (out) A reversal of a payment made by direct debit from the seller's checking account. (out) A reversal of a payment made by direct debit from a seller's checking account when an item is returned by the buyer. (out) A fee charged by eBay for adding a colored band to emphasize a listing. (out) A credit issued by eBay for a highlight fee on an item's listing. (out) (out) A fee charged for a 30-day real estate listing. (out) A credit for a 30-day real estate listing. (out) (out) (out) A fee charged to sellers who do not provide a credit card or checking account number to verify identify. (out) A credit granted for an EquifaxRealtimeFee. (out) (out) (out) Two accounts with the same owner but different user IDs have been merged into one. (out) (out) (out) The option to send the seller paper invoices has been turned on. (out) The option to send the seller paper invoices has been turned off. (out) (out) An automatic reversal of a Final Value Fee credit. (out) A credit granted by eBay when a title search outage of one hour or longer occurs on the site. (out) A fee charged for listing a lot (one or more items) in a Live Auction catalog. (out) A fee charged for listing an extra item in a Live Auction. (out) (out) A credit for listing an item in a Live Auction catalog. (out) A Final Value Fee charged by eBay when a lot listed on a Live Auction is sold. (out) A refund of a Final Value Fee that was charged when a Live Auction lot was sold. (out) A fee paid by the buyer to the auction house for a purchase in a Live Auction. (out) A refund of the fee paid by a buyer to the auction house for a purchase in a Live Auction. (out) A fee charged for audio or video services provided during the sale of lots at a Live Auction. (out) A refund for audio or video services provided at a Live Auction. (out) A fee charged for a panoramic 360-degree photo in a listing. (out) A fee charged for a slide show of panoramic 360-degree photos. (out) A credit granted to reverse an IPIX photo fee. (out) A credit granted to reverse an IPIX slideshow fee. (out) A fee charged for listing an item for 10 days, rather than one, three, five, or seven days. (out) A credit granted to reverse a 10-day auction fee. (out) (out) (out) A fee charged for a subscription to Auction Assistant Basic. (out) A fee charged for a subscription to Auction Assistant Pro. (out) A credit granted for a subscription fee charged for Auction Assistant Basic. (out) A credit granted for a subscription fee charged for Auction Assistant Pro. (out) A fee charged by eBay for a supersized picture in a listing. (out) A credit issued by eBay for a supersized picture. (out) A fee charged by eBay for the Picture Pack feature. The fee differs according to the number of pictures you use. See the online help for details. (out) A partial credit issued by eBay for the Picture Pack fee. (out) A full credit issued by eBay for the Picture Pack fee. (out) A monthly subscription fee charged for an eBay Store. The fee can be Basic, Featured, or Anchor. (out) A credit issued by eBay for the monthly fee charged for an eBay store. (out) The fee charged by eBay for listing a Fixed Price item. (out) A credit issued by eBay for listing a Fixed Price item. (out) The Final Value Fee credit charged by eBay when a fixed price item sells. (out) A credit issued by eBay for the Final Value Fee for a fixed price item. (out) (out) (out) (out) (out) The fee charged by eBay for creating a Fixed Price listing with a 10-day duration. Fixed Price listings of 1, 3, 5, and 7 days are not charged this fee. (out) A credit issued by eBay for a Fixed Price listing with a 10-day duration. (out) A fee charged by eBay for listing a Buy It Now item. (out) A credit issued by eBay for the fee charged for a Buy It Now listing. (out) A fee for scheduling a listing to start at some later time, up to 3 weeks after the listing is created. (out) A credit made by eBay for the fee charged for scheduling a listing to start after the listing is created. (out) The monthly subscription fee charged for Selling Manager Basic. The monthly charge is billed in advance. (out) The monthly subscription fee charged for Selling Manager Pro. The monthly charge is billed in advance. (out) A one-time credit for a free one-month trial of Selling Manager Basic. (out) A one-time credit for a free one-month trial of Selling Manager Pro. (out) The fee charged for a Good-Til-Cancelled listing in an eBay Store. The charge is made once each 30 days, until the listing ends. (out) A credit for the fee charged for a Good-Til-Cancelled listing in an eBay Store. (out) The fee charged for using a Listing Designer theme and layout template for a listing. The fee is displayed to the seller during the listing process. (out) A credit issued by eBay for a Listing Designer fee. (out) The fee charged for listing an auction item for 10 days. (out) A credit for the fee charged for listing an auction item for 10 days. (out) (out) (out) (out) (out) (out) (out) (out) An addition to the seller's eBay Anything Points account. Each point is equivalent to $0.01. (out) A reduction to the seller's eBay Anything Points account. Each point is equivalent to $0.01. (out) An automatic payment of seller fees from the seller's eBay Anything Points account. (out) A one-time payment of seller fees from the seller's eBay Anything Points account. (out) A reversal of a seller fee payment made from the seller's eBay Anything Points account. (out) A cash payment made from the seller's eBay Anything Points account and credited to the seller's account. (out) A credit (return) to your account of Value-Added Tax previously paid. (out) A debit to your account for a Value-Added Tax charge. (out) (out) (out) (out) (out) (out) (out) (out) A fee charged for the difference between an eBay Store inventory listing fee and an auction listing fee if a Store inventory item sells. (out) A credit for a StoresSuccessfulListingFee. (out) (out) A credit posted to a seller's account for sale of Stores Inventory items by buyers referred to the seller's Store by printed materials and emails outside eBay. (out) The fee charged for adding a subtitle to a listing. The subtitle adds information to the title. (out) A credit of the fee charged for adding a subtitle to a listing. (out) (out) (out) (out) The monthly fee charged for subscribing to Picture Manager. The fee varies according to the level of subscription. (out) A credit granted for a Picture Manageer subscription fee. (out) A fee charged for a basic subscription to Seller Reports. (out) A credit granted for a basic subscription to Seller Reports. (out) A fee charged for a subscription to Seller Reports Plus. (out) A credit granted for a subscription to Seller Reports Plus. (out) (out) (out) (out) The fee for adding a border that outlines a listing with a frame. (out) A credit for the border fee charged for a listing. (out) A fee charged to a seller for upgrading a listing from eBay Germany's Car, Motorcycle, and Special Vehicle categories so that it is also searchable on the mobile.de classifieds site. (out) A monthly subscription fee charged for Sales Reports Plus. (out) A credit granted for a Sales Reports Plus monthly subscription fee. (out) A credit granted for upgrading a listing to make it searchable on the mobile.de platform. (out) A fee charged to owners of eBay Stores who have a sent a marketing email to buyers, for the number of email recipients over the Store's monthly free allocation. The monthly allocation varies according to the type of Store. (out) A credit granted for an email marketing fee. (out) A fee charged for the Picture Show service, which lets buyers browse or see a slide show of 2 or more pictures at the top of the item page. (out) A credit granted for a Picture Show fee. (out) A fee charged for the ProPackBundle feature pack (currently available to US and Canada eBay motor vehicle sellers). (out) A credit granted by eBay for the ProPackBundle feature pack (currently available to US and Canada eBay motor vehicle sellers). (out) A fee charged by eBay for the BasicUpgradePackBundle feature pack. No longer applicable to any sites (but formerly applicable to the Australia site, site ID 15). (out) A credit granted by eBay for the BasicUpgradePackBundle feature pack. No longer applicable to any sites (but formerly applicable to the Australia site, site ID 15). (out) A fee charged by eBay for the ValuePackBundle feature pack. (out) A credit granted by eBay for the ValuePackBundle feature pack. (out) A fee charged by eBay for the ProPackPlusBundle feature pack. (out) A credit granted by eBay for the ProPackPlusBundle feature pack. (out) The final entry in an account before it is closed or merged with another account. (out) Reserved for future use. (out) A fee charged for extended listing duration. (out) A credit granted by eBay for extended listing duration. (out) The fee for an international listing. (out) A credit issued by eBay for an international listing. (out) A MarketPlace Research fee for expired subscriptions. (out) A MarketPlace Research credit for expired subscriptions. (out) A MarketPlace Research basic subscription fee. (out) A MarketPlace Research basic subscription credit. (out) A MarketPlace Research pro subscription fee. (out) Basic bundle fee. (out) Basic bundle fee credit. (out) A MarketPlace Research pro subscription fee credit. (out) A Vehicle Local subscription fee. (out) A Vehicle Local subscription fee credit. (out) A Vehicle Local insertion fee. (out) A Vehicle Local insertion fee credit. (out) A Vehicle Local final value fee. (out) A Vehicle Local final value fee credit. (out) A Vehicle Local GTC fee. (out) A Vehicle Local GTC fee credit. (out) eBay Motors Pro fee. Applies to eBay Motors Pro registered dealer applications only. (out) eBay Motors Pro fee credit. Applies to eBay Motors Pro registered dealer applications only. (out) eBay Motors Pro feature fee. Applies to eBay Motors Pro registered dealer applications only. (out) eBay Motors Pro feature fee credit. Applies to eBay Motors Pro registered dealer applications only. (out) A fee charged by eBay for listing an item with the Gallery Plus feature enabled. This feature cannot be removed with ReviseItem or RelistItem. However, if the feature is upgraded, for example, to Gallery Featured, the fee for Gallery Plus is refunded and a fee for Gallery Feature is charged instead. (out) A credit issued by eBay when refunding the fee for enabling the Gallery Plus feature. A Gallery Plus credit may be issued if, for example, a user upgrades their feature with ReviseItem or RelistItem to Gallery Featured. In this case, the original Gallery Plus fee is refunded and a Gallery Featured fee is charged instead. eBay ImmoPro Fee Credit eBay ImmoPro Fee eBay ImmoPro Feature Fee Credit eBay ImmoPro Feature Fee eBay Real Estate Pro Fee Credit eBay Real Estate Pro Fee eBay Real Estate Pro Feature Fee Credit eBay Real Estate Pro Feature Fee PowerSeller, PowerSeller shipping, Top-rated seller, eBay Stores subscription, or other subscription discount against the final value fee, insertion fee, subscription fee, late payment fee, or other fee. See AccountEntry.Title for an explanation of the discount and the percentage that was applied. Reserved for future use. Reserved for future use. (out) The fee charged for Return Shipping. (out) A credit issued by eBay against a Return Shipping charge. Issued as a result of an Unpaid Item dispute, under some circumstances. Collection of zero, one, or multiple individual detail account entries. Contains one AccountEntry object for each account entry returned. See the schema documentation for AccountEntryType for details on its properties. You can uniquely identify the entries that the GetAccount call returns within the AccountEntries tag. Specifically, the following fields, returned within the AccountEntries tag, can be used in combination as a unique key: AccountEntry.Date, AccountEntry.AccountDetailsEntryType, AccountEntry.ItemID, and AccountEntry.RefNumber. Contains the data for one account entry. (See the schema documentation for AccountEntryType for details on its properties.) GetAccount Conditionally Specifies how account entries should be sorted in a response from eBay. (in) Sort by the AccountEntry.Date value in the response, in ascending order. Same as AccountEntryCreatedTimeAscending. (in) Sort by the AccountEntry.Date value in the response, in ascending order. (in) Sort by the AccountEntry.Date value in the response, in descending order. (in) Sort by the AccountEntry.ItemID value in the response, in ascending order. (in) Sort by the AccountEntry.ItemID value in the response, in descending order. (in) Sort by the value returned in AccountEntry.Description, with entries starting with lowercase letters before entries starting with uppercase letters and each group in alphabetical order. (in) Sort by the value returned in AccountEntry.Description, with entries starting with uppercase letters before entries starting with lowercase letters and each group in reverse alphabetical order. (out) Reserved for internal or future use. Contains the data for a single account detail entry. Each detail entry is a transaction posted to the account and may be: a credit, a debit, or an administrative action (such as an update putting a credit card on file for the account). You can uniquely identify the entries that the <b>GetAccount</b> call returns within the <b>AccountEntries</b> tag. Specifically, the following fields, returned within the <b>AccountEntries</b> tag, can be used in combination as a unique key: AccountEntry.Date, AccountEntry.AccountDetailsEntryType, AccountEntry.ItemID, and AccountEntry.RefNumber. Indicates the type of transaction or reason for the transaction. For example, a value of <b>FeeGallery</b> indicates a debit for listing an item in the Gallery. Possible values are enumerated in the <b>AccountDetailEntryCodeType</b> code list. GetAccount Conditionally A description of the monetary transaction or administrative action applied to an eBay account. GetAccount Conditionally Balance after the account entry's credit or debit amount has been applied. Can be 0.00. The value is positive for debits and negative for credits. GetAccount Conditionally Date entry was posted to the account, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) GetAccount Conditionally Gross fees that are assessed by eBay (net fees plus VAT, if any). Returned even if VAT does not apply. The value is positive for debits and negative for credits. GetAccount Conditionally If the account detail entry is associated with an item listing, this field shows the eBay <b>ItemID</b> value. Otherwise, 0 is returned in this field. 19 (Note: The eBay database specifies 38. ItemIDs are usually 9 to 12 digits) GetAccount Conditionally Memo line for the account entry. It can be an empty string. GetAccount Conditionally The rate used for the currency conversion for a transaction. GetAccount Conditionally Net fees that are assessed by eBay, excluding additional surchargesand VAT (if any). Returned even if VAT does not apply. The value is positive for debits (user pays eBay) and negative for credits (eBay pays user). GetAccount Conditionally eBay reference number for the account entry. May return no value for some account transactions, such as an administrative action like placing the user's credit card on file. You can uniquely identify the entries that the <b>GetAccount</b> call returns within the <b>AccountEntries</b> tag. Specifically, the following fields, returned within the <b>AccountEntries</b> tag, can be used in combination as a unique key: AccountEntry.Date, AccountEntry.AccountDetailsEntryType, AccountEntry.ItemID, and AccountEntry.RefNumber. GetAccount Conditionally VAT rate for the item. When the VATPercent is specified, the item's VAT information appears on the item's listing page. In addition, the seller can choose to print an invoice that includes the item's net price, VAT percent, VAT amount, and total price. Since VAT rates vary depending on the item and on the user's country of residence, a seller is responsible for entering the correct VAT rate; it is not calculated by eBay. To specify a <b>VATPercent</b>, a seller must have a VAT-ID registered with eBay and must be listing the item on a VAT-enabled site. Max precision 3 decimal places. Max length 5 characters. Note: The View Item page displays the precision to 2 decimal places with no trailing zeros. However, the full value you send in is stored. Returned for all users, not just VAT users, with GetAccountResponse. GetAccount Conditionally Title of the entry, or explanation of why the debit or credit was applied. GetAccount Conditionally <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. If the account detail entry is associated with an order line item, this field shows the <b>OrderLineItemID</b> value. Otherwise, 0 is returned in this field. 100 GetAccount Conditionally The unique identifier of an order line item (transaction). If the account detail entry is associated with an order line item, this field shows the eBay <b>TransactionID</b> value. Otherwise, 0 is returned in this field. 19 GetAccount Conditionally Specifies a report format to be used to describe the seller's account. (in) Contains the entries since the last invoice eBay sent to the seller. If you use LastInvoice, then InvoiceDate, BeginDate and EndDate are ignored. (in) Contains the entries for a specific invoice, identified by the invoice month and year. If you use SpecifiedInvoice, then you must also use InvoiceDate. If you use SpecifiedInvoice, then BeginDate and EndDate are ignored. (in) Contains entries that were posted to the seller's account between two dates. The period covered may cross the boundaries of formal invoices. If you use BetweenSpecifiedDates, then you also must specify BeginDate and EndDate. If you use BetweenSpecifiedDates, then InvoiceDate is ignored. (out) Reserved for internal or future use. State of an account of an eBay user. (out) The account is active. (out) The account has been created but is not yet active, pending additional information or processing by eBay. (out) The account is inactive. No new seller account entries would be posted by eBay to the account. (out) Reserved for internal or future use. Summary data for the requesting user's seller account as a whole. This includes a balance for the account, any past due amount and date, and defining data for additional accounts (if the user has changed country of residency while having an active eBay account). Indicates the current state of the account (such as active or inactive). Possible values are enumerated in the AccountStateCodeType code list. GetAccount Conditionally Specifies payment made since the previous invoice, but is returned only if AccountHistorySelection is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits. GetAccount Conditionally Specifies credits granted since the previous invoice, but is only returned AccountHistorySelection is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits. GetAccount Conditionally Specifies fees incurred since the last invoice, including tax if applicable. Returned only if AccountHistorySelection is LastInvoice or Specified Invoice. The value is positive for debits and negative for credits. GetAccount Conditionally Contains the data for one additional account. An AccountSummaryType object may return zero, one, or multiple additional accounts. See the schema documentation for AdditionalAccountType for details on additional accounts. The value is positive for debits and negative for credits. GetAccount Conditionally Amount past due, 0.00 if not past due. The value is positive for debits and negative for credits. GetAccount Conditionally First four digits of the bank account the user associated with the seller account (with remainder Xed-out). This may be an empty string depending upon the payment type the user selected for the account (e.g., if no debit-card specified). 4 GetAccount Conditionally Indicates the date and time BankAccountInfo was last modified, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) This may be an empty string depending upon the payment type the user selected for the account (e.g., if no debit-card specified). GetAccount Conditionally Indicates the billing cycle in which eBay sends a billing invoice to the user. A value of 0 (zero) indicates an invoice sent on the last day of the month. A value of 15 indicates an invoice sent on the 15th day of the month. GetAccount Conditionally Expiration date for the credit card selected by the user as payment method for the account, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if no credit card is on file or if the account is inactive - even if there is a credit card on file. GetAccount Conditionally Last four digits of the credit card the user selected as payment method for the account. Empty string if no credit is on file. GetAccount Conditionally Indicates the date and time credit card or credit card expiration date was last modified, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) This may be an empty string depending on the payment method the user selected for the account (e.g., Empty string if no credit card is on file.) GetAccount Conditionally Current balance for the account. Can be 0.00, positive, or negative. The value is positive for debits and negative for credits. GetAccount Conditionally (out) Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Amount of last invoice. 0.00 if account not yet invoiced. The value is positive for debits and negative for credits. GetAccount Conditionally Date of last invoice sent by eBay to the user, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if this account has not been invoiced yet. GetAccount Conditionally Amount of last payment posted, 0.00 if no payments posted. The value is positive for debits and negative for credits. GetAccount Conditionally Date of last payment by the user to eBay, in GMT. (Also see the Data Types appendix for more information on how GMT dates are handled in SOAP.) Empty string if no payments have been posted. GetAccount Conditionally Indicates whether the account has past due amounts outstanding. A value of true indicates that the account is past due. A value of false indicates the account is current. GetAccount Conditionally Indicates the method the user selected to pay eBay with for the account. The values for PaymentMethod vary from one global eBay site to the next. Payment methods are enumerated in the SellerPaymentMethodCodeType code list. GetAccount Conditionally Used to indicate whether the Ad Format feature is enabled for a category. The Ad Format feature is disabled for the category. The Ad Format feature is enabled for the category. The category supports the Ad Format feature only. The lead generation Classified Ad Format feature is enabled for the category. The category supports the lead generation Classified Ad Format feature only. The category supports the lead generation Motors Loccal Market feature only. (out) Reserved for internal or future use. Defines the AdFormatEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (e.g., a boolean value is not returned). Contains information about the status of email correspondence for the lead. A new message from a prospective buyer that the seller has not yet responded to. A message from a prospective buyer that the seller has responded to. (out) Reserved for internal or future use. Contains prospective buyer contact information and other details associated with a lead for an ad format listing. Message sent from the prospective buyer to the seller. Same content as in the AdFormatLead.MemberMessage.MemberMessageExchange.Question.Body node (that is only displayed if IncludeMemberMessages = true is included in the request). The advantage of retrieving the MemberMessageExchange node, however, is that you retrieve the entire exchange between the seller and the lead. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally Address information for the prospective buyer. Not returned or returned self-closed if information is unavailable. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally The time of day when the prospective buyer prefers to be contacted by the seller. Not returned if information is unavailable. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally Email address for the prospective buyer. If the prospective buyer chooses to hide his email address when contacting the seller, this element contains two dashes (--) instead of an email address. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally Date and time (in GMT) that the lead was submitted. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally The ID of the item that the lead is for. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally The title of the item listing. <br><br> <span class="tablenote"><b>Note:</b> The maximum length of an eBay Item Title is increasing to 80 characters in Version 735. </span> 55 GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally The eBay ID of the user who is interested in the seller's item. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally Contains any mail message content shared between the seller and lead. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally Status of the lead. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally The total fee from email and phone leads. Applies to the item specified in the request. LeadFee is part the pay-per-lead feature. GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally Email address for the prospective buyer as entered in the lead form on the View Item page. Provides a way for sellers to contact prospective buyers who choose not to log in to eBay. This applies to only eBay Motors and eBay Motors categories. 128 GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally Prospective buyer's time frame for purchasing a vehicle as entered in the Lead form on View Item page for eBay Motors and eBay Motors categories. Purchasing Time Frames include: <ul> <li> within next 3 days </li> <li> within a week </li> <li> within a month </li> <li> within three months </li> <li> in more than three months </li> <li> within an undecided time frame </li> </ul> 255 GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally The year of the vehicle the prospective buyer would like to trade in. Entered on the lead form on the View Item page. Applies to eBay Motors and Motors categories only. 32 GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally The make of the vehicle the prospective buyer would like to trade in. Entered on the lead form on the View Item page. Applies to eBay Motors and Motors categories only. 128 GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally The model of the vehicle the prospective buyer would like to trade in. Entered on the lead form on the View Item page.Applies to eBay Motors and Motors categories only. 128 GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally Prospective buyer answer whether or not the prospective buyer would like financing. Entered on the lead form on the View Item page. Applies to eBay Motors and Motors categories only. Financing response meanings: 0= no response,1= yes, 2= no. 1 GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally This field corresponds to a configurable question on the lead form in the View Item web page. The corresponding question is site-specific. To determine the question for a specific site, you must view the form in the web flow for the given site. This field applies to Classified Ad format listings in Motors categories only. 1 GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally This field corresponds to a configurable question on the lead form in the View Item web page. The corresponding question is site-specific. To determine the question for a specific site, you must view the form in the web flow for the given site. This field applies to Classified Ad format listings in Motors categories only. 1 GetAdFormatLeads

DetailLevel: ReturnAll

Conditionally Similar to AddItemRequestType, the AddItemRequestContainerType defines a single item to be listed. The AddItems request will support up to five (5) request containers. Contains the fields whose values define a new item. One Item is required. AddItems Yes The MessageID element is used to correlate a given AddItemRequestContainer in the request with the corresponding AddItemResponseContainer in the response. When you pass a message ID in a request container, the same value is returned in the CorrelationID field in the matching response container. You can use this for tracking that a response is returned for every request and to match responses to specific requests. AddItems Yes This container has all of the resulting information from an AddItems call. There will be one container per container specified in the request. Unique item ID for the new listing. Also applicable to Half.com. <br><br> <span class="tablenote"><b>Note:</b> Although we represent item IDs as strings in the schema, we recommend you store them as 64-bit signed integers. If you choose to store item IDs as strings, allocate at least 19 characters (assuming decimal digits are used) to hold them. eBay will increase the size of IDs over time. Your code should be prepared to handle IDs of up to 19 digits. For more information about item IDs, see <a href="http://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=468">Common FAQs on eBay Item IDs and other eBay IDs</a> in the Knowledge Base.</span> 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddItem AddItems Always Starting date and time for the new listing. Also returned for Half.com (for Half.com, the start time is always the time the item was listed). AddItem AddItems Always Date and time when the new listing ends. This is the starting time plus the listing duration. Also returned for Half.com, but for Half.com the actual end time is GTC (not the end time returned in the response). AddItem AddItems 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. Also returned for Half.com, but the values are not applicable to Half.com listings. AddItem AddItems Always http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UsingFeaturePacks 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 it has expired with no replacement, CategoryID does not return a value. Not applicable to Half.com. 10 AddItem AddItems 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. Not applicable to Half.com. 10 AddItem AddItems Conditionally CorrelationID is used to correlate each item request container with its corresponding response container. AddItems Always A list of application-level errors or warnings (if any) that were raised when eBay processed the request. <br> <br> Application-level errors occur due to problems with business-level data on the client side or on the eBay server side. For example, an error would occur if the request contains an invalid combination of fields, or it is missing a required field, or the value of the field is not recognized. An error could also occur if eBay encountered a problem in our internal business logic while processing the request.<br> <br> Only returned if there were warnings or errors. Conditionally Supplemental information from eBay, if applicable. May elaborate on errors or provide useful hints for the seller. This data can accompany the call's normal data result set or a result set that contains only errors. 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. Because this data is returned as a string, the HTML markup elements are escaped with character entity references (e.g.,&lt;table&gt;&lt;tr&gt;...). See the appendices in the eBay Web Services guide for general information about string data types. AddItems Conditionally The nature of the discount, if a discount applied. AddItem AddItems Conditionally Holds the content of the request. Use to track that a response is returned for every request and to match particular responses to particular requests. AddMemberMessagesAAQToBidder Yes An eBay ID that uniquely identifies a given item. Must be a currently active item. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddMemberMessagesAAQToBidder Yes Holds the content of the message. AddMemberMessagesAAQToBidder Yes Contains the response information. Use to track that a response is returned for every request and to match particular responses to particular requests. AddMemberMessagesAAQToBidder Always Indicates the response status (e.g., success). AddMemberMessagesAAQToBidder Always Contains the data for one additional account. An additional account is created when the user has an active account and changes country of registry (i.e., registers with the eBay site for the new country). A new account is created and the old account becomes inactive as an additional account. A user who never changes country of residency while having an account will never have any additional accounts. Indicates the current balance of the additional account. GetAccount Conditionally Indicates the currency in which monetary amounts for the additional account are expressed. GetAccount Conditionally Indicates the unique identifier for the additional account (the account ID). GetAccount 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 an eBay user's 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 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field 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, ReturnAll

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

AddItem AddItems AddSellingManagerTemplate RelistItem ReviseItem ReviseSellingManagerTemplate VerifyAddItem VerifyRelistItem No Line 1 of the user's street address. Also applicable to Half.com (for GetOrders). 180 for US. May differ for other countries. Note: The eBay database allocates up to 512 characters for this field 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, ReturnAll

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). 180 for US. May differ for other countries. Note: The eBay database allocates up to 512 characters for this field 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, ReturnAll

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 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field 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, ReturnAll

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 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field 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, ReturnAll

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, ReturnAll

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). eBay validates the content, not length for this field. Note: The eBay database allocates up to 128 characters for this field 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, ReturnAll

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). 10 digits for US (not counting delimiter characters). May differ for other countries. Note: The eBay database allocates up to 128 characters for this field 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, ReturnAll

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). 9 digits for US (not counting delimiter characters). May differ for other countries. Note: The eBay database allocates up to 24 characters for this field 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, ReturnAll

Always GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

Conditionally GetSellingManagerSoldListings Conditionally Unique ID for a user's address in the eBay database. This value can help prevent the need to store an address multiple times across multiple orders. The ID changes if a user changes their address. GetOrders

DetailLevel: none, ReturnAll

Always GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

Conditionally GetItemTransactions GetSellerTransactions

DetailLevel: none, 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, ReturnAll

Always PayPal address status. Not applicable to Half.com. ID assigned to the address by the address owner, e.g. by the PayPal system. Currently, the ExternalAddressID only applies for a customer address in the PayPal system. The ID changes if a user changes their address. Also see the AddressOwner field. The ExternalAddressID value also is applicable to Half.com (for GetOrders). 20 GetOrders

DetailLevel: none, ReturnAll

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 This tag tells whether current address is a default shipping address or one of the shipping addresses in address book. GetItemTransactions GetOrderTransactions GetSellerTransactions

DetailLevel: none, ReturnAll

Conditionally These values indicate type of an address in AddressType. This is default shipping address which is rendered to buyer on checkout. This is an address which is in user's address book. It can be used at the time of checkout. This is not a valid address. Please use another address. (out) Reserved for internal or future use. Container for fields related to affiliate tracking. For additional information, see the annotations to the elements in this type. The value you specify is obtained from your tracking partner. For eBay Partner Network, the TrackingID is the Campaign ID ("campid") provided by eBay Partner Network. A Campaign ID is a 10-digit, unique number for associating traffic. A Campaign ID is valid across all programs to which you have been accepted. GetProducts PlaceOffer Conditionally Specifies your tracking partner for affiliate commissions. Required if you specify a TrackingID. Depending on your tracking partner, specify one of the following values. Not all partners are valid for all sites. For PlaceOffer, only eBay Partner Network and Mediaplex are valid: <br> <br>2 = Be Free <br>3 = Affilinet <br>4 = TradeDoubler <br>5 = Mediaplex <br>6 = DoubleClick <br>7 = Allyes <br>8 = BJMT <br>9 = eBay Partner Network <br> <br> For information about the eBay Partner Network, see <a href="https://www.ebaypartnernetwork.com" target="_blank">eBay Partner Network</a>. http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AffiliateTrackingConcepts GetProducts PlaceOffer Conditionally Type of device from which the call originated. For PlaceOffer, if you are using affiliate tracking, this field is required as part of the set of tags you use in the AffiliateTrackingDetails container. PlaceOffer Conditionally Need not be specified. You can define an AffiliateUserID (up to 256 characters) if you want to leverage it to better monitor your marketing efforts. If you are using the eBay Partner Network, and you provide an AffiliateUserID, the tracking URL returned by eBay Partner Network will contain the AffiliateUserID, but it will be referred to as a "customid". GetProducts PlaceOffer 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 in requests 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.<br> <br> In the AddItem family of calls, listing fees are returned in the currency of the user's registration site. For example, a user who is registered on the eBay US site always sees their fees returned in USD, even when their listing request is sent to another site, such as eBay UK or eBay Germany. 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, ReturnAll

Always GetOrders InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected

DetailLevel: none, ReturnAll

Conditionally GetSellerTransactions InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected

DetailLevel: none

Conditionally GetOrderTransactions InternationalShippingServiceOption ShippingServiceOptions ShippingServiceSelected

DetailLevel: none, ItemReturnDescription, ReturnAll

Conditionally PlaceOffer ConvertedCurrentPrice CurrentPrice Always PlaceOffer MinimumToBid Conditionally SoldReport 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 Part of the mechanism for eBay to control which announcement messages are to be made available to the user. No message is to be made available. A deprecation message is to be made available, but only if today's date is between AnnouncementMessageType.AnnouncementStartTime and AnnouncementMessageType.EventTime. A mapping message is to be made available, but only if today's date is after AnnouncementMessageType.EventTime. Both "Deprecation" and "Mapping" enumerations are to apply. Reserved for future use. Event messaging details The date on which an upcoming event can start to be announced. GeteBayDetails Conditionally The date on which the event occurs. This is also the ending date of the announcement that lead up to the event (see AnnouncementStartTime). GeteBayDetails Conditionally Control of what messages to display. GeteBayDetails Conditionally Contains the definition of a rule that governs the number of times your application can access the eBay API (invoke a call) on an hourly, daily, or periodic basis. The name of the call that has an access rule. Can be a call name (e.g., AddItem), ApplicationAggregate (returns totals for all calls), PasswordAuthenticationLimiter (dummy call), or NonUTF8UsageLimiter. GetApiAccessRules Always Whether use of this call counts toward the application's aggregate limit for all calls. GetApiAccessRules Always The number of calls per day that your application can make to this call before being refused. The day starts at midnight, 00:00:00 PST (not GMT). GetApiAccessRules Always The number of calls per day that your application can make to this call before you receive a warning. The day starts at midnight, 00:00:00 PST. GetApiAccessRules Always The number of times your application has used this call today. GetApiAccessRules Always The number of calls that your application can make per hour to this call before being refused. Each count begins on the hour (e.g. 1:00:00). GetApiAccessRules Always The number of calls that your application can make to this call per hour before you receive a warning. Each count begins on the hour (e.g. 1:00:00). GetApiAccessRules Always The number of times your application has executed this call during this hour. GetApiAccessRules Always The length of time before your application's perodic usage counter restarts for this call. If the number of calls you make exceeds the periodic hard limit before the current period ends, further calls will be refused until the next period starts. Possible values: -1 (Periodic limit not enforced, could be any negative integer), 0 (Calendar month), 30 (Number of days, could be any positive integer). If the period is based on the calendar month, the usage counters restart on the same day of every month, regardless of the number of days in the month. GetApiAccessRules Always Number of calls per period that your application may make before a call is refused, if the periodic limit is enforced. The length of the period is specified in Period. GetApiAccessRules Always Number of calls per period that your application may make before you receive a warning, if the periodic limit is enforced. The length of the period is specified in Period. GetApiAccessRules Always Number of calls that your application has already made this period. Returns 0 if the periodic access rule has not been configured for the application. The length of the period is specified in Period. The start date of the period is specified in PeriodicStartDate. GetApiAccessRules Always The time (in GMT) when this access rule's period started. The period starts at midnight Pacific time. For example, if the period begins on June 29 in 2005 when California is on Pacific Daylight Time, the GMT value returned would be 2005-06-29T07:00:00.000Z If the period begins on December 29 in 2005 when California is on Pacific Standard Time, the GMT value returned would be 2005-12-29T08:00:00.000Z. Only returned when the eBay Developers Program has configured the start date for the access rule. The start date can vary per application and per call name (i.e., per access rule). GetApiAccessRules Conditionally The date and time this access rule was last modified by eBay. GetApiAccessRules Always Your application's current status for this rule, including whether the rule is set for your application and whether the application has exceeded its daily or hourly limit. GetApiAccessRules Always The status of the access rule, including whether the rule is turned on or off and whether the application is currently blocked from using this call. No effect if RuleCurrentStatus is set to NotSet. GetApiAccessRules Always Specifies preferences about how notifications are delivered to an application. The URL to which eBay delivers all notifications sent to the application. For delivery to a server, the URL begins with http:// or https:// and must be well formed. Use a URL that is functional at the time of the call. For delivery to an email address, the URL begins with mailto:// and specifies a valid email address. SetNotificationPreferences No GetNotificationPreferences Conditionally Enables or disables notifications and alerts. If you disable notifications, the application will not receive them, but its notification preferences are preserved. SetNotificationPreferences No GetNotificationPreferences Conditionally The email address to which eBay sends all application markup and markdown event notifications. When setting the email address, input must be in the format mailto://youremailaddress@yoursite.com. Enable these alerts using the AlertEnable field. Length of valid email IDs SetNotificationPreferences No GetNotificationPreferences Conditionally Enables or disables application markup and markdown alerts. SetNotificationPreferences No GetNotificationPreferences Conditionally If this field is specified, the value must be eBLSchemaSOAP. SetNotificationPreferences No GetNotificationPreferences Conditionally The means of receipt of notification. In most cases, it is Platform (typical API calls and web interaction), so this is the default, if not specified. For wireless applications, use SMS. Do not test Client Alerts in production if you are currently using Platform Notifications. SetNotificationPreferences No GetNotificationPreferences Conditionally Use this field to specify the API version for all notifications for the calling application. If you do not specify PayloadVersion in SetNotificationPreferences, the API version for notifications will be based on the API version specified in your SetNotificationPreferences call. SetNotificationPreferences No GetNotificationPreferences Conditionally Defines settings for notification URLs (including the URL name in DeliveryURLName). You define settings for up to 25 notification URLs (including the URL name in DeliveryURLName) in separate DeliveryURLDetails containers. Associate a user token with notification URLs by using the token in a SetNotificationPreferences request that specifies the URL name or names in SetNotificationPreferencesRequest.DeliveryURLName. Use comma-separated format to specify multiple URL names in SetNotificationPreferencesRequest.DeliveryURLName. Notifications will be sent to these URL(s) if ApplicationDeliveryPreferencesType.ApplicationEnable is set to Enable. SetNotificationPreferences No GetNotificationPreferences Conditionally Device used. Browser device. Wireless device. Desktop device. SetTopTVBox device. Reserved for future use. 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, ReturnAll

Always Used to indicate whether ID-based attributes have been converted to custom Item Specifics. Please note that we no longer recommend passing both ID-based attributes and custom Item specifics in the same request.<br> <br> eBay has not converted the category from ID-based attributes to only support custom Item Specifics. AddItem and related calls may support passing both formats in the same request (if the category supports both formats.) As previously announced in 2011 and early 2012, most categories no longer perform this conversion, so very few categories return this value.<br> <br> eBay has converted the category from ID-based attributes to only support custom Item Specifics. With this setting:<br> <br> You can pass one format or the other in the same AddItem request, but you can't pass both formats together. If you pass in ID-based attributes in the AddItem family of calls, eBay will convert them to custom Item Specifics on your behalf. eBay has converted the category from ID-based attributes to only support custom Item Specifics. ID-based attributes are no longer supported. AddItem and related calls will fail if you pass ID-based attributes in the request. (out) Reserved for internal or future use. Defines the ID-based attribute conversion to custom Item Specifics. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (e.g., a boolean value is not returned). Item Specifics data returned from the Suggested Attributes engine. A list of attribute sets containing recommended attributes and values. Returned from GetItemRecommendations when the Suggested Attributes engine is used See the eBay Web Services guide for additional details. GetItemRecommendations Conditionally 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 RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetSellingManagerTemplates GetItemRecommendations Conditionally 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 attribute 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> Not applicable to Half.com. AddItem AddItems AddSellingManagerTemplate AddLiveAuctionItem GetItemRecommendations VerifyAddItem AddFixedPriceItem RelistFixedPriceItem ReviseFixedPriceItem Conditionally RelistItem ReviseItem ReviseSellingManagerTemplate ReviseLiveAuctionItem VerifyRelistItem No GetItemRecommendations GetProducts GetSellingManagerTemplates 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. 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 GetItemRecommendations Conditionally GetItem GetSellingManagerTemplates

DetailLevel: ItemReturnAttributes, ReturnAll

Conditionally GetOrders

DetailLevel: none, ReturnAll

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 GetItemRecommendations 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 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 GetOrders

DetailLevel: none, ReturnAll

Always Indicates the source of the item's eligibility for the Buyer Protection Program. Buyer protection is covered by the PayPal Protection Program. Reserved for internal or future use. Events that will trigger an automated feedback to a buyer. Applies to Selling Manager Pro users. Leave feedback automatically when you receive positive feedback. Leave feedback automatically when you receive payment. Do not leave feedback automatically. (out) Reserved for internal or future use. Container for average detailed seller ratings. If a seller has detailed ratings, they are displayed in the Feedback Profile of the seller. 587 NoOp Applicable to sites that support the Detailed Seller Ratings feature. The AverageRatingDetails container has information about average detailed seller ratings. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers. GetFeedback Conditionally

DetailLevel: none, ReturnAll

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

DetailLevel: none, ReturnAll

An average detailed seller rating applying to the area in the corresponding RatingDetail field. GetFeedback Conditionally

DetailLevel: none, ReturnAll

The number of detailed seller ratings in the area in the corresponding RatingDetail field. GetFeedback Conditionally

DetailLevel: none, ReturnAll

Container for average detailed seller ratings. If a seller has detailed ratings, they are displayed in the Feedback Profile of the seller. The summary period for which the detail ratings are calculated. GetFeedback Conditionally

DetailLevel: none, ReturnAll

Applicable to sites that support the Detailed Seller Ratings feature. The AverageRatingDetails container has information about average detailed seller ratings. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling. Users retrieve detailed ratings as averages of the ratings left by buyers. GetFeedback Conditionally

DetailLevel: none, ReturnAll

This code identifies the types of balances in an account, e.g., a PayPal account. (out) Custom Code. (out) Reserved for internal or future use. Used for storing an optional reference ID to the binary attachment Stores an optional reference ID to the binary attachment. UploadSiteHostedPictures No Not applicable to any site. Formerly applicable to the Australia site (site ID 15, abbreviation AU) only. Indicates the action taken by a seller for a best offer. (in) To accept something. (in) To decline something. (in) To counter offer. Reserved for internal or future use. A collection of Best Offers. Empty if there are no best offers. A container of details about a best offer. RespondToBestOffer Always GetBestOffers

DetailLevel: none, ReturnAll

Always Defines the BestOfferAutoAcceptEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Defines the BestOfferAutoDeclineEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Defines the BestOfferCounterEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). 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. Defines the BestOfferEnabled feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Unique identifier for a best offer (to differentiate from other best offers for the same item). 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. Details about a best offer. An ID to distinguish this best offer from other best offers made on the item. GetBestOffers

DetailLevel: none, ReturnAll

Always PlaceOffer Conditionally Date and time (in GMT) the offer naturally expires (if the seller has not accepted or declined the offer). GetBestOffers

DetailLevel: none, ReturnAll

Always Information about the buyer who made the best offer. GetBestOffers

DetailLevel: none, ReturnAll

Always The amount of the best offer. GetBestOffers

DetailLevel: none, ReturnAll

Always The state of the offer. In the case of a PlaceOffer response that specified a best offer, Status may be "Accepted" if the best offer was at or above an auto-accept price. GetBestOffers

DetailLevel: none, ReturnAll

Always PlaceOffer Conditionally The number of items for which the buyer is making an offer. GetBestOffers

DetailLevel: none, ReturnAll

Always Text message that was provided by a buyer when placing a best offer. 500 (in bytes) GetBestOffers

DetailLevel: ReturnAll

Conditionally Text response to buyer from seller. 500 (in bytes) GetBestOffers

DetailLevel: none, ReturnAll

Conditionally The best offer type. GetBestOffers

DetailLevel: none, ReturnAll

Always The status of the call, either Success or Failure. RespondToBestOffer Always 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. Possible bid action types or states. Unknown. The item is being offered (or was placed) as a competitive-bid item listing. This auction format if often referred to as a Chinese auction. Not used. The offer was retracted by the user who extended the offer. (This can only be done on the eBay site, not via API.) The offer was automatically retracted. (This can only be done on the eBay site, not via API.) The offer was cancelled. (This can only be done on the eBay site, not via API.) The offer was automatically cancelled. (This can only be done on the eBay site, not via API.) The offer placed was an absentee bid. (This can only be done on the eBay site, not via API.) The offer resulted in the successful exercise of the Buy It Now option for a competitive-bid auction. The offer is being placed, or was placed, on a fixed-price listing. This value is used for fixed-price listings (Basic Fixed-Price and eBay Store Inventory listings) to purchase an item. In PlaceOffer, for Chinese-auction items with the BIN option, specify Purchase to buy the item. In the case of fixed-price items listed with AutoPay, PlaceOffer cannot be used for purchase. But for fixed-price items listed with AutoPay that have the BestOffer option, PlaceOffer can be used to make an offer (but not to purchase). Reserved for future use. If an item is best-offer enabled, use this value if a buyer is making a best offer on the item. After a buyer makes a best offer (or counter-offer, etc.), the buyer can get the status of the best offer (and of a possible seller-counter-offer, etc.) using the GetBestOffers call. See the Trading Web Services Guide for information about best-offer enabled items and about GetBestOffers. If an item is best-offer enabled, use this value if a buyer is making a counteroffer to a seller's counteroffer. If an item is best-offer enabled, use this value if a buyer is accepting a counteroffer of a seller. If an item is best-offer enabled, use this value if a buyer is declining a counteroffer of a seller. Mulitple bidders can be approved with one call. Information that a Live Auction seller selects when approving or denying a user who wants to bid on items in the seller's Live Auctions catalog. User ID for the bidder to be approved. Only bidders who have requested approval can be approved. That is, the seller cannot approve a bidder who has not requested approval. (Bidders request approval via the eBay Live Auctions Web site UI.) When you are approving bidders, if you pass in multiple BidApproval entries with duplicate UserID values, the last entry with that UserID takes precedence (and the earlier duplicate UserID entries are ignored). ApproveLiveAuctionBidders Yes Maximum amount that the seller will allow the specified user to bid. This field is required if the auction house has requested that the bidder enter an amount for the seller's approval. (The bidder requests a maximum bidding limit, but the seller can specify a different maximum bidding limit.) ApproveLiveAuctionBidders Conditionally Comments entered by seller when an approval request is denied. This is required if the seller sets Status to Denied. ApproveLiveAuctionBidders Conditionally Indicates whether the seller approves or denies the bidder's approval request. ApproveLiveAuctionBidders Yes Pending Defines how a list of BidAssistant items should be returned. Use this element to specify the bid group id for the Bid Assistant items that you want information about. GetMyeBayBuying No Specifies whether or not to include Item.PrivateNotes and Item.eBayNotes in the response. GetMyeBayBuying No False Contains a list of items that are part of a bid group. Contains a list of bid groups. GetMyeBayBuying BidAssistantList

DetailLevel: none, ReturnAll

Conditionally This type contains the status of the items within a bid group. (out) The items in the group currently being bid on. (out) Items in the group that were not bid on because a user retracted a bid and closed his group or because eBay Customer Support ended a group and all the active and pending items within that group were cancelled. (out) Items in the bid group that are currently active, but have not yet been bid on. (out) Items that have been skipped and not bid on (and bidded has ended). (out) Item has ended. (out) Item was purchased and has ended. (out) Item has ended. Reserved for future use. Contains information about items that are part of a bid group. Contains a list of the items in a bid group. GetMyeBayBuying BidAssistantList

DetailLevel: none, ReturnAll

Conditionally Contains the status of the items in the bid group. GetMyeBayBuying BidAssistantList Pending, CurrentBid, Skipped, Won

DetailLevel: none, ReturnAll

Conditionally Contains the maximum bid amount for the item in the bid group. GetMyeBayBuying BidAssistantList

DetailLevel: none, ReturnAll

Conditionally This code identifies the status of the bid group. (out) Indicates that the bid group is open. (out) Indicates that the bid group is Closed. Reserved for future use. Contains a paginated list of items in a bid group. Contains a list of bid group item types. GetMyeBayBuying BidAssistantList

DetailLevel: none, ReturnAll

Conditionally Contains the bid group ID. GetMyeBayBuying BidAssistantList No Contains the bid group name. GetMyeBayBuying BidAssistantList

DetailLevel: none, ReturnAll

Conditionally Contains the bid group status. GetMyeBayBuying BidAssistantList

DetailLevel: none, ReturnAll

Conditionally A collection of Bidder Detail. Details about a Live Auctions bidder. Returned if at least one bidder has requested approval. GetLiveAuctionBidders Conditionally Contains the data for a user who is interested in bidding on items in a Live Auctions catalog. ID of the user requesting approval. GetLiveAuctionBidders Always E-mail address of the bidder. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in an order relationship and the call is being executed within a certain amount of time after the order line item is created. Returned as CDATA. When an email address can not be returned, the string "Invalid Request" is returned instead. GetLiveAuctionBidders Always Aggegate feedback score for the specified user. Feedback score is only return if the user has not chosen to make his or her feeback private. GetLiveAuctionBidders Conditionally Total count of negative Feedback entries received by the user, including weekly repeats. GetLiveAuctionBidders Always Total count of positive Feedback entries received by the user, including weekly repeats. GetLiveAuctionBidders Always Total count of neutral Feedback entries received by the user, including weekly repeats. GetLiveAuctionBidders Always Contains a seller's preferences for receiving bidder notices. If true, sends the seller a notice containing the contact information for unsuccessful bidders. GetUserPreferences Conditionally SetUserPreferences No This code identifies the status of the bidder's request Seller has approved the bidder. Seller has denied the bidder's approval request. Seller has not yet approved or denied the bidder (or the status is still being processed). Reserved for internal or future use. BidderTypeCodeType - Type declaration to be used by other schema. Specifies the whether to retrieve all bidders for ended or open listings. (in) Retrieve all bidders for ended or open listings. (in) Retrieve all high bidders. (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 Specifies whether a listing feature is available for the site specified in the request. The listing feature is enabled for the site. The listing feature is disabled for the site. Reserved for future use. Specifies whether a listing feature is available for the site specified in the request. The listing feature is enabled for the site. The listing feature is disabled for the site. Reserved for internal or future use. This type defines the Brand/Manufacturer Part Number feature, and whether this feature is enabled at the site level. An empty BrandMPNIdentifierEnabled field is returned under the FeatureDefinitions container in GetCategoryFeatures if the feature is applicable to the site and if BrandMPNIdentifierEnabled is passed in as a FeatureID (or if no FeatureID is passed in, hence all features are returned). 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 GetItem GetItems 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 GetItem GetItems Conditionally (out) Reserved for internal or future use. 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

Defines the BuyerGuarantee feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). 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 Indicates the status of the item's eligibility for a Buyer Protection Program. GetItemTransactions Conditionally GetOrderTransactions Conditionally GetSellerTransactions Conditionally GetItem GetSellingManagerTemplates 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 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 this feedback score or lower. Ignored as input if the application uses version 451 or older. Valid values: -3, -2, -1. 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 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 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, 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). Applies to the following eBay sites only: <ul> <li>Australia</li> <li>France</li> <li>India</li> <li>Ireland</li> <li>Spain</li> <li>UK</li> </ul> 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 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 Specifies 1 year feedback metrics as buyer. Count of positive feedback entries given as a buyer. GetFeedback

DetailLevel: none, ReturnAll

Conditionally Count of negative feedback entries given as a buyer. GetFeedback

DetailLevel: none, ReturnAll

Conditionally Count of neutral feedback entries given as a buyer. GetFeedback

DetailLevel: none, ReturnAll

Conditionally Percentage of leaving feedback as a buyer. GetFeedback

DetailLevel: none, ReturnAll

Conditionally Container for fields related to buyer satisfaction. Your buyer satisfaction rating, as a qualitative summary. To determine this rating, eBay considers your detailed seller ratings, your overall feedback rating, and whatever buyer protection claims might exist on your account. eBay uses the buyer satisfaction rating to see if you are eligible for certain rewards, or if you need additional guidance to help you give better service. NeedsWork GetSellerDashboard Always A message to help you understand your buyer satisfaction status. Not returned if there are no existing alerts. GetSellerDashboard Conditionally Buyer satisfaction status. You are doing an excellent job as an eBay seller. Be sure to continue providing members with a positive buying experience. A buyer satisfaction rating of Excellent ensures that you are eligible for eBay incentives. You are doing a good job as an eBay seller. Buyers have been satisfied with your customer service. Be sure to continue providing members with a positive buying experience. A buyer satisfaction rating of Good ensures that you are eligible for eBay incentives. You are doing a mediocre job as an eBay seller. Some of your buyers have not been satisfied with your service. Improve your customer service to earn a higher buyer satisfaction rating. 605 NotReturned Poor You are not doing a good job as an eBay seller. Some of your buyers have not been satisfied with your service. Improve your customer service to earn a higher buyer satisfaction rating. If your customer service continues to receive poor responses from customers, your buyer satisfaction rating can drop and could put your eBay seller's account at risk. You are doing a very poor job as an eBay seller. You need to improve your selling practices immediately. Too many of your customers have not been satisfied with your customer service and you are at risk of losing your eBay account. You are doing an unacceptable job as an eBay seller. Improve your selling practices immediately. Your account may be suspended because of your unacceptable customer service. Reserved for internal or future use. Contains information about a user as a buyer. Contains the shipping address of the buyer. 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 Information about zero or more buying guides and the site's buying guide hub. Buying guides contain content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Multiple buying guides can be returned. See the eBay Web Services Guide for additional information. Information that identifies a buying guide. A buying guide contains content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. 5 GetProducts Conditionally URL of the buying guide home page for the site being searched. Your application can present this URL as a link. Optionally, you can use a value like "See all buying guides" as the link's display name. GetProducts returns this URL even when no guides are available for the product. GetProducts Conditionally Information that identifies a buying guide. A buying guide provides content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them. Display name of the buying guide. <br> <br> GetProducts only returns 20 characters, followed by "..." if the name is longer than 20 characters. For the full title, see BuyingGuide.Title instead. 23 GetProducts Conditionally URL for the buying guide. Your application can present this as a link. Use the value of Name as the link's display name. GetProducts Conditionally Identifies the category (if any) that is associated with the buying guide. For a matching categories search, you can use this information to determine the order that the buying guides are returned in when multiple guides are found. Optionally, you can use this information to determine where to present the buying guide link in your application. Not returned for product finder searches. 10 GetProducts Conditionally Identifies the product finder (if any) that is associated with the buying guide. Only returned for product finder searches. The title of the buying guide. 55 GetProducts Conditionally The text of the guide. If the guide is longer than 2000 characters, the text is cut off and it ends with "...". See BuyingGuide.URL for a link to the full text of the review. GetProducts Conditionally The time and date when the guide was posted. GetProducts Conditionally The author's eBay user ID. GetProducts Conditionally The number of items the user has bid on. GetMyeBayBuying

DetailLevel: none, ReturnAll

Conditionally The number of items the user has bid on and is winning, but that have not yet ended. GetMyeBayBuying

DetailLevel: none, ReturnAll

Conditionally The total cost of items the user is presently winning. GetMyeBayBuying

DetailLevel: none, ReturnAll

Conditionally The number of items the user has bid on and won. GetMyeBayBuying

DetailLevel: none, ReturnAll

Conditionally The total cost of items the user has bid on and won. GetMyeBayBuying

DetailLevel: none, ReturnAll

Conditionally The time period for which won items are displayed. Default is 31 days. GetMyeBayBuying

DetailLevel: none, ReturnAll

Conditionally The number of items the user has made best offers on. GetMyeBayBuying

DetailLevel: none, ReturnAll

Conditionally Instructions on packaging/handling costs for combined payment. The type of discount that is detailed in the profile. If the selection is EachAdditionalAmount, EachAdditionalAmountOff or EachAdditionalPercentOff, the value is set in the child element of same name in CalculatedHandlingDiscount. If the selection is CombinedHandlingFee, specify the amount in CalculatedHandlingDiscount.OrderHandlingAmount. If the selection is IndividualHandlingFee, the amount is determined by eBay by adding the fees of the individual items. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally If specified, this is the fixed shipping cost to charge for an order, regardless of the number of items in the order. This field is mutually exclusive with the other amount and percentage fields within this type. This field only applies when DiscountName is CombinedHandlingFee. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally The packaging/handling cost for each item beyond the first item (where the item with the highest packaging/handling cost is selected by eBay as the first item). Let's say the buyer purchases three items, each assigned a packaging/handling cost of $8, and the seller set EachAdditionalAmount to $6. The packaging/handling cost for three items would normally be $24, but since the seller specified $6, the total packaging/handling cost would be $8 + $6 + $6, or $20. This field is mutually exclusive with the other amount and percentage fields within this type. This field only applies when DiscountName is EachAdditionalAmount. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally The amount by which to reduce the packaging/handling cost for each item beyond the first item (where the item with the highest packaging/handling cost is selected by eBay as the first item). Let's say the buyer purchases three items, each assigned a packaging/handling cost of $8, and the seller set EachAdditionalAmountOff to $2. The packaging/handling cost for three items would normally be $24, but since the seller specified $2, the total packaging/handling cost would be $24 - (two additional items x $2), or $20. This field is mutually exclusive with the other amount and percentage fields within this type. This field only applies when DiscountName is EachAdditionalOffAmount. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally The percentage by which to reduce the packaging/handling cost for each item beyond the first item (where the item with the highest packaging/handling cost is selected by eBay as the first item). Let's say the buyer purchases three items, each assigned a packaging/handling cost of $8, and the seller set EachAdditionalPercentOff to 0.25. The packaging/handling cost for three items would normally be $24, but since the seller specified 0.25 ($2 out of 8), the total packaging/handling cost would be $24 - (two additional items x $2), or $20. This field is mutually exclusive with the amount fields within this type. This field only applies when DiscountName is EachAdditionalPercentOff. GetShippingDiscountProfiles Conditionally SetShippingDiscountProfiles Conditionally Calculated Shipping Charge Options Charge the actual shipping cost and my full packaging and handling fee for each item. Charge the actual shipping cost and a packaging and handling fee of X amount for the entire order. Reserved for internal or future use. 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ShippingDiscountProfiles This type contains Calculated Shipping rules and preferences for the seller. DO NOT USE THIS FIELD. Calculated Shipping discount profiles are created and managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to retrieve Calculated Shipping discount profiles. GetUserPreferences Conditionally SetUserPreferences No DO NOT USE THIS FIELD. Calculated Shipping discount profiles are created and managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to retrieve Calculated Shipping discount profiles. GetUserPreferences Conditionally SetUserPreferences No DO NOT USE THIS FIELD. Calculated Shipping discount profiles are created and managed with SetShippingDiscountProfiles. Use GetShippingDiscountProfiles to retrieve Calculated Shipping discount profiles. GetUserPreferences Conditionally SetUserPreferences No DO NOT USE THIS FIELD. Shipping insurance parameters are passed in through SetShippingDiscountProfiles and retrieved using GetShippingDiscountProfiles. <br><br> InsuranceOption is only valid on the following eBay sites: AU, FR, IT, and IN. GetUserPreferences Conditionally SetUserPreferences NotOfferedOnSite No Calculated Shipping Rate Options. Calculate the Actual Shipping Rate from Combined Item Weight Calculate the Actual Shipping Rate from Individual Item Weight Reserved for internal or future use. Details pertinent to one or more items for which calculated shipping (or flat rate shipping using shipping rate tables with weight surcharges) 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 GetOrders

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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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 GetOrders

DetailLevel: none, ReturnAll

Conditionally http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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 GetOrders

DetailLevel: none, ReturnAll

Conditionally http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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 GetOrders

DetailLevel: none, ReturnAll

Conditionally http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=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 GetOrders

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 GetOrders

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 GetOrders

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. <br><br> For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. 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 GetOrders

DetailLevel: none, ReturnAll

Conditionally See the definition of WeightMajor. For calculated shipping or for flat rate shipping if shipping rate tables are specified and the shipping rate table uses weight surcharges. (When used with the shipping rate tables with weight surcharge, any WeightMinor value greater than zero results in WeightMajor getting rounded up in the shipping cost calculation for example, 1 lb, 2 oz is rounded up to 2 lbs.) <br><br> 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 GetOrders

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 GetOrders

DetailLevel: none, ReturnAll

Conditionally Container for a list of offers. May contain zero, one, or multiple OfferType objects, each of which represents one offer extended by a user on a listing. Contains the data for one offer. This includes: data for the user making the offer, the amount of the offer, the quantity of items being bought from the listing, the type of offer being made, and more. Container for a list of offers. May contain zero, one, or multiple OfferType objects, each of which represents one offer extended by a user on a listing. Contains the data for one offer. This includes: data for the user making the offer, the amount of the offer, the quantity of items being bought from the listing, the type of offer being made, and more. Details about an item in a cart. 587 NoOp When used as input, this is the item to be added, removed or updated in the cart. Only ItemID and Quantity apply. This is only required as input if the parent container is submitted. When returned, this is one of the items remaining in the cart. An ID created by eBay and returned along with an item, if items are returned. This ID must be provided on input to SetCart along with the corresponding item when doing a Delete or Update related to that item. What is to be done with the item. If the action is Delete or Update, ReferenceID must be provided. (It was returned with the item when the item was initially added to the cart.) This is only required if the parent container is submitted. Information about an eBay catalog product. The title of the product. Always returned when Product is returned. GetProducts Always Fully qualified URL for optional information about the product, such as a movie's description or film credits. This information is hosted through the eBay Web site and it cannot be edited. Portions of the content are protected by copyright. Applications can include this URL as a link in product search results so that end users can view additional descriptive details about the product.<br> <br> <span class="tablenote"><b>Note:</b> You can use the ProductMementoString parameter in this URL as the ProductID value in GetSearchResults requests. This parameter is a colon-delimited alphanumeric value. For an example of how to use this string, see the GetProducts samples in the eBay Web Services guide.</span> GetProducts Always Fully qualified URL for a stock image (if any) that is associated with the eBay catalog product. The URL is for the image eBay usually displays in product search results (usually 70px tall). It may be helpful to calculate the dimensions of the photo programmatically before displaying it. GetProducts Conditionally If true, your application can attempt to display stock photos that are returned. If false, your application should not attempt to display any stock photos that are returned. This recommendation is useful for catalog data related to products like coins, where stock photos are not necessarily applicable or available. An application with a graphical user interface can use this flag to determine when to hide customized stock photo widgets. GetProducts Always Total number of listings on the specified eBay site that use stock information from this catalog product. This value can be greater than the number of listings returned in ItemArray. To retrieve more listings, use GetSearchResults. Only returned when you use ExternalProductID or ProductReferenceID and you set IncludeItemArray to true. GetProducts Always An ISBN, UPC, or EAN value that is associated with this eBay catalog product (if any). These values are only returned for products in "media" domains (Books, DVDs and Movies, Music, and Video Games). Products in other domains don't return this value (even if a UPC is available in the Item Specifics.) Please note that as of February 2007, GetProducts may temporarily return two ExternalProductID nodes for ISBN for some sites (one with a 13-digit value and one with a 10-digit value). This is a bug and it will be fixed in an upcoming release. Instead, one ExternalProductID node will be returned with an additional field. Do not code your application to expect multiple ExternalProductID nodes to be returned for ISBN values on an ongoing basis. GetProducts Conditionally The numeric ID for the eBay catalog product. After selecting a product returned from a keyword query, pass this value in GetProducts to retrieve more information about that product. GetProducts Conditionally Numeric ID for the product's domain (characteristic set). When you use GetProducts by itself, this can be useful when you want to group product results by domain (e.g., all book products together). For a mapping of attribute set IDs to names, see the eBay Web Services guide. Alternatively, use GetCategory2CS to retrieve the mappings periodically (e.g., once a day) and store them locally. (We do not recommend using the product histogram, for this purpose.) GetProducts Conditionally A list of attribute and value pairs that are included in the product's pre-filled Item Specifics. Also see ExternalProductID for ISBN, UPC, or MPN values, if applicable. This is usually returned. (We are not aware of any cases in which this node is not be returned. However, it may be safest to check for the existence of this node.) GetProducts Conditionally The total number of reviews that are available for this product on the eBay Web site. This can be greater than the number of reviews returned by GetProducts. See ReviewDetails.Review.URL for information about viewing more reviews. GetProducts Always 0 The product's most helpful reviews, if any. The reviews are sorted by most helpful review (most votes) first. Only returned when you pass in ExternalProductID or ProductReferenceID and you set IncludeReviewDetails to true. Up to 20 of the reviews are returned. If more reviews are available, (that is, if ReviewCount is greater than 20), the user can look at additional reviews on the eBay Web site. See ReviewDetails.Review.URL for information about viewing more reviews. GetProducts Conditionally Indicates that the product has changed or will soon change (usually due to a migration from one catalog to another catalog). Typically, this field is returned for up to 90 days for a given product. After that, the product either no longer returns this field or the product is no longer returned (depending on the state change). <br><br> This data is primarily applicable to catalogs used by the US, Germany, Austria, and Switzerland sites. Other sites may undergo catalog changes in the future. GetProducts Conditionally Container for a list of categories. Contains details about one category. For GetCategories, this node is not returned when no detail level is specified. GetCategories

DetailLevel: ReturnAll

Always GetPopularKeywords Always GetCategory2CS MappedCategoryArray

DetailLevel: ReturnAll

Always GetCategory2CS UnmappedCategoryArray

DetailLevel: ReturnAll

Conditionally The Detail Level argument for GetCategories allows the following settings to control the detail level of the result set. Return all available data. Return the category feature definitions only. (out) Reserved for internal or future use. A container node that identifies a category that has one of the features specified in FeatureID (in GetCategoryFeaturesRequest). Specifies the identifier of the category that has the feature. 10 GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Identifies the listing duration set that applies to the category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether sellers are required to specify shipping items for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether best offers is allowed for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent.. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether Buy It Now is allowed in this category for Dutch (multi-item) auctions. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. <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> GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether a bidder must consent to the bid by confirming that he or she read and agrees to the terms in eBay's privacy policy. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether or not it is possible to enhance a listing by putting it into a rotation for display on a special area of the eBay home page. Support for this feature varies by site. Item or feedback restrictions may apply. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether ProPackBundle (a feature pack) is enabled for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Not applicable to any site. Indicated whether the Basic Upgrade Pack bundle feature was enabled for this category. Formerly, Australia site (site ID 15, abbreviation AU) only. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether ValuePack bundle (a feature pack) is enabled for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the ProPackPlus bundle (a feature pack) is enabled for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the Classified Ad format feature is enabled for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether counter offers are allowed on best offers for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether auto decline for best offers is allowed for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether LocalMarketSpecialitySubscription feature is supported for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether LocalMarketRegularSubscription feature is supported for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether LocalMarketPremiumSubscription feature is supported for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether LocalMarketNonSubscription feature is supported for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether listings in this category are eligible for eBay Express (assuming other item and user eligibility requirements are also met). <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. 579 NoOp GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether a listing requires a picture (or gallery image) in order to qualify for eBay Express when listed in this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. 579 NoOp GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether a listing requires the Item Condition to be specified (using Item Specifics in AttributeSetArray) in order to qualify for eBay Express when listed in this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. 579 NoOp GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether Minimum Reserve Price is enabled for this category. On the Germany, Austria, Belgium French, and Belgium Dutch sites, Minimum Reserve Price is supported for the Art and Antiques, Watches and Jewelry, and Motorbikes categories. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether this category supports seller-level contact information for Classified Ad format listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the Transaction Confirmation Request feature is supported for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether Store Inventory Format is enabled for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the addition of Skype buttons to listings is supported for this category for sales listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the addition of Skype buttons to listings is supported for this category for ad listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the payment method should be displayed to the user for Classified Ad format listings. Even if enabled, checkout may or may not be enabled. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates if shipping options are available for Classified Ad listings in the category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates if Best offer is enabled for Classified Ad listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether counter offers are allowed on Classified Ad listings for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether automatic decline for best offers for Classified Ad listings is allowed for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the telephone is supported as a contact method for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports email as a contact method. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether listings in this category need to have a safe payment method, for all sellers registered after January 17,2007. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates if pay-per-lead listings are allowed for this category. Pay-per-lead listings can be applicable if the ListingType is LeadGeneration and the ListingSubtype is ClassifiedAd. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports custom Item Specifics. If enabled, sellers can use the Item.ItemSpecifics node in AddItem and related calls to fill in Item Specifics. If your application supports the older ID-based Attribute format, please remove all dependencies on that format by May 2012. Also see AttributeConversionEnabled. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally The presence of this field indicates that the category supports the PaisaPayEscrow payment method. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally The presence of this field indicates that the category supports the Universal Parcel Code (UPC) listing feature. This feature allows the seller to pass in a UPC value through the Item.ProductListingDetails.UPC field to identify and pre- fill information for a product when adding, revising, or relisting an item. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally The presence of this field indicates that the category supports the European Article Number (EAN) listing feature. This feature allows the seller to pass in an EAN value through the Item.ProductListingDetails.EAN field to identify and pre-fill information for a product when adding, revising, or relisting an item. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally The presence of this field indicates that the category supports the International Standard Book Number (ISBN) listing feature. This feature allows the seller to pass in an ISBN value through the Item.ProductListingDetails.ISBN field to identify and pre-fill information for a product when adding, revising, or relisting an item. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally The presence of this field indicates that the category supports the Brand/Manufacturer Part Number listing feature. This feature allows the seller to pass in a brand and MPN value through the Item.ProductListingDetails.BrandMPN container to identify and pre-fill information for a product when adding, revising, or relisting an item. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports setting a price at which best offers are automatically accepted for Classified Ads. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports setting a price at which best offers are automatically accepted. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports specifying that listings be displayed in the default search results of North America sites. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports specifying that listings be displayed in the default search results of the UK site. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports specifying that listings be displayed in the default search results of the Australia site. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally For the Australia site, if both PayPalBuyerProtectionEnabled and BuyerGuaranteeEnabled are returned, then buyer protection is allowed for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally For the Australia site, if both PayPalBuyerProtectionEnabled and BuyerGuaranteeEnabled are returned, then buyer protection is allowed for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports combined fixed price treatment for the following two listing types: Store Inventory Format and Basic Fixed Price. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports durations for "Gallery Featured". <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category requires PayPal as a payment method. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies whether this category allows Classified Ad listings. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether this category supports including the telephone in the seller's contact information. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates which telephone option is enabled for the seller's contact information. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether this category supports including the address in the seller's contact information. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates which address option is enabled for the seller's contact information. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether this category supports including the company name in the seller's contact information. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether this category supports including an email address in the seller's contact information. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates if Best Offer is supported for Classified Ad listings in this category. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies whether this category allows auto-accept for Best Offers for Classified Ads. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies whether this category allows auto-decline for Best Offers for Classified Ads. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates if the payment method should be displayed to the user for this category. Even if enabled, checkout may or may not be enabled. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates if shipping options are available for this category. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether counter offers are allowed on Best Offers for this category. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies whether this category allows seller-level contact information for Classified Ad listings. A value of true means seller-level contact information is available for Classified Ad listings. This element is for eBay Motors Pro users. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies whether this category supports Classified Ad listings. This is added for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether this category supports including a telephone number in the seller's contact information. This element is added for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates which telephone option is enabled for the seller's contact information. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports including an address in the seller's contact information. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates which address option for is included in the seller's contact information. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports including a company name in the seller's contact information. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports including an email address in the seller's contact information. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates if Best Offer is enabled for Classified Ad listings in this category. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies whether this category supports auto-accept for best offers for Classified Ads. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies whether this category supports auto-decline for best offers for Classified Ads. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates if the payment method should be displayed to the user for this category. Even if enabled, checkout may or may not be enabled. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates if shipping options are available for this category. This element is for Local market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether counter offers are allowed on best offers for this category. This element is for Local market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies the whether this category allows seller-level contact information for Classified Ad listings. This element is for Local Market dealers. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates which telephone option is included in the seller's contact information. This element is for For Sale By Owner listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether this category supports including an address in the seller's contact information. This element is for For Sale By Owner listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates which address option is included in the seller's contact information. This element is for For Sale By Owner listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether this category supports including a company name in the seller's contact information. This element is for For Sale By Owner listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies this speciality subscription feature for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies the regular lsubscription feature that is supported for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies the premium subscription feature for this category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies the supported local listing distances for this category, for users who have not subscribed to either Regular or Specialty vehicles. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates the escrow workflow version that applies to the category on the India site: Default Workflow, Workflow A or Workflow B. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Defines if PayPal is required for Store Owner listings in this category. Applies to Fixed Price Listings as well as Store Inventory Format listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally If true, the item quantity for listings in this category can be revised while the listing is in semi or fully restricted mode. Applies to Fixed Price Listings as well as Store Inventory Format listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally If true, the start price for items in this category can be revised while the listing is in semi or fully restricted mode. Applies to Fixed Price Listings as well as Store Inventory Format listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Defines if extended store owner listing durations are enabled in a given category. When the value of this element is true, it means the listing duration values defined in StoreOwnerExtendedListingDurations are applicable to fixed price listings in a given category. Applies to Fixed Price Listings as well as Store Inventory Format listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Provides additional listings durations that are supported by Store Owners. The extended listing durations provided here in this element should be merged in with the baseline listing durations provided in the ListingDurations element. Applies to Fixed Price Listings as well as Store Inventory Format listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally <b>For most sites:</b> If true, listings in this category require a return policy. <br> <br> <b>For eBay India (IN), Australia (AU), and US eBay Motors Parts and Accessories:</b> If true, the category supports but does not require a return policy. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally If false, listings in this category require a handling time (see DispatchTimeMax in AddItem) when flat or calculated shipping is specified. (A handling time is not required for local pickup or for freight shipping.)<br> <br> The handling time is the maximum number of business days the seller commits to for preparing an item to be shipped after receiving a cleared payment. The seller's handling time does not include the shipping time (the carrier's transit time). <br> For a list of the handling time values allowed for each site, use DispatchTimeMaxDetails in GeteBayDetails.<br> <br> <span class="tablenote"><b>Note:</b> Although the field name ends with "Enabled", a value of true means that a handling time is NOT supported, and value of false means that a handling time IS supported.</span> <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally The maximum cost the seller can charge for the first domestic flat rate shipping service. The total shipping cost is the seller's base flat rate shipping cost plus the cost of insurance, if insurance is required. Only returned if MaxFlatShippingCostEnabled is true. Mutually exclusive with the GroupNMaxFlatShippingCost elements. <br><br> Returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MaxFlatRateShippingCost Returns the applicable max cap per shipping cost for shipping service group1. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Returns the applicable max cap per shipping cost for shipping service group2. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Returns the applicable max cap per shipping cost for shipping service group3. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally One <b>PaymentMethod</b> field is returned for each acceptable payment method. Acceptable payment methods for an item are dependent on the listing site and the category. If the seller making the call is a new to listing on the DE or AT sites, hence is subject to the new payment process, only one <b>PaymentMethod</b> field will be returned, and the value will always be <b>StandardPayment</b>. Starting in late August 2011, a new payment begins for new sellers listing on the German (DE) or Austrian (AT) sites. <br><br> The seller can specify one or more of the acceptable payment methods when making an Add/Revise/RelistItem API call. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally If true, you can pass in Item.Variations in the AddFixedPriceItem family of calls when you list in this category.<br> <br> Multi-variation listings contain items that are logically the same product, but that vary in their manufacturing details or packaging. For example, a particular brand and style of shirt could be available in different sizes and colors, such as "large blue" and "medium black" variations. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Most eBay categories no longer support ID-based attributes. The remaining categories (e.g., US eBay Motors) will drop support for ID-based attributes by May 2012. New applications should not use ID-based attributes. Existing applications should be updated to remove all dependencies on ID-based attributes now.<br> <br> Indicates whether eBay has converted the category from ID-based attributes to custom Item Specifics. Only applicable to categories that previously supported ID-based attributes.<br> <br> If conversion is Enabled or Disabled and the category is flagged as CatalogEnabled in GetCategory2CS, you can use GetItemRecommendations to retrieve product details in the custom Item Specifics format instead of using GetProductSellingPages to retrieve product details in the ID-based attributes format.<br> <br> With version 607 and lower, categories with attribute conversion Enabled or Disabled do not return recommendations in GetCategorySpecifics. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. http://developer.ebay.com/DevZone/XML/docs/WebHelp/ReleaseNotes.html#759-CF GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports free, automatic upgrades for Gallery Plus, which enhances pictures in search results. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports free, automatic upgrades for Picture Pack, a discount package that includes super-sizing of pictures. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports parts compatibility by application (ByApplication), by specification (BySpecification), or not at all (Disabled). Categories cannot support both types of parts compatibility. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally This field specifies the minimum number of required compatible applications for listing items. A value of "0" indicates it is not mandatory to specify parts compatibilities when listing. <br><br> This applies to categories that are enabled for compatibility by application only. Parts compatiblity by application can be specified by listing with a catalog product that supports parts compatibility or by specifying parts compatibility by application manually (<b class="con"> Item.ItemCompatibilityList</b>). <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally This field specifies the maximum number of compatible applications allowed per item when adding or revising items. This is relevant for specifying parts compatibility by application manually (<b class="con"> Item.ItemCompatibilityList</b>) only. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether the category supports (or requires) using Item.ConditionID to specify an item's condition in AddItem and related calls. See ConditionValues for a list of valid IDs.<br> <br> <span class="tablenote"><b>Note:</b> Some categories may still support using the older Attribute model and/or Custom Item Specifics model for item condition. If ConditionEnabled=Enabled (or Required) for a category, you should stop using these other fields to specify the condition in your listings. </span> <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Specifies the supported item conditions for the category, plus related policies and other details. Only returned if ConditionEnabled is Enabled or Required for the category (and the condition values are different than the site defaults). <br><br> Returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Some eBay sites may select a few categories and designate them as "value categories". These are typically selected from categories where buyers can find great deals. (Not all categories with great deals are designated as value categories.) This designation can change over time. <br> <br> While a category is designated as a value category (i.e., when ValueCategory is true), it is subject to the following rule: Items in value categories can only be listed in one category.<br> <br> For example, if you attempt to list in two categories and the PrimaryCategory or SecondaryCategory is a value category, then eBay drops the SecondaryCategory and lists the item in the PrimaryCategory only. Similarly, if you attempt to add a secondary category to an existing listing, or you change the category for an existing listing, and if the primary or secondary category is a value category, then eBay drops the secondary category. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates whether a category supports product creation, the ability to add products to the eBay catalog associated with the category. Also indicates whether sellers must list with a product in categories that support product creation. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates, for the given category the total number of fine grained item compatibilities that can be applied to a listing. <br><br> When you list with parts compatibility, using only the high-level compatibility search names, such as Year, Make, and Model, the fitment applies to the various unspecified lower-level compatiblity search names and values, such as Trim and Engine, as well. This means that specifying a single coarsely defined item compatibility may result in multiple fitments applying to the listing at the lowest level of granularity. Up to 300 (or whatever maximum is indicated by MaxItemCompatibility) coarse parts compatiblities can be specified for a given listing. <br><br> Alternatively, you can explicitly specify up to 1000 (or whatever maximum is indicated by MaxGranularFitmentCount) parts compatibilities at the lowest level of granularity. That is, if you specify your parts compatibilities using all of the supported compatiblity search names (e.g., Year, Make, Model, Trim, and Engine), you can specify up to 1000 compatibilities. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Indicates which vehicle type, Cars and Trucks or Motorcycles, is supported for specfying parts compatibility for listings in this category. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally This field is returned in the GetCategoryFeature response if the Payment Options Group feature applies to the category. The Payment Options Group feature is only applicable to DE and AT listings. <br><br> Only returned when this value (or this category's setting) overrides the value inherited from the category's parent. GetCategoryFeatures

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Type defining the <b>CategoryGroup</b> container, which defines the category group to which the corresponding Business Policies profile will be applied, and a flag that indicates whether or not that Business Policies profile is the default for that category group. <br><br> <span class="tablenote"><strong>Note:</strong> Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings. </span> Defines the name of the category group that a policy belongs to. Valid values are ALL (referring to all non-motor vehicle category groups)or MOTOR_VEHICLE (referring to only motor vehicle category groups). <br><br> <span class="tablenote"><strong>Note:</strong> Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings. </span> GetUserPreferences Conditionally SetUserPreferences No Identifies that the corresponding Business Policies profile is the default for the category group. <br><br> <span class="tablenote"><strong>Note:</strong> Beginning with Version 763, the new Business Policies Management API and related Trading API containers/fields become available for testing in the Sandbox environment. In May 2012, Business Policies becomes fully functional and sellers can apply Business Policies profiles to live eBay listings. </span> GetUserPreferences Conditionally SetUserPreferences No Defines details about recommended names and values for custom Item Specifics. A leaf-level eBay category ID. This call retrieves recommended Item Specifics (if any) for each leaf category you specify. (The call returns no results for a parent category.) To determine which leaf categories support listing with custom Item Specifics, use GetCategoryFeatures. <br> <br> <span class="tablenote"><b>Note:</b> This call may return recommendations for categories that don't support listing with custom Item Specifics. That is, the presence of recommendations for a category does not necessarily mean that AddItem supports custom Item Specifics for that category and site.</span><br> <br> The request requires either CategoryID, CategorySpecfics.CategoryID, or CategorySpecificsFileInfo (or the call returns an error). CategoryID and CategorySpecific.CategoryID can both be used in the same request. (CategorySpecific offers more options to control the response.) Some input fields, such as IncludeConfidence, only work when CategoryID or CategorySpecfics.CategoryID is specified.<br> <br> You can specify multiple leaf categories, but more categories can result in longer response times. If your request times out, specify fewer IDs. If you specify the same ID twice, we use the first instance. 10 100 GetCategorySpecifics Conditionally In the request, use this to retrieve recommended values for a particular name (in the specified category). This could be an arbitrary name that the seller wants to check, or it could be a name that was returned in a prior response. At the time of this writing, this value is case-sensitive. (Wildcards are not supported.)<br> <br> In the response, contains a list of Item Specifics (if any) that eBay recommends as most popular within the specified category. GetCategorySpecifics Conditionally Mapping between an old category ID and an active category ID. Identifier for an old category that has been combined with an active category. Unique for the site. These IDs correspond to older category IDs that calls like GetCategories have returned in the past. In GetCategoryMappings, this is always returned when CategoryMapping is returned. GetCategoryMappings Conditionally Identifier for an active category. Unique for the site. These IDs correspond to the current IDs in the category hierarchy (returned from GetCategories and related calls). Multiple mappings can specify the same active category ID, because different old IDs can be mapped to the same active category. See "Mapping Categories on the Client Side" in the eBay Web Services guide. In GetCategoryMappings, this is always returned when CategoryMapping is returned. GetCategoryMappings 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AutoPay 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 http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=B2BVAT 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 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 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. GetCategories

DetailLevel: ReturnAll

Always 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 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 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 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). 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. 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 list of one or more characteristic set IDs. Numeric identifier for a domain (characteristic set).<br> <br> For GetProducts (for buying tools), you can use the list of catalog-enabled attribute sets in the documentation (see link below).<br> <br> For GetProductSearchResults (for selling tools), it's best to use GetCategory2CS to determine mappings between categories and characteristic sets that are flagged as CatalogEnabled. ../../Support/CatalogEnabledAttrSets.html GetProductSearchResults GetProducts No 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 Indicates whether one attribute or multiple attributes can be used as the search criteria when calling GetProductSearchResults. (out) The search criteria can consist of one attribute. (out) Not used. (For multi-attribute search criteria, call GetProductFinder instead.) (out) Reserved for internal or future use A generic type used for histograms. In GetProducts, each histogram entry shows how many matching products were found in each matching domain. A domain is like a high-level category. (A domain is also called an attribute set or a characteristic set.) GetProducts Conditionally 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 Type defining the <b>Charity</b> container, which consists of all details related to a nonprofit charity organization. The name of a non-profit charity organization. The <b>Name</b> field is required if non-registered charity organization, since these companies will not have a eBay Giving Works <b>CharityID</b> 150 GetCharities Conditionally The mission statement of a nonprofit charity organization registered with eBay Giving Works. The mission statement is returned in <b>GetCharities</b> and is displayed in item listings if the nonprofit charity organization is registered with eBay Giving Works. 511 GetCharities Conditionally This URL indicates the location of the nonprofit charity organization's logo image. The image file must be JPG or GIF format, and its size cannot exceed 50 KB. This logo is displayed in item listings if the nonprofit charity organization is registered with eBay Giving Works. A standard eBay Giving Works logo is used in place of the charity organization's logo if the <b>LogoURL</b> or <b>LogoURLSelling</b> values are not provided or these value point to bad URLs or to URLs containing no images or images not meeting eBay logo size and format requirements. This value is returned if set. GetCharities Conditionally Enumeration value that indicates whether or not the charity is a valid eBay Giving Works nonprofit organization. GetCharities Always Keyword string to be used for search purposes. Integer value that indicates the nonprofit charity organization's region. Each nonprofit charity organization may be associated with only one region. GetCharities Conditionally Integer value that indicates the domain (mission area) of the nonprofit charity organization. A nonprofit charity organization does not have to specify a charity domain, so it is possible that this field will not be returned in <b>GetCharities</b>. Each nonprofit charity organization can belong to as many as three charity domains. GetCharities Conditionally A unique identifier created by eBay and assigned to registered nonprofit charity organizations. This identifier can be used as a filter in the <b>GetCharities</b> request, and it will always be returned if the nonprofity charity organization is registered with eBay Giving Works. GetCharities Conditionally An alternative to the <b>LogoURL</b> value. This URL indicates the location of the nonprofit charity organization's logo image. The image file must be JPG or GIF format, and its size cannot exceed 50 KB. This URL will be used if the <b>LogoURL</b> value points to a broken link or if that location either contains no image or contains an image that does not meet the eBay requirements - GIF or JPG file; maximum size of 50 KB. A nonprofit charity organization's logo is displayed in item listings if the nonprofit charity organization is registered with eBay Giving Works. A standard eBay Giving Works logo is used in place of the charity organization's logo if the Logo URL is not provided. This value is returned if set. GetCharities Conditionally <b>Deprecated.</b> This field will be removed from the schema in a future release. Recommended to use IsFeaturedInSYI. This boolean value should be set to true if an alternate logo URL should be supplied by sellers using the eBay Sell Your Item flow. If this field has not been set to true, it will return the default value of false. GetCharities Conditionally 659 672 NoOp FeaturedInSelling <b>Deprecated.</b> This field will be removed from the schema in a future release. Recommended to use a combination of IsFeaturedInXO/DisplayAtCheckout, based on the scenario. Set this boolean value to true if the name of the nonprofit company should be shown during checkout. If this field has not been set to true, it will return the default value of false. If the user rolls their mouse over the name of the nonprofit company, they will see the nonprofit company's mission statement. GetCharities Conditionally 659 672 NoOp FeaturedInCheckout This field provides a short description about the nonprofit charity organization's primary purpose. "I want to support" will be added to the beginning of the contents of this field. For example, if the description is "the fight against cancer", then on the checkout page "I want to support the fight against cancer" will be displayed. The description may contain a maximum of 115 charecters. This value is returned if set. 115 GetCharities Conditionally This field must be used with the DisplayNameInCheckout field to control the options that are visible to a buyer during checkout. If the DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout field is set to False, a checkbox with the one dollar option will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout field is set to False, no options will be displayed during checkout. <br><br> Reserved for future use. If the DisplayNameInCheckout field is set to True, and the ShowMultipleDonationAmountInCheckout field is set to True, a dropdown with multiple donation amounts will be displayed during checkout. If the DisplayNameInCheckout field is set to False, and the ShowMultipleDonationAmountInCheckout field is set to True, no options will be displayed during checkout, but the multiple donation amount field will be set. GetCharities Conditionally An integer value that indicates a nonprofit charity organization's popularity rank in comparison with other registered eBay Giving Works organizations. This value is determined and managed by MissionFish and is based on various factors. This value is always returned for nonprofit organizations registered with eBay Giving Works. SetCharities No GetCharities Conditionally This value is the Employer Identification Number (EIN) of the nonprofit charity organization. A nonprofit company's EIN is used for tax purposes by the Internal Revenue Service. This value is returned if the nonprofit organization has an EIN and it has been set. SetCharities No GetCharities Conditionally An alternative name for the nonprofit charity organization. This value is used by PayPal to search for nonprofit organizations. This value is returned if set. SetCharities No GetCharities Conditionally Container consisting of the address (including latitude and longitude) of a nonprofit charity organization. This container is always returned if it is set. SetCharities No GetCharities Conditionally Container consisting of the nonprofit charity organization's social networking site ID/handle. A <b>NonProfitSocialAddress</b> container will exist for each social networking site that the charity organization is asssociated with. Supported social networking sites include Facebook, Twitter, LinkedIn, Google+, MySpace, and Orkut. One or more of these containers are returned if set. SetCharities No GetCharities Conditionally This attribute is a unique identifier used by the corresponding social networking site to identify the nonprofit charity organization. GetCharities Conditionally Type defining the <b>NonProfitSocialAddress</b> container, which identifies the nonprofit organization's social networking site account ID. A <b>NonProfitSocialAddress</b> container will exist for each social networking site that the charity organization is asssociated with. Enumeration value that indicates the social networking site that the nonprofit charity organization is associated with. This is a required field for each social networking account associated with the nonprofit organzation. 512 SetCharities No GetCharities Conditionally The account ID/handle associated with the nonprofit charity organization's social networking site. This is a required field for each social networking account associated with the nonprofit organzation. 512 SetCharities No GetCharities Conditionally Enumerated type that defines the social networking sites that are supported by eBay Giving Works. The supported social networking sites are listed below. This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> is associated with the nonprofit company's Facebook account. This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> is associated with the nonprofit company's Twitter account. This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> is associated with the nonprofit company's LinkedIn account. This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> is associated with the nonprofit company's Google+ account. This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> is associated with the nonprofit company's MySpace account. This value indicates that the <b>Charity.NonProfitSocialAddress.SocialAddressId</b> is associated with the nonprofit company's Orkut account. This value is reserved for internal or future use. 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 The checkout method used by the buyer at external site. Other Checkout Method was used. As of July 1, 2011, third-party applications can no longer be used for checkout. All purchased items must go through the eBay Checkout flow. (out) Reserved for internal or future use. Details of the order for a checked out cart. 587 NoOp The total item cost of all items in the cart. The total shipping cost of all items in the cart. The total tax for all items in the cart. The overall total cost (including item cost, shipping cost and taxes). Indicates the current Checkout status for an order line item. (out) Checkout complete. (out) Checkout incomplete. (out) Buyer requests total from seller. (out) Seller responded to buyer's request. (out) Reserved for future use. Indicates the success or failure of a buyer's payment for an order. <br><br> Also applicable to Half.com (for GetOrders). GetOrders

DetailLevel: none, ReturnAll

Always GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

Always SoldReport Always Indicates the last time that there was a change in value of the CheckoutStatus.Status field, such as Pending to Complete. <br><br> This field is also applicable to Half.com listing when using GetOrders. GetOrders

DetailLevel: none, ReturnAll

Always GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

Always The payment method that the buyer selected to pay for the order. <br> <br> This field is also applicable to Half.com listing when using GetOrders. GetOrders

DetailLevel: none, ReturnAll

Always GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

Always SoldReport Always Indicates the status of the order. This value is subject to change based on the status of the checkout flow. Generally speaking, the Status reads Incomplete when payment has yet to be initiated, Pending when payment has been initiated but is in process, and Complete when the payment process has completed. <br><br> <b>Note</b>: If the PaymentMethod is CashOnPickup, the Status value will read Complete right at Checkout, even though the seller may not have been officially paid yet, and the eBayPaymentStatus field will read NoPaymentFailure. The CheckoutStatus.Status value will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. <br><br> This field is also applicable to Half.com listing when using GetOrders. GetOrders

DetailLevel: none, ReturnAll

Always GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

Always SoldReport Always Indicates whether the item can be paid for through a payment gateway (Payflow) account. If IntegratedMerchantCreditCardEnabled is true, then integrated merchant credit card (IMCC) is enabled for credit cards because the seller has a payment gateway account. Therefore, if IntegratedMerchantCreditCardEnabled is true, and AmEx, Discover, or VisaMC is returned for an item, then on checkout, an online credit-card payment is processed through a payment gateway account. GetOrders

DetailLevel: none, ReturnAll

Always GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

Always This container is returned when a buyer's payment does not match the total cost of an order going through the new eBay payment process. This container is only applicable for German and Austrian orders going through the new eBay payment process, and if the buyer has selected EFT as the payment method. GetOrders

DetailLevel: none, ReturnAll

Conditionally GetItemTransactions

DetailLevel: none, ReturnAll

Conditionally GetOrderTransactions

DetailLevel: none, ReturnAll

Conditionally GetSellerTransactions

DetailLevel: none, ReturnAll

Conditionally Indicates whether automatic acceptance of best offers is allowed for this category. Returned only if this category overrides the site default. Indicates whether automatic declining of best offers is allowed for this category. Returned only if this category overrides the site default. Used to indicate whether Best Offer is enabled for a category belonging to the Classified Ad Format. The Best Offer feature is disabled for the category. The Best Offer feature is enabled for the category. The category supports the Best Offer feature only. (out) Reserved for internal or future use. Indicates whether Contact Seller is enabled for Classified Ads. Indicates whether the category supports the use of a company name when contacting the seller for Classified Ad format listings. Added for the For Sale By Owner format. Indicates whether the category supports the use of an address when contacting the seller for Classified Ad format listings. Added for the For Sale By Owner format. Indicates if Email can be a contact method for the category Indicates whether the telephone can be a contact method for the category. Indicates whether counter offers are allowed on best offers for this category. Returned only if this category overrides the site default. Defines the pay-per-lead feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Used to indicate whether the payment method will be displayed for a category belonging to the Lead Generation Format. Display the payment method and permit checkout. Display the payment method and suppress checkout. Do not display the payment method. (out) Reserved for internal or future use. Indicates whether Contact Seller is enabled Classified Ads. Indicates which phone option the category supports for contacting the seller for Classified Ad format listings. Added for the For Sale By Owner format. Indicates whether shipping options are available for the category. Indicates which address option the category supports for Classified Ad format listings. Added for the For Sale By Owner format. Defines the Combined Fixed Price Treatment feature. If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Combined Purchase Options Combined payments are not allowed by seller. Yes. Specify discount now. Yes. Specify discount later. Reserved for internal or future use. Number of days. 3 days 5 days 7 days 14 days 30 days No restriction period is being applied Reserved for internal or future use Type used to define all Combined Payment preferences, including preferences and rules for Calculated and Flat Rate shipping, a flag to allow or disallow Combined Payment orders, and the time period in which to allow buyers to combine multiple purchases from the seller into a Combined Payment order. DO NOT USE THIS CONTAINER. As an alternative, use SetShippingDiscountProfiles to set all Calculated Shipping rules and preferences, and use GetShippingDiscountProfiles to retrieve the same information. GetUserPreferences Conditionally SetUserPreferences No Specifies whether or not a seller wants to allow buyers to combine single order line items into a Combined Payment order. A Combined Payment order can be created by the buyer or seller if multiple unpaid order line items exist between the same buyer and seller. Often, a Combined Payment order can reduce shipping and handling expenses for the buyer and seller. GetUserPreferences Conditionally SetUserPreferences No DO NOT USE THIS FIELD. As an alternative, use the CombinedDuration field in SetShippingDiscountProfiles to specify the time period in which to allow buyers to combine order line items into a Combined Payment order. Use GetShippingDiscountProfiles to retrieve the CombinedDuration value. GetUserPreferences Conditionally SetUserPreferences No DO NOT USE THIS CONTAINER. As an alternative, use SetShippingDiscountProfiles to set all Flat Rate Shipping rules and preferences, and use GetShippingDiscountProfiles to retrieve the same information. GetUserPreferences Conditionally SetUserPreferences No These are the codes used to specify the type of feedback/comments in a single feedback record. Additional information about feedback is available in the online Help of the eBay website. Positive feedback. Increases total feedback score. Neutral feedback. No effect on total feedback score. Negative feedback. Decreases total feedback score. Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible. Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party. Reserved for internal or future use. Defines the vehicle type to which parts compatibility applies. If the field is present, the corresponding feature applies to the site. The field is returned as an empty element (e.g., a boolean value is not returned). Indicates whether the order is complete, incomplete, or pending. The order is incomplete. Generally speaking, an order is incomplete when payment from the buyer has yet to be initiated. The order is complete. Generally speaking, an order is complete when payment from the buyer has been initiated and processed. <br><br> <b>Note</b>: If the PaymentMethod is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete right at Checkout, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. The order is pending. Generally speaking, an order is pending when payment from the buyer has been initiated but has yet to be fully processed. <br><br> <b>Note</b>: If the PaymentMethod is CashOnPickup, the CheckoutStatus.Status value in GetOrders will read Complete right at Checkout, even though the seller may not have been officially paid yet. The CheckoutStatus.Status value in GetOrders will remain as Complete even if the seller uses ReviseCheckoutStatus to change the checkout status to Pending. However, the eBayPaymentStatus value in GetOrders will change from NoPaymentFailure to PaymentInProcess. Reserved for internal or future use Values indicate whether the ConditionID field is enabled, disabled or required for a category. Item condition is not supported for the category. Do not pass ConditionID in AddItem and related calls. Item condition is supported for the category. You can pass ConditionID to specify the condition in AddItem and related calls. Item condition is required for the category. You must use ConditionID to specify the condition in AddItem and related calls. (out) Reserved for internal or future use. Defines the condition enablement feature. If a field of this type is present, the corresponding feature applies to the site. The field is returned as an empty element (e.g., a boolean value is not returned). Fields in this type provide IDs and values for item conditions (in GetCategoryFeatures). The numeric ID of a condition (e.g., 1000). Use the ID in AddItem and related calls. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally The human-readable label for the condition (e.g., "New"). This value is typically localized for each site. The display name can vary by category. For example, condition ID 1000 could be called "New: with Tags" in one category and "Brand New" in another. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally Defines the Item Condition feature. If a field of this type is present, the corresponding feature applies to the site. The field is returned as an empty element (e.g., a boolean value is not returned). Fields in this type provide condition values and display names. Defines an item condition that a category supports. GetCategoryFeatures

DetailLevel: ReturnAll

Conditionally URL to the eBay Web site's item condition help for the category. This may include policies about how to assess the condition of an item in the category. To reduce item-not-as-described disputes, we recommend that you refer sellers (and buyers) to these help pages. These help pages may vary for some categories.<br> <br> The Sandbox might not return valid help URLs. GetCategoryFeatures

DetailLevel: 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 Score and rank for a keyword identified for a web page. The keyword. 64 GetContextualKeywords Always The eBay category in which the keyword is used. GetContextualKeywords Always The ranking of this keyword and category relative to other keywords and categories (when scores are sorted). 1 2147483647 GetContextualKeywords Always Various groupings of Shipping Service Cost. Shipping Service Cap Group 1. Shipping Service Cap Group 2. Shipping Service Cap Group 3. Reserved for internal or future use. 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 Details about a specific country. Two-letter country abbreviation.<br><br> Related fields:<br> Item.Country in AddItem GeteBayDetails Conditionally Full country name for display purposes. May be similar to (but not necessarily identical to) CountryName in addresses (e.g., User.RegistrationAddress.CountryName in GetUser). GeteBayDetails Conditionally Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data. GeteBayDetails

DetailLevel: none, ReturnSummary, ReturnAll

Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data. GeteBayDetails

DetailLevel: none, ReturnSummary, ReturnAll

Always Defines the CrossBorderTradeAustraliaEnabledDefinitionType feature (used for specifying that listings be displayed in the default search results of other sites). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Defines the CrossBorderTradeGBEnabledDefinitionType feature (used for specifying that listings be displayed in the default search results of other sites). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Defines the CrossBorderTradeNorthAmericaEnabled feature (used for specifying that listings be displayed in the default search results of other sites). If the field is present, the corresponding feature applies to the category. The field is returned as an empty element (i.e., a boolean value is not returned). Contains preferences describing how items similar to the one the user is presently viewing are promoted. (For eBay store owners only) Specifies whether cross-promotions are enabled for the seller's listings. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies which items should be shown in cross-sell promotions (such as Buy It Now or Store Inventory items) and in which sequence. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies whether to display only items with gallery images and whether they should precede other items in cross-sell promotions. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies how to sort items displayed in a cross-sell promotion. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies which items (such as Buy It Now or Store Inventory items) should be shown in upsell promotions and in which sequence. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies whether to display only items with gallery images in upsell promotions and whether they should precede other items. GetUserPreferences Conditionally SetUserPreferences No (For eBay store owners only) Specifies how to sort items used in an upsell promotion. GetUserPreferences Conditionally SetUserPreferences No 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. This value is not applicable since the API is not used with new 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. Details about a currency. Currency abbreviation.<br><br> Related fields:<br> Item.Currency and Item.StartPrice in AddItem GeteBayDetails Conditionally Full currency name for display purposes. GeteBayDetails Conditionally Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data. GeteBayDetails

DetailLevel: none, ReturnSummary, ReturnAll

Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data. GeteBayDetails

DetailLevel: none, ReturnSummary, ReturnAll

Always Container for a set of data elements (see below) that are applicable for a set of products that were returned within the same response. The data elements contain supplemental information that can help end users understand product search results. Usage of this information is optional and may require developers to inspect the information to determine how it can be applied in an application. Output only. An HTML snippet that specifies hints for the user, help links, help graphics, and other supplemental information that varies per characteristic set. In GetProductSearchPage, one DataElement value contains a hint (including an empty HTML achor element), one DataElement value may contain a URL to insert into the HTML anchor as the href value, and one DataElement value may contain a URL that eBay uses as a help graphic. If no value is available in the meta-data, a dash ("--") is returned instead. Usage of this information is optional and may require developers to inspect the information to determine how it can be applied in an application. Because this is returned as a string, the HTML markup elements are escaped with character entity references (e.g.,&lt;a href=""&gt;&lt;Attributes&gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductSearchPage

DetailLevel: ReturnAll

Always GetProductFamilyMembers Always Identifier for a data element. This is primarily for internal use by eBay. Developers can choose to inspect this information and determine how it can be applied in their applications. GetProductSearchPage

DetailLevel: ReturnAll

Always Matches the AttributeSetID associated with a response returned from the same call that returned the data element set. As calls like GetProductSearchResults can perform batch searches, this ID helps you determine which attribute set the data element set is associated with. GetProductFamilyMembers GetProductSearchPage GetProductSearchResults

DetailLevel: ReturnAll

Always Specifies a subcomponent of a date. Useful in cases when it is helpful to allow separate text fields or drop-down lists to be rendered for each date subcomponent. (For example, when calling GetProductSearchResults, you use date specifiers to indicate the date subcomponent that the attribute represents.) (in) The month subcomponent of a date. (in) The day subcomponent of a date. (in) The year subcomponent of a date. (out) Reserved for internal or future use. Defines year, month, and day as individual components of a date. Only applicable to use cases that support incomplete dates. Otherwise, we use xs:dateTime (or xs:date, as appropriate). A year in the form YYYY. For ticket searches on the US site, only specify 2007 or 2008. If you specify any other year, it is ignored. A calendar month (e.g., 2 or 02 for February). For ticket searches, Month is required if Day is specified. A calendar day (e.g., 2 or 02). For ticket searches, Day is only valid if Month is also specified. DayOfWeekCodeType - Specifies the day of week. Sunday Monday Tuesday Wednesday Thursday Friday Saturday (out) 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. Defines settings for a notification URL (including the URL name in DeliveryURLName). The name of a notification delivery URL. You can list up to 25 instances of DeliveryURLName, and then subscribe these URLs to notifications by listing them in comma- separated format in the DeliveryURLName element outside of ApplicationDeliveryPreferences. GetNotificationPreferences Conditionally SetNotificationPreferences No The address of a notification delivery URL. This address applies to the DeliveryURLName within the same ApplicationDeliveryPreferences.DeliveryURLDetails container. For delivery to a server, the URL begins with http:// or https:// and must be well formed. Use a URL that is functional at the time of the call. For delivery to an email address, the URL begins with mailto: and specifies a valid email address. unknown SetNotificationPreferences No GetNotificationPreferences Conditionally The status of a notification delivery URL. This status applies to the DeliveryURLName and delivery URL within the same ApplicationDeliveryPreferences.DeliveryURLDetails container. If the status is disabled, then notifications will not be sent to the delivery URL. GetNotificationPreferences Conditionally SetNotificationPreferences No For vehicles listed through the US eBay Motors site, DepositType indicates how the buyer should pay the deposit amount. It is used in conjunction with a buyer payment method (BuyerPaymentMethodCodeType). (out) No deposit needed. (out) Pay the deposit using PayPal, and then use any of the other specified payment methods to pay the balance. (out) No longer used. (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 template details establish how pictures are to be positioned relative to the description text. The template determines which eBay-provided theme (e.g. Valentine's Day) is to be applied for presenting pictures and description text. Reserved for future use. The information for one Theme or one Layout. Unique identifier for the group in which a Theme falls (holidays, special events, etc.). Not returned for Layouts. GetDescriptionTemplates Always Unique identifier for one Theme or Layout. GetDescriptionTemplates Always URL for a small (100x120 pixel) image providing a sample of how a Theme or Layout looks. GetDescriptionTemplates Always Unique text name of the Theme or Layout. GetDescriptionTemplates Always XML defining the template. Elements you must include in your XML: ThemeTop, ThemeUserCellTop, ThemeUserContent, ThemeUserCellBottom, ThemeBottom. Not returned for Layouts. GetDescriptionTemplates Always Either Layout or Theme. GetDescriptionTemplates Always The designations for the different types of information that you want returned by GeteBayDetails. The details are returned for the specified eBay site. Lists the country code and associated name of the countries supported by the eBay system. Lists the currencies supported by the eBay system. Not functional. Do not use this value. <br /> Formerly, this value was used to get details about specific payment options. Not functional. Do not use this value. Lists the regions and locations supported by eBays shipping services. Lists the shipping services supported by the specified eBay site. Lists the available eBay sites and their associated SiteID numbers. Details the different tax jurisdictions supported by the specified eBay site. Lists the different eBay URLs associated with the specified eBay site. Lists the details of the time zones supported by the eBay system. Not functional. Do not use this value.<br /> Details about the region of origin of a listing. Details about maximum dispatch times. Details about Item Specifics rules for the specified site. Lists the suggested unit-of-measurement strings to use with Item Specifics descriptions. Lists the various shipping packages supported by the specified site. Reserved for future use. Lists the shipping carriers supported by the specified site. Lists the minimum starting prices for the supported types of eBay listings. Lists the return policies supported by the specified eBay site. Details various eBay-buyer requirements. Details the listing features available for the specified site. Details the multi-variation listing rules for the site. Lists the locations supported by the ExcludeShipToLocation feature. <br /> The codes reflect the <a href= "http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm" >ISO 3166</a> location codes. Details the recoupment policies of the site. Enumeration of the categories in which the shipping services available for the site belongs to. The means of receipt of notification. Typical API, web page interaction. For SMS/wireless application. Note that SMS is currently reserved for future use. Warning: do NOT set this value in production if you currently use Platform Notifications with this application ID. Setting this value will discontinue all platform notifications for this application ID, until this value is reset to Platform. <br> <br> Set this enum value to specify that the notification client is a Client Alerts API client. Alerts will be delivered through the Client Alerts system. (out) Reserved for internal or future use. Specifies which discount type to use. Specifies discount type as percentage. Specifies discount type as a fixed amount. Discount will be in the currency of the original listing. 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. Using this container, a seller can supply original retail price and discount price for an item to clarify the discount treatment (also known as strike-through pricing). Only applies to fixed price, Buy It Now listings. This feature is available for large enterprise sellers via white list. A seller can provide discount treatment regardless of whether the listing includes a SKU. The actual retail price set by the manufacturer (OEM). eBay does not maintain or validate the OriginalRetailPrice supplied by the seller. OriginalRetailPrice should always be less than StartPrice. Compare the StartPrice/BuyItNowPrice to OriginalRetailPrice to determine the amount of savings to the buyer. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

GetSellerList

DetailLevel: ItemReturnDescription, ReturnAll

Conditionally Minimum Advertised Price (MAP) is an agreement between suppliers (or manufacturers (OEM)) and the retailers (sellers) stipulating the lowest price an item is allowed to be advertised at. Sellers can offer prices below MAP by means of other discounts. Applies only to fixed price and Buy It Now listings. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

GetSellerList

DetailLevel: ItemReturnDescription, ReturnAll

Conditionally For MinimumAdvertisedPrice (MAP) listings only. A seller cannot show the actual discounted price on eBay's View Item page. Instead, the buyer can either click on a pop-up on eBay's View Item page, or the discount price will be shown during checkout. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

GetSellerList

DetailLevel: ItemReturnDescription, ReturnAll

Conditionally Not applicable in listing requests. Based on OriginalRetailPrice, MinimumAdvertisedPrice, and StartPrice values, eBay identifies whether the listing falls under MAP or STP (aka OriginalRetailPrice). GetItem returns this for items listed with one of these discount pricing treatments. GetSellerList returns the DiscountPriceInfo container. GetItem Conditionally

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

GetSellerList

DetailLevel: ItemReturnDescription, ReturnAll

Conditionally false Used by the eBay UK and eBay Germany (DE) sites, this field indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on eBay within the previous 30 days. The discount price is always in reference to the seller's own price for the item. <br><br> If this field is set, eBay displays 'Was' in the UK and 'Ursprunglich' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set, SoldOneBay takes precedence. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

GetSellerList

DetailLevel: ItemReturnDescription, ReturnAll

Conditionally false Used by the eBay UK and eBay Germany (DE) sites, this field indicates that the discount price (specified as StartPrice) is the price for which the seller offered the same (or similar) item for sale on a web site or offline store other than eBay in the previous 30 days. The discount price is always in reference to the seller's own price for the item. <br><br> If this field is set, eBay displays 'Was*' in the UK and 'Ursprunglich*' in Germany, next to the discounted price of the item. In the event both SoldOffeBay and SoldOneBay fields are set, SoldOneBay takes precedence. AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

GetSellerList

DetailLevel: ItemReturnDescription, ReturnAll

Conditionally false Applicable only if the item was specifically made for sale through dedicated eBay outlet pages (e.g., eBay Fashion Outlet).<br> <br> The comparison price is the price of a comparable product sold through non-outlet channels on eBay (or elsewhere), or not specifically made for the outlet.<br> <br> In fashion, a "comparable" product shares the same design, but is not considered an identical product. Some products are specifically made for outlets, and may have a different SKU than the "comparable" product. These made-for-outlet products may be manufactured in a different place, with different materials, or according to different specifications (i.e. different stitch pattern, seam reinforcement, button quality, etc.) AddFixedPriceItem ReviseFixedPriceItem RelistFixedPriceItem VerifyAddFixedPriceItem Conditionally AddItem ReviseItem RelistItem VerifyAddItem Conditionally GetItem Conditionally

DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll

GetSellerList

DetailLevel: ItemReturnDescription, ReturnAll

Conditionally 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 Details about a specific maximum dispatch time, the maximum number of business days required to ship an item to domestic buyers after receiving a cleared payment. Integer value (1, 2, 3, 4, 5, 10, 15, or 20) corresponding to the maximum dispatch time. <br><br> Related field:<br> Item.DispatchTimeMax in AddItem GeteBayDetails Conditionally Value and unit (e.g., 10 Days) for the maximum dispatch time. Useful for display purposes. GeteBayDetails Conditionally Returns the latest version number for this field. The version can be used to determine if and when to refresh cached client data. GeteBayDetails

DetailLevel: none, ReturnSummary, ReturnAll

Always Gives the time in GMT that the feature flags for the details were last updated. This timestamp can be used to determine if and when to refresh cached client data. GeteBayDetails

DetailLevel: none, ReturnSummary, ReturnAll

Always Ways to Display PayNow Button Show PayNow Button For All Payment Methods Show PayNow Button For PayPal Only Reserved for internal or future use Represents a list of disputes. Can hold zero or more Dispute types, each of which describes a dispute. The information that describes a dispute, including the buyer's name, the transaction ID, the dispute state and status, whether the dispute is resolved, and any messages posted to the dispute. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Always Contains all information describing a dispute. The unique identifier of an eBay dispute. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally A value to indicate the type of dispute. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The internal state of the dispute. The value determines which values of <b>DisputeActivity</b> are valid when responding to a dispute. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The status of the dispute, which provides additional information about the dispute state. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The role of the person involved in the dispute who is not taking action or requesting information. The role is either <b>Buyer</b> or <b>Seller</b>. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The user name of the person involved in the dispute who is not taking action or requesting information. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The role of the person involved in the dispute who is taking action or requesting information. The role is either <b>Buyer</b> or <b>Seller</b>. GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The eBay user ID of the buyer involved in the dispute. GetDispute Always The eBay user ID of the seller involved in the dispute. GetDispute Always The unique identifier of the order line item (transaction) under dispute. An order line item is created once there is a commitment from a buyer to purchase an item. In the case of <b>GetDispute</b> and <b>GetUserDisputes</b> responses, this value identifies the order line item involved in the dispute. 19 (Note: The eBay database specifies 38. TransactionIDs are usually 9 to 12 digits.) GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally Container consisting of high-level details about the item involved in the dispute. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The top-level reason for the dispute. The value of <b>DisputeReason</b> determines which values of <b>DisputeExplanation</b> are valid. See <b>DisputeExplanationCodeList</b> for details. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The detailed explanation for the dispute. Valid values depend on the value of <b>DisputeReason</b>. See <b>DisputeExplanationCodeList</b> for details. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally A value to indicate whether or not the seller is currently eligible for a Final Value Fee credit. This tag only indicates credit eligibility and does not mean that the case can be closed. (Credit eligibility determines whether the seller gets the Final Value Fee back when the dispute is closed.) The value is usually eligible until 4 days (for new flow) or 7 days (for old flow) after the dispute was created unless the dispute is closed with buyer payment or Final Value Fee credit has already been granted. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The date and time the dispute was created, in GMT. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The date and time the dispute was modified, in GMT. GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally The action resulting from the dispute resolution. The action might include a Final Value Fee credit to the seller, a strike to the buyer, a reversal, or an appeal. GetUserDisputes

DetailLevel: ReturnAll, none

Conditionally A response or message posted to a dispute, either by an application or by a user on the eBay site. GetDispute Always GetUserDisputes

DetailLevel: ReturnAll, none

Conditionally Whether the buyer can close a dispute unhappy and escalate it to the eBay Standard Purchase Protection Program. To escalate, the buyer must be eligible for the PPP. Used in Item Not Received disputes. GetDispute Always Whether the buyer is eligible for the eBay Standard Purchase Protection Program. The eligibility rules are described in the eBay site online help. Used in Item Not Received disputes. GetDispute Always <b>OrderLineItemID</b> is a unique identifier for an eBay order line item and is based upon the concatenation of <b>ItemID</b> and <b>TransactionID</b>, with a hyphen in between these two IDs. In the case of <b>GetDispute</b> and <b>GetUserDisputes</b> responses, this value identifies the order line item involved in the dispute. <br> 50 (Note: ItemIDs and TransactionIDs usually consist of 9 to 12 digits.) GetDispute Always GetUserDisputes

DetailLevel: ReturnSummary, ReturnAll, none

Conditionally DistanceType used in proximity search The measurement used in a proximity search distance calculation. GetProducts Conditionally The unit used in a proximity search distance calculation. GetProducts Conditionally Defines the DutchBINEnabled feature. If the field is present, the Buy It Now is enabled in this category for Ducth (multi-item) auctions. The field is returned as an empty element (i.e., a boolean value is not returned). <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> This type defines the European Article Number (EAN) feature, and whether this feature is enabled at the site level. An empty EANIdentifierEnabled field is returned under the FeatureDefinitions container in GetCategoryFeatures if the feature is applicable to the site and if EANIdentifierEnabled is passed in as a FeatureID (or if no FeatureID is passed in, hence all features are returned). 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. A container to specify a single eBay item to end. The ID of the item listing to be ended. An ItemID must be specified in the EndItems request, except that in the case of a Half.com item, either an ItemID or a SellerInventoryID must be specified. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) EndItems 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. Also applicable to Half.com. EndItems Conditionally The MessageID element is used to correlate a given EndItemRequestContainer in the request with the corresponding EndItemResponseContainer in the response. If you pass a message ID in a request container, the same value is returned in the CorrelationID field in the matching response container. 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. EndItems No A unique identifier that the seller specified in Item.SellerInventoryID when they listed an item on Half.com. In the case of a Half.com item, either an ItemID or a SellerInventoryID must be specified in the call request. <br><br> The SellerInventoryID field is applicable only to Half.com. <br><br> For a Half.com item, you can either specify an ItemID or SellerInventoryID. An error occurs if you try to specify a conflicting ItemID and SellerInventoryID (for the same item). EndItems Conditionally Includes the acknowledgement of date and time the auction was ended due to the call to EndItem. Indicates the date and time (returned in GMT) the specified item listing was ended. Also applicable to Half.com. EndItem EndItems Always CorrelationID is used to correlate a given EndItemRequestContainer in the request with the corresponding EndItemResponseContainer in the response. If you pass a message ID in a request container, the same value is returned in the CorrelationID field in the matching response container. You can use this for tracking that a response container is returned for every request container and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. EndItems Conditionally A list of application-level errors or warnings (if any) that were raised when eBay processed the request. <br> <br> Application-level errors occur due to problems with business-level data on the client side or on the eBay server side. For example, an error would occur if the request contains an invalid combination of fields, or it is missing a required field, or the value of the field is not recognized. An error could also occur if eBay encountered a problem in our internal business logic while processing the request.<br> <br> Only returned if there were warnings or errors. Conditionally Contains the seller's preferences for the email sent to the buyer after the creation of the order line item. The text of the custom message for the email. GetUserPreferences Conditionally SetUserPreferences No The URL of the logo to include in the customized email. GetUserPreferences Conditionally SetUserPreferences No The type of logo to include in the customized email. GetUserPreferences Conditionally SetUserPreferences None No Indicates whether or not the seller wishes to send a customized email to winning buyers. GetUserPreferences Conditionally SetUserPreferences No Indicates whether or not the text of the customized message will be customized. GetUserPreferences Conditionally SetUserPreferences No Indicates whether or not the seller wishes to include a logo in the customized email. GetUserPreferences Conditionally SetUserPreferences No Indicates whether or not the seller wishes to receive a copy of the customized email sent to the winning buyer. GetUserPreferences Conditionally SetUserPreferences No EndOfAuctionLogoTypeCodeType - Type declaration to be used by other schema. Indicatest the type of logo to be used in a customize end of auction (EOA) email. The PayPal Winning Bidder Notice logo. The seller's eBay Store logo. A custom logo specified in LogoURL. (out) Reserved for internal or future use. Indicates that no logo has been specified for use in the end of auction (EOA) email. 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. EscrowCodeType - Type declaration to be used by other schema. Indicates whether escrow is used for a listing. By Buyer By Seller None Reserved for internal or future use Container for the list of site-specific locations supported by the Exclude Ship To Locations feature. The localized location name. GeteBayDetails Conditionally The location or region code to be used with the AddItem family of calls. These codes are also returned by GetItem. This code reflects the <a href= "http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm" >ISO 3166</a> codes. GeteBayDetails Conditionally The region code to which the location belongs. GeteBayDetails Conditionally Returns the current version number of the ExcludeShippingLocation data. Use the version number to determine if you need to refresh your cached client data. GeteBayDetails Conditionally The time in GMT that the feature flags for the details were last updated. Use this timestamp to determine if you need to refresh your cached client data. GeteBayDetails Conditionally For the US and Germany sites, an eBay item must meet a number of eligibility requirements in order to also be included on eBay Express. One requirement is that the item must include the Item Condition attribute (using Item Specifics). Some categories may waive this requirement. Currently, this type defines no special meta-data. (An empty element is returned.) 579 NoOp For the US and Germany sites, an eBay item must meet a number of eligibility requirements in order to also be included on eBay Express. One requirement is that the category needs to support Express. Currently, this type defines no special meta-data. (An empty element is returned.) 579 NoOp 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