GET/category_tree/{category_tree_id}/get_expired_categories
This method retrieves the mappings of expired leaf categories in the specified category tree to their corresponding active leaf categories. Note that in some cases, several expired categories are mapped to a single active category.
Note: This method only returns information about categories that have been mapped (i.e., combined categories and split categories). It does not return information about expired categories that have no corresponding active categories. When a category expires in this manner, any completed items that were listed in the expired category can still be found, but new listings cannot be created in the category.
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
| Parameter | Type | Description |
|---|---|---|
| category_tree_id | string | The unique identifier of the eBay category tree. The category tree ID for an eBay marketplace can be retrieved using the getDefaultCategoryTreeId method. 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
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 |
|---|---|---|
| expiredCategories | array of ExpiredCategory | An array of expired category ID(s) for the requested category tree, and the currently active category ID(s) that have replaced them. Occurrence: Conditional |
| expiredCategories.fromCategoryId | string | The unique identifier of the expired eBay leaf category. Occurrence: Always |
| expiredCategories.toCategoryId | string | The unique identifier of the currently active eBay leaf category that has replaced the expired leaf category. Occurrence: Always |
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 | Success |
| 204 | No content |
| 400 | Bad Request |
| 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 |
|---|---|---|---|
| 62000 | API_TAXONOMY | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 62004 | API_TAXONOMY | REQUEST | The specified category tree ID was not found. |
| 62103 | API_TAXONOMY | REQUEST | The CategoryTreeId is not supported. |
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: Retrieve category mappings for expired categories
This sample retrieves an array of expired category IDs for the specified category tree and the corresponding active eBay leaf categories that have replaced them.
Input
Use the category_tree_id path parameter to specify the category tree for which to retrieve expired leaf categories and their associated active leaf categories.
GEThttps://api.ebay.com/commerce/taxonomy/v1/category_tree/0/get_expired_categories
Output
A successful call returns an array of expired leaf categories (fromCategoryId), each one accompanied by the corresponding active leaf category (toCategoryId). Note that the response shown is only a sample of a much larger response.