Skip to main content

Sell APIs

eBay's RESTful Sell APIs let you create applications that configure eBay seller accounts, define business policies, manage inventories and orders, market listings and review their performance:

  • Account API: Manage your business policies (such as seller's payment, shipping, and return policies), set tax tables, and check your seller privileges using the Account API. See Configuring seller accounts in the Selling Integration Guide.
  • Analytics API: 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.
  • Compliance API: Provides tools for validating listings to help sellers keep their listings in compliance with eBay’s policies.
  • Feed API: Manage your eBay business by downloading or uploading files, and creating schedules. The Feed API includes order management, customer service metrics, and scheduling resources. These resources have been designed to make a large merchant's workflow more efficient by leveraging eBay infrastructure to use parallel execution and to automatically retry on errors. See Using the sell Feed API in the Selling Integration Guide.
  • Finances API:Sellers in eBay's Managed Payments program retrieve seller payout information for their orders.
  • Fulfillment API: Manage the completion of an order in accordance with the payment method and timing specified at checkout. See Handling orders in the Selling Integration Guide.
  • Inventory API: Create and manage inventory item records, and then convert these inventory items into product offers on eBay marketplaces. See Managing inventory and offers in the Selling Integration Guide.
  • Listing API: Lets Partners create draft listings on eBay for their seller.
  • Logistics API: Get quotes for shipping rates and shipping labels for a range of shipping services, all priced with eBay-negotiated shipping rates, and to download shipping labels.
  • Marketing API: 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. See Marketing seller inventory in the Selling Integration Guide.
  • Metadata API: Retrieves eBay category policies and information on sales tax jurisdictions.
  • Negotiation API: Gives seller the ability to reach out and make a discount offer to buyers who have shown an interest in their item listings.
  • Recommendation API: Returns information that sellers can use to configure Promoted Listings ad campaigns.

Developers can also use the Taxonomy API (in the Commerce API context) for discovering the eBay item categories which best suit their item listings.

Developer API documentation and resources

eBay developer documentation consists of several sets of documentation, and the Developer API context makes use of the same documentation structure that's used across all eBay RESTful APIs.

RESTful API documentation

The Using eBay RESTful APIs guide sits atop all the RESTful documentation and describes how to format requests, configure the OAuth authorization needed for each request, handle errors, and more. Refer to this guide for all the details on making RESTful requests.

In addition to Using eBay RESTful APIs, each API also gets released with complete set of documentation that describes the details of API methods with samples and how-to information. The structure of each APIs documentation is outlined in the following table:

API Documentation

Document Title

Description

API Overview

The Overview for an API contains:

  • A general description of the API, with details on the resources supported by the API.
  • A list of the use cases that can be addressed with the API.
  • The list of requirements and restrictions that you need to be aware of when using the API.

Release Notes

Each API has a set of Release Notes that detail each major and minor release of the API.

API Reference

The API Reference for each API contains a index of the resources used by the API and the list of methods that act upon each resource.

Each method in the API has a method page that details the HTTP headers, OAuth scopes, and any parameters needed to make a request to the method. The page also details of request and response payloads, with descriptions of request and response objects and associated fields. The response information includes a list or error codes that can be returned plus details on the HTTP status codes returned in the response.

Each method page also contains one or more samples that shows the key inputs and outputs for the method.

Integration Guide

The Selling Integration Guide provides conceptual and how-to information for the main tasks performed by developers who code selling applications.

OpenAPI specs

Each API Reference has links to the OpenAPI specs that you can use to download the OpenAPI 2 or OpenAPI 3 contracts for the API in either YAML or JSON  formats. You can use these contracts to create application stubs in the language of your choice.

API Explorer

The API Explorer is a tool that you can use to quickly review request samples and make calls to the methods you're researching.

For details, see Using API Explorer.

Other resources

In addition to the above-mentioned documentation and resources, refer to the following resources for additional help: