eBay Trading API Call Reference Version 823 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

Call Index Field Index Enumeration Index Type Index Deprecated Objects Errors by Number Input Output Detail Controls Samples Change History Top Errors for GetStoreOptions User Notes

GetStoreOptions

Use this call to retrieve the current set of eBay Store configuration options. This is set of store options provided by eBay.

GetStoreOptions takes no call-specific inputs, although the call must be authenticated using an authentication token. The results returned are be the same no matter which token is used, they are the latest store options provided by eBay.

If the GetStoreOptions execution is successful, it returns the current set of eBay Stores options. The set of options can be used to fill in the input fields for other eBay Stores calls.

You can test this call in the Sandbox, the response is the same as a call made to the production environment.

See:
    Editing the Store Settings
    Managing eBay Stores

See also the reference documentation for this call:

• GetStore - Retrieves configuration information for the eBay store owned by the specified UserID, or by the caller.

Back to top

GetStoreOptions Input

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 Samples.

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"?>
<GetStoreOptionsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Input fields) -->

  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetStoreOptionsRequest>

Back to top

GetStoreOptions Output

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 Samples.

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"?>
<GetStoreOptionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <AdvancedThemeArray> StoreThemeArrayType
    <GenericColorSchemeArray> StoreColorSchemeArrayType
      <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>
      <!-- ... more ColorScheme nodes allowed here ... -->
    </GenericColorSchemeArray>
    <Theme> StoreThemeType
      <Name> string </Name>
      <ThemeID> int </ThemeID>
    </Theme>
    <!-- ... more Theme nodes allowed here ... -->
  </AdvancedThemeArray>
  <BasicThemeArray> StoreThemeArrayType
    <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>
    <!-- ... more Theme nodes allowed here ... -->
  </BasicThemeArray>
  <LogoArray> StoreLogoArrayType
    <Logo> StoreLogoType
      <LogoID> int </LogoID>
      <Name> string </Name>
    </Logo>
    <!-- ... more Logo nodes allowed here ... -->
  </LogoArray>
  <MaxCategories> int </MaxCategories>
  <MaxCategoryLevels> int </MaxCategoryLevels>
  <SubscriptionArray> StoreSubscriptionArrayType
    <Subscription> StoreSubscriptionType
      <Fee currencyID="CurrencyCodeType"> AmountType (double) </Fee>
      <Level> StoreSubscriptionLevelCodeType </Level>
    </Subscription>
    <!-- ... more Subscription nodes allowed here ... -->
  </SubscriptionArray>
  <!-- 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>
</GetStoreOptionsResponse>

Back to top

GetStoreOptions Detail Controls

Detail Control: DetailLevel

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

Back to top

GetStoreOptions Samples

New to making API calls? Please see Routing the Request.

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.

Returns details on the current eBay store option settings.

Description

There are no special input parameters, although the call does require an authentication token.

Input

XML format (HTTP POST). Also available is the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?> 
<GetStoreOptionsRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials> 
    <eBayAuthToken>ABC...123</eBayAuthToken> 
  </RequesterCredentials> 
</GetStoreOptionsRequest> 

Output

XML format. Also available is the .txt version of this XML.

<GetStoreOptionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-01-14T23:33:46.025Z</Timestamp>
  <Ack>Success</Ack>
  <Version>643</Version>
  <Build>E643_CORE_BUNDLED_10284414_R1</Build>
  <BasicThemeArray>
    <Theme>
      <ThemeID>1</ThemeID>
      <Name>Fireworks</Name>
      <ColorScheme>
        <ColorSchemeID>1</ColorSchemeID>
        <Name>Fireworks - Orange</Name>
        <Color>
          <Primary>A9A9A9</Primary>
          <Secondary>F4F4F4</Secondary>
          <Accent>FD7714</Accent>
        </Color>
        <Font>
          <NameFace>Arial</NameFace>
          <NameSize>M</NameSize>
          <NameColor>FFFFFF</NameColor>
          <TitleFace>Arial</TitleFace>
          <TitleSize>XS</TitleSize>
          <TitleColor>FFFFFF</TitleColor>
          <DescFace>Arial</DescFace>
          <DescSize>XS</DescSize>
          <DescColor>333333</DescColor>
        </Font>
      </ColorScheme>
    </Theme>

<!-- More Basic Themes -->

  </BasicThemeArray>
  <AdvancedThemeArray>
    <Theme>
      <ThemeID>1000000</ThemeID>
      <Name>Classic Left</Name>
    </Theme>
    <Theme>
      <ThemeID>1000001</ThemeID>
      <Name>Classic Top</Name>
    </Theme>
    <Theme>
      <ThemeID>1000002</ThemeID>
      <Name>Minimal Left</Name>
    </Theme>
    <Theme>
      <ThemeID>1000003</ThemeID>
      <Name>Minimal Top</Name>
    </Theme>
    <Theme>
      <ThemeID>1000004</ThemeID>
      <Name>Custom Header Only</Name>
    </Theme>
    <GenericColorSchemeArray>
      <ColorScheme>
        <ColorSchemeID>1000000</ColorSchemeID>
        <Name>Coral</Name>
        <Color>
          <Primary>990000</Primary>
          <Secondary>FFE9E9</Secondary>
          <Accent>FF9999</Accent>
        </Color>
        <Font>
          <NameFace>Arial</NameFace>
          <NameSize>M</NameSize>
          <NameColor>FFFFFF</NameColor>
          <TitleFace>Arial</TitleFace>
          <TitleSize>XS</TitleSize>
          <TitleColor>FFFFFF</TitleColor>
          <DescFace>Arial</DescFace>
          <DescSize>XS</DescSize>
          <DescColor>333333</DescColor>
        </Font>
      </ColorScheme>

<!-- More Color Schemes -->

    </GenericColorSchemeArray>
  </AdvancedThemeArray>
  <LogoArray>
    <Logo>
      <LogoID>1</LogoID>
      <Name>Antiques & Art</Name>
    </Logo>

<!-- More Logos -->

  </LogoArray>
  <SubscriptionArray>
    <Subscription>
      <Level>Featured</Level>
      <Fee currencyID="USD">49.95</Fee>
    </Subscription>
    <Subscription>
      <Level>Anchor</Level>
      <Fee currencyID="USD">299.95</Fee>
    </Subscription>
    <Subscription>
      <Level>Basic</Level>
      <Fee currencyID="USD">15.95</Fee>
    </Subscription>
  </SubscriptionArray>
  <MaxCategories>300</MaxCategories>
  <MaxCategoryLevels>3</MaxCategoryLevels>
</GetStoreOptionsResponse>

Back to top

GetStoreOptions Change History

This section notes changes made since Version 465.

Back to top

User-Contributed Notes

Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.