GET/subscription/{subscription_id}/filter/{filter_id}
This method allows applications to retrieve the filter details for the specified subscription filter.
Specify the subscription filter to retrieve by using the subscription_id and the filter_id associated with the subscription filter. The filter_id can be found in the response body for the getSubscription method, if there is a filter applied on the subscription.
Filters allow applications to only be sent notifications that match a provided criteria. Notifications that do not match this criteria will not be sent to the destination.
Input
Resource URI
This method is not supported in Sandbox environment.
URI parameters
| Parameter | Type | Description |
|---|---|---|
| subscription_id | string | The unique identifier of the subscription associated with the filter. Use getSubscriptions to retrieve subscription IDs. Occurrence: Required |
| filter_id | string | The unique identifier of the subscription filter. Filter ID values, if configured for a subscription, will be shown in the subscriptions.filterId field in getSubscription and getSubscription responses. The filter ID value is also returned in the Location response header when a filter is created with createSubscriptionFilter. Occurrence: Required |
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
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.
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 |
|---|---|---|
| subscriptionId | string | The unique identifier for the subscription. Occurrence: Conditional |
| filterId | string | The unique identifier for this subscription filter. Occurrence: Conditional |
| filterSchema | object | The content of this subscription filter as a valid JSON Schema Core document (version 2020-12 or later). The filterSchema provided must describe the subscription's notification payload such that it supplies valid criteria to filter the subscription's notifications. Occurrence: Conditional |
| filterStatus | SubscriptionFilterStatus | The status of this subscription filter. Occurrence: Conditional |
| creationDate | string | The creation date for this subscription filter. 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.
| Status | Meaning |
|---|---|
| 200 | OK |
| 403 | Forbidden |
| 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. |
| 195013 | API_NOTIFICATION | REQUEST | The subscription id does not exist. |
| 195028 | API_NOTIFICATION | REQUEST | The application is not authorized to access the specified subscription. |
| 195029 | API_NOTIFICATION | REQUEST | Invalid subscription filter id. |
| 195031 | API_NOTIFICATION | REQUEST | The specified subscription id does not match the specified filter 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 Subscription Filter
This call retrieves the filter details for a specified subscription filter.
Input
This input specifies the subscription_id and the filter_id.
GEThttps://api.ebay.com/commerce/notification/v1/subscription/{subscription_id}/filter/{filter_id}
Output
If the call is successful, the details about the subscription filter are returned, such as the subscriptionId, filterId, filterSchema, filterStatus, and creationDate.