Skip to content
Eike Welk edited this page Jan 21, 2014 · 35 revisions

This wrapper intends to support all of these operations. The list if taken from eBay Developer site.

Legend:
:) : Developed
:| : Under development
:( : Not implemented not under development

Note: We won't be implementing Trading API and Large Merchant Services for now.

1. Finding API :)

Type: REST, SOAP, XML, support in Sandbox
getSearchKeywordsRecommendation: Get recommended keywords for search
findItemsByKeywords: Search items by keywords
findItemsByCategory: Search items in a category
findItemsAdvanced: Advanced search capabilities
findItemsByProduct: Search items by a product identifier
findItemsIneBayStores: Search items in stores
getHistograms: Get category and domain meta data

2. Shopping API :)

Type: REST, SOAP, XML. support in Sandbox

Item Search

  • FindProducts: Search for products on eBay via keyword or ProductID.
  • FindHalfProducts: Search for Half.com product-related information from the catalog via keywords and category based search.

Item Data

  • GetSingleItem: Simplified buyer specific view of item data
  • GetItemStatus: Retrieve changing item information towards the end of an auction
  • GetShippingCosts: Retrieve item shipping details
  • GetMultipleItems: Retrieve multiple item data in a single request.

User Reputation

  • GetUserProfile: Retrieve eBay user profile and feedback information.

eBay Pop!

  • FindPopularSearches: Retrieve popular and related search keywords by category or keyword.
  • FindPopularItems: Retrieve popular items by category

Search

  • FindReviewsandGuides: Search for reviews and guides by user, category or ProductID.

Utilities

  • GetCategoryInfo: Categories are used to group products in eBay. Return information about them.
  • GeteBayTime: Get the current time from the eBay server.

3. Best Match API :)

Type: SOAP, XML, Only Production, no sandbox env
Note: Only works on Production environment, so generate an access token for production.
findBestMatchItemDetailsAcrossStores: Returns Best Match information about items in eBay stores based on a specified set of keywords, a category ID, or both.
findBestMatchItemDetailsAdvanced: Returns Best Match information about items based on a specified set of keywords, a category ID, or both.
findBestMatchItemDetailsByCategory: Returns Best Match information about items based on a specified category ID.
findBestMatchItemDetailsByKeywords: Returns Best Match information about items based on a specified set of keywords.
findBestMatchItemDetailsByProduct: Returns Best Match information about items based on a specified product ID.
findBestMatchItemDetailsBySeller: Returns Best Match information about items associated with the authorized caller.
getBestMatchItemDetails: Returns Best Match information about items matching specified item ID values.
getVersion: Returns the version of the eBay Best Match Item Details server.

4. Merchandising API :)

Type: REST, SOAP, XML, Supported on sandbox
getDeals: Get the best deals on eBay (temporarily not functional)
getMostWatchedItems: Get items with the highest watch counts
getRelatedCategoryItems: Get items from related eBay categories
getSimilarItems: Get items that are similar to the specified item NEW!
getTopSellingProducts: Get the best selling products on eBay

5. Feedback API :)

Type: SOAP, XML, Only Production, no sandbox env. Use CAUTION WHILE TESTING
createDSRSummaryByCategory: Creates a seller's DSR summary report for sold items based on the categories they were listed in and a date range.
createDSRSummaryByPeriod: Creates a seller's DSR summary report for sold items based on a date range.
createDSRSummaryByShippingDetail: Creates a seller's DSR summary report for sold items based on shipping details for the items and a date range.
createDSRSummaryByTransaction: Creates a seller's DSR summary report for sold items specified with transaction information.
getDSRSummary: Retrieves a DSR report which had previously been created for specific criteria, such as a list of transactions, period of time, listing category, or shipping details.

6. Product API :|

Type: SOAP, REST, XML. support on sandbox
findCompatibilitiesBySpecification: Retrieves compatible applications for a product based on its specifications. findProducts: Finds products for a given category and search criteria. findProductsByCompatibility: Finds products for the specified category, catalog property name-value pairs, and compatibility property name-value pairs. getProductCompatibilities: Returns all available compatibility details for the specified product. getProductDetails: Retrieve product details for the specified product ID, including whether the product has fitment information or not.

7. Client Alerts API :)

Type: REST, SOAP, XML Support on Sandbox
GetPublicAlerts: Retrieves a list of public channel messages. Input should be in name-value pair format. GetUserAlerts: Retrieves alerts privately subscribed to by the user. Input should be in name-value pair format. Login: Logs the client application in to the client alerts server. All subsequent GetUserAlerts calls will require the SessionID returned by this call. The SessionData element returned by this call includes a timestamp to keep track of when alerts have been retrieved. Request should be in name- value pair format. Return will be in JSON. view Logout: Logs the client application out of the client alerts server. Input should be in name-value pair format. Output will be in JSON.

8. Platform Notification API :|

Type: SOAP, XML. Support on Sandbox
SetNotificationPreferences: Configure the application and user notification preferences including server end point and list of events to be notified about.
GetNotificationPreferences: Retrieve the configured notification preference values for a user.
GetNotificationsUsage: Retrieves information about platform notifications sent to a given application.

9. Resolution Case Management API :)

Type: SOAP, XML. supported on Sandbox
Case Retrieval Calls
getUserCases: Retrieve high-level information (including a case ID) of all cases for which the eBay User is involved. This includes all eBay Buyer Protection cases, Unpaid Item disputes, legacy (eBay and PayPal) disputes, and canceled transactions.
getEBPCaseDetail: Retrieve details of a specific eBay Buyer Protection case.

Seller Option Calls
provideTrackingInfo: Provide the tracking number and the name of the shipping carrier to the buyer.
issueFullRefund: Issue a full refund to the buyer.
offerOtherSolution: Offer the buyer an alternative solution to resolve the case.
escalateToCustomerSupport: Escalate an eBay Buyer Protection case to eBay customer support.
appealToCustomerSupport: Appeal the decision made by eBay customer support on an eBay Buyer Protection case.

Metadata Calls
getActivityOptions: Retrieve a list of the next available seller options based on the case type and the status of the case.
getVersion: Retrieve the current service version.

10. Research API :| - Production API is paid, Sandbox API is free

Details: http://developer.researchadvanced.com/pages/developers_area/ebay_research_api.html
http://developer.researchadvanced.com/
Type: REST
GetPriceResearch: Returns basic pricing statistics for a keyword and date range combination.

11. Trading API :(

Type: SOAP, XML
Now, this one is huge: http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/index.html

12. Large Merchant Services :(

Type: SOAP, XML
3 Types:
Merchant Data API Call Reference: http://developer.ebay.com/DevZone/merchant-data/CallRef/index.html
ActiveInventoryReport: Reports price and quantity details for a seller's active listings.
FeeSettlementReport: Contains information about user invoice and related order information, such as: fee type, fee amount, item category, order id, transaction id, item id, and item title.
OrderAck: Request that you use to acknowlege that an order has been received.
SetShipmentTrackingInfo: Specifies the shipment tracking information associated with one package of an order.
SoldReport: Contains information about the sold item, such as: order ID, buyer information, shipping information, order creation time, payment cleared time, tax amount, insurance cost, and total cost.

Bulk Data Exchange API Call Reference: http://developer.ebay.com/DevZone/bulk-data-exchange/CallRef/index.html
abortJob: Stops (aborts) processing the uploaded file.
abortRecurringJobExecution: Deletes the next instance of a recurring job
activateRecurringJob: Re-activates a recurring job that has been suspended
createRecurringJob: Creates a recurring Bulk Data Exchange Job
createUploadJob: Creates a Bulk Data Exchange Job and assigns it a job id and a file reference id
deleteRecurringJob: Deletes recurring job
getJobs: Lists Bulk Data Exchange jobs for this Seller ID
getJobStatus: Get job status for the provided job ID.
getRecurringJobExecutionHistory: Returns all instances of a recurring job that have occurred so far
getRecurringJobExecutionStatus: Check recurring job execution status
getRecurringJobs: Get all recurring jobs submitted by this seller
startDownloadJob: Begins processing the data for a report file the you will download
startUploadJob: Begins processing the data in the uploaded file
suspendRecurringJob: Stops the processing for a recurring job

File Transfer API Call Reference: http://developer.ebay.com/DevZone/file-transfer/CallRef/index.html
downloadFile: Transfers the report information from one of eBay's servers
uploadFile: Transfers a data file to one of eBay's servers