GetStore

Use this call to retrieve configuration information for the eBay store owned by the user specified with UserID. If you do not specify a UserID, the store configuration information is returned for the authenticated caller.

Usage Details

GetStore returns the complete eBay store configuration in StoreType, which includes the store name, URL, subscription level, and other data. You can set CategoryStructureOnly to true to retrieve only information about the category hierarchy of the store.

GetStore does not return any of the eBay store custom page data; use GetStoreCustomPage to retrieve that data.

For information about updating a Store to the New eBay Store design, see Updating the Store Design.

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 configuration for that store.

   The CategoryStructureOnly input field lets you retrieve just the category structure of the store. Note that store categories show up on the storefront in the site UI only when they have items listed in them, or listed in a subcategory.

Related Information

See Managing eBay Stores.

See also the reference documentation for this call:

• SetStore - This call is used to set/modify the configuration of a seller's eBay 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>

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>
    <CustomHeader> string </CustomHeader>
    <CustomHeaderLayout> StoreCustomHeaderLayoutCodeType </CustomHeaderLayout>
    <CustomListingHeader> StoreCustomListingHeaderType
      <AddToFavoriteStores> boolean </AddToFavoriteStores>
      <DisplayType> StoreCustomListingHeaderDisplayCodeType </DisplayType>
      <LinkToInclude> StoreCustomListingHeaderLinkType
        <LinkID> int </LinkID>
        <LinkType> StoreCustomListingHeaderLinkCodeType </LinkType>
        <Order> int </Order>
      </LinkToInclude>
      <!-- ... more LinkToInclude nodes allowed here ... -->
      <Logo> boolean </Logo>
      <SearchBox> boolean </SearchBox>
      <SignUpForStoreNewsletter> boolean </SignUpForStoreNewsletter>
    </CustomListingHeader>
    <Description> string </Description>
    <ExportListings> boolean </ExportListings>
    <HeaderStyle> StoreHeaderStyleCodeType </HeaderStyle>
    <HomePage> long </HomePage>
    <ItemListLayout> StoreItemListLayoutCodeType </ItemListLayout>
    <ItemListSortOrder> StoreItemListSortOrderCodeType </ItemListSortOrder>
    <LastOpenedTime> dateTime </LastOpenedTime>
    <Logo> StoreLogoType
      <LogoID> int </LogoID>
      <Name> string </Name>
      <URL> anyURI </URL>
    </Logo>
    <Name> string </Name>
    <SubscriptionLevel> StoreSubscriptionLevelCodeType </SubscriptionLevel>
    <Theme> StoreThemeType
      <ColorScheme> StoreColorSchemeType
        <Color> StoreColorType
          <Accent> string </Accent>
          <Primary> string </Primary>
          <Secondary> string </Secondary>
        </Color>
        <ColorSchemeID> int </ColorSchemeID>
        <Font> StoreFontType
          <DescColor> string </DescColor>
          <DescFace> StoreFontFaceCodeType </DescFace>
          <DescSize> StoreFontSizeCodeType </DescSize>
          <NameColor> string </NameColor>
          <NameFace> StoreFontFaceCodeType </NameFace>
          <NameSize> StoreFontSizeCodeType </NameSize>
          <TitleColor> string </TitleColor>
          <TitleFace> StoreFontFaceCodeType </TitleFace>
          <TitleSize> StoreFontSizeCodeType </TitleSize>
        </Font>
        <Name> string </Name>
      </ColorScheme>
      <Name> string </Name>
      <ThemeID> int </ThemeID>
    </Theme>
    <TitleWithCompatibility> boolean </TitleWithCompatibility>
    <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>

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.

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