Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business.
Resource URI (production)
|limit||string||The number of items, from the result set, returned in a single page. Range is from 10-100. If this parameter is omitted, the default value is used.|
Maximum: 100 items per page
|continuation_token||string||The continuation token for the next set of results. |
HTTP request headers
This request requires an access token created with either authorization code grant flow or client credentials grant flow. Please refer to the note below for more details.
The access token must be created using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
See OAuth access tokens for more information.
Note: An OAuth token created with the client credentials grant flow and the https://api.ebay.com/oauth/api_scope scope is required in order to create, update, or retrieve application-based subscriptions to notification topics. An OAuth token created with the authorization code grant flow and the https://api.ebay.com/oauth/api_scope/commerce.notification.subscription scope is required in order to create, update, or retrieve user-based subscriptions to notification topics.
|total||integer||The total number of matches for the search criteria. |
|href||string||The path to the call URI that produced the current page of results. |
|next||string||The URL to access the next set of results. This field includes a continuation_token. No prev field is returned, but this value is persistent during the session so that you can use it to return to the next page.|
This field is not returned if fewer records than specified by the limit field are returned.
|limit||integer||The value of the limit parameter submitted in the request, which is the maximum number of items to return per page, from the result set. A result set is the complete set of results returned by the method.|
Note: Though this parameter is not required to be submitted in the request, the parameter defaults to
|subscriptions||array of Subscription||The subscriptions that match the search criteria. |
|subscriptions.subscriptionId||string||The unique identifier for the subscription. |
|subscriptions.topicId||string||The unique identifier for the topic associated with this subscription. |
|subscriptions.status||SubscriptionStatusEnum||The status of this subscription. |
|subscriptions.creationDate||string||The creation date for this subscription. |
|subscriptions.payload||SubscriptionPayloadDetail||The payload associated with this subscription. |
|subscriptions.payload.format||FormatTypeEnum||The supported format. |
|subscriptions.payload.schemaVersion||string||The supported schema version. |
|subscriptions.payload.deliveryProtocol||ProtocolEnum||The supported protocol. For exmaple: |
|subscriptions.destinationId||string||The unique identifier for the destination associated with this subscription. |
For more on errors, plus the codes of other common errors, see Handling errors.
|195000||API_NOTIFICATION||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|195004||API_NOTIFICATION||REQUEST||Invalid limit. Supported ranges 10 - 100.|
|195005||API_NOTIFICATION||REQUEST||Invalid continuation token.|
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get subscriptions