Skip to main content


This method is used to rename the single category of a user's eBay store through an asynchronous request. A successful call returns the getStoreTask URI in the Location response header. The user calls getStoreTask to retrieve the status of the rename 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.


Resource URI


This method is supported in Sandbox environment. To access the endpoint, just replace the root URI with

URI parameters

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. This is the category that is to be renamed.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.

Content-TypestringThis header indicates the format of the request body provided by the client. Its value should be set to application/json.

For more information, refer to HTTP request headers.

Occurrence: Required

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):

See OAuth access tokens for more information.

Request payload

Copy complete valid JSON to clipboard

Request fields

Input container/fieldTypeDescription

The seller-specified name of the custom category. This is the new name of the category specified through path parameter.

Max Length: 35

Occurrence: Required


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.

204No Content
400Bad Request
500Internal Server Error

Error codes

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

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.
226000API_STORESREQUESTYou cannot have duplicate category names under the same category parent.
226001API_STORESREQUESTInvalid characters found in {category_name}. Please see documentation for more information on recommended valid characters.
226002API_STORESREQUESTCategory name can not be empty, or 'Other'.
226003API_STORESREQUESTCategory name {category_name} exceeds the maximum allowed length of {max_length} characters.
226006API_STORESREQUESTCategory id {category_id} doesn't exist for the store.


This call has no warnings.


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: Rename the category of a user's eBay store.

The seller can rename an existing eBay store category.


The following sample renames one existing eBay store category.



If the call is successful, the store category is renamed and the getStoreTask URI is returned in the Location response header.