notification APIv1.2.0

getTopics

GET
/topic
This method returns a paginated collection of all supported topics, along with the details for the topics. This information includes supported schema versions, formats, and other metadata for the topics.

Applications can subscribe to any of the topics for a supported schema version and format, limited by the authorization scopes required to subscribe to the topic.

A topic specifies the type of information to be received and the data types associated with an event. An event occurs in the eBay system, such as when a user requests deletion or revokes access for an application. An event is an instance of an event type (topic).

Input

Resource URI (production)

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

URI parameters

ParameterTypeDescription
limitstringThe 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. 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 token used to access 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.

OAuth scope

This request requires an access token created with the client credentials grant flow, 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

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
totalintegerThe total number of matches for the search criteria.

Occurrence: Always

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

Occurrence: Always

nextstringThe 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

limitintegerThe 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.

Occurrence: Always

topicsarray of TopicAn array of topics that match the specified criteria.

Occurrence: Conditional

topics.topicIdstringThe unique identifier for the topic.

Occurrence: Always

topics.descriptionstringThe description of the topic.

Occurrence: Always

topics.authorizationScopesarray of stringThe authorization scopes required to subscribe to this topic.

Occurrence: Conditional

topics.statusStatusEnumThe status of this topic.

Occurrence: Always

topics.contextContextEnumThe business context associated with this topic.

Occurrence: Always

topics.scopeScopeEnumThe scope of this topic.

Occurrence: Always

topics.supportedPayloadsarray of PayloadDetailThe supported payloads for this topic.

Occurrence: Conditional

topics.supportedPayloads.schemaVersionstringThe supported schema version.

Occurrence: Conditional

topics.supportedPayloads.formatarray of FormatTypeEnumThe supported format. Presently, JSON is the only supported format.

Occurrence: Always

topics.supportedPayloads.deliveryProtocolProtocolEnumThe supported delivery protocols.

Occurrence: Always

topics.supportedPayloads.deprecatedbooleanA deprecation indicator.

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.

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

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 topics

This method allows applications to browse the details and status of supported topics.

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.
GET
https://api.ebay.com/commerce/notification/v1/topic

Output

If the call is successful, the results including the following fields are returned: topicId, description, status, context, scope, and supportedPayloads (including format, schemaVersion, deliveryProtocol, and deprecated).