Shopping API
Information about the schema location is in the Schema Location section of the Making an API Call topic.
Are you just getting started with the Shopping API? The following describes how to join the eBay Developers Program:
| Release Version | Release Date | Description of Release | |
|---|---|---|---|
| 1157 | 2020-06-05 | Added Support for OAuth Tokens | |
| 1145 | 2020-03-13 | Updates to Charity-related documentation | |
| 1139 | 2020-01-31 | Postal codes masked in GetSingleItem/GetMultipleItems except to sellers |
For older release notes, see the Release Notes archive.
Documentation Changes and Errata - 1157
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
No schema changes in this release.
Instead of passing in an App ID through the appid URL parameter or through the X-EBAY-API-APP-ID HTTP header, a developer can now use the new X-EBAY-API-IAF-TOKEN HTTP header to pass in an OAuth application access token. See the The client credentials grant flow topic for more information on generating and managing OAuth application access tokens.
Note: Starting on July 1, 2021, developers using Shopping API calls must authenticate with an OAuth application access token using the X-EBAY-API-IAF-TOKEN HTTP header, as both the appid query parameter and X-EBAY-API-APP-ID HTTP header will be deprecated on June 30, 2021. Developers should start making plans at their earliest convenience to migrate to using OAuth application access tokens with https://api.ebay.com/oauth/api_scope scope.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1157.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1157 and Changed Functionality - 1157.
Updated return policy-related documentation to make it more clear that if a seller does not add a separate international return policy for an item, the settings in the domestic return policy will be used instead. For more information, see the ReturnPolicy container in GetSingleItem call.
Documentation Changes and Errata - 1145
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
Enumeration note: You need to use this release version or higher to retrieve new code list values that were added in this release. See Code Lists.
No schema changes in this release.
See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.
The CharityNumber field returned in GetSingleItem and GetMultipleItems has been scheduled for deprecation. It is the CharityID value that should be used instead if the user wishes to retrieve more details on a nonprofit organization by using the Trading API's GetCharities call, or used by a seller in an Add/Revise/Relist call when they want to identify the nonprofit organization that will receive sale proceeds for a listing.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1145.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
None for this release.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1145 and Changed Functionality - 1145.
Updated the CharityID and CharityNumber field descriptions to make it clear that CharityID is the eBay-assigned unique identifier for an eBay for Charity organization, and CharityNumber is the PayPal Giving Fund identifier. It is the CharityID value that should be used to identify a charity organization in an Add/Revise/Relist or GetCharities call in Trading API
Documentation Changes and Errata - 1139
For a current list of known issues, see Site Status Updates and the Knowledge Base.
These calls were added, modified, deprecated, or affected by documentation changes in this release. The changes are described below as well as in each call's Change History.
No new calls in this release.
None for this release.
See the Site Status Updates for bug fixes related to this release.
This section describes new features that have been added as of this release. New features can involve new calls, new capabilities, and/or new fields added to existing calls.
For logical or functional changes to existing features and calls, including code list changes, see Changed Functionality - 1139.
None for this release.
This section describes logical or functional changes that have been made to existing functionality, including new code list values and/or changes in validation rules.
Postal code values returned in the Item.PostalCode field of GetSingleItem/GetMultipleItems will be masked to all users except for the seller of the item. Different countries will mask postal/zip codes in slightly different ways, but an example would be 951**.
This section lists additional documentation changes and corrections that were made with this release and that are not already mentioned in New Features - 1139 and Changed Functionality - 1139.
Added site-specific max length values for several address-related fields (in AddressType), including Street1, Street2, CityName, StateOrProvince, and PostalCode. For all five of these fields, the max lengths according eBay marketplace are shown:
Copyright © 2007–2021 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.