Skip to main content

Buy APIs

The Buy APIs let you create buying experiences outside of the site. Users can search for, select, and purchase eBay items. Sellers can mirror and curate the contents of the items in an eBay category, provide marketing information to buyers to encourage conversion, and track their orders, all from within your own site. The following are the Buy APIs:

  • Browse API: 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. It also provides the ability for eBay members to add and remove items and change the quantity of an item in their eBay shopping cart as well as view the contents of their eBay cart.
  • Deal API: Search for and retrieve details about eBay deals and events, as well as the items associated with those deals and events.
  • Feed API: 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.
  • Marketing API: Retrieve products based on category and metric, such as best selling, and 'also viewed" and 'also bought' products based on a product.
  •  Marketplace Insights API: Retrieve the sales history of items sold on eBay. (This is a Limited Release.)
  • Offer API: Place bids for a buyer on auction items and retrieve the bidding details for an auction where the buyer has placed a bid.
  • Order API: Open a checkout session (either as an eBay member or a guest), update orders, apply a coupon to the order, retrieve order, payment status, and shipment details, and pay for the order whether you are PCI compliant or not. For eBay member checkouts, it also provides legacy IDs to enable you to use the Post Order API for returns and cancellations.

Note: You can also use the Commerce Taxonomy API to discover and use appropriate categories to filter items retrieved by the Buy APIs.

Using eBay Buy API documentation

Buy API documentation consists of:

  • Using eBay RESTful APIs, an overview of how REST and OAuth authentication works and eBay's implementation of it
  • Documents for each Buy API:
    • API Overview
    • API Reference
    • Release Notes
    • OpenAPI JSON and YAML Specs
  • Buying Integration Guide, an overview and guide for how to use the Buy APIs in your application

When on a Buy API documentation page, use the four item horizontal menu just above the page's content to navigate in the Buy APIs documentation. The menu items are:

  • Start Here: Takes you to this page as does clicking on the BUY icon at the far left of the menu line
  • API Documentation: A menu of the Buy APIs. Clicking on any of them takes you to the API Overview page
  • Buying Integration: Takes you to the Buying Integration Guide landing page
  • Related Docs: A menu of associated documentation

API overviews

The overviews tell you:

  • What the API does
  • Why and when you will use the API
  • What restrictions and limitations apply

API references

The API references list all the methods for their respective API. Each method entry lists the following values:

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

API release notes

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

OpenAPI specs

The Buy APIs have links in the left navigation menu to download their OpenAPI specs, one in JSON format and one in YAML format.

Buying Integration Guide

The Buying Integration Guide provides a more detailed view of what the Buy APIs can do, and what you can build on top of them. This guide covers:

  • The functionality provided by each API and how to use them together.
  • Requirements for using the Buy APIs on the live eBay site.
  • How to use the Taxonomy API (which is part of the Commerce APIs, not the Buy APIs) to find what categories may have items your buyers are interested in. It includes an example, and an overview of other Taxonomy API uses.
  • An example that walks you through an application using the following capabilities, in each case describing what is happening and why, as well as showing a sample HTTP request and response.