deleteSubscriptionFilter: eBay Notification API

DELETE/subscription/{subscription_id}/filter/{filter_id}

This method allows applications to disable the active filter on a subscription, so that a new subscription filter may be added.

Note: Subscription filters in PENDING status can not be disabled. However, a new filter can be created instead with the createSubscriptionFilter method and this new filter will override the PENDING filter.

Input

Resource URI

DELETE https://api.ebay.com/commerce/notification/v1/subscription/{subscription_id}/filter/{filter_id}

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
subscription_id	string	The unique identifier of the subscription associated with the filter to delete. Use getSubscriptions to retrieve subscription IDs. Occurrence: Required
filter_id	string	The unique identifier of the subscription filter to delete. 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

See OAuth access tokens for more information.

Note: An OAuth token created with the client credentials grant flow and the https://api.ebay.com/oauth/api_scope scope is required in order to create, update, or retrieve application-based subscriptions to notification topics. An OAuth token created with the authorization code grant flow and the https://api.ebay.com/oauth/api_scope/commerce.notification.subscription scope is required in order to create, update, or retrieve user-based subscriptions to notification topics.

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

This call has no payload.

Response fields

This call has no field definitions.

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
204	No Content
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.
195030	API_NOTIFICATION	REQUEST	The specified filter is either disabled or pending and cannot be deleted at this time. Only enabled filters may be deleted.
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: Disables a Subscription Filter

This method allows applications to disable a subscription filter.

Input

This input specifies the subscription_id and the filter_id.

DELETEhttps://api.ebay.com/commerce/notification/v1/subscription/{subscription_id}/filter/{filter_id}

Output

A successful call returns the HTTP status code 204 No content. This method has no response payload.