POST/store/categories/move_category
This method is used to move an existing user's eBay store custom category 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 move 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
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
This method has no URI parameters.
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.
| Header | Type | Description |
|---|---|---|
| Content-Type | string | This 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):
https://api.ebay.com/oauth/api_scope/sell.stores
See OAuth access tokens for more information.
Request payload
Copy complete valid JSON to clipboardRequest fields
| Input container/field | Type | Description |
|---|---|---|
| categoryId | string | The 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 moved. Occurrence: Required |
| destinationParentCategoryId | string | The new parent category of the category to be moved is specified in this field. If the category is being moved to level 1 category, set this value to -999. Occurrence: Required |
| listingDestinationCategoryId | string | This field is only needed if the category to be moved is a leaf category with listings, but a category that becomes a non-leaf category after the move. The listings of the category to be moved are moved to the category specified in this field. Occurrence: Optional |
Output
HTTP response headers
See HTTP response headers for details.
| Header | Meaning |
|---|---|
| Location | The location url is used to poll the async task status.Use it to call getStoreTask api. |
| Retry-After | The 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.
| Status | Meaning |
|---|---|
| 202 | The request is accepted, user should get the location url in response to retrieve async task status. |
| 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 |
|---|---|---|---|
| 225000 | API_STORES | APPLICATION | Internal server error encountered. If this problem persists, contact the eBay Developers Program for support. |
| 225001 | API_STORES | REQUEST | Input data for {param} is invalid or missing. Please check API documentation. |
| 225002 | API_STORES | REQUEST | The user must have an active store subscription. |
| 225003 | API_STORES | REQUEST | You cannot make additional category changes until your previous change request has completed. Use getStoreTask method to get latest status of your last request. |
| 226000 | API_STORES | REQUEST | You cannot have duplicate category names under the same category parent. |
| 226005 | API_STORES | REQUEST | Custom store category {category_name} exceeds the maximum allowed category depth {depth_limit}. |
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: Move single category of a user's eBay Store
The seller can move single category of a user's eBay store.
Input
The following sample moves one category underneath a new parent category in an eBay store category structure.
POSThttps://api.ebay.com/sell/stores/v1/store/categories/move_category
Output
If the call is successful, a single category of a user's eBay Store is moved.