Unpaid Item Disputes

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. (Item Not Received disputes can only be created via the eBay web site.)

Enables a seller to create a new Unpaid Item dispute. (Item Not Received disputes can only be created via the eBay web site.)

Unpaid Item Disputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes An explanation of the dispute that supplements the DisputeReason. The allowed value depends on the value of DisputeReason. AddDispute Yes The top-level reason for the Unpaid Item Dispute. DisputeReasonCodeType has several possible values. However, only BuyerHasNotPaid and TransactionMutuallyCanceled apply to AddDispute--you can only use AddDisputeCall to create Unpaid Item disputes. AddDispute Yes The eBay ID of the item in dispute, an item which has been sold but not yet paid for. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddDispute Yes The eBay ID of a transaction, created when the buyer committed to purchasing the item. A transaction ID is unique to the item but not across the entire eBay site. The transaction ID must be combined with an item ID to uniquely identify an item. 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) AddDispute Yes Returned after calling AddDisputeRequest. 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.

Unpaid Item Disputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes Item Not Received Disputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemNotReceivedDisputes 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 are for Unpaid Item disputes and some are for Item Not Received disputes. AddDisputeResponse Conditionally Unpaid Item Disputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=UnpaidItemDisputes Item Not Received Disputes http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemNotReceivedDisputes The shipping carrier used for the item in dispute. Required if DisputeActivity is SellerShippedItem; otherwise, optional. AddDisputeResponse Conditionally The shipper's tracking number for the item being shipped. Required if DisputeActivity is SellerShippedItem; otherwise, optional. AddDisputeResponse Conditionally The date the item under dispute was shipped. Required if DisputeActivity is SellerShippedItem; otherwise, optional. AddDisputeResponse Conditionally Response to a call of AddDisputeResponse. Defines a single new fixed-price listing and lists it on the eBay site that you specified in the HTTP request header or URL. A fixed-price listing can include multiple identical items for sale by setting the Quantity to a value greater than 1. You also use AddFixedPriceItem to define multi-variation listings (e.g., a particular shirt in varying sizes and colors). To list multiple unrelated fixed-price items, call AddFixedPriceItem once for each type of item. AddFixedPriceItem supports most of the same input fields as AddItem. The main differences are: <ul> <li>AddFixedPriceItem only supports fields that are applicable to basic fixed-price listings and store inventory listings (no fields that are exclusively applicable to auctions, classifieds, or listings with Best Offer).</li> <li>AddFixedPriceItem gives you an option to track eBay items by SKU instead of item ID (see Item.InventoryTrackingMethod and Item.SKU).</li> <li>AddFixedPriceItem supports mult-variation listings.</li> </ul> Note for Users of Large Merchant Services: As of release 637, a namespace is returned in the BulkDataExchangeResponseType (top level) of the response. This container is not shown in the call output description, but you can see it in the Upload Multiple Listings in Bulk (for Large Merchants) samples at the end of this page.

Creates a new fixed-price listing on eBay. 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 listing has ended).

samples AddItem, AddItems, AddToItemDescription, EndFixedPriceItem, GetItem, GetItemRecommendations, RelistFixedPriceItem, ReviseFixedPriceItem, VerifyAddFixedPriceItem Listing an Item http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem Listing Items http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingItemsIntro Introduction to Pictures in Item Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures Multi-Variation Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Variations Considering Best Match When Listing Items 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 item ID for the new fixed-price listing. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) AddFixedPriceItem Always Item-level SKU for the new listing, if the seller specified Item.SKU in the request. Variation SKUs are not returned (see GetItem instead). AddFixedPriceItem Conditionally Starting date and time for the new listing. This value is based on the time the listing was received and processed, or the time the item will be listed if the seller specified Item.ScheduleTime in the request. AddFixedPriceItem Always Date and time when the new listing ends. This is the starting time plus the listing duration. AddFixedPriceItem Always Child elements contain the estimated listing fees for the new item listing. The fees do not include the Final Value Fee (FVF), which cannot be determined until an item is sold. eBay.com Fees http://pages.ebay.com/help/sell/fees.html AddFixedPriceItem Always Final Value Fees and Credits http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits Final Value Fees http://pages.ebay.com/help/sell/fvf.html Fees per Site http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite Using Feature Packs to Save on Upgrade Fees 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 applied. AddFixedPriceItem Conditionally Defines a single new item and lists it on a specified eBay site. 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).

Defines a single new item and lists it on a specified eBay site. 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).

samples AddFixedPriceItem, AddItems, AddToItemDescription, GetItem, GetItemRecommendations, GetSellerList, RelistItem, ReviseItem, VerifyAddItem Listing an Item http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem Listing Items http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingItemsIntro Seller Checklist http://pages.ebay.com/sell/April2009Update/Checklist/ Introduction to Pictures in Item Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures Considering Best Match When Listing Items 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. 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. Applicable to Half.com. Note: 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. 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. 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. 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. Applicable to Half.com, but the values are not applicable to Half.com listings. AddItem Always eBay.com Fees http://pages.ebay.com/help/sell/fees.html Final Value Fees and Credits http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits Final Value Fees http://pages.ebay.com/help/sell/fvf.html Fees per Site http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite Using Feature Packs to Save on Upgrade Fees 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 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 Conditionally The nature of the discount, if a discount applied. AddItem Conditionally Creates listings from Selling Manager templates. This call is subject to change without notice; the deprecation process is inapplicable to this call.

Creates listings from Selling Manager templates.

samples AddSellingManagerTemplate,GetSellingManagerTemplates Using Selling Manager Calls in the Trading API http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps Selling Manager page on the eBay Site http://pages.ebay.com/selling_manager/ Selling Manager Pro page on the eBay Site 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 Currently, only the following can be specified as children of this container: payment methods, the PayPal email address, and CategoryMappingAllowed. 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 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 one to five items and lists them on a specified eBay site. Returns the item ID for each. Returns fees the seller will incur for each listing (not including the Final Value Fee, which cannot be calculated until the item is sold). You can specify up to five items, each of which is in an AddItemRequestContainer. The AddItemRequestContainer is similar to an AddItem request.

Defines one to five items and lists them on a specified eBay site. Returns the item ID for each. Returns fees the seller will incur for each listing (not including the Final Value Fee, which cannot be calculated until the item is sold).

samples Listing an Item http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingAnItem Listing Items http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ListingItemsIntro Seller Checklist http://pages.ebay.com/sell/April2009Update/Checklist Introduction to Pictures in Item Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures AddItem http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AddItem Considering Best Match When Listing Items 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 a transactional relationship to send messages to each other within 90 days of the creation of the transaction. The sale does not have to be ended to make this request.

Enables a buyer and seller in a transactional relationship to send messages to each other's My Messages Inboxes within 90 days of the creation of the transaction. The sale does not have to be ended to make this request.

Communication Between Members http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers AddMemberMessageAAQToPartner http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AddMemberMessageAAQToPartner AddMemberMessagesAAQToBidder,AddMemberMessageRTQ The unique ID of the item about which the question was asked. AddMemberMessageAAQToPartner Yes The message itself. AddMemberMessageAAQToPartner Yes Response to AddMemberMessageAAQToPartner request. Enables a seller to reply to a question about an active item listing.

Enables a seller to reply to a question about an active item listing. The reply is sent to the user's My Messages inbox.

Communication Between Members http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers AddMemberMessagesAAQToBidder,AddMemberMessageAAQToPartner 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 The body of the message. This should contain the answer to a question that an eBay user asks you (the seller) about an active listing. The character limit for this field is 2000. AddMemberMessageRTQ Yes Response to AddMemberMessageRTQ request. Enables a seller to send up to 10 messages to bidders and users who have made offers (via Best Offer) during an active listing.

Enables a seller to send up to 10 messages to bidders and users who have made offers (via Best Offer) during an active listing. Messages to a user appear in the user's My Messages inbox.

Communication Between Members http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers AddMemberMessageAAQToPartner, AddMemberMessageRTQ 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 transactions into a single order, enabling a buyer to pay for all of those transactions with a single payment (and, if so arranged, ship all of the items together). Strong recommendation: avoid mixing digital and non-digital listings in the same order. (In the future, AddOrder may enforce this recommendation.)

Combines two or more transactions into a single order, enabling a buyer to pay for all of those transactions with a single payment (and, if so arranged, ship all of the items together).

samples Working with Combined Payment 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 item transactions that are included in the order. The unique identifier for the order. AddOrder Always The date and time the 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.

Creates a new Second Chance Offer (that is, an offer for an unsold item) for one of that item's non-winning bidders.

Making Second Chance Offers for Items 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.

Adds a new product folder to a user's Selling Manager account.

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

samples AddSellingManagerTemplate,GetSellingManagerTemplates,AddSellingManagerInventoryFolder Using Selling Manager Calls in the Trading API http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps Selling Manager page on the eBay Site http://pages.ebay.com/selling_manager/ Selling Manager Pro page on the eBay Site 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.

Adds a Selling Manager template.

samples GetSellingManagerTemplates Using Selling Manager Calls in the Trading API http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps Selling Manager page on the eBay Site http://pages.ebay.com/selling_manager/ Selling Manager Pro page on the eBay Site 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 Final Value Fees and Credits http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FinalValueFeesAndCredits Fees per Site http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeesPerSite Using Feature Packs to Save on Upgrade Fees 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.

Appends a horizontal rule, then a message about what time the addition was made by the seller, and then the seller-specified text.

Changing Item Descriptions http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ChangingItemDescriptions AddItem, ReviseItem samples 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.

Adds one or more items to the user's My eBay watch list.

samples 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. 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 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 listing specified by ItemID (if listed for at least 24 hours) and creates a new Transaction Confirmation Request (TCR) for an item, enabling the TCR recipient to purchase the item. A TCR can be sent by a seller to any one of the following: a bidder, a best offer buyer, a member who has asked the seller a question, or any member with a postal code. This call can also be used to verify whether a new TCR can be created. Applies to the US eBay Motors site (except Parts and Accessories category).

Ends the listing specified by ItemID (if listed for at least 24 hours) and creates a new Transaction Confirmation Request (TCR) for an item, enabling the TCR recipient to purchase the item. This call can also be used to verify whether a new TCR can be created.

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 an item transaction or multiple-item order has been created. Task examples include leaving feedback for the buyer, changing the paid status, and setting shipment tracking information.

Enables a seller to do various tasks after an item transaction or multiple-item order has been created. Task examples include leaving feedback for the buyer, changing the paid status, and setting shipment tracking information.

ID of the listing associated with the transaction that the seller is completing. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) CompleteSale Yes Unique identifier for a transaction from the listing indicated by ItemID. Call GetItemTransactions or GetSellerTransactions to determine the appropriate transaction ID. Required for all listing types (pass 0 for Chinese auctions). 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) CompleteSale Yes Specifies feedback the seller is leaving for the buyer. The seller can leave feedback once for a given transaction, and no further modifications can be made to that feedback entry. If feedback has already been left, FeedbackInfo is not allowed. Call GetFeedback to determine whether feedback has already been left. CompleteSale No If true, the transaction is marked as shipped in My eBay. If false, the transaction is marked as not shipped in My eBay. If not specified, the shipped status in My eBay is not modified. CompleteSale No If true, the transaction is marked as paid in My eBay. If false, the transaction is marked as not paid in My eBay. If not specified, the paid status in My eBay is not modified. CompleteSale No If included in the request, and with a value of ListingType = Half, indicates that the given ItemID and TransactionID values are for Half.com. Required for Half.com items. CompleteSale Half Conditionally Details about the shipment. Setting the tracking number and carrier automatically marks the item as shipped (sets Shipped to true). CompleteSale No Unique ID for a multi-item order. ItemID and TransactionID are ignored if a call includes OrderID. CompleteSale applies to the specified order as a whole (and thus the child transactions associated with the order). Not applicable to Half.com. 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. Applies to half.com. 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. Identifies a user without requiring UserID or password or user token.

Identifies a user without requiring UserID or password or user token.

A string obtained by making 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 alerts and messages for a given user. Alerts that require action and have not been resolved by the user cannot be deleted.

Removes selected alerts and messages for a given user.

Contains 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.

Removes the association of Selling Manager automation rules to an item.

Deletes a Selling Manager product.

Deletes a Selling Manager template.

Removes the association of Selling Manager automation rules to a template.

samples AddSellingManagerTemplate,GetSellingManagerTemplates,SetSellingManagerTemplateAutomationRule Using Selling Manager Calls in the Trading API http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SellingManagerApps Selling Manager page on the eBay Site http://pages.ebay.com/selling_manager/ Selling Manager Pro page on the eBay Site 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 who has opted into the automated Unpaid Item Assistance mechanism to disable that Assistance for an item. The item is identified either by its item ID / transaction ID pair or by the dispute ID assigned to it by the Assistance mechanism. The dispute created by the Assistance mechanism is then converted to a "manual" dispute for the seller to manage like any other manually-created dispute. disputes.

Enables a seller who has opted into the automated Unpaid Item Assistance mechanism to disable that Assistance for an item.

samples http://pages.ebay.com/sell/UPI/upiassistant/index.html Unpaid Item Assistant http://pages.ebay.com/sell/UPI/standardprocess/index.html Understanding the New Unpaid Item Process The eBay ID of the item to exclude from the automated Unpaid Item Assistance mechanism. If ItemID is provided, TransactionID must be provided. The ItemID/TransactionID pairing of tags is mutually exclusive with DisputeID: Provide the pair or provide DisputeID, but not both. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) DisableUnpaidItemAssistance Yes The eBay ID of a transaction, created when the buyer committed to purchasing the item. A transaction ID is unique to the item but not across the entire eBay site. The transaction ID must be combined with an item ID to uniquely identify an item. The ItemID/TransactionID pairing of tags is mutually exclusive with DisputeID: Provide the pair or provide DisputeID, but not both. 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) DisableUnpaidItemAssistance Yes The ID for a dispute created by the Unpaid Item Assistance Mechanism. Mutually exclusive with the ItemID/TransactionID pair. DisableUnpaidItemAssistance No 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). Only the item's seller can use EndFixedPriceItem to end an item listing. You can also use EndItem to end fixed-price listings. EndFixedPriceItem is nearly identical to EndItem, but EndFixedPriceItem also accepts a seller's SKU to identify the listing (if the seller listed the item with SKU-based inventory tracking). Note: When you use EndFixedPriceItem 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, but you can see them in the samples at the end of this page.

Ends the specified fixed-price listing before the date and time at which it would normally end (per the listing duration). The item can be identified by an eBay item ID or the seller's SKU (in certain cases).

samples EndItem, RelistFixedPriceItem Ending Items Early 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.. 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.) 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. To remove a SKU when you revise or relist an item, use DeletedField in the revision or relist call. 50 EndFixedPriceIteme> Conditionally Acknowledgement that includes SKU, as well as the date and time the auction was ended due to the call to EndFixedPriceItem. Indicates the date and time (returned in GMT) the specified item listing was ended. EndItem Always The SKU (stock-keeping unit) that the seller specified for the listing, if any. 50 EndFixedPriceIteme> Conditionally Ends the specified item listing before the date and time at which it would normally end (per the listing duration).

Ends the specified item listing before the date and time at which it would normally end (per the listing duration).

AddItem, EndFixedPriceItem, EndItems, RelistItem Ending Items Early 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. For Half.com listings, you can either specify ItemID or SellerInventoryID. 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. 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). 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 the specified item listings before the date and time at which it would normally end (per the listing duration). As many as ten (10) listings can be ended per request. For competitive-bidding listings that have bids on them, you must specify an EndingReason value. If you specify SellToHighBidder, the listing ends as a successful auction with winning bidder(s). Otherwise, all bids are cancelled before the item is ended. There are two restrictions for ending items early in the last 12 hours of a listing. If there is a qualified bid (i.e., current high bid that, when applicable, meets the minimum reserve price) in the last 12 hours of a listing, the seller cannot end the item early. If the seller has cancelled a bid in the last 12 hours of the listing, the seller cannot end the item early. Only the item's seller can use EndItems to end an item listings.

Ends the specified item listings before the date and time at which they would normally end (per the listing duration). Supports up to ten (10) entries per request.

samples AddItems, EndItem, RelistItem Ending Items Early 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 Retrieves user token. The call can be used to get a token only after a user, at an eBay sign-in page, gives consent for the token to be generated. After token retrieval, the token can be used to authenticate other calls made on behalf of the user.

Retrieves a user token.

Getting Tokens http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingAToken Getting a Token via FetchToken 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 Getting Tokens 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 Enables a seller to retreive his or her own account data. Returns account data in a report format the user selects. Also returns summary data for the account.

Enables a seller to retreive his or her own account data.

Getting Account Information http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GettingAccountInformation 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 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. GetAdFormatLeadsRequest returns the number of leads for an ad and any contact information that the prospective buyer submitted.

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

Conditionally Provides three modes for retrieving a list of the users that bid on a listing. One of the modes is of particular value in support of the Second Chance Offer feature. Includes the list of bidders for the requested item as part of the general item listing data.

Provides three modes for retrieving a list of the users that bid on a listing. One of the modes is of particular value in support of the Second Chance Offer feature.

Extending a Second Chance Offer http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ExtendingSecondChanceOffer detailed information on working with the result set Making Second Chance Offers for Items http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=MakingSecondChanceOffersForItems The item ID for which to retrieve the list of bidders. 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.

Reports how many calls your application has made and is allowed to make per hour or day.

http://developer.ebay.com/support/certification Compatible Application Check 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 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. See the eBay Web Services Guide for an overview of Item Specifics and details about the eBay attribute model. Item Specifics are optional when listing in most categories; however, some categories (such as Real Estate, US Tickets, and US eBay Motors) require Item Specifics.

Retrieves an XML string that describes how to present Item Specifics to a seller who is creating a new listing. Item Specifics are optional when listing in most categories; however, some categories (such as Real Estate, US Tickets, and US eBay Motors) require Item Specifics to be specified using this model. Some categories support this Item Specifics model; other categories support the model returned by GetCategorySpecifics.

DetailLevel The Attributes (Item Specifics) API http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttributesAPI Retrieving Item Specifics Meta-Data http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGACS Listing with Item Specifics and Catalog Data 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). Because this is returned as a string, the XML markup elements are escaped with character entity references (e.g., &lt;eBay&gt;&lt;Attributes&gt; ...). See the appendices in the eBay Web Services guide for general information about string data types. GetAttributesCS

DetailLevel: none, ReturnAll

Always The Attribute Meta-Data Model http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel Data Types http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DataTypes 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.

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 Retrieving the Item Specifics SYI XSL Stylesheet http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGAXSL Working with the Item Specifics XSL Stylesheet 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 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 the best offers associated with an ItemID, according to the BestOfferStatus filter, where Active is the default value. You can specify a best offer ID to retrieve the details for a specific best offer. A buyer can use GetBestOffers to see the buyer's best offer (BestOfferID, etc.) and the current state of the best offer (e.g., whether the seller has made a counter offer).

Retrieves the best offers associated with an ItemID according to the BestOfferStatus filter, where Active is the default value. Specify a best offer ID to retrieve the details for a specific best offer.

DetailLevel RespondToBestOffer, PlaceOffer The item for which Best Offer information is to be returned. If you are a buyer and you have a valid best offer, then your best-offer information will be returned for the item you specify. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetBestOffers No Need not be specified by a buyer or a seller. The BestOfferID is the specific Best Offer you want information about. If you are the seller, you can get a list of all best offers (according to BestOfferStatus) by omitting this field. GetBestOffers No A filter that specifies which Best Offers to return for an item (such as countered, expired, or accepted). Active is the default. 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). Default for EntriesPerPage with GetBestOffers is 20. 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, or has won or purchased. You can control the result set with elements such as ActiveItemsOnly, which limits the result set to active items. Note that since bidder information is anonymous to everyone except the bidder and the seller (during an active auction), only sellers who know the user IDs of their bidders 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.

Retrieves all items on which the user is currently bidding or which the buyer has won or purchased.

Introduction to Pictures in Item Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures GetBidderList http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetBidderList GetSellerList Retrieves all items on which the user is currently bidding or which the buyer has won or purchased. Indicates whether 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), active and ended items are returned. GetBidderList No 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 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. GetBidderList Conditionally The user for whom information should be returned. If provided, overrides user defined via RequesterCredentials in header. GetBidderList No For GetBidderList, you can reduce the ItemType fields and other fields returned by specifying one of two values in the GranularityLevel field, Coarse or Medium. If you specify Coarse, the primary fields returned are the following: Item.ItemID and Item.ListingDetails.EndTime. If you specify Medium, an abbreviated result set is returned that includes many more fields than in the case of Coarse, including the following: Item.BuyItNowPrice, Item.Currency, Item.Site, and Item.Title. 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, samples Categories http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryOverview GetCategory2CS, GetCategoryFeatures, GetCategoryListings, 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 to which you are submitting the request. If you are using the GetCategories call with eBay Motors, this is a required field and must have a value of 100, 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 Retrieves mappings between categories and characteristics sets that are available for an eBay site. Retrieves all mappings or just those that match category IDs passed in the call.

Retrieves mappings between categories and characteristic sets that are available for an eBay site.

DetailLevel Working with Attribute-Based Features http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview Retrieving Category-to-Meta-Data Mappings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGC2CS Listing an Item with Attribute and/or Product Data http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrLWAttributPD GetAttributesCS, GetCategories, GetProductFinder, GetProductSearchPage, GetProducts 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 Retrieving Category-to-Meta-Data Mappings 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. Note: 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. Contains data about categories that are mapped to characteristics sets. Use this data to determine: - The names and IDs of the characteristics sets - The availability of the Pre-filled Item Information feature for listings in that category (i.e., whether the category is catalog-enabled) - For catalog-enabled categories, the available product search methods - The current version information for the complete mapping - The version information for each characteristics set GetCategory2CS

DetailLevel: ReturnAll

Conditionally Retrieving Category-to-Meta-Data Mappings 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 specific features that may only be applicable to certain categories on the site, such as listing durations, shipping term requirements, and Best Offer support.

Returns information about certain features that may only be applicable to certain categories on the site, such as particular listing durations, shipping term requirements, and Best Offer support.

DetailLevel, samples Categories 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 feature settings. 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. If you also set AllFeaturesForCategory to true, eBay returns the site defaults, plus all the site overrides for the specified category. Child category information is not returned in this case. 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. In this case, each Category container shows only the features that it has overridden from its parent node. 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. 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 feature settings. GetCategoryFeatures No ConditionEnabled, ConditionValues Use this switch to view all of the site overrides for a specific category. This element works in conjunction with CategoryID--refer to the notes for that element for more details. GetCategoryFeatures No 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. 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: L1's settings (A) match the site default, so L1 is not returned. L2's settings (B) are different from L1's, so L2 is returned. L3's settings (B) are the same as L2's, so L3 is not returned L4's settings (A) are different from L3's, so L4 is returned L5's settings (A) are the same as L4's, so L5 is not returned. 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 <table><tbody><tr> <td class="notebox">Note: This API call is being deprecated and will not be available after July 1, 2010. The functionality provided by this call will be supported in the new <a href=" http://developer.ebay.com/products/finding/">Finding API</a>. If you're building new search applications, we recommend you start with the Finding API. </td> </tr></tbody></table> Returns items in a specified category. A number of inputs are provided for filtering the item listings returned using such criteria as location, whether the item is listed in an ebay Store, the listing type, and including or excluding specified sellers. If you are not using the BestMatch search option, the API search results may not match the search results returned by the eBay website. It is recommended that you consider using FindItemsAdvanced (in the Shopping API) instead of GetCategoryListings because FindItemsAdvanced is easier to use and faster. See <a href="http://developer.ebay.com/products/shopping/" target="_blank">Shopping API</a> for more information.

Returns items in a specified category. A number of inputs are provided for filtering the item listings returned using such criteria as the listing type and whether the item is listed in an ebay Store.

Finding All Item Listings in a Specified Category http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FindingListingsInCategory GetCategoryListings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetCategoryListings Introduction to Pictures in Item Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures Filters the response based on each item's eligibility to appear on the mobile.de site. If false, excludes eligible items from search results. If true, queries for eligible items only. If not specified, the search results are not affected. Only applicable for items listed on the eBay Germany site (site ID 77) in subcategories of mobile.de search-enabled categories. GetCategoryListings No Specifies the category for which to retrieve item listings. 10 GetCategoryListings Yes Searching by Category ID http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByCategoryID Restricts listings to return only items that have the Ad Format feature. If true, the values of ItemTypeFilter and StoreSearchFilter are ignored (if they are specified). That is, "AND" logic is not applied. GetCategoryListings No If true, only items with free shipping for the user's location are returned. The user's location is determined from the site ID specified in the request. If false, no filtering is done via this attribute. A listing is not considered a free shipping listing if it requires insurance or requires pick up or requires a shipping surcharge. false GetCategoryListings No A currency value. Limits the result set to just those items listed using a specified currency. Not applicable to US eBay Motors searches. GetCategoryListings No Filters items based on the ListingType set for the items. If ItemTypeFilter is not specified (or if the AllItemTypes value of ItemTypeFilter is specified), all listing types can be returned unless another relevant filter is specified. GetCategoryListings No Searching By Listing Type http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByListingType Specifies whether to limit the item listings to just those that are category featured or super featured or all items. GetCategoryListings No Specifies the order in which the item listings returned will be sorted. Store Inventory listings are usually returned after other listing types, regardless of the sort order. BestMatchSort GetCategoryListings 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. GetCategoryListings No Limits the result set to just those items that meet location criteria: listed in a specified eBay site, location where the seller has the item, location from which the user is searching, and/or items listed with a specified currency. GetCategoryListings No Limits the result set to just those items that meet proximity search criteria: postal code and max distance. GetCategoryListings No When passed with a value of true, limits the results to Get It Fast listings. GetCategoryListings No Specifies items that accept a specific payment method or methods. GetCategoryListings No If true, each item in the result set can also include the item condition (whether the item is new or used). The item's condition is returned in Item.AttributeSetArray. An item only includes condition attribute if the item's seller filled in the Item Condition in the Item Specifics section of the listing. (That is, the condition is not returned if the seller only put the word "New" in the listing's title.) GetCategoryListings No If true, each item in the result set also includes information about the seller's feedback. GetCategoryListings No Include local items in returning results near this postal code. This postal code is the basis for local search. GetCategoryListings No The maximum number of related keywords to be retrieved. Use this field if you want the results to include recommended keywords (that is, keywords matching the category ID) in a RelatedSearchKeywordArray container. A value of 0 (the default) means no related search information is processed. 100 0 GetCategoryListings No You can group Best Match search results by category. To group by category, put the BestMatchCategoryGroup value in the OrderBy field. When you use the BestMatchCategoryGroup value, you can include group parameters in your call. Note that there will be significanty fewer results returned with a BestMatchCategoryGroup sort because the results account for Best Matches in lower-level (leaf) as well as higher-level categories. There is not a direct correlation between the number of results returned in a regular sort or the number of results returned with a BestMatch sort, and the results that are returned by the BestMatchCategoryGroup sort. You should not receive more than 2 pages of results with this type of sort. See also the new GroupCategoryID element in ItemType. GetCategoryListings 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: <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> For Auctions, items must also have the same price and number of bids to be considered duplicates. Filtering of duplicate item listings is not supported on all sites. false GetCategoryListings No Contains the item listings for the specified category and which meet the input filtering criteria (if any is specified). Consists of one ItemType object for each returned item listing. GetCategoryListings Conditionally Indicates the category from which the listings were drawn. GetCategoryListings Always Collection of the sub-categories that are child to the category indicated in Category. Data for each sub-category is conveyed in a CategoryType object. GetCategoryListings Conditionally Indicates the maximum number of item listings that will be returned per call. GetCategoryListings Always Indicates the page of data returned in the current call. GetCategoryListings Always Indicates whether there are more item listings that can be returned (items listed in the specified category and that meet any input filtering criteria). GetCategoryListings 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 items there are to be returned. GetCategoryListings Always Contains information about relevant buying guides (if any) and the site's buying guide hub. 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. GetCategoryListings Conditionally Container for keywords related to the category ID in the request. Can be returned if the request specified more than zero in the MaxRelatedSearchKeywords field. GetCategoryListings Conditionally Indicates whether there are duplicated items not returned by this response when HideDuplicateItems is true in the request. GetCategoryListings Conditionally Retrieves a map of old category IDs and corresponding active category IDs defined for the site to which the request is sent. Typically used to update an older item definition with a new category ID prior to listing the item.

Retrieves a map of old category IDs and corresponding active category IDs defined for the site to which the request is sent.

DetailLevel Mapping Old Category IDs to Current IDs http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryMapping CategoryMappingDetails Elements http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategoryMappingDetails Maintaining Category Data http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CategorySync GetCategories, GetCategory2CS, GetCategoryFeatures 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 Item Specifics are name-value pairs that describe typical aspects of items in a particular category. They enable sellers to classify items by presenting descriptive details in a structured way. For example, in a jewelry category, you might describe a locket using "Gemstone=Amber", but in a Washers & Dryers category, you might use "Type=Top-Loading" instead. GetCategorySpecifics returns the most popular custom Item Specific names and values for each leaf category you request. (eBay determines the popularity based on several factors, such as the number of recent listings and/or recently sold listings in the same category that have used the same name or value.)

Retrieves the most popular custom Item Specifics that sellers use when they list items in certain categories. Item Specifics are optional in listings. Some categories support this Item Specifics model; other categories support the model returned by GetAttributesCS.

samples Working with Custom Item Specifics http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=ItemSpecifics AddItem, GetCategoryFeatures, GetCategories, GetAttributesCS, GetItemRecommendations A leaf category to retrieve recommended Item Specifics for. (This call returns no results for a parent category.) To determine which leaf categories support listing with custom Item Specifics, use GetCategoryFeatures and GetCategories. Note: 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. Alternatively, you can use the CategorySpecific to specify the category. (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.) You can specify multiple leaf categories (but more categories can result in longer response times). If you specify the same ID twice, we use the first instance. Required if CategorySpecificsFileInfo is not provided. Depending on how many recommendations are found, your request may time out if you specify too many category IDs. (Typically, you can download recommendations for about 275 categories at a time.) 275 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. 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. Use this to retrieve fewer values per name. For example, if you only want the most popular value, specify 1. 1 see GeteBayDetails 25 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.) 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. 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.) 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. 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. 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. Some sellers may find this useful when choosing whether to use eBay's recommendation or their own name or value. 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.) Either CategorySpecificsFileInfo or a CategoryID is required (or you can specify both). Note: You can use the File Transfer API without using or learning about the Bulk Data Exchange API or other Large Merchant Services APIs. GetCategorySpecifics Conditionally downloadFile in the File Transfer API 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. 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. The most relevant Item Specifics are returned first. If a name has multiple values, the first value is more popular. 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). 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.) Only returned when CategorySpecificsFileInfo is passed in the request. GetCategorySpecifics Conditionally downloadFile in the File Transfer API 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.) Only returned when CategorySpecificsFileInfo is passed in the request. GetCategorySpecifics Conditionally downloadFile in the File Transfer API 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. Use this call in any process for which you would find a botblock challenge to be of value. To use this call, make a GetChallengeToken request to get a token, an image URL and an audio clip URL. Then, optionally, call ValidateChallengeInput with the token, the user's response, and whether the retrieved token should remain valid for a short period of time. The response from ValidateChallengeInput indicates whether the token is valid.

Retrieves a botblock token and URLs for an image or audio clip that the user is to match.

ValidateChallengeInput 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.

Searches for nonprofit charity organizations that meet the criteria specified in the request.

Identifying Listings that Benefit Nonprofits 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 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. Required input is a valid user token, which is the same user token used for authentication and authorization in the Trading API. Client Alerts token also required for Client Alerts API calls Login and Logout.

Retrieves a token required for the GetUserAlerts call in the Client Alerts API.

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 The use of this call requires approval from the eBay Developers Program. If you would like access, please send an email to developer-relations@ebay.com detailing your typical usage, with estimated usage numbers for this call. This call retrieves top-ranked contextual eBay keywords and categories for a specified web page. Results are ranked according to score. This enables developers to create applications that are different from traditional contextual ad serving. For instance, instead of building a standard ad banner or skyscraper ad like those from eBay AdContext, a developer could create an application that does inline hyperlinking of keywords on any page or create widgets for blog platforms. Not available for SG and HK sites.

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. The seller must be the owner of an eBay Stores storefront to cross-promote items.

Retrieves a list of upsell or cross-sell items associated with the specifeid item ID.

Cross-Promotions 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. Request for DescriptionTemplates.

Retrieves the DescriptionTemplates for a category.

Using Description Templates 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 Requests the details of a dispute corresponding to the given dispute ID, any time after the dispute was opened and up to five years after it was closed. Can be used with Unpaid Item or Item Not Received disputes.

Requests the details of a dispute corresponding to the given dispute ID, any time after the dispute was opened and up to five years after it was closed.

Retrieves the accumulated feedback left for a specified user, or the summary feedback data for a specific transaction or item.

LeaveFeedback, GetSellerDashboard, GetSellerTransactions Leaving and Retrieving Feedback http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Feedback Introduction to Feedback http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeedbackIntro Getting Feedback Left By Another User http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=FeedbackGet Detailed Seller Ratings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DetailedSellerRatings DetailLevel 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 The ID of the item that you want feedback data about. If not specified, feedback for all items is returned. Note that when you specify this ItemID field, the response is also changed as follows: any FeedbackType filter you specify is ignored; the maximum number of feedback records returned is 100; and the Pagination input fields are ignored. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetFeedback No Transaction ID whose feedback record you want to inspect. If not specified, then the feedback for all transactions are returned. When a Transaction ID is specified, since only one record is returned, pagination values are ignored. 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) GetFeedback No Returns feedback of a specified type (positive, negative, or neutral) in a FeedbackDetailArray. You can include two CommentTypes in your call if you want to exclude the third type from your results. If no CommentType 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 FeedbackType in your call. If no FeedbackType is specified, all of the available feedback is returned. GetFeedback No Controls the pagination of the result set. Child elements, EntriesPerPage and PageNumber, specify the maximum number of individual feedback records to return per call and which page of data to return. Only applicable if DetailLevel is set to ReturnAll and the call is returning feedback for a User ID. Feedback summary data is not paginated, but when pagination is used, it is returned after the last feedback detail entry. Valid Pagination.EntriesPerPage input for GetFeedback is limited to 25 (the default), 50, 100, and 200. If you specify a value of zero or less, 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 The GetFeedback response contains the feedback summary if a Transaction ID or Item ID is specified, and contains the specified user's total feedback score and feedback summary data if a User ID is specified. If no value is supplied, the feedback score and feedback summary for the requesting user will be returned. 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, transaction, or item is 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 predefined 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 Learning About Bidders 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. Note: 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. 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. Note: 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. GetHighBidders Always 611 681 NoOp Returns item data (title, description, price information, seller information, and so on) for the specified item ID.

Returns item data (title, description, price information, seller information, and so on) for the specified item ID.

DetailLevel, samples half AddItem, AddFixedPriceItem, GetItems, GetSellerEvents, GetSellerList, RelistItem, ReviseItem Retrieving Items http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RetrievingItems Introduction to Pictures in Item Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures Specifies the item ID that uniquely identifies the item listing for which to retrieve the data. ItemID is a required input in most cases. SKU can be used instead in certain cases (see the description of SKU). If both ItemID and SKU are specified for items where the inventory tracking method is ItemID, ItemID takes precedence. 19 (Note: The eBay database specifies 38. Currently, Item IDs 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. 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 Item.CrossPromotion.PromotedItem.PromotionDetails. A promoted item will now contain multiple PromotionDetails containers. 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, PromotedPrice and PromotedPriceType, are returned in Item.CrossPromotion.PromotedItem. If a promoted item has multiple PromotedPriceType and PromotedPrice value pairs, only the last pair is returned. GetItem No If true, the response returns the ItemSpecifics node (if the listing has custom Item Specifics). 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. (This does not cause the response to include ID-based attributes. To also retrieve ID-based attributes, pass DetailLevel in the request with the value ItemReturnAttributes or ReturnAll.) GetItem No Working with Custom Item Specifics 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 IncludeTaxTable 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. 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 a transaction is created. (SKU is recommended as an alternative to ApplicationData.) In GetItem, SKU can only be used to retrieve one of your own items, where 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.) Either ItemID or SKU is required in the request. If both are passed, they must refer to the same item, and that item must have InventoryTrackingMethod set to SKU. 50 GetItem Conditionally Variation-level SKU that uniquely identifes a Variation within the listing identified by ItemID. Only applicable when the seller listed the item with Variation-level SKU (Variation.SKU) values. Retrieves all the usual Item fields, but limits the Variations 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 ItemID. Only applicable when the seller listed the item with Variations. Retrieves all the usual Item fields, but limits the Variations content to the specified Variation(s). If the specified pairs do not match any Variation, eBay returns all Variations. To retrieve only one variation, specify the full set of name/value pairs that match all the name-value pairs of one Variation. 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 Identifies a single transaction for a listing. A transaction begins when a winning bidder or buyer is determined, and ends when the buyer finishes the checkout process. Since sellers can change active multiple-quantity fixed price listings, even after one of the items has been purchased, the transaction ID is associated with a snapshot of the item data at the time of the purchase. Specifying a TransactionID in the request enables developers to retrieve a snapshot of the listing as it was when the transaction was created. 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) GetItem Conditionally ComingSoon 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.

Examines potential item data that a seller has specified and returns recommended changes or opportunities for improvement.

samples Introduction to Pictures in Item Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures GetItemRecommendations http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=getItemRecommendations Getting Recommendations to Improve a Listing http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=EngineRecs Working with Custom Item Specifics 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.

Returns shipping cost estimates for an item for every calculated shipping service that the seller has offered with the listing.

samples Determining Shipping Costs for a Listing 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. It is possible for a seller to offer a shipping service which turns out to be a mismatch in some way with the item(s) being shipped. For example, if a buyer purchases more than one of an item, the weight might be too great for First Class mail. In such a case, GetItemShipping will omit that shipping service from the response. GetItemShipping Always Retrieves transaction information for a specified itemID. The call returns zero, one, or multiple transactions, depending on the number of items sold from the listing.

Retrieves transaction information for a specified itemID. The call returns zero, one, or multiple transactions, depending on the number of items sold from the listing.

DetailLevel, samples GetSellerTransactions, GetOrderTransactions Email and Address Privacy Policy 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. Retrieving the Transactions for a Single Item http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=RetrievingTransactionsForSingleItem Unique item ID for a listing that has transactions (purchases). When you use ItemID alone, eBay returns all available transactions that are associated with the listing. Also see other input filters (such as the time filters) for ways to reduce the number of transactions returned. If a listing has a Quantity greater than 1, and one or more items were purchased separately, the call can return multiple transactions. To uniquely identify and retrieve a particular transaction, use both ItemID and TransactionID together. Note: GetItemTransactions doesn't support SKU as an input because this call requires an identifier that is unique across your active and ended listings. Even when InventoryTrackingMethod is set to SKU in a listing, the SKU is only unique across your active listings (not your ended listings). To retrieve transactions by SKU, use GetSellerTransactions instead. 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits) GetItemTransactions Yes Also see NumberOfDays, which (if used), takes precedence over ModTimeFrom and ModTimeTo. If you prefer to use ModTimeFrom and ModTimeTo, specify the time range within which retrieved transactions' statuses were modified. ModTimeFrom is the earlier (older) date and ModTimeTo is the later (more recent) date. If you specify ModTimeFrom, but do not specify the other end of the range, the time range is set to 30 days. The time range between ModTimeFrom to ModTimeTo cannot be greater than 30 days. GetItemTransactions No Also see NumberOfDays, which (if used), takes precedence over ModTimeFrom and ModTimeTo. If you prefer to use ModTimeFrom and ModTimeTo, specify the time range within which retrieved transactions' statuses were modified. ModTimeFrom is the earlier (older) date and ModTimeTo is the later (more recent) date. If you specify ModTimeTo, but do not specify the other end of the range, the time range is set to 30 days. The time range between ModTimeFrom to ModTimeTo cannot be greater than 30 days. GetItemTransactions No Identifies one transaction for a listing. For Chinese auction listings (single-item listings for which there can be only one transaction), TransactionID is always 0, and for multi-quantity listings (for which there can be multiple transactions), TransactionID has a non-0 value. If TransactionID is provided, details are returned for the transaction, regardless of any time range you might have specified (e.g. ModTimeFrom, NumberOfDays). To determine the valid transaction IDs for a listing, you typically need to have previously executed GetItemTransactionsCall or GetSellerTransactionsCall and stored all the listing's transactions. 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) GetItemTransactions 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. GetItemTransactions No Indicates whether to include a 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. For Dutch (multi-item) auctions that end with bids (not Buy It Now purchases), the Final Value Fee is returned in Item.SellingStatus.FinalValueFee. For Dutch Buy It Now listings, the Final Value Fee is returned on a transaction-by-transaction basis. Note: 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. GetItemTransactions No Whether to retrieve the order information. Default is false. GetItemTransactions No Name of the eBay co-branded site upon which the transaction was made. This will serve as a filter for the transactions to get emitted in the response. GetItemTransactions No NumberOfDays enables you to specify the number of days' worth of new and modified transactions that you want to retrieve. The call response contains the transactions 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 GetItemTransactions No If true, all variations defined for the item are returned in the Item-level details, including variations that have no transactions. (If false, the applicable variations are still returned in the Transaction-level details.) This information is intended to help sellers to reconcile their local inventory with eBay's records while processing transactions (without requiring a separate call to GetItem). GetItemTransactions false No Returns an array of 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 end-of-auction processing. Zero, one, or many Transaction objects can be returned in the array. The set of transactions returned is limited to those that were modified between the times specified in the request's ModTimeFrom and ModTime filters. Also returns the item object that spawned the transactions. 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. Data from the transaction array 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 transaction was created. Contains the total number of pages (TotalNumberOfPages) and the total number of entries (TotalNumberOfEntries) 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 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 transactions returned per page (per call). May be a higher value than ReturnedTransactionCountActual 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 transactions the response returned. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Number of transactions retrieved in the current page of results just returned. May be a lower value than TransactionsPerPage if the page returned is the last page and more than one page of data exists. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always Item object that spawned the transaction. It is a purchase from this item's listing that the transaction represents. GetItemTransactions

DetailLevel: none, ReturnAll, ItemReturnDescription

Always List of Transaction objects representing the transactions resulting from the listing. Each Transaction object contains the data for one purchase (of one or more items in the same listing). The Transaction.Item field is not returned because the Item 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 transactions in which the user was involved and for which feedback is still needed from either the buyer or seller.

Returns items for which feedback needs to be left.

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.

Retrieves messages posted to the Ask Seller A Question messaging system.

AddMemberMessagesAAQToBidder, AddMemberMessageAAQToPartner, AddMemberMessageRTQ Communication Between Members 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. 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 Yes The status of the message. GetMemberMessages Conditionally Specifies if the message should be displayed on the website with the item listing. 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. For CEM messages, StartCreationTime and EndCreationTime must be provided. 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. For CEM messages, StartCreationTime and EndCreationTime must be provided. 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 Yes 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. If the seller has not customized the ASQ subjects using SetMessagePreferences, the call will return the current default values.

Returns a seller's Ask Seller a Question (ASQ) subjects.

GetMessagePreferences http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMessagePreferences 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 Used to retrieve information about the messages and alerts sent to a given user. Depending on the detail level, this information can include message and alert counts, resolution and flagged status, message and/or alert headers, and message and/or alert body text. Note that this call requires a DetailLevel in the request. Omitting the Detail Level returns an error. ItemID is not returned with this call. Use GetMemberMessages instead.

Retrieves information about the messages and alerts sent to a given user.

Communication Between Members http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=CommunicationBetweenMembers GetMyMessages http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMyMessages DetailLevel Contains a list of up to 10 AlertID values. When AlertID values are used as input, you must generally specify either AlertID values, or MessageID values, or both. GetMyMessages Conditionally Contains a list of up to 10 MessageID values. When MessageID values are used as input, you must generally specify either AlertID values, or MessageID values, or both. GetMyMessages Conditionally An ID that uniquely identifies the My Messages folder from which to retrieve alerts or messages. GetMyMessages No Used as beginning of date range filter. GetMyMessages No Used as end of date range filter. GetMyMessages Conditionally Available on the US site as of September 2009. 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 Conains information about the messages and alerts sent to a given user. Depending on the detail level, this information can include message and alert counts, resolution and flagged status, message and/or alert headers, and message and/or alert body text. Summary data for a given user's alerts and messages. This includes the numbers of new alerts and messages, unresolved alerts, flagged messages, and total alerts and messages. The amount and type of data returned is the same whether or not the request included specific AlertID or MessageID values. Always/Conditionally returned logic assumes a detail level of ReturnMessages. GetMyMessages

DetailLevel: ReturnSummary

Conditionally Contains the alert information for each alert specified in AlertIDs. The amount and type of information returned varies based on the requested detail level. Contains one MyMessagesAlertType object per alert. Returned as an empty node if user has no alerts. 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 All Buying section of the user's My eBay account, including items the user is watching, bidding on, has won, has not won, or has made best offers on. A DetailLevel of ReturnSummary returns only the BuyingSummary and the specific container(s) requested (by adding an Include value of true for each container you want to include in the response). A DetailLevel of ReturnAll returns the BuyingSummary and all other containers that do not contain the Include tag. Any containers that have an Include value specified will not be returned with the response.

Returns items from the All Buying section of the user's My eBay account, including items the user is watching, bidding on, has won, has not won, or has made best offers on.

My eBay http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=My_eBay Introduction to Pictures in Item Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures GetMyeBayBuying http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMyeBayBuying DetailLevel Specifies how to return the list of watched items in the user's My eBay list. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of items bid on in the buyer's My eBay Bidding list. Allowed values are Sort and IncludeNotes.Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of items on which the user has placed best offers. Allowed values are Include, ListingType, Sort, DurationInDays (0-60 valid), IncludeNotes, and Pagination. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of items bid on and won in the user's My eBay list. Allowed values are DurationInDays (valid values 0-60), Sort, IncludeNotes, and Pagination. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of items bid on and lost in the user's My eBay list. Allowed values are DurationInDays (valid values 0-60), Sort, IncludeNotes, and Pagination. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of favorite searches in the user's My eBay list. Only returned if the user has Favorite Searches. All detail levels return the search name, search query, and search elements, such as QueryKeywords, SortOrder, and Condition. Do not use an Include tag if you are using a detail level of ReturnAll. GetMyeBayBuying No Specifies how to return the list of favorite sellers in the user's My eBay list. All values are allowed. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of second chance offers in the user's My eBay list. All values are allowed. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No This is an optional element, used to indicate whether the Bid Assistant feature is being used. GetMyeBayBuying No Specifies how to return the list of items won and deleted from the buyer's My eBay list. Allowed values are DurationInDays (0-60), IncludeNotes, Sort, and Pagination. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No Specifies how to return the list of items lost and deleted from the buyer's My eBay list. Allowed values are DurationInDays (0-60), IncludeNotes, Sort, and Pagination. Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBayBuying No With a request version of 605 or higher, the buying summary container is not included in the response by default. You must add a BuyingSummary element with an Include field set to true, if you want to receive a BuyingSummary container in your response. With a request version lower than 605, the BuyingSummary is always returned by default. You must add a BuyingSummary element with an Include field set to false, if you do not want to receive a BuyingSummary container in your response. GetMyeBayBuying No 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: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, 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. You can paste the Search Query response, that comes back as a URL, into a browser to re-play the Favorite Search. The search elements that are returned by this call can be used as input for the Shopping Web Service FindItemsAdvanced request. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

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

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

Conditionally Contains the items that were bid on using the Bid Assistant feature. GetMyeBayBuying

DetailLevel: none, ReturnSummary, ReturnAll

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

Conditionally Requests reminder type totals from the user's MyeBay account.

Requests totals of various reminder types from the user's MyeBay account.

My eBay http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=My_eBay GetMyeBayReminders http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMyeBayReminders 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 a summary and details of items a user is selling from the user's My eBay account.

Returns a summary and details of items a user is selling from the user's My eBay account.

My eBay http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=My_eBay Introduction to Pictures in Item Listings http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=Pictures GetMyeBaySelling http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=GetMyeBaySelling DetailLevel Contains the list of items the user has scheduled to sell but whose listings have not yet opened. Valid subelements are Sort, IncludeNotes, and Pagination. GetMyeBaySelling No Contains the list of items the user is actively selling whose listings are active. Valid subelements are Sort, IncludeNotes, Pagination, ListingDuration, and ListingType (with valid values Auction, FixedPriceItem, StoresFixedPrice, or AdType). Note that if a DetailLevel of ReturnAll is specified in the request, this element is ignored as a way to filter the response, and ALL containers are returned. GetMyeBaySelling No Contains the list of items the user has sold. Valid subelements are DurationInDays (with valid values 0-60), IncludeNotes, and Pagination. Note that if a DetailLevel of ReturnAll is specified in the request, this element is ignored as a way to filter the response, and ALL containers are returned. GetMyeBaySelling No Contains the list of items the user has listed but whose listings have ended without being sold. Valid subelements are DurationInDays (with valid values 0-60), Sort, IncludeNotes, and Pagination. Note that if a DetailLevel of ReturnAll is specified in the request, this element is ignored as a way to filter the response, and ALL containers are returned. GetMyeBaySelling No Specifies how to return the list of items bid on in the seller's My eBay Active Selling/Items I'm Selling list. Allowed values are Sort and IncludeNotes.Include in the request to return this container at a DetailLevel of ReturnSummary. GetMyeBaySelling No Specifies how to return the list of items the seller has sold and then deleted from My eBay. Allowed values are DurationInDays (0-90), Sort, IncludeNotes, and Pagination. Note that if a DetailLevel of ReturnAll is specified in the request, this element is ignored as a way to filter the response, and ALL containers are returned. GetMyeBaySelling No Specifies how to return the list of items the seller has either ended or not sold which have been deleted from My eBay. Allowed values are DurationInDays (0-90), Sort, IncludeNotes, and Pagination. Note that if a DetailLevel of ReturnAll is specified in the request, this element is ignored as a way to filter the response, and ALL containers are returned. GetMyeBaySelling No With a request version of 605 or higher, the selling summary container is not included in the response by default. You must add a SellingSummary element with an Include field set to true, if you want to receive a SellingSummary container in your response. With a request version lower than 605, the SellingSummary is always returned by default. You must add a SellingSummary element with an Include field set to false, if you do not want to receive a SellingSummary container in your response. GetMyeBaySelling No 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, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Contains the items the user has sold. GetMyeBaySelling

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

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

DetailLevel: none, ReturnSummary, ReturnAll

Conditionally Retrieves the requesting application's notification preferences. Details are only returned for events for which a preference was set at one point. 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.

Retrieves the requesting application's notification preferences.

Working with Platform Notifications http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=PlatformNotifications Specifies what type of Preference to retrieve. 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 return user data for notification settings such as set mobile phone number etc. GetNotificationPreferences Conditionally Characteristics or details of an event such as type, name and value. 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.

Retrieves usage information about platform notifications for a given application.

Working with Platform Notifications 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 Retrieves information about one or more orders or one or more transactions (or both). If you have both orderIDs and itemIDs/transactionIDs, you may find this "combined call" more convenient than calling GetOrders and GetItemTransactions separately. Note that every transaction is nested within an Order node, even if the transaction does not belong to an order. Note: OrderID is not returned when the GetOrderTransactions request includes ItemTransactionID, even if the transaction is part of an order. To get the OrderID for a transaction, call GetItemTransaction with IncludeContainingOrder = true.

Retrieves information about one or more orders or one or more transactions (or both).

DetailLevel 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 transaction was made. This will serve as a filter for the transactions 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. For Dutch Buy It Now listings, the Final Value Fee is returned on a transaction-by-transaction basis. Note: 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. GetOrderTransactions No Response to GetOrderTransactions request. An array of Orders. GetOrderTransactions

DetailLevel: none, ItemReturnDescription, ReturnAll

Always Retrieves all of the orders for which the user is a participant (as either buyer or seller) that meet the criteria specified in the request. An order is a combination of two or more transactions. There are two mutually exclusive sets of filtering input arguments that you can use to query for orders. The first set is based on specific order IDs (one or more order IDs are passed in the call). The second set is a combination of date range, order role, and order status. If you use one set of filtering arguments, the arguments for the other filtering mechanism should not be specified in the same call. If a given call to GetOrders includes both criteria sets, the query based on order IDs is used, and the criteria for date range/order status/order role is ignored. Applicable to Half.com (used to retrieve unshipped Half.com orders, such as orders that the seller has received but has not yet processed).

Retrieves all of the orders for which the user is a participant (as either buyer or seller) that meet the criteria specified in the request.

DetailLevel Working with Combined Payment http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=WorkingWithCombinedPayment AddOrder, GetOrderTransactions A set of orders to retrieve. Not applicable to Half.com. GetOrders Conditionally The starting date of the date range for the orders to retrieve. Applicable to Half.com. GetOrders Conditionally The ending date of the date range for the orders to retrieve. Applicable to Half.com. GetOrders Conditionally Filters orders based on the role of the user making the GetOrders request. Not applicable to Half.com. GetOrders Conditionally Filters the returned orders by order status (Active or Completed). To retrieve orders with a status of Inactive or Cancelled, you must specify the order IDs (OrderIDArray.OrderID). When you specify OrderIDArray.OrderID, no other filters are used. 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 To retrieve Half.com orders, specify Half--Do not specify this field if you are retrieving eBay orders. This field cannot be used as a listing type filter on eBay.com. If not provided, or if any value other than Half is specified, 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. GetOrders Half Conditionally Not applicable to eBay.com. Applicable to Half.com. If many orders are available, you may need to call GetOrders 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. GetOrders No Returns the set of orders that match the order IDs or filter criteria specified. Applies only to Half.com. Contains information regarding the pagination of data (if pagination is used), including total number of pages and total number of entries. GetOrders

DetailLevel: none

Always Applies only to Half.com. If true, there are more orders yet 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

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

Always Applies only to Half.com. Indicates the number of orders 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 orders returned per page (see ReturnedOrderCountActual). GetOrders

DetailLevel: none

Always Applies only to Half.com. Indicates which page of data holds the current result set. Will be the same as the value specified in the Pagination.PageNumber input. If orders are returned, the first page is 1. GetOrders

DetailLevel: none

Always Applies only to Half.com. Indicates the total number of orders returned. GetOrders

DetailLevel: none

Always This call will be deprecated by late 2009. 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 be deprecated by late 2009.

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 This call will be deprecated by late 2009. 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, such as subscription type and picture display. This call will be deprecated by late 2009.

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 more frequently used by eBay users when searching for listings. These keywords are generated weekly by eBay. Thus, calls retrieve static data. GetPopularKeywords is not available for the following sites: FR, HK, MY, PH, PL, SG, SE.

Retrieves the words more frequently used 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. 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 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.) 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. 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. 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). To use this data in a listing, pass the product ID and the optional Item Specifics in the seller's listing request (AddItem).

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.

Working with Attribute-Based Features http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview The Catalog Product (Product Details) API http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI Retrieving All Members of a Product Family 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 Retrieving All Members of a Product Family 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 Retrieving All Members of a Product Family http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPFM 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. 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 or as input to GetSearchResults to conduct the search for listed items. (Please note that this call may not return valid product finder IDs for some GetSearchResults use cases. See the Knowledge Base article referenced below for details.) To retrieve single-attribute search criteria (querying against a single attribute, like UPC), use GetProductSearchPage instead (only applicable for catalog searches). 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.

Retrieves data that you use to construct valid "product finder" queries (queries against multiple attributes) against catalog products or (in some cases) listed items.

DetailLevel The Catalog Product (Product Details) API http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI Retrieving Product Finder Meta-Data http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPF The Product Finder Meta-Data Model http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFModel Searching with a Sell-Side Product Finder http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFSearch Searching by Item Specifics (Buy-Side Product Finder) http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByItemSpecifics Knowledge Base: ProductFinderID for Buy-Side Searches https://ebay.custhelp.com/cgi-bin/ebay.cfg/php/enduser/std_adp.php?p_faqid=560 GetProductFinderXSL, GetProductSearchResults, GetProductSellingPages, GetSearchResults 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. For sell-side searches, you can determine the product finder IDs for a category by calling GetCategory2CS. 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. 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 Retrieving Product Finder Meta-Data http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPF Searching by Item Specifics (Buy-Side Product Finder) http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=SearchingByItemSpecifics Knowledge Base: ProductFinderID for Buy-Side Searches 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). Because this is returned as a string, the XML markup is escaped with character entity references (e.g., &lt;eBay&gt;&lt;ProductFinders&gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductFinder

DetailLevel: ReturnAll

Conditionally Retrieving Product Finder Meta-Data http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPF The Product Finder Meta-Data Model http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFModel Data Types http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DataTypes 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.

Retrieves the Product Finder XSL stylesheet for use with the XML returned from GetProductFinder.

DetailLevel The Catalog Product (Product Details) API http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI Working with the Product Finder XSL Stylesheet http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrPFXSL Retrieving the Product Finder XSL Stylesheet 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 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.

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.

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 Retrieving Product Search Page Meta-Data http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSrchP 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 GetSearchResults.) 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. You can use this call to search for different products at the same time. That is, this call can perform batch searches. 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. 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. GetProductSearchPage: 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. GetProductFinder: 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. 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. 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. 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. 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). To use this data in a listing, pass the product ID and the optional Item Specifics in the seller's listing request (AddItem).

Searches for Pre-filled Item Information within one or more characteristic sets. Use the response from GetProductSearchPage or GetProductFinder to determine the attributes that can be used as criteria for the search. After a user selects a product by its ID, use the ID as input to GetProductSellingPages. This call also supports batch requests (i.e., searching for several products in the same call).

Working with Attribute-Based Features http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview The Catalog Product (Product Details) API http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductAPI Searching for Catalog Product Details http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductSearch Searching for Catalog Products 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 Searching for Catalog Product Details 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 Searching for Catalog Product Details http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrProductSearch 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.

Retrieves information that describes how to present catalog product information to a seller. Use this data when listing an item with Pre-filled Item Information.

Working with Attribute-Based Features http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrOverview Retrieving a Product's Item Specifics http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrGPSellP The Attribute Meta-Data Model http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel Listing with Item Specifics and Catalog Data 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. Valid values: SYI = Sell Your Item. Use before adding an item. Causes the response to include the latest product ID in the system (given an ID specified in the Products element) and the corresponding characteristic meta-data. RYI = Revise Your Item. Use this before revising an item. Causes the response to return the product ID, attribute data, and other data associated with the version of the product that you pass in the Products element. This is useful in case the product ID or associated data has changed in the system since the item was originally listed. When revising an item, this helps you make changes that are consistent with the original listing. RELIST = Use this before relisting an item. Causes the response to include the latest product ID in the system (given an ID specified in the Products element) and the corresponding characteristic meta-data. (Same as SYI). 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 Retrieving a Product's Item Specifics 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. 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. 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. See the Attribute Meta-Data Model section of the eBay Web Services guide for information about each element in the ProductSellingPagesData string. Because the content is returned as a string, the XML markup elements are escaped with character entity references (e.g.,&lt;eBay&gt;&lt;Attributes&gt;...). See the appendices in the eBay Web Services guide for general information about string data types. GetProductSellingPages Always The Attribute Meta-Data Model http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AttrModel Data Types http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=DataTypes Searches for stock information and reviews for certain kinds of products, such as a particular digital camera model. GetProducts is designed to be useful to applications that support shopping comparison, product reviews, or basic supply and demand data. GetProducts also supports tracking so that members of the eBay Affiliates Program can get commissions for driving traffic to eBay. Note: For selling use cases, use GetProductSearchResults and GetProductSellingPages instead. 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. For each product of interest, you call GetProducts again to retrieve additional details that would be useful to buyers: <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 GetSearchResults.)</li> </ul> Note: As catalog queries can take longer than item queries, GetProducts can be slower than GetSearchResults. Also, due to the way product data is cached, you may get a faster response when you run the same query a second time.

Searches for stock product information (Pre-filled Item Information), such as information about a particular DVD or camera. Also, retrieves top reviews, buying guides, and up to 200 listings associated with a product. Primarily useful for buying use cases.

GetSearchResults, 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). Affiliate Tracking Concepts 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: <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> For Auctions, items must also have the same price and number of bids to be considered duplicates. 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 domain 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 pos