Reference
CAUTION
This is an experimental eBay SDK in an early alpha stage. Not all APIs have been fully tested or can be tested due to user, marketplace, country restrictions, or sandbox limitations. While the SDK should be usable, breaking changes may occur at any time, including minor releases.
Events
- Package Events: SDK exposed Laravel Events
- eBay Notifications: eBay Notifications pushed as Laravel Events
Buying APIs
| API-Reference | Description | eBay |
|---|---|---|
| BrowseAPI | Search for and retrieve eBay items and use filters and parameters to create customized item sets. Search by image ID (a Base64 string) and check if a product is compatible with the specified item, such as if a specific car is compatible with a specific part or search for a compatible part. | |
| CatalogAPI | Search the eBay catalog for products on which to base a seller's item listing, retrieve a product record by its eBay product identifier (ePID). | |
| DealAPI | Search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events. | |
| FeedAPI | Use metadata methods to see what feed types and feed files you have access to, and then download the feed files you want. | |
| FeedBetaAPI | Download daily files containing newly listed items or weekly bootstrap files containing all the items in a category. Download an hourly file of items that have changed in a category during that hour. | |
| IdentityAPI | Retrieve account profile information for an authenticated user. | |
| MarketingAPI | Returns an array of products based on the category and metric specified. This includes details of the product, such as the eBay product ID (EPID), title, and user reviews and ratings for the product. In addition, retrieve items with the highest watch counts in a specific category. | |
| MarketingBetaAPI | Returns an array of products based on the category and metric specified. This includes details of the product, such as the eBay product ID (EPID), title, and user reviews and ratings for the product. | |
| OfferAPI | Place bids for a buyer on auction items and retrieve the bidding details for an auction where the buyer has placed a bid. | |
| OrderAPI | Open a guest checkout session, update orders, apply a coupon to the order, retrieve order, payment status, and shipment details, and pay for the order. For eBay member checkouts, it also provides legacy IDs to enable you to use the Post Order API for returns and cancellations. | |
| TaxonomyAPI | Discover appropriate categories to filter listings retrieved by the Buy APIs, or determine the best category in which to offer an item for sale and determine what categories to include in campaigns or promotions with the Sell APIs. | |
| TranslationAPI | DTranslate common commerce content, such as the title and description of an item to help present marketplace listings to buyers in different countries or regions. The Translation API takes foreign language search queries from the buyer and translates them for the target marketplace, as well. |
Developer APIs
| API-Reference | Description | eBay |
|---|---|---|
| AnalyticsAPI | Provides call-limit and call usage data. | |
| ClientRegistrationAPI | Registers a new third-party financial application with eBay. | |
| KeyManagementAPI | Creates encrypted keypairs that are required when creating digital signatures for eBay APIs which access confidential financial information. |
Selling APIs
| API-Reference | Description | eBay |
|---|---|---|
| AccountAPI (v1) | Manage your business policies and custom policies, manage your shipping rate tables and sales tax tables, opt in and out of selling programs, and check your seller privileges using the Account API v1. | |
| AccountAPI (v2) | Provides advanced tools for managing and updating custom shipping rate tables. | |
| AnalyticsAPI | Provides information about an individual seller’s business performance through different report and data gathering resources including customer service metrics, traffic reports, and seller profiles. See Analyzing seller performance in the Selling Integration Guide. | |
| CatalogAPI | Search the eBay catalog for products on which to base a seller's item listing, retrieve a product record by its eBay product identifier (ePID). | |
| ComplianceAPI | Provides tools for validating listings to help sellers keep their listings in compliance with eBay’s policies. | |
| FeedAPI | Manage your eBay business by downloading or uploading inventory, order, and customer service metric files, and creating schedules. This API is designed to make a large merchant's workflow more efficient by leveraging eBay infrastructure to use parallel execution and to automatically retry on errors. | |
| FeedbackAPI | Allows users to manage feedback across buying and selling activities. | |
| FinancesAPI | Retrieve detailed information on seller payouts for eBay orders, and also retrieve details on all monetary transactions on eBay's system between the seller, buyer, and eBay. These transactions include sales, buyer refunds, seller credits, payment disputes, shipping label purchases, and non-sales related charges to the seller's account. | |
| FulfillmentAPI | Retrieve and fulfill orders, issue refunds, and manage third-party payment disputes initiated by buyers. See Handling orders in the Selling Integration Guide. | |
| IdentityAPI | Retrieve account profile information for an authenticated user. | |
| InventoryAPI | Create and manage inventory item records, and then convert these inventory items into product offers on eBay marketplaces. | |
| LeadsAPI | Use this API to retrieve and respond to purchase offers, and retrieve sales leads from classified ads. | |
| MarketingAPI | Provides the ability to offer appealing discounts and eye-catching ad placements that display in key spots throughout the eBay buying flows; manages the life cycle of item promotions and promoted listings, and generates reports. | |
| MediaAPI | Create videos and documents which can be attached to listings. | |
| MessageAPI | Send messages, retreive conversations, and modify the status of conversations. | |
| MetadataAPI | CRetrieves eBay category policies and information on sales tax jurisdictions. | |
| NegotiationAPI | Gives seller the ability to reach out and make a discount offer to buyers who have shown an interest in their item listings. | |
| NotificationAPI | Explore, subscribe to, and process eBay notifications. | |
| RecommendationAPI | Returns information that sellers can use to configure Promoted Listings ad campaigns. | |
| StoresAPI | Manage a store's category hierarchy. | |
| TaxonomyAPI | Discover appropriate categories to filter listings retrieved by the Buy APIs, or determine the best category in which to offer an item for sale and determine what categories to include in campaigns or promotions with the Sell APIs. | |
| TranslationAPI | Translate common commerce content, such as the title and description of an item to help present marketplace listings to buyers in different countries or regions. The Translation API takes foreign language search queries from the buyer and translates them for the target marketplace, as well. |