Skip to main content

GET/store/categories

This method is used to retrieve the category hierarchy for an eBay user's store.

Note: Three levels of store categories are supported.

Input

Resource URI

GET https://api.ebay.com/sell/stores/v1/store/categories

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.

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

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/fieldTypeDescription
storeCategoriesarray of StoreCategoryType

An array of top-level categories defined for the eBay store. A childrenCategories array is used for second and third-level categories, if defined for the store.

Occurrence: Always

storeCategories.categoryIdstring

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.

Occurrence: Always

storeCategories.categoryNamestring

The seller-specified name of the custom category.

Occurrence: Always

storeCategories.childrenCategoriesarray of StoreCategoryType

This array is returned to show second and third-level store categories. eBay Stores support up to three category levels.

Occurrence: Conditional

storeCategories.childrenCategories.categoryIdstring

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.

Occurrence: Always

storeCategories.childrenCategories.categoryNamestring

The seller-specified name of the custom category.

Occurrence: Always

storeCategories.childrenCategories.childrenCategoriesarray of StoreCategoryType

This array is returned to show second and third-level store categories. eBay Stores support up to three category levels.

Occurrence: Conditional

storeCategories.childrenCategories.childrenCategories.categoryIdstring

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.

Occurrence: Always

storeCategories.childrenCategories.childrenCategories.categoryNamestring

The seller-specified name of the custom category.

Occurrence: Always

storeCategories.childrenCategories.childrenCategories.childrenCategoriesarray of StoreCategoryType

This array is returned to show second and third-level store categories. eBay Stores support up to three category levels.

Occurrence: Conditional

storeCategories.childrenCategories.childrenCategories.levelinteger

The level indicates the category level of the category tree.
Note: Three levels of store categories are supported. All categories belonging to the same parent should have the same level.

Occurrence: Always

storeCategories.childrenCategories.childrenCategories.orderinteger

The order in which the custom store category appears in the list of store categories when the eBay store is visited.

Occurrence: Always

storeCategories.childrenCategories.levelinteger

The level indicates the category level of the category tree.
Note: Three levels of store categories are supported. All categories belonging to the same parent should have the same level.

Occurrence: Always

storeCategories.childrenCategories.orderinteger

The order in which the custom store category appears in the list of store categories when the eBay store is visited.

Occurrence: Always

storeCategories.levelinteger

The level indicates the category level of the category tree.
Note: Three levels of store categories are supported. All categories belonging to the same parent should have the same level.

Occurrence: Always

storeCategories.orderinteger

The order in which the custom store category appears in the list of store categories when the eBay store is visited.

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.

StatusMeaning
200OK
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.
225002API_STORESREQUESTUser must have an active store subscription.

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: Get information about an eBay Store Category hierarchy

The seller can retrieve information about an eBay Store Category hierarchy.

Input

This call does not use request payload.

GEThttps://api.ebay.com/sell/stores/v1/store/categories

Output

If the call is successful, eBay returns an HTTP status code of 200 OK and information about the eBay Store Category hierarchy.