getTopics: eBay Notification API | eBay Developers Program

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

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

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 notification topics 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 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

Copy complete valid JSON to clipboard

{ /* TopicSearchResponse */

"href" : "string",

"limit" : "integer",

"next" : "string",

"topics" : [

{ /* Topic */

"authorizationScopes" : [

"string"

"context" : "ContextEnum : [BUY,SELL,COMMERCE...]",

"description" : "string",

"filterable" : "boolean",

"scope" : "ScopeEnum : [APPLICATION,USER]",

"status" : "StatusEnum : [ENABLED,DISABLED,DEPRECATED]",

"supportedPayloads" : [

{ /* PayloadDetail */

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

"deprecated" : "boolean",

"format" : [

"FormatTypeEnum : [JSON]"

"schemaVersion" : "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. 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
topics	array of Topic	An array of topics that match the specified criteria. Occurrence: Conditional
topics.authorizationScopes	array of string	The authorization scopes required to subscribe to this topic. Occurrence: Conditional
topics.context	ContextEnum	The business context associated with this topic. Occurrence: Always
topics.description	string	The description of the topic. Occurrence: Always
topics.filterable	boolean	The indicator of whether this topic is filterable or not. Occurrence: Always
topics.scope	ScopeEnum	The scope of this topic. Occurrence: Always
topics.status	StatusEnum	The status of this topic. Occurrence: Always
topics.supportedPayloads	array of PayloadDetail	The supported payloads for this topic. Occurrence: Conditional
topics.supportedPayloads.deliveryProtocol	ProtocolEnum	The supported delivery protocols. Occurrence: Always
topics.supportedPayloads.deprecated	boolean	A deprecation indicator. Occurrence: Always
topics.supportedPayloads.format	array of FormatTypeEnum	The supported format. Presently, `JSON` is the only supported format. Occurrence: Always
topics.supportedPayloads.schemaVersion	string	The supported schema version. Occurrence: Conditional
topics.topicId	string	The unique identifier for the topic. Occurrence: Always
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 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.

GEThttps://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, supportedPayloads (including format, schemaVersion, deliveryProtocol, and deprecated), and filterable.

{
  "total": 6,
  "href": "https://api.ebay.com/commerce/notification/v1/topic?limit=20",
  "limit": 20,
  "topics": [
    {
      "topicId": "ITEM_AVAILABILITY",
      "description": "The topic contains the availability change event for items (currently only for fixed price items on ebay UK site). It includes 3 types: AVAILABLE, UNAVAILABLE, TEMPORARY_UNAVAILABLE.",
      "authorizationScopes": [
        "https://api.ebay.com/oauth/api_scope/buy.item.stream"
      ],
      "status": "ENABLED",
      "context": "BUY",
      "scope": "APPLICATION",
      "supportedPayloads": [
        {
          "format": [
            "JSON"
          ],
          "schemaVersion": "1.0",
          "deliveryProtocol": "HTTPS"
        }
      ],
      "filterable": true
    },
    {
      "topicId": "ITEM_PRICE_REVISION",
      "description": "The topic contains the price change event for items (currently only for fixed price items on ebay UK site).",
      "authorizationScopes": [
        "https://api.ebay.com/oauth/api_scope/buy.item.stream"
      ],
      "status": "ENABLED",
      "context": "BUY",
      "scope": "APPLICATION",
      "supportedPayloads": [
        {
          "format": [
            "JSON"
          ],
          "schemaVersion": "1.0",
          "deliveryProtocol": "HTTPS"
        }
      ],
      "filterable": true
    },
    {
      "topicId": "PRIORITY_LISTING_REVISION",
      "description": "contains priority listing status update changes",
      "authorizationScopes": [
        "https://api.ebay.com/oauth/api_scope/buy.item.stream"
      ],
      "status": "ENABLED",
      "context": "BUY",
      "scope": "APPLICATION",
      "supportedPayloads": [
        {
          "format": [
            "JSON"
          ],
          "schemaVersion": "1.0",
          "deliveryProtocol": "HTTPS"
        }
      ],
      "filterable": true
    },
    {
      "topicId": "MARKETPLACE_ACCOUNT_DELETION",
      "description": "Subscribe to this topic to receive notifications when users submit requests for account deletion.",
      "status": "ENABLED",
      "context": "COMMERCE",
      "scope": "APPLICATION",
      "supportedPayloads": [
        {
          "format": [
            "JSON"
          ],
          "schemaVersion": "1.0",
          "deliveryProtocol": "HTTPS"
        }
      ],
      "filterable": false
    },
    {
      "topicId": "AUTHORIZATION_REVOCATION",
      "description": "Subscribe to this topic to receive notifications when app authorization is revoked for users.",
      "status": "ENABLED",
      "context": "DEVELOPER",
      "scope": "APPLICATION",
      "supportedPayloads": [
        {
          "format": [
            "JSON"
          ],
          "schemaVersion": "1.0",
          "deliveryProtocol": "HTTPS"
        }
      ],
      "filterable": false
    },
    {
      "topicId": "PLA_CAMPAIGN_BUDGET_STATUS",
      "description": "Subscribing to this topic notifies you if any of your Promoted Listings Advanced campaigns exhaust their daily allocated budget.",
      "authorizationScopes": [
        "https://api.ebay.com/oauth/api_scope/sell.marketing",
        "https://api.ebay.com/oauth/api_scope/sell.marketing.readonly"
      ],
      "status": "ENABLED",
      "context": "SELL",
      "scope": "USER",
      "supportedPayloads": [
        {
          "format": [
            "JSON"
          ],
          "schemaVersion": "1.0",
          "deliveryProtocol": "HTTPS"
        }
      ],
      "filterable": false
    }
  ]
}