eBay Trading APIVersion 1035

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. n/a
AddDisputeResponse Used to respond to a PayPal Purchase Protection dispute or to update an Unpaid Item case. n/a
AddFixedPriceItem Defines and lists a new fixed-price item. A fixed-price listing can include multiple identical items. n/a
AddItem Creates a fixed-price, auction, or classified ad listing. n/a
AddItemFromSellingManagerTemplate Creates a listing based on settings contained in a Selling Manager Pro template. n/a
AddItems Defines from one to five items and lists them on a specified eBay site. n/a
AddMemberMessageAAQToPartner Enables a buyer and seller in an order relationship to send messages to each other's My Messages Inboxes. n/a
AddMemberMessageRTQ Enables a seller to reply to a question about an active item listing. n/a
AddMemberMessagesAAQToBidder Enables a seller to send up to 10 messages to bidders/potential buyers regarding an active listing. n/a
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. n/a
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. n/a
AddSellingManagerInventoryFolder Adds a new product folder to a user's Selling Manager account. n/a
AddSellingManagerProduct Creates a Selling Manager product, which can be used to create Selling Manager listing templates. n/a
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. n/a
AddToItemDescription Adds additional text to an active listing's item description. n/a
AddToWatchList Adds one or more order line items to the eBay user's Watch List. n/a
AddTransactionConfirmationItem Ends an eBay Motors listing and creates a new Transaction Confirmation Request (TCR) for the item. n/a
CompleteSale Enables a seller to do various tasks after the creation of a single line item or multiple line item (Combined Invoice) order. n/a
ConfirmIdentity Returns the ID of a user who has gone through an application's consent flow process for obtaining an authorization token. n/a
DeleteMyMessages Removes selected messages for a given user. n/a
DeleteSellingManagerInventoryFolder Removes a Selling Manager inventory folder. n/a
DeleteSellingManagerItemAutomationRule Removes the association of Selling Manager automation rules to an item. n/a
DeleteSellingManagerProduct Deletes a Selling Manager product. n/a
DeleteSellingManagerTemplate Deletes a Selling Manager template. n/a
DeleteSellingManagerTemplateAutomationRule Removes the association of Selling Manager automation rules to a template. n/a
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. n/a
EndFixedPriceItem Ends the specified fixed-price listing before the date and time at which it would normally end (per the listing duration). n/a
EndItem Ends the specified item listing before the date and time at which it would normally end per the listing duration. n/a
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. n/a
ExtendSiteHostedPictures By default, unpublished pictures uploaded to eBay Picture Services (EPS) via the UploadSiteHostedPictures call will be kept on the server for five days before being purged. n/a
FetchToken Retrieves an authentication token for a user. n/a
GetAccount Returns a seller's invoice data for their eBay account, including the account's summary data. n/a
GetAdFormatLeads Retrieves sales lead information for a lead generation listing. n/a
GetAllBidders This is the base request type for the GetAllBidders call, which is used to retrieve bidders from an active or recently-ended auction listing. n/a
GetApiAccessRules The base request type for the GetApiAccessRules call, which returns details on how many calls your application has made and is allowed to make per hour or day. n/a
GetBestOffers This is the base request type of the GetBestOffers call. n/a
GetBidderList Retrieves all items the user is currently bidding on, and the ones they have won or purchased. n/a
GetCategories Retrieves the latest eBay category hierarchy for a given eBay site. n/a
GetCategoryFeatures Returns information about the features that are applicable to different categories, such as listing durations, shipping term requirements, and Best Offer support. n/a
GetCategoryMappings Retrieves a map of old category IDs and corresponding active category IDs defined for the site to which the request is sent. n/a
GetCategorySpecifics This is the base request type for the GetCategorySpecifics call. n/a
GetChallengeToken This is the base request type for the GetChallengeToken call. n/a
GetCharities This is the base request type for the GetCharities call. n/a
GetClientAlertsAuthToken This is the base request type for the GetClientAlertsAuthToken call. n/a
GetContextualKeywords Retrieves top-ranked contextual eBay keywords and categories for a specified web page. n/a
GetDescriptionTemplates This is the base request type for the GetDescriptionTemplates call. n/a
GetDispute This is the base request type for the GetDispute call. n/a
GeteBayDetails This is the base request type for the GeteBayDetails call. n/a
GeteBayOfficialTime Gets the official eBay system time in GMT. n/a
GetFeedback Retrieves one, many, or all Feedback records for a specific eBay user. n/a
GetItem The GetItem call returns listing data such as title, description, price information, user information, and so on, for the specified ItemID. n/a
GetItemsAwaitingFeedback This is the base request type of the GetItemsAwaitingFeedback call. n/a
GetItemShipping This is the base request type of the GetItemShipping call. n/a
GetItemTransactions Retrieves order line item information for a specified ItemID. n/a
GetMemberMessages Retrieves a list of the messages buyers have posted about your active item listings. n/a
GetMessagePreferences Returns a seller's Ask Seller a Question (ASQ) subjects, each in its own Subject node. n/a
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. n/a
GetMyeBayReminders This is the base request type of the GetMyeBayReminders call. n/a
GetMyeBaySelling Retrieves information regarding the user's selling activity, such as items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items. n/a
GetMyMessages Retrieves information about the messages sent to a user. n/a
GetNotificationPreferences Retrieves the requesting application's notification preferences. n/a
GetNotificationsUsage Retrieves usage information about platform notifications for a given application. n/a
GetOrders Retrieves the orders for which the authenticated user is a participant, either as the buyer or the seller. n/a
GetOrderTransactions The base request type for the GetOrderTransactions call. n/a
GetPromotionalSaleDetails The base request type for the GetPromotionalSaleDetails call. n/a
GetSellerDashboard The base request type for the GetSellerDashboard call. n/a
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. n/a
GetSellerList Retrieves a list of the items posted by the authenticated user, including the related item data. n/a
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. n/a
GetSellingManagerAlerts Retrieves Selling Manager alerts. n/a
GetSellingManagerEmailLog Retrieves a log of emails sent, or scheduled to be sent, to buyers. Includes success or failure status. n/a
GetSellingManagerInventory Retrieves a paginated listing of a user's Selling Manager inventory. n/a
GetSellingManagerInventoryFolder Retrieves Selling Manager inventory folders. n/a
GetSellingManagerItemAutomationRule Retrieves the set of Selling Manager automation rules associated with an item. n/a
GetSellingManagerSaleRecord Retrieves the data for one or more Selling Manager sale records. n/a
GetSellingManagerSoldListings Retrieves information about items that a seller has sold. n/a
GetSellingManagerTemplateAutomationRule Retrieves the set of Selling Manager automation rules associated with a Selling Manager template. n/a
GetSellingManagerTemplates Retrieves Selling Manager templates. n/a
GetSessionID Retrieves a session ID that identifies a user and your application when you make a FetchToken request. n/a
GetShippingDiscountProfiles Returns the shipping discount profiles defined by the user, along with other Combined Invoice-related details such as packaging and handling costs. n/a
GetStore Retrieves configuration information for the eBay store owned by the specified UserID, or by the caller. n/a
GetStoreCategoryUpdateStatus Returns the status of the processing for category-structure changes specified with a call to SetStoreCategories. n/a
GetStoreCustomPage Retrieves the custom page or pages for the authenticated user's Store. n/a
GetStoreOptions Retrieves the current list of eBay store configuration settings. n/a
GetStorePreferences Retrieves a user's Store preferences. n/a
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. n/a
GetTaxTable The base request type of the GetTaxTable call, which retrieves information on the seller's tax table. n/a
GetTokenStatus Requests current status of user token. n/a
GetUser Retrieves data pertaining to a single eBay user. n/a
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. n/a
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. n/a
GetUserPreferences Retrieves the specified user preferences for the authenticated caller. n/a
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. n/a
GetVeROReportStatus Retrieves status information about VeRO reported items. You must be a member of the Verified Rights Owner (VeRO) Program to use this call. n/a
LeaveFeedback Enables a buyer and seller to leave feedback for their order partner at the conclusion of a successful order. n/a
MoveSellingManagerInventoryFolder Moves a Selling Manager inventory folder. n/a
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. n/a
RelistFixedPriceItem Enables a seller to relist a fixed-price listing that has recently ended on a specified eBay site. n/a
RelistItem Enables a seller to relist a listing that has recently ended on a specified eBay site. n/a
RemoveFromWatchList The call enables a user to remove one or more items from their Watch List. n/a
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. n/a
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. n/a
ReviseCheckoutStatus Enables a seller to update the payment details, the shipping details, and the status of an order. n/a
ReviseFixedPriceItem Enables a seller to revise a fixed-price listing on a specified eBay site. n/a
ReviseInventoryStatus Enables a seller to change the price and/or quantity of one or more fixed-price listings (single-variation or multiple-variation). n/a
ReviseItem Enables a seller to revise a listing on a specified eBay site. n/a
ReviseMyMessages Sets the read state for messages, sets the flagged state of messages, and moves messages into and out of folders. n/a
ReviseMyMessagesFolders Renames, removes, or restores the specified My Messages folders for a given user. n/a
ReviseSellingManagerInventoryFolder Revises the name of a Selling Manager inventory folder. n/a
ReviseSellingManagerProduct Revises a Selling Manager product. n/a
ReviseSellingManagerSaleRecord Request type containing the input fields for the ReviseSellingManagerSaleRecord call. n/a
ReviseSellingManagerTemplate Revises a Selling Manager template. n/a
RevokeToken Revokes a token before it would otherwise expire. n/a
SaveItemToSellingManagerTemplate Creates a Selling Manager listing template that is similar to an item. n/a
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. n/a
SendInvoice Enables a seller to send an order invoice to a buyer. n/a
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. n/a
SetNotificationPreferences Manages notification and alert preferences for applications and users. n/a
SetPromotionalSale Creates or modifies a promotional sale. Promotional sales enable sellers to apply discounts and/or free shipping across many listings. n/a
SetPromotionalSaleListings Enables the seller to change the item listings that are affected by a promotional sale. n/a
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). n/a
SetSellingManagerItemAutomationRule Revises or adds to the set of Selling Manager automation rules associated with a specific item. n/a
SetSellingManagerTemplateAutomationRule Revises or adds to the Selling Manager automation rules associated with a specific template. n/a
SetShippingDiscountProfiles This call enables a seller to create and manage shipping discounts rules. n/a
SetStore Sets the configuration of the eBay store owned by the caller. n/a
SetStoreCategories Changes the category structure of an eBay store. n/a
SetStoreCustomPage Creates or updates a custom page on a user's eBay Store. n/a
SetStorePreferences Sets the preferences for a user's eBay Store. n/a
SetTaxTable This call allows you to add or modify sales tax rates for one or more tax jurisdictions within the specified site. n/a
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. n/a
SetUserPreferences This call allows an eBay user to set/modify numerous seller account preferences. n/a
UploadSiteHostedPictures Uploads a picture to the eBay Picture Service and returns a URL of the picture. n/a
ValidateChallengeInput Validates the user response to a GetChallengeToken botblock challenge. n/a
ValidateTestUserRegistration Requests to enable a test user to sell items in the Sandbox environment. n/a
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. n/a
VerifyAddItem Enables a seller to specify the definition of a new item and submit the definition to eBay without creating a listing. n/a
VerifyAddSecondChanceItem Simulates the creation of a new Second Chance Offer listing of an item without actually creating a listing. n/a
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. n/a
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. n/a


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>