Just getting started with the Notification API? See the following documents for details on using this API:
- Buying Integration Guide
- Selling Integration Guide
- Using eBay RESTful APIs
- Notification API Overview
- Notification API Reference
The API release history
The following table lists the releases for the Notification API:
| Version | Release Date | Summary of Release |
|---|---|---|
|
2024-09-12 |
Enabled sandbox support. |
|
|
2024-08-05 |
Added notification topics: Seller Customer Service Metric Rating and Seller Standards Profile Metrics |
|
|
2023-12-14 |
Added new error codes to createSubscriptionFilter method |
|
|
2023-06-07 |
Added one new notification topic: Priority Listing Revision |
|
|
2023-03-14 |
Added three new methods: createSubscriptionFilter, getSubscriptionFilter, deleteSubscriptionFilter |
|
|
2022-11-01 |
Added two notification topics: Item Availability and Item Price Revision |
|
|
2021-09-15 |
Enabled the authorization code grant flow for user-based subscriptions in the subscription resource methods |
|
|
2021-06-30 |
Added four new resources |
|
|
2021-03-22 |
Initial release of Version 1.0.0 |
Version 1.6.1
This release adds sandbox support for all methods in the Notification API. To access the sandbox endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com. Support was also added to the API explorer.
Version 1.6.0
This release adds two notification topics. See Select a notification topic for additional information.
- SELLER_CUSTOMER_SERVICE_METRIC_RATING: This notification is sent to sellers to inform them about critical changes to their customer service metrics performance (this includes proactive warnings when their service metrics are trending towards 'very high'). The payload for this notification is similar to the Analytics API getCustomerServiceMetric method.
- SELLER_STANDARDS_PROFILE_METRICS: This notification is sent to sellers to inform them about critical changes to their seller performance metrics and seller level (this includes proactive warnings when their performance metrics are close to the threshold that could change the seller's standard level). The payload for this notification is similar to the Analytics API findSellerStandardsProfiles method.
Version 1.5.1
Adds two error codes to the createSubscriptionFilter method. See Creating a subscription filter for a topic for additional information.
| Code | Meaning |
|---|---|
| 195032 | The specified subscription topic is not filterable. |
| 195033 | The specified 'filterSchema' value is invalid. |
Version 1.5.0
This release adds the following new notification topic:
- PRIORITY_LISTING_REVISION: Developers who are subscribed to this topic receive a push notification when their Priority Listing has been revised.
Version 1.4.0
This release adds three new methods: createSubscriptionFilter, getSubscriptionFilter, and deleteSubscriptionFilter.
- createSubscriptionFilter: This method allows applications to create a filter for a subscription. Filters allow applications to only send notifications when they match a provided criteria.
- getSubscriptionFilter: This method allows applications to retrieve the filter details for the specified subscription filter.
- deleteSubscriptionFilter: This method allows applications to disable an active filter on a subscription.
A new field, filterable, has been added to in the getTopic response to indicate if the topic is filterable or not.
A new field, filterId, has been added to the getSubscription response that holds the id of the filter applied to the subscription.
Version 1.3.0
This release adds two notification topics: ITEM_AVAILABILITY and ITEM_PRICE_REVISION. These topics are currently available only for fixed-price items on the eBay UK marketplace.
- ITEM_AVAILABILITY: Developers who are subscribed to this topic receive a push notification when an item's availability type changes. Availability types include Available, Unavailable, and Temporarily Unavailable.
- ITEM_PRICE_REVISION: Developers who are subscribed to this topic receive a push notification when an item's price changes.
Version 1.2.0
This release adds the following new OAuth authorization code scopes to the subscription resource in order to support user-based subscriptions:
https://api.ebay.com/oauth/api_scope/commerce.notification.subscription
https://api.ebay.com/oauth/api_scope/commerce.notification.subscription.readonly
These new scopes enable the creation of user-based subscriptions to notification topics using the authorization code grant flow. When creating user-based subscriptions, the new scopes must be included when the OAuth token is minted.
Similarly, when retrieving subscriptions using the getSubscription or getSubscriptions method, the appropriate scopes must be included in the OAuth token in order to view application-based (using the client credentials grant flow) or user-based (using the authorization code grant flow) subscriptions for a topic.
Tip: See the Notification overview page for more information about how subscription services work.
Version 1.1.0
This release adds the following new resources to the Notification API:
- topic - This resource enables users to browse supported notification topics and retrieve details for those topics.
- config - This resource enables users to create, update, and retrieve alert configuration details.
- destination - This resource enables users to create and manage the destination endpoints that will receive notifications.
- subscription - This resource enables users to create, manage, and test their notification subscriptions.
Tip: See the Notification overview page for more information about how these new methods can be used to manage eBay notification preferences.
Version 1.0.0
This is the initial release of the Notification API, Version 1.0.0. For a list of the new resource and methods, see the Notification API Reference.