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. They let you create applications that handle the full selling life cycle of:

  • Purchasing or adding inventory
  • Marketing inventory via Promoted Listings and promotions
  • Processing orders
  • Tracking sales performance
  • Managing inventory levels
  • Improving peformance via traffic and sales reports and analysis

eBay Sell APIs

There are six eBay Sell APIs, all REST based.

  • Account API: Manage business policies, such as seller's payment, shipping, and return policies. Also set tax tables and check your seller privileges
  • Analytics API: Provides data on a seller's business performance
  • Fulfillment API: Manage and/or facilitate fulfilling an order including payment and shipping
  • Inventory API: Create and manage product offers
  • Marketing API: Manage the life cycle of item promotions and promoted listings and generate reports
  • Metadata API: Retrieve sales tax jurisdictions

Selling applications also use an eBay Commerce API, the Taxonomy API, for discovering and applying eBay item categories.

Using Sell API documentation

Sell API documentation consists of:

When on a Sell API documentation page in eBay Developers Program documentation, overall Sell APIs navigation is done via a four item horizontal menu just above the page's content. The menu items are:

API overviews

The Account, Analytics, Fulfillment, Inventory, Marketing, and Metadata API overviews (links are to the individual overviews) tell you:

  • What the API does
  • Why and when you will use the API
  • What constraints are on the API usage

API references

The Account, Analytics, Fulfillment, Inventory, Marketing, and Metadata API references (links are to the individual resource references) list all the calls for their respective API. Each call entry lists the following values:

  • Input (Request content)
    • Resource URI (production)
    • URI parameters
    • HTTP request headers
    • OAuth request scope
    • Payload model
    • Request fields
  • Output (Response content)
    • Response headers
    • Payload model (all fields and their types that could be including in the response)
    • Description and data type of each response field and type, including constraints and requirements
    • HTTP status codes
    • Error codes
  • Samples (Request/Response example)

API release notes

The Account, Analytics, Fulfillment, Inventory, Marketing, and Metadata API release notes (links to the individual release notes) start with a table listing for each release of that API:

  • Release version, linked to the more detailed description of it later in the release notes
  • Release date
  • Short summary of what changed in the release

Each release is then described in detail, starting with the most recent. Each change, addition, or deletion is described under its own subheading.

Selling Integration Guide

The Selling Integration Guide provides a more detailed view of what the Sell APIs can do, and what you can build on top of them.

How to develop a selling application

This section describes the life cycle and process steps for developing eBay selling applications. It covers:

  • Registering as an eBay developer
  • Overview of Using eBay RESTful APIs
  • Registering your application
  • Using the eBay Checklist for Going Live
  • Overview of what you'll need to code to create your application
  • Testing, going live in Production, and using eBay Techincal Support

Configuring eBay seller accounts with the Account API

This section covers how to configure, customize, and manage eBay selling accounts. You can:

  • Check your account's active/inactive status and its selling limits
  • Set and manage payment, fulfillment, and return business policies
  • Get a list of sales tax jurisdictions for a country and set up sales tax tables for different jurisdictions
  • Opt-in to the eBay out of stock control and selling policy management programs

Finding categories for listings or promotions with the Taxonomy API.

This section describes how to use the Taxonomy API to determine under what category to list or promote an item. The Taxonomy API is part of the Commerce APIs, not the Sell APIs, but is used when writing both selling and buying applications. The workflow is:

  • Identify the default category tree for your marketplace
  • Get suggested leaf categories from the marketplace category tree
  • If the suggested categories aren't acceptable, get the whole category tree and go through it with your seller

Managing your inventory with the Inventory API

This section describes using the Inventory API to create and manage offers on eBay marketplaces. It covers:

  • Inventory API's major components
  • The process flow of publishing a single variation offer, from creating an item record to creating and publishing an offer
  • Managing inventory locations
  • Creating and managing inventory item groups
  • Doing bulk quantity and price updates
  • Retrieving expected listing fees
  • Managing inventory items, including getting, updating, and deleting them
  • Managing offers, including updating, publishing, retrieving, and deleting them

Handle orders with the Fulfillment API

This section describes using the Fulfillment API to help with packaging, addressing, handling, and shipping orders. It covers:

  • API objects used in the fulfillment process and their relationships
  • Determining which orders have not been fulfilled
  • Ensuring all of an order's line items are fulfilled
  • Managing order fulfillments

Marketing seller inventory and highlighting listings with the Marketing API

This section describes how to use the Marketing API to:

  • Highlight listings by adding them to a Promotions Manager promotion or Promoted Listings campaign
  • Manage your promotion and campaign lifecycles

Grow your business using information from the Analytics API

This section describes how to use the Analytics API to generate two reports:

  • Seller performance
  • A listings traffic report

Related documents