GET/store
This method is used to retrieve information for an eBay user's store such as store name, store URL, and description.
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.
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/field | Type | Description |
|---|---|---|
| description | string | The seller-provided description of the eBay Store. Occurrence: Always |
| lastOpenedTime | string | Indicates the time the store was last opened or reopened. Occurrence: Conditional |
| logo | StoreLogoType | This container provides information about a Store logo. Occurrence: Conditional |
| logo.url | string | The URL of the seller's store logo. Occurrence: Conditional |
| name | string | The name of the eBay Store. The name is shown at the top of the Store page. Occurrence: Always |
| url | string | The complete URL of the user's store. Occurrence: Conditional |
| urlPath | string | The relative URL path of the Store. Occurrence: Conditional |
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 | OK |
| 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. |
| 225002 | API_STORES | REQUEST | User 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 for an eBay Store
The seller can retrieve information about their active eBay store.
Input
This call does not use request payload.
GEThttps://api.ebay.com/sell/stores/v1/store
Output
If the call is successful, eBay returns an HTTP status code of 200 OK and information about the eBay store.