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
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
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 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.
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/field | Type | Description |
|---|---|---|
| authorizationScopes | array of string | Occurrence: Conditional |
| context | ContextEnum | The business context associated with this topic. Occurrence: Always |
| description | string | The description of the topic. Occurrence: Always |
| filterable | boolean | The indicator of whether this topic is filterable or not. Occurrence: Always |
| scope | ScopeEnum | The scope of this topic. Occurrence: Always |
| status | StatusEnum | The status of this topic. Occurrence: Always |
| supportedPayloads | array of PayloadDetail | The supported payloads for this topic. Occurrence: Conditional |
| supportedPayloads.deliveryProtocol | ProtocolEnum | The supported delivery protocols. Occurrence: Always |
| supportedPayloads.deprecated | boolean | A deprecation indicator. Occurrence: Always |
| supportedPayloads.format | array of FormatTypeEnum | The supported format. Presently, Occurrence: Always |
| supportedPayloads.schemaVersion | string | The supported schema version. Occurrence: Conditional |
| topicId | string | The unique identifier for the topic. 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 |
| 404 | Not Found |
| 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. |
| 195002 | API_NOTIFICATION | REQUEST | Invalid or missing topic id. |
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 topic
This method retrieves the topic resource which includes meta information for the topic.
Input
The input is the topic_id.
GEThttps://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, supportedPayloads (including format, schemaVersion, deliveryProtocol, and deprecated), and filterable.