GetStoreOptions

Retrieves the current list of Store configuration options.

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 not returned (or soon will not be returned) or are not operational (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"?>
<GetStoreOptionsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- 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 here ... -->
    </GenericColorSchemeArray>
    <Theme> StoreThemeType 
      <Name> string </Name>
      <ThemeID> int </ThemeID>
    </Theme>
    <!-- ... more Theme nodes 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 here ... -->
  </BasicThemeArray>
  <LogoArray> StoreLogoArrayType 
    <Logo> StoreLogoType 
      <LogoID> int </LogoID>
      <Name> string </Name>
    </Logo>
    <!-- ... more Logo nodes 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 here ... -->
  </SubscriptionArray>
</GetStoreOptionsResponse>

Return Value	Type	Occurrence	Meaning

Standard Output Fields [Jump to call-specific 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 Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
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	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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. See Error Handling.
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.
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 the "Errors by Number" document.
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	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
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) Application-level error • Warning (out) Warning or informational error
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 Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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 "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.

Call-specific Output Fields
AdvancedThemeArray	StoreThemeArrayType	Always	The current set of advances themes. Unlike basic themes, you can use any color scheme with an advanced theme. These themes are suitable for more advanced customization.
AdvancedThemeArray .GenericColorSchemeArray	StoreColorSchemeArrayType	Always	Set of color schemes. This set is for use with those themes that do not explicitly list a color scheme in the theme definition (these themes are also known as advanced themes).
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme	StoreColorSchemeType	Always, repeatable: [1..*]	A Store color scheme.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Color	StoreColorType	Always	Store color set.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Color.Accent	string	Always	Accent color for the Store. Specified in 6-digit Hex format. For example: F6F6C9 Max length: 6.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Color.Primary	string	Always	Primary color for the Store. Specified in 6-digit Hex format. For example: F6F6C9 Max length: 6.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Color.Secondary	string	Always	Secondary color for the Store. Specified in 6-digit Hex format. For example: F6F6C9 Max length: 6.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.ColorSchemeID	int	Always	Store color scheme ID. (use GetStoreOptions to get the list of valid theme color scheme IDs).
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font	StoreFontType	Always	Store font set.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font.DescColor	string	Always	Font color for the Store description. Specified in 6-digit Hex format. For example: F6F6C9
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font.DescFace	StoreFontFaceCodeType	Always	Font for the Store description. Applicable values: • Arial (in/out) Arial font. • Courier (in/out) Courier font. • CustomCode (in/out) Reserved for internal or future use. • Times (in/out) Times New Roman font. • Verdana (in/out) Verdana font.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font.DescSize	StoreFontSizeCodeType	Always	Font size for the Store description. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • L (in/out) Large. • M (in/out) Medium. • S (in/out) Small. • XL (in/out) Extra large. • XS (in/out) Extra small. • XXL (in/out) Extra extra large. • XXS (in/out) Extra extra small.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font.NameColor	string	Always	Font color for the Store name. Specified in 6-digit Hex format. For example: F6F6C9 Max length: 6.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font.NameFace	StoreFontFaceCodeType	Always	Font for the Store name. Applicable values: • Arial (in/out) Arial font. • Courier (in/out) Courier font. • CustomCode (in/out) Reserved for internal or future use. • Times (in/out) Times New Roman font. • Verdana (in/out) Verdana font.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font.NameSize	StoreFontSizeCodeType	Always	Font size for the Store name. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • L (in/out) Large. • M (in/out) Medium. • S (in/out) Small. • XL (in/out) Extra large. • XS (in/out) Extra small. • XXL (in/out) Extra extra large. • XXS (in/out) Extra extra small.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font.TitleColor	string	Always	Font color for the Store section title. Specified in 6-digit Hex format. For example: F6F6C9
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font.TitleFace	StoreFontFaceCodeType	Always	Font for the Store section title. Applicable values: • Arial (in/out) Arial font. • Courier (in/out) Courier font. • CustomCode (in/out) Reserved for internal or future use. • Times (in/out) Times New Roman font. • Verdana (in/out) Verdana font.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Font.TitleSize	StoreFontSizeCodeType	Always	Font size for the Store section title. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • L (in/out) Large. • M (in/out) Medium. • S (in/out) Small. • XL (in/out) Extra large. • XS (in/out) Extra small. • XXL (in/out) Extra extra large. • XXS (in/out) Extra extra small.
AdvancedThemeArray .GenericColorSchemeArray .ColorScheme.Name	string	Always	Store color scheme name. Provides a user-friendly name for the color scheme.
AdvancedThemeArray.Theme	StoreThemeType	Always, repeatable: [1..*]	A Store theme.
AdvancedThemeArray.Theme.Name	string	Always	Store theme name. Provides a user-friendly name for the theme.
AdvancedThemeArray.Theme .ThemeID	int	Always	Store theme ID (use GetStoreOptions to get the list of valid theme IDs).
BasicThemeArray	StoreThemeArrayType	Always	The current set of basic themes. Each basic theme definition specifies a valid color scheme for the theme.
BasicThemeArray.Theme	StoreThemeType	Always, repeatable: [1..*]	A Store theme.
BasicThemeArray.Theme .ColorScheme	StoreColorSchemeType	Always	Theme color scheme.
BasicThemeArray.Theme .ColorScheme.Color	StoreColorType	Always	Store color set.
BasicThemeArray.Theme .ColorScheme.Color.Accent	string	Always	Accent color for the Store. Specified in 6-digit Hex format. For example: F6F6C9 Max length: 6.
BasicThemeArray.Theme .ColorScheme.Color.Primary	string	Always	Primary color for the Store. Specified in 6-digit Hex format. For example: F6F6C9 Max length: 6.
BasicThemeArray.Theme .ColorScheme.Color.Secondary	string	Always	Secondary color for the Store. Specified in 6-digit Hex format. For example: F6F6C9 Max length: 6.
BasicThemeArray.Theme .ColorScheme.ColorSchemeID	int	Always	Store color scheme ID. (use GetStoreOptions to get the list of valid theme color scheme IDs).
BasicThemeArray.Theme .ColorScheme.Font	StoreFontType	Always	Store font set.
BasicThemeArray.Theme .ColorScheme.Font.DescColor	string	Always	Font color for the Store description. Specified in 6-digit Hex format. For example: F6F6C9
BasicThemeArray.Theme .ColorScheme.Font.DescFace	StoreFontFaceCodeType	Always	Font for the Store description. Applicable values: • Arial (in/out) Arial font. • Courier (in/out) Courier font. • CustomCode (in/out) Reserved for internal or future use. • Times (in/out) Times New Roman font. • Verdana (in/out) Verdana font.
BasicThemeArray.Theme .ColorScheme.Font.DescSize	StoreFontSizeCodeType	Always	Font size for the Store description. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • L (in/out) Large. • M (in/out) Medium. • S (in/out) Small. • XL (in/out) Extra large. • XS (in/out) Extra small. • XXL (in/out) Extra extra large. • XXS (in/out) Extra extra small.
BasicThemeArray.Theme .ColorScheme.Font.NameColor	string	Always	Font color for the Store name. Specified in 6-digit Hex format. For example: F6F6C9 Max length: 6.
BasicThemeArray.Theme .ColorScheme.Font.NameFace	StoreFontFaceCodeType	Always	Font for the Store name. Applicable values: • Arial (in/out) Arial font. • Courier (in/out) Courier font. • CustomCode (in/out) Reserved for internal or future use. • Times (in/out) Times New Roman font. • Verdana (in/out) Verdana font.
BasicThemeArray.Theme .ColorScheme.Font.NameSize	StoreFontSizeCodeType	Always	Font size for the Store name. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • L (in/out) Large. • M (in/out) Medium. • S (in/out) Small. • XL (in/out) Extra large. • XS (in/out) Extra small. • XXL (in/out) Extra extra large. • XXS (in/out) Extra extra small.
BasicThemeArray.Theme .ColorScheme.Font.TitleColor	string	Always	Font color for the Store section title. Specified in 6-digit Hex format. For example: F6F6C9
BasicThemeArray.Theme .ColorScheme.Font.TitleFace	StoreFontFaceCodeType	Always	Font for the Store section title. Applicable values: • Arial (in/out) Arial font. • Courier (in/out) Courier font. • CustomCode (in/out) Reserved for internal or future use. • Times (in/out) Times New Roman font. • Verdana (in/out) Verdana font.
BasicThemeArray.Theme .ColorScheme.Font.TitleSize	StoreFontSizeCodeType	Always	Font size for the Store section title. Applicable values: • CustomCode (in/out) Reserved for internal or future use. • L (in/out) Large. • M (in/out) Medium. • S (in/out) Small. • XL (in/out) Extra large. • XS (in/out) Extra small. • XXL (in/out) Extra extra large. • XXS (in/out) Extra extra small.
BasicThemeArray.Theme .ColorScheme.Name	string	Always	Store color scheme name. Provides a user-friendly name for the color scheme.
BasicThemeArray.Theme.Name	string	Always	Store theme name. Provides a user-friendly name for the theme.
BasicThemeArray.Theme.ThemeID	int	Always	Store theme ID (use GetStoreOptions to get the list of valid theme IDs).
LogoArray	StoreLogoArrayType	Always	The current set of Store logos. These logos are used in the Store header.
LogoArray.Logo	StoreLogoType	Always, repeatable: [1..*]	A Store logo.
LogoArray.Logo.LogoID	int	Always	Store logo ID (use GetStoreOptions to get the list of valid logo IDs).
LogoArray.Logo.Name	string	Always	Store logo name. Provides a user-friendly name for the logo.
MaxCategories	int	Always	The maximum number of categories in this store.
MaxCategoryLevels	int	Always	The maximum number of category levels in this store.
SubscriptionArray	StoreSubscriptionArrayType	Always	The current set of eBay Store subscription tiers and corresponding subscription prices.
SubscriptionArray.Subscription	StoreSubscriptionType	Always, repeatable: [1..*]	A Store subscription level.
SubscriptionArray.Subscription .Fee	AmountType (double)	Always	Monthly fee for the Store subscription level.
SubscriptionArray.Subscription .Fee [ attribute currencyID ]	CurrencyCodeType	Always	Currency in which the monetary amount is specified. In the AddItem family of calls, the currency can be specified in the Item.Currency field instead. If you do specify this attribute in the AddItem family of calls, the value must match the site currency (i.e., it must be the same as the value in Item.Currency) unless otherwise stated. For a list of possible enumeration values, see CurrencyCodeType.
SubscriptionArray.Subscription .Level	StoreSubscriptionLevelCodeType	Always	Store subscription level. Applicable values: • Anchor (in/out) Anchor level subscription. • Basic (in/out) Basic level subscription. • Featured (in/out) Featured level subscription. (Not all values in StoreSubscriptionLevelCodeType apply to this field.)

GetStoreOptions Detail Controls

Detail Control: DetailLevel

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

GetStoreOptions Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetStoreOptions.

GetStoreOptions Change History

This section notes changes made since Version 465.

This document was generated with a customized version of the apireferencedocs tool.

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. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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., 549). 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 (XML API Only) 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 in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.

eBay Trading API Call Reference Version 643

eBay Trading API
Call Reference Version 643