getSubscriptions: eBay Notification API

GET/subscription

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.

Input

Resource URI

GET https://api.ebay.com/commerce/notification/v1/subscription?

limit=string&

continuation_token=string

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

Parameter	Type	Description
limit	string	The maximum number of subscriptions to return per page from the result set. Min: 10 Max: 100 Default: 20 Occurrence: Optional
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. Occurrence: Optional

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.

OAuth scope

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):

https://api.ebay.com/oauth/api_scope

https://api.ebay.com/oauth/api_scope/commerce.notification.subscription.readonly

https://api.ebay.com/oauth/api_scope/commerce.notification.subscription

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.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

This call has no response headers.

Response payload

Copy complete valid JSON to clipboard

{ /* SubscriptionSearchResponse */

"href" : "string",

"limit" : "integer",

"next" : "string",

"subscriptions" : [

{ /* Subscription */

"creationDate" : "string",

"destinationId" : "string",

"filterId" : "string",

"payload" :

{ /* SubscriptionPayloadDetail */

"deliveryProtocol" : "ProtocolEnum : [HTTPS]",

"format" : "FormatTypeEnum : [JSON]",

"schemaVersion" : "string"

"status" : "SubscriptionStatusEnum : [ENABLED,DISABLED]",

"subscriptionId" : "string",

"topicId" : "string"

}

"total" : "integer"

}

Response fields

Output container/field	Type	Description
href	string	The path to the call URI that produced the current page of results. Occurrence: Always
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 `20` if omitted. Default: 20 Occurrence: Always
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. Occurrence: Conditional
subscriptions	array of Subscription	The subscriptions that match the search criteria. Occurrence: Conditional
subscriptions.creationDate	string	The creation date for this subscription. Occurrence: Conditional
subscriptions.destinationId	string	The unique identifier for the destination associated with this subscription. Occurrence: Conditional
subscriptions.filterId	string	The unique identifier for the filter associated with this subscription. Occurrence: Conditional
subscriptions.payload	SubscriptionPayloadDetail	The payload associated with this subscription. Occurrence: Conditional
subscriptions.payload.deliveryProtocol	ProtocolEnum	The supported delivery protocol of the notification topic. Note: `HTTPS` is currently the only supported delivery protocol of all notification topics. Occurrence: Required
subscriptions.payload.format	FormatTypeEnum	The supported data format of the payload. Note: JSON is currently the only supported format for all notification topics. Occurrence: Required
subscriptions.payload.schemaVersion	string	The supported schema version for the notification topic. See the supportedPayloads.schemaVersion field for the topic in getTopics or getTopic response. Occurrence: Required
subscriptions.status	SubscriptionStatusEnum	The status of this subscription. Occurrence: Conditional
subscriptions.subscriptionId	string	The unique identifier for the subscription. Occurrence: Conditional
subscriptions.topicId	string	The unique identifier for the topic associated with this subscription. Occurrence: Conditional
total	integer	The total number of matches for the search criteria. Occurrence: Always

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.

Status	Meaning
200	OK
400	Bad Request
500	Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

Code	Domain	Category	Meaning
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.

Warnings

This call has no warnings.

Samples

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.

Input

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.

GEThttps://api.ebay.com/commerce/notification/v1/subscription

Output

The output is an array of subscriptions and their details such as the subscriptionId, topicId, status, creationDate, payload, and destinationId.