Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

This API provides stores-related resources for third-party developers. These resources let you retrieve basic store information such as store name, description, store url, return store category hierarchy, add/rename/move/delete a single user's eBay store category, and retrieve the processing status of these tasks.

The stores resource methods require 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)


Method NameHTTP MethodPathSummarySamples
addStoreCategoryPOST/store/categoriesAdds a single new category to a user's eBay store.View addStoreCategory - /store/categories
deleteStoreCategoryDELETE/store/categories/{category_id}Deletes one category of a user's eBay store.View deleteStoreCategory - /store/categories/{category_id}
getStoreGET/storeRetrieves information such as store name, store URL, and description for an eBay store.View getStore - /store
getStoreCategoriesGET/store/categoriesRetrieves eBay Store Category hierarchy.View getStoreCategories - /store/categories
getStoreTaskGET/store/tasks/{task_id}Retrieves the current status of a recent store operation.View getStoreTask - /store/tasks/{task_id}
getStoreTasksGET/store/tasksRetrieves all store tasks.View getStoreTasks - /store/tasks
moveStoreCategoryPOST/store/categories/move_categoryMove single category of a user's eBay store.View moveStoreCategory - /store/categories/move_category
renameStoreCategoryPUT/store/categories/{category_id}Renames a single category of a user's eBay store.View renameStoreCategory - /store/categories/{category_id}