Client Alerts API
Note: All methods of the Client Alerts API will be decommisioned on May 31, 2023. The alternative for this API is Platform Notifications, which supports all notification event types supported by Client Alerts API.
For anyone that is not familiar with Platform Notifications, we recommend that you read the Platform Notifications Guide to get started.
Are you just getting started with the Client Alerts API? The following documents describe how to join the eBay Developers Program and get started with the Client Alerts API:
Information about the schema location is in the Schema Location.
|
For older release notes, see the Release Notes archive.
Documentation Changes and Errata - 777
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.
| Name | Part of Schema | Type of Change |
|---|---|---|
AskSellerQuestionEventType.Title |
Element | New |
ItemMarkedPaidEventType.Title |
Element | New |
ItemMarkedShippedEventType.Title |
Element | New |
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 - 777.
The item title is now returned in the following Client Alerts event types in the GetUserAlerts call:
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 - 777 and Changed Functionality - 777.
None for this release.
Documentation Changes and Errata - 775
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.
No changed 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.
| Name | Part of Schema | Type of Change |
|---|---|---|
ClientAlertsEventType.BestOffer |
Element | New |
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 - 775.
If BestOffer is tagged in GetPublicAlerts as an event type to retrieve, it is sent to a seller when a bidder makes a best offer on an item opted into the Best Offer feature by the seller.
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 - 775 and Changed Functionality - 775.
None for this release.
For a current list of known issues, see Site Status Updates and the Knowledge Base.
| Name | Part of Schema | Type of Change |
|---|---|---|
SimpleUserType |
Complex type | Reserved for future use |
SellerBusinessCodeType |
Enumerated type | Reserved for future use |
SellerLevelCodeType |
Enumerated type | Reserved for future use |
SiteCodeType |
Enumerated type | Reserved for future use |
SortOrderCodeType |
Enumerated type | Reserved for future use |
UserStatusCodeType |
Enumerated type | Reserved for future use |
New types were added to the schema, but none are used by Client Alerts at this time.
No new calls in this release.
No changed calls in this release.
Documentation Changes and Errata - 691
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.
No changed 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.
| Name | Part of Schema | Type of Change |
|---|---|---|
ClientAlertsTransactionType.OrderLineItemID |
Element | New |
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 - 691.
Note that this feature is only available if you set your request version to 705. It is eBay's recommendation to test the use of this field in Sandbox before implementing it in production code.
OrderLineItemID field introduced in Trading API calls that use ItemID and TransactionID. OrderLineItemID is a concatenation of ItemID and TransactionID with a hyphen in between these two IDs. For Trading calls that take ItemID and TransactionID as input, OrderLineItemID can be used as a replacement for these two fields.
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 - 691 and Changed Functionality - 691.
None for this release.
Documentation Changes and Errata - 677
For a current list of known issues, see Site Status 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.
No changed 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 - 677.
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 - 677 and Changed Functionality - 677.
None for this release.
Documentation Changes and Errata - 675
For a current list of known issues, see Site Status 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 Statue 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 - 675.
A new event alert for sellers, ItemListed, is added for GetUserEvents. This alert confirms to a seller that an item has been listed successfully.
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 - 675 and Changed Functionality - 675.
None for this release.
Documentation Changes and Errata - 665
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.
No changed 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.
As of this release, Client Alerts Release Notes will no longer be released for every version. Release Notes will only appear when Client Alerts functionality changes or when there is an announcement about Client Alerts. As a result, you may see version numbers in your Client Alerts calls that are later than the version of these release notes.
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 - 665.
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 - 665 and Changed Functionality - 665.
None for this release.
Documentation Changes and Errata - 663
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.
No changed 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 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 - 663.
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 - 663 and Changed Functionality - 663.
None for this release.
Documentation Changes and Errata - 661
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.
No changed calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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 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 - 661.
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 - 661 and Changed Functionality - 661.
None for this release.
Documentation Changes and Errata - 659
For a current list of known issues, see Site Status 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.
No changed 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 - 659.
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 - 659 and Changed Functionality - 659.
None for this release.
Documentation Changes and Errata - 657
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.
No changed calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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 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 - 657.
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 - 657 and Changed Functionality - 657.
None for this release.
Documentation Changes and Errata - 655
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.
No changed calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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 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 - 655.
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 - 655 and Changed Functionality - 655.
None for this release.
Documentation Changes and Errata - 653
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.
No changed calls in this release.
Schema changes in pink (for example, SomeType.Somedata) are for future use. Monitor upcoming release notes for descriptions of their purpose and use.
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 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 - 653.
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 - 653 and Changed Functionality - 653.
None for this release.
No 651 schema was released.
No new calls in this release.
No changed calls in this release.
Copyright © 2008–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.