This Call Reference describes the elements and attributes for each call in the eBay Trading API.

These details also apply to the XML API, SOAP API, eBay SDK for Java, and eBay SDK for .NET.

Additional resources are available for this eBay Web Service. Please see the eBay Developer Documentation Center.

See also the calls in the eBay Shopping API.

Table of Contents

Call Summary Samples
AddDispute Enables a seller to create a new Unpaid Item dispute. (Item Not Received disputes can only be created via the eBay web site.) Guide only
AddDisputeResponse Adds a response or comment to a dispute, or closes a dispute. Guide only
AddFixedPriceItem 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). view
AddItem 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). view
AddItemFromSellingManagerTemplate Creates listings from Selling Manager templates. view
AddItems 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). view
AddMemberMessageAAQToPartner Enables a buyer and seller in a transactional relationship to send messages to each other's My Messages Inboxes. view
AddMemberMessageRTQ Enables a seller to reply to a question about an active item listing. view
AddMemberMessagesAAQToBidder Enables a seller to send up to 10 messages to bidders, or to users who have made offers via Best Offer, regarding an active item listing. view
AddOrder 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). view
AddSecondChanceItem Creates a new Second Chance Offer (that is, an offer for an unsold item) for one of that item's non-winning bidders. view
AddSellingManagerInventoryFolder Adds a new product folder to a user's Selling Manager account. view
AddSellingManagerProduct Creates a Selling Manager product, which contains templates for repeat listings. view
AddSellingManagerTemplate Adds a Selling Manager template. view
AddToItemDescription Appends a horizontal rule, then a message about what time the addition was made by the seller, and then the seller-specified text. view
AddToWatchList Adds one or more items to the user's My eBay watch list. view
AddTransactionConfirmationItem Ends the eBay Motors listing specified by ItemID and creates a new Transaction Confirmation Request (TCR) for the item, thus enabling the TCR recipient to purchase the item. You can also use this call to see if a new TCR can be created for the specified item. view
CompleteSale 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. view
ConfirmIdentity Returns the ID of a user who has gone through an application's consent flow process for obtaining an authorization token. view
DeleteMyMessages Removes selected alerts and messages for a given user. view
DeleteSellingManagerInventoryFolder Removes a Selling Manager inventory folder. view
DeleteSellingManagerItemAutomationRule Removes the association of Selling Manager automation rules to an item. view
DeleteSellingManagerProduct Deletes a Selling Manager product. view
DeleteSellingManagerTemplate Deletes a Selling Manager template. view
DeleteSellingManagerTemplateAutomationRule Removes the association of Selling Manager automation rules to a template. view
DisableUnpaidItemAssistance Enables a seller who has opted into the automated Unpaid Item Assistance mechanism to disable that Assistance for an item. view
EndFixedPriceItem 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). view
EndItem Ends the specified item listing before the date and time at which it would normally end (per the listing duration). view
EndItems Ends up to 10 specified item listings before the date and time at which it would normally end (per the listing duration). view
FetchToken Retrieves an authentication token for a user. view
GetAccount Enables a seller to retreive his or her own account data. Guide only
GetAdFormatLeads Retrieves sales lead information for a lead generation listing. Guide only
GetAllBidders 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. Guide only
GetApiAccessRules Reports how many calls your application has made and is allowed to make per hour or day. view
GetAttributesCS 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. Guide only
GetAttributesXSL 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. Guide only
GetBestOffers Retrieves the best offers associated with an ItemID according to the BestOfferStatus filter (the default is Active). view
GetBidderList Retrieves all items the user is currently bidding on, and the ones they have won or purchased. view
GetCategories 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. view
GetCategory2CS Retrieves mappings between categories and characteristic sets that are available for an eBay site. view
GetCategoryFeatures Returns information about the features that are applicable to different categories, such as listing durations, shipping term requirements, and Best Offer support. view
GetCategoryListings Returns items in a specified category, with the ability to filter the items in various ways. view
GetCategoryMappings Retrieves a map of old category IDs and corresponding active category IDs defined for the site to which the request is sent. view
GetCategorySpecifics Returns the most popular custom Item Specific names and values for each leaf category you request. view
GetChallengeToken Retrieves a botblock token and URLs for an image or audio clip that the user is to match. view
GetCharities Searches for nonprofit charity organizations that meet the criteria specified in the request. Guide only
GetClientAlertsAuthToken Retrieves a token required for the GetUserAlerts call in the Client Alerts API. Guide only
GetContextualKeywords Retrieves top-ranked contextual eBay keywords and categories for a specified web page. Guide only
GetCrossPromotions Retrieves a list of upsell or cross-sell items associated with the specifeid item ID. Guide only
GetDescriptionTemplates Retrieves the DescriptionTemplates for a category. Guide only
GetDispute 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. view
GeteBayDetails Retrieves eBay IDs and codes (e.g., site IDs and shipping service codes), enumerated data (e.g., payment methods), and other common eBay meta-data. view
GeteBayOfficialTime Gets the official eBay system time in GMT. view
GetFeedback Retrieves the accumulated feedback left for a specified user, or the summary feedback data for a specific transaction or item. view
GetHighBidders Deprecated as of version 611. 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. Guide only
GetItem Returns item data (title, description, price information, seller information, and so on) for the specified item ID. view
GetItemRecommendations Examines potential item data that a seller has specified and returns recommended changes or opportunities for improvement. view
GetItemsAwaitingFeedback Returns items for which feedback needs to be left. Guide only
GetItemShipping Returns shipping cost estimates for an item for every calculated shipping service that the seller has offered with the listing. view
GetItemTransactions 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. view
GetMemberMessages Retrieves a list of the messages buyers have posted about your active item listings. view
GetMessagePreferences Returns a seller's Ask Seller a Question (ASQ) subjects, each in its own Subject node. view
GetMyeBayBuying Returns items from the Buying section of the user's My eBay account, including items that the user is watching, bidding on, has won, has not won, and has made best offers on. view
GetMyeBayReminders Requests totals for the Buying and Selling reminders from the user's My eBay account. view
GetMyeBaySelling Returns items from the Selling section of the user's My eBay account, including items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items. view
GetMyMessages Retrieves information about the messages and alerts sent to a given user. view
GetNotificationPreferences Retrieves the requesting application's notification preferences. Guide only
GetNotificationsUsage Retrieves usage information about platform notifications for a given application. Guide only
GetOrders Retrieves the orders for which the authenticated user is a participant, either as the buyer or the seller. The call returns all the orders that meet the request specifications. view
GetOrderTransactions Retrieves information about one or more orders, or one or more transactions (or both). view
GetPictureManagerDetails Requests information about folders or pictures in a Picture Manager account or the account settings. This call will soon be deprecated. Guide only
GetPictureManagerOptions Requests a list of Picture Manager options and allowed values. This call will soon be deprecated. Guide only
GetPopularKeywords Retrieves the words that are most frequently submitted by eBay users when searching for listings. view
GetProductFamilyMembers 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. Guide only
GetProductFinder Retrieves data that you use to construct valid "product finder" queries (queries against multiple attributes) against catalog products or (in some cases) listed items. Guide only
GetProductFinderXSL Retrieves the Product Finder XSL stylesheet for use with the XML returned from GetProductFinder. Guide only
GetProducts 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. Guide only
GetProductSearchPage 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. Guide only
GetProductSearchResults 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). Guide only
GetProductSellingPages 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. Guide only
GetPromotionalSaleDetails Obtains information about promotional sales set up by an eBay store owner (the authenticated caller). view
GetPromotionRules Retrieves all promotion rules associated with the specified item or store category. view
GetSearchResults Retrieves item listings based on keywords you specify. The keywords can include wildcards. view
GetSellerDashboard Retrieves a brief summary of the requester's status as an eBay seller. view
GetSellerEvents Retrieves price changes, item revisions, description revisions, and other changes that have occurred within the last 48 hours related to a seller's eBay listings. view
GetSellerList Returns a list of items a seller has listed for auction. Returns an array of zero, one, or multiple items. You can specify that the returned data include only items that start or end within a specified date range. Guide only
GetSellerPayments Retrieves a summary of pending or paid payments that Half.com created for the seller identified by the authentication token in the request. Guide only
GetSellerTransactions Retrieves transaction information for the user for which the call is made, and not for any other user. (To retrieve transactions for another seller's listings, use GetItemTransactions.) view
GetSellingManagerAlerts Retrieves Selling Manager alerts. view
GetSellingManagerEmailLog Retrieves a log of emails sent, or scheduled to be sent, to buyers. Includes success or failure status. view
GetSellingManagerInventory Retrieves a paginated listing of a user's Selling Manager inventory. view
GetSellingManagerInventoryFolder Retrieves Selling Manager inventory folders. view
GetSellingManagerItemAutomationRule Retrieves the set of Selling Manager automation rules associated with an item. view
GetSellingManagerSaleRecord Requests the data in a Selling Manager sale record. view
GetSellingManagerSoldListings Retrieves information about items that a seller has sold. view
GetSellingManagerTemplateAutomationRule Retrieves the set of Selling Manager automation rules associated with a Selling Manager template. view
GetSellingManagerTemplates Retrieves Selling Manager templates. view
GetSessionID Retrieves a session ID that identifies a user and your application when you make a FetchToken request. view
GetShippingDiscountProfiles Returns the shipping discount profiles defined by the user, along with other combined payment-related details such as packaging and handling costs. view
GetStore Retrieves configuration information for the eBay store owned by the specified UserID, or by the caller. view
GetStoreCategoryUpdateStatus Returns the status of the processing for category-structure changes specified with a call to SetStoreCategories. view
GetStoreCustomPage Retrieves the custom page or pages for the authenticated user's Store. view
GetStoreOptions Retrieves the current list of eBay store configuration settings. view
GetStorePreferences Retrieves a user's Store preferences. view
GetSuggestedCategories Returns a list of up to 10 categories that have the highest percentage of listings whose titles or descriptions contain the keywords you specify. view
GetTaxTable Retrieves the tax table for a user on a given site or retrieves the valid jurisdictions (if any) for a given site. view
GetTokenStatus Requests current status of user token. view
GetUser Retrieves data pertaining to a single eBay user or transactions for which there is a relationship between the requestor and the target user. view
GetUserContactDetails Returns contact information for a specified user, given that a bidding relationship (as either a buyer or seller) exists between the caller and the user. view
GetUserDisputes Requests a list of disputes the requester is involved in as buyer or seller. The list includes both Unpaid Item and Item Not Received disputes. view
GetUserPreferences Retrieves the specified user preferences for the authenticated caller. view
GetVeROReasonCodeDetails Retrieves details about VeRO reason codes for a given site or all sites. You must be a member of the Verified Rights Owner (VeRO) Program to use this call. Guide only
GetVeROReportStatus Retrieves status information about VeRO reported items. You must be a member of the Verified Rights Owner (VeRO) Program to use this call. Guide only
GetWantItNowPost Retrieves data for a specific, active Want It Now post identified by a post ID. Guide only
GetWantItNowSearchResults Retrieves a list of active Want It Now posts that match specified keywords and/or a specific category ID. Guide only
IssueRefund Issues a refund for a single Half.com transaction. Guide only
LeaveFeedback Enables a user to leave feedback about another user at the conclusion of a successful sales transaction (item sold). view
MoveSellingManagerInventoryFolder Moves a Selling Manager inventory folder. view
PlaceOffer Enables the authenticated user to to make a bid, a best offer, or a purchase on the item specified by the ItemID input field. view
RelistFixedPriceItem Enables a seller to take a single item (or a single multi-item listing) and relist it on a specified eBay site. If the listing ended with no buyers, the relisted item may be eligible for a relist credit for the insertion fee under some conditions. view
RelistItem Enables a seller to take a single item (or a single multi-item listing) and re-list it on a specified eBay site. view
RemoveFromWatchList Enables a user to remove one or more items from their My eBay watch list. view
RespondToBestOffer Enables the seller of a Best Offer item to accept, decline, or counter offers made by bidders. Guide only
RespondToFeedback Use this call to reply to feedback that has been left for a user, or to post a follow-up comment to a feedback comment a user has left for someone else. view
RespondToWantItNowPost Enables a seller to respond to a Want It Now post with an item listed on the eBay site. Guide only
ReviseCheckoutStatus A seller can use this call to update the payment details and status of a transaction or order. view
ReviseFixedPriceItem Enables a seller to change the properties of a currently active listing. Inputs are the item ID of the item being revised and any properties that are being changed. view
ReviseInventoryStatus Enables a seller to change the price and quantity of currently active fixed-price items. view
ReviseItem Enables a seller to change the properties of a currently active listing. view
ReviseMyMessages Sets the read state for messages and alerts, the flagged state of messages, and moves alerts and messages into and out of folders. Guide only
ReviseMyMessagesFolders Renames, removes, or restores specified My Messages folders for a given user. Guide only
ReviseSellingManagerInventoryFolder Revises the name of a Selling Manager inventory folder. view
ReviseSellingManagerProduct Revises a Selling Manager product. view
ReviseSellingManagerSaleRecord Revises a Selling Manager sale record when you specify one of the following: an ItemID, a TransactionID, or an OrderID. view
ReviseSellingManagerTemplate Revises a Selling Manager template. view
RevokeToken Voluntarily revokes a token before it would otherwise expire. view
SaveItemToSellingManagerTemplate Creates a Selling Manager listing template that is similar to an item. view
SellerReverseDispute Enables a seller to "reverse" an Unpaid Item dispute that has been closed, for example, if buyer and seller reach an agreement. The seller's Final Value Fee credit and the buyer's strike are both reversed. if applicable. Guide only
SendInvoice Enables a seller to send an invoice to a buyer involved in a single transaction or order. view
SetMessagePreferences Enables a seller to add custom Ask Seller a Question (ASQ) subjects to their Ask a Question page, or to reset any custom subjects to their default values. view
SetNotificationPreferences Manages a user's notification and alert preferences. view
SetPictureManagerDetails Creates, updates, or deletes Picture Manager account settings, folders, or pictures. This call will soon be deprecated. Guide only
SetPromotionalSale Creates or modifies a promotional sale. Promotional sales enable sellers to apply discounts and/or free shipping across many listings. view
SetPromotionalSaleListings Changes which item listings are affected by a promotional sale. view
SetSellingManagerFeedbackOptions Enables Selling Manager and Selling Manager Pro subscribers to store feedback comments for buyers and set automated feedback preferences (Selling Manager Pro subscribers only). view
SetSellingManagerItemAutomationRule Revises or adds to the set of Selling Manager automation rules associated with a specific item. view
SetSellingManagerTemplateAutomationRule Revises or adds to the Selling Manager automation rules associated with a specific template. view
SetShippingDiscountProfiles Enables a seller to define shipping cost discount profiles for things such as combined payments for shipping and handling costs. view
SetStore Sets the configuration of the eBay store owned by the caller. view
SetStoreCategories Changes the category structure of an eBay store. view
SetStoreCustomPage Creates or updates a custom page on a user's eBay Store. view
SetStorePreferences Sets the preferences for a user's eBay Store. view
SetTaxTable Sets the tax table for a seller on a given site. view
SetUserNotes Enables users to add, replace, and delete My eBay notes for items that are being tracked in the My eBay All Selling and All Buying areas. view
SetUserPreferences Sets the authenticated user's preferences to those specified in the request. view
UploadSiteHostedPictures Uploads a picture for a listing and returns a URL for the picture. view
ValidateChallengeInput Validates the user response to a GetChallengeToken botblock challenge. Guide only
ValidateTestUserRegistration Requests to enable a test user to sell items in the Sandbox environment. Guide only
VerifyAddFixedPriceItem Enables a seller to specify the definition of a new fixed-price listing and submit the definition to eBay without creating a listing. view
VerifyAddItem Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing. view
VerifyAddSecondChanceItem Simulates the creation of a new Second Chance Offer listing of an item without actually creating a listing. Guide only
VerifyRelistItem Checks arguments for RelistItemCall for errors and lists fees-without actually relisting the item. Guide only
VeROReportItems Reports items that allegedly infringe your copyright, trademark, or other intellectual property rights. You must be a member of the Verified Rights Owner (VeRO) Program to use this call. Guide only


Standard Requester Credentials for Making Calls

The prototypes and tables do not include the RequesterCredentials container and fields. For example, the input sections do not include eBayAuthToken. For information about authenticating requests, please refer to the guide for the API or SDK you are using. If you are using the Trading API, pass the RequesterCredentials node in the request XML as in the snippet below for most XML requests (exceptions are FetchToken and GetSessionID). In SOAP requests, pass the token and the RequesterCredentials in the SOAP header. See Standard Data for All Calls for fuller examples and information, including a SOAP example.

<RequesterCredentials>
  <eBayAuthToken>string</eBayAuthToken>
</RequesterCredentials>

User-Contributed Notes

Share tips or code samples related to this call or document. Questions or observations are welcome, too.

eBay employees moderate these notes to ensure they're pertinent to the document and relevant to the community. Your submission will show up for all developers when it's activated by the moderator.

   
 
 
 

This document was generated with a customized version of the apireferencedocs tool.

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