This method allows applications to retrieve a list of all subscriptions. The list returned is a paginated collection of subscription resources.
Subscriptions allow applications to express interest in notifications and keep receiving the information relevant to their business.
This method is not supported in Sandbox environment.
|limit||string||The maximum number of subscriptions to return per page from the result set.|
|continuation_token||string||This string value can be used to return the next page in the result set. The string to use here is returned in the next field of the current page of results. |
HTTP request headers
All requests made to eBay REST operations require you to provide the
Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
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.
This call has no payload.
This call has no field definitions.
HTTP response headers
This call has no response headers.
The total number of matches for the search criteria.
The path to the call URI that produced the current page of results.
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.
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.
|subscriptions||array of Subscription|
The subscriptions that match the search criteria.
The unique identifier for the subscription.
The unique identifier for the topic associated with this subscription.
The status of this subscription.
The creation date for this subscription.
The payload associated with this subscription.
The supported data format of the payload.
The supported schema version for the notification topic. See the supportedPayloads.schemaVersion field for the topic in getTopics or getTopic response.
The supported delivery protocol of the notification topic.
The unique identifier for the destination associated with this subscription.
The unique identifier for the filter associated with this subscription.
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
|500||Internal Server Error|
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.|
This call has no warnings.
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
This method retrieves an array containing the details and status of all subscriptions limited by the authorization scope.
The input specifies the optional limit and continuation_token query parameters. Since no limit is specified in this request, the default value of
20 is used.
The output is an array of subscriptions and their details such as the subscriptionId, topicId, status, creationDate, payload, and destinationId.