notification APIv1.2.0

getTopic

GET
/topic/{topic_id}
This method allows applications to retrieve details for the specified topic. This information includes supported schema versions, formats, and other metadata for the topic.

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

Specify the topic to retrieve using the topic_id URI parameter.

Note: Use the getTopics method to find a topic if you do not know the topic ID.

Input

Resource URI (production)

GET https://api.ebay.com/commerce/notification/v1/topic/{topic_id}

URI parameters

ParameterTypeDescription
topic_idstringThe ID of the topic for which to retrieve the details.

Occurrence: Required

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
topicIdstringThe unique identifier for the topic.

Occurrence: Always

descriptionstringThe description of the topic.

Occurrence: Always

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

Occurrence: Conditional

statusStatusEnumThe status of this topic.

Occurrence: Always

contextContextEnumThe business context associated with this topic.

Occurrence: Always

scopeScopeEnumThe scope of this topic.

Occurrence: Always

supportedPayloadsarray of PayloadDetailThe supported payloads for this topic.

Occurrence: Conditional

supportedPayloads.schemaVersionstringThe supported schema version.

Occurrence: Conditional

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

Occurrence: Always

supportedPayloads.deliveryProtocolProtocolEnumThe supported delivery protocols.

Occurrence: Always

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
404Not Found
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.
195002API_NOTIFICATIONREQUESTInvalid or missing topic id.

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 topic

This method retrieves the topic resource which includes meta information for the topic.

Input

The input is the topic_id.
GET
https://api.ebay.com/commerce/notification/v1/topic/{topic_id}

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