Skip to main content

DELETE/store/categories/{category_id}

This method is used to delete one custom category of a user's eBay store through an asynchronous request. A successful call returns the getStoreTask URI in the Location response header. Call getStoreTask (or getStoreTasks) method to retrieve the status of the delete category operation.

Important! If you initiate a category change, you cannot make additional category changes until the previous change request has completed. Use getStoreTask (or getStoreTasks) method to get latest status of your last request.

Input

Resource URI

DELETE https://api.ebay.com/sell/stores/v1/store/categories/{category_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

ParameterTypeDescription
category_idstringThe unique identifier of an eBay Store's custom category. eBay auto-generates this identifier when a seller establishes a custom store category. This category ID should not be confused with an eBay category ID.
The getStoreCategories method can be used to retrieve store category IDs.

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 authorization code 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/sell.stores

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

Request fields

Input container/fieldTypeDescription
listingDestinationCategoryIdstring

This field is only needed if the category to be deleted or any of its children categories have one or more active listings. The operation will fail otherwise. All active listings in or under the category to be deleted will be moved to the store category specified in this field.
The getStoreCategories method can be used to retrieve store category IDs.

Default: OTHER category ID (1) if it's null.

Occurrence: Conditional

Output

HTTP response headers

See HTTP response headers for details.

HeaderMeaning
LocationThe location url is used to poll the async task status. Use it to call getStoreTask api.
Retry-AfterThe polling interval time in milliseconds.

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.

StatusMeaning
202The request is accepted, user should get the location url in response to retrieve async task status.
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
225000API_STORESAPPLICATIONInternal server error encountered. If this problem persists, contact the eBay Developers Program for support.
225001API_STORESREQUESTInput data for {param} is invalid or missing. Please check API documentation.
225002API_STORESREQUESTThe user must have an active store subscription.
225003API_STORESREQUESTYou cannot make additional category changes until your previous change request has completed. Use getStoreTask method to get latest status of your last request.
226006API_STORESREQUESTCategory id {category_id} doesn't exist for the store.

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: Delete a category from an eBay Store

The seller can delete a category from an eBay Store.

Input

The following sample shows how to delete category from an eBay store. Any listings listed under the deleted category are moved under the category specified with listingDestinationCategoryId .

DELETEhttps://api.ebay.com/sell/stores/v1/store/categories/1**1

Output

If the call is successful, a category is deleted from an eBay store and the getStoreTask URI is returned in the Location response header.