Welcome to the eBay Features Guide
The eBay Features Guide is your first resource for understanding how to work with eBay APIs and the eBay Developers Program. The information provided here is intended to help you plan your web application by introducing the application development process, and describing the features and functionality that are available through eBay's web services.
How this Documentation is Organized
For more specific information about eBay's APIs, see the API References. Each set of API-specific reference pages includes a guide to making a call, tutorials, release notes, a Users Guide and a Call Reference. You can find links to all of the API References at the Documentation & Tools Center on the eBay Developers Program site.
eBay Developers Program Documentation & Tools
This documentation is updated for each release (see The eBay Developers Program Release Cycle). The release number for each API appears in the release notes and at the top of each page of the API's Call Reference.
Note: Throughout the eBay API documentation, you will occasionally encounter links that target pages you can see only if you're signed in to a particular eBay environment or site. If you're not signed in or you don't have an account on that site, you'll often be automatically redirected to a higher level page from which you can navigate to the appropriate signin page. Once signed in, the same links will now take you to the correct page. For more information, see About eBay Login Credentials.
We assume you are an eBay Developers Program member who is comfortable working with XML. This guide doesn't include general information about using XML.
Please see Third-Party Resources for additional information.
How this Documentation is Organized
This documentation is organized into several parts.
Welcome to the eBay Features Guide covers the following subjects:
- This Welcome page introduces the Features Guide.
- Product Overview introduces eBay's web services, SDKs, common use cases and types of applications you can build.
Basics and Concepts covers the following subjects:
- Understanding the eBay API discusses the APIs' basic building blocks, user roles, sites and environments, affiliate tracking and application planning.
- Making an API Call discusses system requirements, schema elements, routing, headers, error handling, the Java SDK, testing in the Sandbox, keys and tokens, going live, and some general best practices.
- Useful Information discusses third party resources and data types.
Developing Applications covers the following subjects:
- Adding Inventory discusses item categories, creating listings, describing items, custom item specifics, description templates, multi-variation listings, compatible parts, specialty areas (classified ads, real estate, digital downloads, event tickets and Want It Now posts), PayPal, special payment processes, and shipping.
- Managing Inventory discusses revising listings, relisting ended listings, conducting a sale, ending listings, tracking listing changes, tracking bidders, and using Selling Manager.
- Managing Sales and Orders discusses processing checkouts, completing the sale, second chance bidding, and feedback.
- Handling Disputes and Refunds discusses common selling and buying issues, the eBay Buyer Protection Program, seller and buyer disputes, and the Resolution Case Management API.
- Finding and Using Item Data discusses how to search for and retrieve item data.
- Customer Relationship Management discusses communications between members (sellers and buyers), working with user information, and My eBay data.
- Specialty and International Sites discusses eBay stores, eBay Motors, Half.com, and international differences between eBay sites (value-added tax, B2B selling in Europe and field differences).
Platform Notifications covers the following subjects:
In addition to the information in this guide, detailed information about each property in the Trading API is provided in the eBay Trading API Reference. This reference document describes the standard and call-specific input and output fields for Trading API calls. See:
eBay Trading API Reference
The eBay Trading API Reference also contains a Type Index page that contains links to all complex and enumerated data type definitions. In addition to defining the type, each Type HTML page contains all fields (with descriptions) of the type, as well as all calls and parent types that use that type. The Type Index can be useful if you are using an eBay SDK and you want to map the types in the schema to classes in the SDK. However, note that some calls only use a subset of the fields defined on a type (that's why you usually need to look at the "Call" view of the schema). See:
The Errors by Number documentation lists all of the error messages that could be encountered when invoking eBay Web services. The information for each error includes: error code, error severity, short error string, and long error string. All error messages are supplied only in English, but the error codes can be used as an index for a structure, array, or string table to supply messages in whatever language is desired. See:
Errors by Number
Some codes that identify listing types appear in the response when you retrieve a listing, but you cannot specify them in requests. See Code Lists for information about the notation we use to identify these cases.
When the rules for a given property are not the same for all calls, the rules are described in the documentation.
In this guide, we use the following typographic conventions:
Typographic Conventions Used in this Documentation
||Language- and protocol-independent references to call names, data types and fields; for example: "Use AddItem to list an item on an eBay site."
||Association or containment relationship; for example, Item.ShippingDetails means we are referring to the ShippingDetails field of the Item object.
|Literal values and messages, as well as snippets of sample code; for example: "Specify a listing type of
FixedPriceItem when you list an item on the eBay site."
||New terms; for example: "The Store Inventory format lets sellers list items with longer durations and lower insertion fees." Also indicates a placeholder value (variable) in code syntax.
Copyright © 2005–2014 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.