Skip to main content

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 (production)

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

URI parameters

ParameterTypeDescription
limitstringThe 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.

Default: 20

Maximum: 100 items per page

Occurrence: Optional

continuation_tokenstringThe continuation token for the next set 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.

This method has no additional required headers. See HTTP request headers- opens rest request components page for details.

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

Response fields

Output container/fieldTypeDescription
totalinteger

The total number of matches for the search criteria.

Occurrence: Always

hrefstring

The path to the call URI that produced the current page of results.

Occurrence: Always

nextstring

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

limitinteger

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

subscriptionsarray of Subscription

The subscriptions that match the search criteria.

Occurrence: Conditional

subscriptions.subscriptionIdstring

The unique identifier for the subscription.

Occurrence: Conditional

subscriptions.topicIdstring

The unique identifier for the topic associated with this subscription.

Occurrence: Conditional

subscriptions.statusSubscriptionStatusEnum

The status of this subscription.

Occurrence: Conditional

subscriptions.creationDatestring

The creation date for this subscription.

Occurrence: Conditional

subscriptions.payloadSubscriptionPayloadDetail

The payload associated with this subscription.

Occurrence: Conditional

subscriptions.payload.formatFormatTypeEnum

The supported format.

Occurrence: Required

subscriptions.payload.schemaVersionstring

The supported schema version.

Occurrence: Required

subscriptions.payload.deliveryProtocolProtocolEnum

The supported protocol. For exmaple: HTTPS

Occurrence: Required

subscriptions.destinationIdstring

The unique identifier for the destination associated with this subscription.

Occurrence: Conditional

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.

StatusMeaning
200OK
400Bad Request
500Internal Server Error

Error codes

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

CodeDomainCategoryMeaning
195000API_NOTIFICATIONAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
195004API_NOTIFICATIONREQUESTInvalid limit. Supported ranges 10 - 100.
195005API_NOTIFICATIONREQUESTInvalid 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.