eBay Trading APIVersion 1379
 

GetStore

Use this call to retrieve information for an eBay store.

Testing GetStore

You can test this call in the Sandbox, as follows:

  1. With a test user, use SetStore to create an eBay Store in the Sandbox environment.
  2. Call GetStore to retrieve the details for that store.



Input

See also Samples.

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetStoreRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <CategoryStructureOnly> boolean </CategoryStructureOnly>
  <LevelLimit> int </LevelLimit>
  <RootCategoryID> long </RootCategoryID>
  <UserID> UserIDType (string) </UserID>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetStoreRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
CategoryStructureOnly boolean Optional Include this field and set its value to true if you wish to restrict the call response to only the store category hierarchy data.
Default: false.
LevelLimit int Optional This field allows the seller to limit the number of levels of eBay Store categories that are returned. To return only top-level eBay Store categories, the user can include this field and set its value to 1 (and not use a RootCategoryID value). To retrieve a specific eBay Store Category and that category's child categories, the user could specify the unique eBay Store Category ID in the RootCategoryID field and then set the LevelLimit value to 2.

If LevelLimit is omitted, the complete eBay Store Category hierarchy is returned, or all of specified store category's child categories. eBay Stores support only three levels of store categories.
RootCategoryID long Optional The unique identifier of an eBay Store category. This field is used if the user wants to isolate the category hierarchy data to one particular eBay category (and its subcategories if applicable). The LevelLimit value will determine how many additional levels of categories are returned.
UserID UserIDType (string) Optional The eBay user ID of the eBay seller that owns the eBay Store to be retrieved. This field is only needed if the user wants to view the eBay Store information owned by a different seller (than the seller associated with the authenticated user token). If this field is omitted, the eBay Store information for the seller associated with the authenticated user token is returned.
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Below are some examples from different countries.

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States
MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version string Conditional The version number of the API code that you are programming against (e.g., 1149). The version you specify for a call has these basic effects:
  • It indicates the version of the code lists and other data that eBay should use to process your request.
  • It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.
For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    HTTP headers
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

High
(in) The WarningLevel value is set to High if the user wishes to receive warnings when the application passes unrecognized or deprecated elements in an API call request. Setting the WarningLevel value to High is not recommended in a production environment. Instead, it should only be used during the development/debugging stage.
Low
(in) The WarningLevel value is set to Low if the user does not wish to receive warnings when the application passes unrecognized or deprecated elements in an API call request. This is the default value if WarningLevel is not specified in the call request.

See Warning Level.



Output

See also Samples.

The box below lists all fields that might be returned in the response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<GetStoreResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <Store> StoreType
    <CustomCategories> StoreCustomCategoryArrayType
      <CustomCategory> StoreCustomCategoryType
        <CategoryID> long </CategoryID>
        <ChildCategory> StoreCustomCategoryType
          <CategoryID> long </CategoryID>
          <ChildCategory> StoreCustomCategoryType
            <CategoryID> long </CategoryID>
            <ChildCategory> StoreCustomCategoryType </ChildCategory>
              <!-- >>> ChildCategory can be nested within itself an unlimited number of times >>> -->
            <!-- ... more ChildCategory nodes allowed here ... -->
            <Name> string </Name>
            <Order> int </Order>
          </ChildCategory>
          <!-- ... more ChildCategory nodes allowed here ... -->
          <Name> string </Name>
          <Order> int </Order>
        </ChildCategory>
        <!-- ... more ChildCategory nodes allowed here ... -->
        <Name> string </Name>
        <Order> int </Order>
      </CustomCategory>
      <!-- ... more CustomCategory nodes allowed here ... -->
    </CustomCategories>
    <Description> string </Description>
    <LastOpenedTime> dateTime </LastOpenedTime>
    <Logo> StoreLogoType
      <URL> anyURI </URL>
    </Logo>
    <Name> string </Name>
    <URL> anyURI </URL>
    <URLPath> string </URLPath>
  </Store>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetStoreResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
Store StoreType Always This container consists of detailed information on the seller's eBay Store.
Store.CustomCategories StoreCustomCategoryArrayType Always Container consisting of an array of one or more CustomCategory containers. Each CustomCategory container consists of details related to an eBay Store custom category.

To modify an eBay Store's custom categories, an eBay Store owner would use the StoreCategories container in the request of a SetStoreCategories call.
Store.CustomCategories
  .CustomCategory
StoreCustomCategoryType Always,
repeatable: [1..*]
This container is used to express details about a customized eBay Store category.
Store.CustomCategories
  .CustomCategory.CategoryID
long Always 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 field is conditionally required for SetStoreCategories, if the Action value is set to Rename, Move or Delete.
Store.CustomCategories
  .CustomCategory.ChildCategory
StoreCustomCategoryType Always,
repeatable: [1..*]
This container is used if the seller wants to add child categories to a top-level eBay store category. eBay Stores support three category levels.
Store.CustomCategories
  .CustomCategory.ChildCategory
  .CategoryID
long Always 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 field is conditionally required for SetStoreCategories, if the Action value is set to Rename, Move or Delete.
Store.CustomCategories
  .CustomCategory.ChildCategory
  .ChildCategory
StoreCustomCategoryType Always,
repeatable: [1..*]
This container is used if the seller wants to add child categories to a top-level eBay store category. eBay Stores support three category levels.
Recursion: Whatever the depth of data returned, the deepest level does not include ChildCategory.
Store.CustomCategories
  .CustomCategory.ChildCategory
  .Name
string Always The seller-specified name of the custom category.
This field is conditionally required for SetStoreCategories, if the Action value is set to Add.
Store.CustomCategories
  .CustomCategory.ChildCategory
  .Order
int Always The order in which the custom store category appears in the list of store categories when the eBay store is visited.
Store.CustomCategories
  .CustomCategory.Name
string Always The seller-specified name of the custom category.
This field is conditionally required for SetStoreCategories, if the Action value is set to Add.
Store.CustomCategories
  .CustomCategory.Order
int Always The order in which the custom store category appears in the list of store categories when the eBay store is visited.
Store.Description string Always The seller-provided description of the eBay Store.
Max length: 300.
Store.LastOpenedTime dateTime Conditionally Indicates the time the store was last opened or reopened.
Store.Logo StoreLogoType Conditionally This container provides information about a Store logo.

The GetStore call now only returns the Logo.URL value, but not Logo.LogoID or Logo.Name.
Store.Logo.URL anyURI Conditionally The URL of the seller's store logo.
Store.Name string Always Name of the eBay Store. The name is shown at the top of the Store page.
Max length: 35.
Store.URL anyURI Conditionally The complete URL of the user's Store. This field is only ever returned, and does not need to be explicitly set.
Store.URLPath string Conditionally The URL path of the Store (58 characters maximum). Only if you are using Chinese characters in the Name property do you need to use this field, such as if you are opening a Store on the Taiwan site. The reason for this is that the URL path is normally derived from the Store name, but it cannot be derived from the name of the Store if it contains Chinese characters because URLs cannot contain Chinese characters.
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(Not all values in AckCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
Build string Always This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID string Conditionally Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.
Errors.ErrorClassification ErrorClassificationCodeType Conditionally API errors are divided between two classes: system errors and request errors.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
RequestError
(out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data.
SystemError
(out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.

Code so that your app gracefully handles any future changes to this list.
Errors.ErrorCode token Conditionally A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

See Errors By Number.

Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Error
(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.

If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
  • If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.
  • If the source of the problem is on eBay's side, An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.


See the Error handling section of the Making a Trading API call guide for more information.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Code so that your app gracefully handles any future changes to this list.
Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp dateTime Always This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See the Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Detail Controls


DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.



Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Gets the configuration information for an eBay store.

Description

This sample retrieves the configuation information for an eBay store. Because no UserID is specified, the configuation is retrieved for the authenticated caller's store.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetStoreRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <LevelLimit>1</LevelLimit>
</GetStoreRequest>

Output

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<GetStoreResponse 
  xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-05T22:27:50.267Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_UNI_API5_19098188_R1</Build>
  <Store>
    <Name>A***** T*****</Name>
    <URLPath>Invalid Request</URLPath>
    <URL>http://www.ebay.com/str/a*****s</URL>
    <SubscriptionLevel>CustomCode</SubscriptionLevel>
    <Logo/>
    <Theme>
      <ThemeID>1*****0</ThemeID>
      <ColorScheme>
        <ColorSchemeID>1000005</ColorSchemeID>
        <Color>
          <Primary>0C04B8</Primary>
          <Secondary>CFEBFF</Secondary>
          <Accent>0099FF</Accent>
        </Color>
        <Font>
          <NameColor>FFFFFF</NameColor>
          <TitleColor>FFFFFF</TitleColor>
          <DescColor>333333</DescColor>
        </Font>
      </ColorScheme>
    </Theme>
    <HeaderStyle>Full</HeaderStyle>
    <HomePage>**0</HomePage>
    <ItemListLayout>ListView</ItemListLayout>
    <ItemListSortOrder>EndingFirst</ItemListSortOrder>
    <CustomHeaderLayout>NoHeader</CustomHeaderLayout>
    <ExportListings>false</ExportListings>
    <CustomCategories>
      <CustomCategory>
        <CategoryID>1</CategoryID>
        <Name>Other</Name>
        <Order>0</Order>
      </CustomCategory>
      <CustomCategory>
        <CategoryID>24574768010</CategoryID>
        <Name>Dolls</Name>
        <Order>1</Order>
      </CustomCategory>
      <CustomCategory>
        <CategoryID>24574769010</CategoryID>
        <Name>Collector Plates</Name>
        <Order>2</Order>
      </CustomCategory>
      <CustomCategory>
        <CategoryID>25337304010</CategoryID>
        <Name>Jewelry</Name>
        <Order>3</Order>
      </CustomCategory>
      <CustomCategory>
        <CategoryID>26230204010</CategoryID>
        <Name>Christmas Items</Name>
        <Order>4</Order>
      </CustomCategory>
    </CustomCategories>
    <CustomListingHeader>
      <DisplayType>FullAndLeftNavigationBar</DisplayType>
      <Logo>true</Logo>
      <SearchBox>false</SearchBox>
      <LinkToInclude>
        <LinkID>0</LinkID>
        <Order>1</Order>
        <LinkType>None</LinkType>
      </LinkToInclude>
      <LinkToInclude>
        <LinkID>0</LinkID>
        <Order>2</Order>
        <LinkType>None</LinkType>
      </LinkToInclude>
      <LinkToInclude>
        <LinkID>0</LinkID>
        <Order>3</Order>
        <LinkType>None</LinkType>
      </LinkToInclude>
      <LinkToInclude>
        <LinkID>0</LinkID>
        <Order>4</Order>
        <LinkType>None</LinkType>
      </LinkToInclude>
      <LinkToInclude>
        <LinkID>0</LinkID>
        <Order>5</Order>
        <LinkType>None</LinkType>
      </LinkToInclude>
      <AddToFavoriteStores>true</AddToFavoriteStores>
      <SignUpForStoreNewsletter>true</SignUpForStoreNewsletter>
    </CustomListingHeader>
    <MerchDisplay>StoreTheme</MerchDisplay>
    <LastOpenedTime>2018-07-12T21:04:50.000Z</LastOpenedTime>
    <TitleWithCompatibility>true</TitleWithCompatibility>
  </Store>
</GetStoreResponse>



Change History

Change Date Description
1303
2023-03-24
  • StoreSubscriptionLevelCodeType (doc change): This type has been decommissioned.
1125
2019-09-13
  • StoreSubscriptionLevelCodeType (modified): Starter and Enterprise values added to account for the two new eBay Store subscription levels.
0601
2009-01-21
  • Store.ItemListSortOrder.HighestPricedPlusShipping, Store.ItemListSortOrder.LowestPricedPlusShipping (added): New values enabled for specifying default sort order for the display of items withtin an eBay store.
0515
2007-05-30
  • UserID (added): GetStore now allows the use of UserID as input to retrieve store information for a specific store owner.
0511
2007-05-02
  • Store.CustomListingHeader.BreadCrumb (deprecated): eBay no longer supports this functionality. This optional field is no longer returned (regardless of your request version). It has been deleted from the schema as of release 511.
0499
2007-02-07
  • RootCategoryID, Store.CustomCategories.CustomCategory.CategoryID, Store.HomePage (modified): The data types for IDs used for eBay Stores have changed from xs:int to xs:long to prepare for future increases in ID values.