eBay Trading APIVersion 1039

Call Index

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

The details in this Call Reference apply if you are developing applications with the supplied WSDL or Schema (XSD), or if you are using one of the eBay SDKs. If you are using an SDK, note that there can be differences between the calls outlined in this reference and the calls in the SDK. For details, see eBay SDKs.

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

See also the calls in the eBay Shopping API.

Call Summary Samples
AddDispute Creates an Unpaid Item case against a buyer or cancels a single line item order. view
AddDisputeResponse Used to respond to a PayPal Purchase Protection dispute or to update an Unpaid Item case. view
AddFixedPriceItem Defines and lists a new fixed-price item. A fixed-price listing can include multiple identical items. view
AddItem Creates a fixed-price, auction, or classified ad listing. view
AddItemFromSellingManagerTemplate Creates a listing based on settings contained in a Selling Manager Pro template. view
AddItems Defines from one to five items and lists them on a specified eBay site. view
AddMemberMessageAAQToPartner Enables a buyer and seller in an order 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/potential buyers regarding an active listing. view
AddOrder Combines two or more order line items into a single order, enabling a buyer to pay for all of those order line items with a single payment. view
AddSecondChanceItem Used by the seller of an auction listing to provide a Second Chance Offer to one of that auction 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 can be used to create Selling Manager listing templates. view
AddSellingManagerTemplate Creates a Selling Manager listing template that can be used to create an eBay listing based on the Selling Manager product associated with the template. view
AddToItemDescription Adds additional text to an active listing's item description. view
AddToWatchList Adds one or more order line items to the eBay user's Watch List. view
AddTransactionConfirmationItem Ends an eBay Motors listing and creates a new Transaction Confirmation Request (TCR) for the item. view
CompleteSale Enables a seller to do various tasks after the creation of a single line item or multiple line item (Combined Invoice) order. 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 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 Assistant mechanism to disable the Unpaid Item Assistant at the order line item level. view
EndFixedPriceItem Ends the specified fixed-price listing before the date and time at which it would normally end (per the listing duration). view
EndItem Ends the specified item listing before the date and time at which it would normally end per the listing duration. view
EndItems The EndItems call is used to end up to 10 specified eBay listings before the date and time at which those listings would normally end per the listing duration. view
ExtendSiteHostedPictures This call is used to extend this expiration date of pictures uploaded to the eBay Picture Server (EPS). view
FetchToken Retrieves an authentication token for a user. view
GetAccount Returns a seller's invoice data for their eBay account, including the account's summary data. view
GetAdFormatLeads Retrieves sales lead information for a lead generation listing. view
GetAllBidders This call is used to retrieve bidders from an active or recently-ended auction listing. view
GetApiAccessRules This call returns details on how many calls your application has made and is allowed to make per hour or day. view
GetBestOffers This call can be used by a seller to retrieve all active Best Offers, all Best Offers on a specific listing, a specific Best Offer for a specific listing, or Best Offers in a specific state. 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. 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
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 This call is used to retrieve recommended Item Specifics names and values for one or multiple eBay Categories. view
GetChallengeToken This call retrieves a botblock token and URLs for an image or audio clip that the user is to match. view
GetCharities This call is used to search for eBay for Charity nonprofit organizations. view
GetClientAlertsAuthToken This call retrieves a Client Alerts token for the user, which is required when the user makes a GetUserAlerts call (Client Alerts API). view
GetContextualKeywords Retrieves top-ranked contextual eBay keywords and categories for a specified web page. view
GetDescriptionTemplates This call retrieves detailed information on the Listing Designer templates that are available for use by the seller. view
GetDispute This call retrieves the details of a seller-initiated dispute. view
GeteBayDetails This call retrieves the latest eBay feature-related metadata values that are supported when listing items. view
GeteBayOfficialTime Gets the official eBay system time in GMT. view
GetFeedback Retrieves one, many, or all Feedback records for a specific eBay user. view
GetItem The GetItem call returns listing data such as title, description, price information, user information, and so on, for the specified ItemID. view
GetItemsAwaitingFeedback This call retrieves all completed order line items for which the user (buyer or seller) still needs to leave Feedback for their order partner. view
GetItemShipping This call takes an ItemID value for an item that has yet to be shipped, and then returns estimated shipping costs for every shipping service that the seller has offered with the listing. view
GetItemTransactions Retrieves order line item information for a specified ItemID. 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 Retrieves information regarding a user's buying activity, such as items they are watching, bidding on, have won, did not win, and have made Best Offers on. view
GetMyeBayReminders This call returns the total counts for My eBay Buying and/or My eBay Selling Reminders for a user. view
GetMyeBaySelling Retrieves information regarding the user's selling activity, such as items that the user is currently selling (the Active list), auction listings that have bids, sold items, and unsold items. view
GetMyMessages Retrieves information about the messages sent to a user. view
GetNotificationPreferences Retrieves the requesting application's notification preferences. view
GetNotificationsUsage Retrieves usage information about platform notifications for a given application. view
GetOrders Retrieves the orders for which the authenticated user is a participant, either as the buyer or the seller. view
GetOrderTransactions This call retrieves detailed information about one or more orders. view
GetPromotionalSaleDetails This call retrieves information about promotional sales set up by an eBay store owner. view
GetSellerDashboard This call retrieves seller performance data, including seller standards level, Power Seller status, Buyer Satisfaction status, eBay Search standing, and any seller fee discounts. 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 Retrieves a list of the items posted by the authenticated user, including the related item data. view
GetSellerTransactions Retrieves order line item information for the user for which the call is made, and not for any other user. To retrieve order line items 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 Retrieves the data for one or more Selling Manager sale records. 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 This call retrieves all shipping discount profiles currently defined by the user, along with other Combined Invoice-related details such as packaging and handling costs. view
GetStore This call is used to retrieve detailed information on a seller's eBay Store, including store theme information and eBay Store category hierarchy. view
GetStoreCategoryUpdateStatus This call is used to retrieve the status of an eBay Store Category hierarchy change that was made with a SetStoreCategories call. view
GetStoreCustomPage This call is used to retrieve a specific custom page or all custom pages created for a seller's eBay Store. view
GetStoreOptions This call is used to retrieve the current list of eBay Store configuration settings. view
GetStorePreferences This call is used to retrieve an eBay seller's Store preferences. view
GetSuggestedCategories This call returns a list of up to 10 eBay categories that have the highest percentage of listings whose listing titles or descriptions contain the keywords you specify. view
GetTaxTable This call is used to retrieve information on the seller's Sales Tax Table. view
GetTokenStatus This call is used to get the current status of a user token. view
GetUser Retrieves data pertaining to a single eBay user. view
GetUserContactDetails This call is used to retrieve contact information for a specified eBay 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. eBay Money Back Guarantee Item Not Received and Return cases are not returned with this call. 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. view
GetVeROReportStatus Retrieves status information about VeRO reported items. You must be a member of the Verified Rights Owner (VeRO) Program to use this call. view
LeaveFeedback Enables a buyer and seller to leave Feedback for their order partner at the conclusion of a successful order. view
MoveSellingManagerInventoryFolder Moves a Selling Manager inventory folder. view
PlaceOffer Enables the authenticated user to to make a bid on an auction item, propose a Best Offer, or purchase a fixed-price/Buy It Now item. view
RelistFixedPriceItem Enables a seller to relist a fixed-price listing that has recently ended on a specified eBay site. view
RelistItem Enables a seller to relist a listing that has recently ended on a specified eBay site. view
RemoveFromWatchList The call enables a user to remove one or more items from their Watch List. view
RespondToBestOffer This call enables the seller to accept or decline a buyer's Best Offer on an item, or make a counter offer to the buyer's Best Offer. view
RespondToFeedback Enables a seller to reply to Feedback that has been left for a user, or to post a follow-up comment to a Feedback comment the user has left for someone else. view
ReviseCheckoutStatus Enables a seller to update the payment details, the shipping details, and the status of an order. view
ReviseFixedPriceItem Enables a seller to revise a fixed-price listing on a specified eBay site. view
ReviseInventoryStatus Enables a seller to change the price and/or quantity of one or more fixed-price listings (single-variation or multiple-variation). view
ReviseItem Enables a seller to revise a listing on a specified eBay site. view
ReviseMyMessages This call can be used to mark one or more messages as 'Read', to flag one or more messages, and/or to move one or more messages to another My Messages folder. view
ReviseMyMessagesFolders This call can rename, remove, or restore My Messages folders for a given user. view
ReviseSellingManagerInventoryFolder Revises the name of a Selling Manager Inventory folder. view
ReviseSellingManagerProduct Revises a Selling Manager Product. view
ReviseSellingManagerSaleRecord This call is used to revise a Selling Manager Sale Record. A Selling Manager Pro subscription is required to use this call. view
ReviseSellingManagerTemplate Revises a Selling Manager template. view
RevokeToken Revokes a token before it would otherwise expire. view
SaveItemToSellingManagerTemplate Creates a Selling Manager template based on an existing eBay listing. 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. view
SendInvoice Enables a seller to send an order invoice to a buyer. 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 notification and alert preferences for applications and users. view
SetPromotionalSale Creates or modifies a promotional sale. Promotional sales enable sellers to apply discounts and/or free shipping across many listings. view
SetPromotionalSaleListings Enables the seller to change the item listings that 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 This call enables a seller to create and manage shipping discounts rules. view
SetStore This call is used to set/modify the configuration of a seller's eBay Store. view
SetStoreCategories This call allows you to set or modify 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 This call allows you to add or modify sales tax rates for one or more tax jurisdictions within the specified site. view
SetUserNotes Enables users to add, modify, or delete a pinned note for any item that is being tracked in the My eBay All Selling and All Buying areas. view
SetUserPreferences This call allows an eBay user to set/modify numerous seller account preferences. view
UploadSiteHostedPictures Uploads a picture to the eBay Picture Service and returns a URL of the picture. view
ValidateChallengeInput Validates the user response to a GetChallengeToken botblock challenge. view
ValidateTestUserRegistration Requests to enable a test user to sell items in the Sandbox environment. view
VerifyAddFixedPriceItem Enables a seller to test the definition of a new fixed-price listing by submitting the definition to eBay without creating an actual 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. view
VerifyRelistItem Enable the seller to verify that the data they plan to pass into a RelistItem call will produce the results that you are expecting, including a successful call with no errors. view
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. view


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>