eBay Trading Web Services

List of All Calls Field Index Enumeration Index Type Index Deprecated Objects Errors by Number

Input/Output ReferenceVersion 563

This call reference describes the elements and attributes for each call in the eBay Trading Web Services. 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 Web Services.

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.) view

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

AddItem Sends data defining a new item (specified by a seller) to eBay, where it becomes a new listing. 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

AddLiveAuctionItem Available to eBay Live Auctions sellers. Sends data defining a single new lot item to the eBay Live Auctions site, where it becomes a new lot in a seller's Live Auction catalog. The listing also appears on the main eBay site. As in the case of AddItem, the data returned includes an item ID for the new listing and estimated fees, not including the Final Value Fee. view

AddMemberMessageAAQToPartner 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. view

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

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

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

ApproveLiveAuctionBidders Provides Live Auction sellers with the ability to approve, decline, and set the bidding limit of the bidders that have signed up for a catalog. view

CompleteSale Enables a seller to do various tasks after a transaction has been created. A seller can leave feedback for the buyer, change the paid status, or set shipment tracking information (or any combination of these). view

DeleteMyMessages Removes selected alerts and messages for a given user. view

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

FetchToken Retrieves a user token. Also can be used to retrieve a REST token. view

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

GetAdFormatLeads Retrieves sales lead information for a lead generation listing. view

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

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

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

GetBestOffers 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. view

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

GetCart Retrieves information about an eBay Express shopping cart. 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 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. view

GetCategoryListings 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. 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 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. 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. view

GetContextualKeywords Retrieves top-ranked contextual eBay keywords and categories for a specified web page. view

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

GetDescriptionTemplates Retrieves the DescriptionTemplates for a category. view

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

GetExpressWishList Retrieves eBay Express user wish lists. view

GetFeedback Retrieves the accumulation of feedback left for the specified user by other users. view

GetHighBidders 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. view

GetItem Requests data for a specific item identified by item ID. Data returned includes title, description, minimum bid price, seller information, high bidder information (if there currently is a high bidder), and shipping specifications (if the seller elected to have the buyer pay for shipping). 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. view

GetItemShipping 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. view

GetItemTransactions Retrieves transaction information for a specified itemID. Depending on whether the listing sells one or multiple items and on whether anything has been sold in that listing, this returns zero, one or multiple transactions. view

GetLiveAuctionBidders Gets a list of users who have signed up to participate in their auctions, including the bid approval status of each user. view

GetLiveAuctionCatalogDetails Retrieves all the eBay Live Auctions catalogs and upcoming sale schedules that the user has created. view

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

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

GetMyeBayBuying 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. view

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

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

GetMyMessages Retrieves information about the messages and alerts sent to a given 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 all of the orders for which the user is a participant (as either buyer or seller) that meet the criteria specified in the request. 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. view

GetPictureManagerOptions Requests a list of Picture Manager options and allowed values, such as subscription type and picture display. view

GetPopularKeywords Retrieves the words more frequently used 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. view

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

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

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

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

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). view

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

GetPromotionalSaleDetails Used to obtain information about promotional sales. This call is part of the Promotional Price Display feature, which enables sellers to apply discounts across many listings. view

GetPromotionRules Requests a list of the cross-promotion rules associated with a specific referring item or store category. view

GetReturnURL Returns an application's authentication and authorization preferences and related data, such as the URLs that eBay should redirect users to after they complete the authentication and authorization process. view

GetRuName Returns a globally unique runame (unique identifier for an authentication data entry). view

GetSearchResults Retrieves item listings based on keywords you specify. The keywords can include wildcards. The response is in the form of an array whose size and contents you specify, using a variety of input fields. You can filter the item listings returned using such criteria as the listing category, location, whether the item is listed in an ebay Store, and listing type. You can include or exclude specified sellers. view

GetSearchResultsExpress Please check this Knowledge Base article for updates on current issues with GetSearchResultsExpress.

Retrieves brief details about active items that are listed on eBay Express, eBay catalog products that have been used to pre-fill data in these items, and a histogram that shows the distribution of items and catalog products across Express departments, aisles, and/or product types. view

GetSellerDashboard Coming Soon: (Available in late May 2008) Retrieves a brief summary of the requester's status as an eBay seller. This status information can help an eBay seller monitor their selling performance and keep their account in good standing. 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. view

GetSellerPayments Retrieves a summary of pending or paid payments that Half.com created for the seller identified by the authentication token in the request. view

GetSellerTransactions Retrieves transaction information for the user for which the call is made (and not for any other user), where a transaction is the information about the sale of one or more items by one buyer from a single listing. (To retrieve transactions for another seller's listing, use GetItemTransactions.) view

GetSessionID Retrieves a session ID that identifies a user and your application. view

GetShippingDiscountProfiles Returns details of the shipping discount profiles defined by the user, along with other combined payment-related details such as packaging/handling cost and shipping insurance. view

GetStore Retrieves configuration information for the eBay store owned by the specified user or caller. view

GetStoreCategoryUpdateStatus Returns the status of the processing progress for category structure changes specified with a SetStoreCategories request. view

GetStoreCustomPage Retrieves the custom page or pages for the user's Store. view

GetStoreOptions Retrieves the current list of Store configuration options. view

GetStorePreferences Retrieves a user's Store preferences. view

GetSuggestedCategories Requests a list of up to 10 categories with 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 for one eBay user. Input fields control what user data is returned. view

GetUserContactDetails Returns contact information for a specified user if a bidding relationship exists. Both sellers and bidders can use this call. 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 some or all of a user's preferences. 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

GetWantItNowPost Retrieves data for a specific, active Want It Now post identified by a post ID. view

GetWantItNowSearchResults Retrieves a list of active Want It Now posts that match specified keywords and/or a specific category ID. view

IssueRefund Issues a refund for a single Half.com transaction. view

LeaveFeedback Enables a user to leave feedback about another user. view

PlaceOffer Enables the requesting user to submit a bid (make an offer) on the item listing specified in ItemID. view

RelistItem Enables a seller to take a single item (or a single multi-item listing) that ended without bidders or buyers and re-list it on a specified eBay site. view

RemoveFromWatchList Enables a user to remove item from his or her My eBay watch list. view

RespondToBestOffer Enables the seller of a Best Offer item to accept, decline, or counter offers made by bidders. view

RespondToFeedback Enables users to reply to feedback left by the other party in the transaction and/or follow up on the feedback left for the other party. view

RespondToWantItNowPost Enables a seller to respond to a Want It Now post with an item listed on the eBay site. view

ReviseCheckoutStatus Enables a seller to update the payment status of an item. view

ReviseItem Enables a seller to change the properties of a currently active listing. view

ReviseLiveAuctionItem Enables an eBay Live Auctions seller to modify a single lot item on the eBay Live Auctions site. 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. view

ReviseMyMessagesFolders Renames, removes, or restores specified My Messages folders for a given user. view

RevokeToken Voluntarily revokes a token before it would otherwise expire, typically because of security concerns or because the user has unsubscribed. 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 invoice to a buyer involved in the transaction. view

SetCart Enables a third party developer to create a new shopping cart in the eBay Express domain or to modify the contents of an existing shopping cart by adding or removing items or changing item quantity. view

SetMessagePreferences Enables a seller to add custom Ask Seller a Question (ASQ) subjects to display on the seller's Ask a Question page. view

SetNotificationPreferences Manages a user's notification preferences. This is part of the eBay Platform Notifications feature. Notification can be used to alert production applications of selected events on the eBay site, helping reduce the number of times your application needs to retrieve certain information. view

SetPictureManagerDetails Creates, updates, or deletes Picture Manager account settings, folders, or pictures. view

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

SetPromotionalSaleListings Used to change which item listings are affected by a promotional sale. view

SetReturnURL Configures your application's authentication and authorization preferences and other data, such as the URLs that eBay should redirect users to after they complete the authentication and authorization process. view

SetShippingDiscountProfiles Enables a seller to define shipping cost discount profiles and a few additional parameters related to combined payment, such as shipping insurance and packaging handling costs. view

SetStore Sets the configuration of the eBay store owned by the caller. view

SetStoreCategories Requests changes to the category structure for a store. view

SetStoreCustomPage Sets a custom page for 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 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. view

ValidateTestUserRegistration Requests to enable a test user to sell items in the Sandbox environment. 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

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

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.)	view
AddDisputeResponse	Adds a response or comment to a dispute, or closes a dispute.	view
AddItem	Sends data defining a new item (specified by a seller) to eBay, where it becomes a new listing. 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
AddLiveAuctionItem	Available to eBay Live Auctions sellers. Sends data defining a single new lot item to the eBay Live Auctions site, where it becomes a new lot in a seller's Live Auction catalog. The listing also appears on the main eBay site. As in the case of AddItem, the data returned includes an item ID for the new listing and estimated fees, not including the Final Value Fee.	view
AddMemberMessageAAQToPartner	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.	view
AddMemberMessageRTQ	Enables a seller to reply to a question about an active item listing. The reply is sent to the user's My Messages inbox.	view
AddMemberMessagesAAQToBidder	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.	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
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 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.	view
ApproveLiveAuctionBidders	Provides Live Auction sellers with the ability to approve, decline, and set the bidding limit of the bidders that have signed up for a catalog.	view
CompleteSale	Enables a seller to do various tasks after a transaction has been created. A seller can leave feedback for the buyer, change the paid status, or set shipment tracking information (or any combination of these).	view
DeleteMyMessages	Removes selected alerts and messages for a given user.	view
EndItem	Ends the specified item listing before the date and time at which it would normally end (per the listing duration).	view
FetchToken	Retrieves a user token. Also can be used to retrieve a REST token.	view
GetAccount	Enables a seller to retreive his or her own account data.	view
GetAdFormatLeads	Retrieves sales lead information for a lead generation listing.	view
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.	view
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.	view
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.	view
GetBestOffers	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.	view
GetBidderList	Retrieves all items on which the user is currently bidding or which the buyer has won or purchased.	view
GetCart	Retrieves information about an eBay Express shopping cart.	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 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.	view
GetCategoryListings	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.	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	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.	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.	view
GetContextualKeywords	Retrieves top-ranked contextual eBay keywords and categories for a specified web page.	view
GetCrossPromotions	Retrieves a list of upsell or cross-sell items associated with the specifeid item ID.	view
GetDescriptionTemplates	Retrieves the DescriptionTemplates for a category.	view
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
GetExpressWishList	Retrieves eBay Express user wish lists.	view
GetFeedback	Retrieves the accumulation of feedback left for the specified user by other users.	view
GetHighBidders	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.	view
GetItem	Requests data for a specific item identified by item ID. Data returned includes title, description, minimum bid price, seller information, high bidder information (if there currently is a high bidder), and shipping specifications (if the seller elected to have the buyer pay for shipping).	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.	view
GetItemShipping	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.	view
GetItemTransactions	Retrieves transaction information for a specified itemID. Depending on whether the listing sells one or multiple items and on whether anything has been sold in that listing, this returns zero, one or multiple transactions.	view
GetLiveAuctionBidders	Gets a list of users who have signed up to participate in their auctions, including the bid approval status of each user.	view
GetLiveAuctionCatalogDetails	Retrieves all the eBay Live Auctions catalogs and upcoming sale schedules that the user has created.	view
GetMemberMessages	Retrieves messages posted to the Ask Seller A Question messaging system.	view
GetMessagePreferences	Returns a seller's Ask Seller a Question (ASQ) subjects.	view
GetMyeBayBuying	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.	view
GetMyeBayReminders	Requests totals of various reminder types from the user's MyeBay account.	view
GetMyeBaySelling	Returns a summary and details of items a user is selling from the user's My eBay account.	view
GetMyMessages	Retrieves information about the messages and alerts sent to a given 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 all of the orders for which the user is a participant (as either buyer or seller) that meet the criteria specified in the request.	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.	view
GetPictureManagerOptions	Requests a list of Picture Manager options and allowed values, such as subscription type and picture display.	view
GetPopularKeywords	Retrieves the words more frequently used 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.	view
GetProductFinder	Retrieves data that you use to construct valid "product finder" queries (queries against multiple attributes) against catalog products or listed items.	view
GetProductFinderXSL	Retrieves the Product Finder XSL stylesheet for use with the XML returned from GetProductFinder.	view
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.	view
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.	view
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).	view
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.	view
GetPromotionalSaleDetails	Used to obtain information about promotional sales. This call is part of the Promotional Price Display feature, which enables sellers to apply discounts across many listings.	view
GetPromotionRules	Requests a list of the cross-promotion rules associated with a specific referring item or store category.	view
GetReturnURL	Returns an application's authentication and authorization preferences and related data, such as the URLs that eBay should redirect users to after they complete the authentication and authorization process.	view
GetRuName	Returns a globally unique runame (unique identifier for an authentication data entry).	view
GetSearchResults	Retrieves item listings based on keywords you specify. The keywords can include wildcards. The response is in the form of an array whose size and contents you specify, using a variety of input fields. You can filter the item listings returned using such criteria as the listing category, location, whether the item is listed in an ebay Store, and listing type. You can include or exclude specified sellers.	view
GetSearchResultsExpress	Please check this Knowledge Base article for updates on current issues with GetSearchResultsExpress. Retrieves brief details about active items that are listed on eBay Express, eBay catalog products that have been used to pre-fill data in these items, and a histogram that shows the distribution of items and catalog products across Express departments, aisles, and/or product types.	view
GetSellerDashboard	Coming Soon: (Available in late May 2008) Retrieves a brief summary of the requester's status as an eBay seller. This status information can help an eBay seller monitor their selling performance and keep their account in good standing.	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.	view
GetSellerPayments	Retrieves a summary of pending or paid payments that Half.com created for the seller identified by the authentication token in the request.	view
GetSellerTransactions	Retrieves transaction information for the user for which the call is made (and not for any other user), where a transaction is the information about the sale of one or more items by one buyer from a single listing. (To retrieve transactions for another seller's listing, use GetItemTransactions.)	view
GetSessionID	Retrieves a session ID that identifies a user and your application.	view
GetShippingDiscountProfiles	Returns details of the shipping discount profiles defined by the user, along with other combined payment-related details such as packaging/handling cost and shipping insurance.	view
GetStore	Retrieves configuration information for the eBay store owned by the specified user or caller.	view
GetStoreCategoryUpdateStatus	Returns the status of the processing progress for category structure changes specified with a SetStoreCategories request.	view
GetStoreCustomPage	Retrieves the custom page or pages for the user's Store.	view
GetStoreOptions	Retrieves the current list of Store configuration options.	view
GetStorePreferences	Retrieves a user's Store preferences.	view
GetSuggestedCategories	Requests a list of up to 10 categories with 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 for one eBay user. Input fields control what user data is returned.	view
GetUserContactDetails	Returns contact information for a specified user if a bidding relationship exists. Both sellers and bidders can use this call.	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 some or all of a user's preferences.	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
GetWantItNowPost	Retrieves data for a specific, active Want It Now post identified by a post ID.	view
GetWantItNowSearchResults	Retrieves a list of active Want It Now posts that match specified keywords and/or a specific category ID.	view
IssueRefund	Issues a refund for a single Half.com transaction.	view
LeaveFeedback	Enables a user to leave feedback about another user.	view
PlaceOffer	Enables the requesting user to submit a bid (make an offer) on the item listing specified in ItemID.	view
RelistItem	Enables a seller to take a single item (or a single multi-item listing) that ended without bidders or buyers and re-list it on a specified eBay site.	view
RemoveFromWatchList	Enables a user to remove item from his or her My eBay watch list.	view
RespondToBestOffer	Enables the seller of a Best Offer item to accept, decline, or counter offers made by bidders.	view
RespondToFeedback	Enables users to reply to feedback left by the other party in the transaction and/or follow up on the feedback left for the other party.	view
RespondToWantItNowPost	Enables a seller to respond to a Want It Now post with an item listed on the eBay site.	view
ReviseCheckoutStatus	Enables a seller to update the payment status of an item.	view
ReviseItem	Enables a seller to change the properties of a currently active listing.	view
ReviseLiveAuctionItem	Enables an eBay Live Auctions seller to modify a single lot item on the eBay Live Auctions site.	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.	view
ReviseMyMessagesFolders	Renames, removes, or restores specified My Messages folders for a given user.	view
RevokeToken	Voluntarily revokes a token before it would otherwise expire, typically because of security concerns or because the user has unsubscribed.	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 invoice to a buyer involved in the transaction.	view
SetCart	Enables a third party developer to create a new shopping cart in the eBay Express domain or to modify the contents of an existing shopping cart by adding or removing items or changing item quantity.	view
SetMessagePreferences	Enables a seller to add custom Ask Seller a Question (ASQ) subjects to display on the seller's Ask a Question page.	view
SetNotificationPreferences	Manages a user's notification preferences. This is part of the eBay Platform Notifications feature. Notification can be used to alert production applications of selected events on the eBay site, helping reduce the number of times your application needs to retrieve certain information.	view
SetPictureManagerDetails	Creates, updates, or deletes Picture Manager account settings, folders, or pictures.	view
SetPromotionalSale	Creates or modifies a promotional sale. Promotional sales enable sellers to apply discounts and/or free shipping across many listings.	view
SetPromotionalSaleListings	Used to change which item listings are affected by a promotional sale.	view
SetReturnURL	Configures your application's authentication and authorization preferences and other data, such as the URLs that eBay should redirect users to after they complete the authentication and authorization process.	view
SetShippingDiscountProfiles	Enables a seller to define shipping cost discount profiles and a few additional parameters related to combined payment, such as shipping insurance and packaging handling costs.	view
SetStore	Sets the configuration of the eBay store owned by the caller.	view
SetStoreCategories	Requests changes to the category structure for a store.	view
SetStoreCustomPage	Sets a custom page for 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 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.	view
ValidateTestUserRegistration	Requests to enable a test user to sell items in the Sandbox environment.	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
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

Limitations of This Document

The prototypes and tables do not yet 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. For example, if you are using the XML API, the RequesterCredentials node looks like this for most calls (except Auth & Auth calls):

<!-- Standard Input Fields -->
<RequesterCredentials>
  <eBayAuthToken>string</eBayAuthToken>
</RequesterCredentials>
... more standard input fields ...

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].