eBay Trading APIVersion 1267
 

SetStore

Note: Due to the fact that the new Stores platform no longer supports custom store pages and other store customization functionality, the SetStore call will be decommissioned on September 30, 2022, and this call will be removed from the Trading WSDL at that time.

Use this call to set the configuration of a user's eBay store. To call SetStore, the user must have an eBay Stores subscription and they must have created an eBay Store on the eBay website.

Usage Details

Submit to SetStore the complete set of data needed to specify the user's eBay Store configuration. The call overwrites any existing store configuration information, therefore, you must supply a complete set of configuration information if you want to update the configuration for an existing store. SetStore does not return any call-specific data, it returns only Success if the call succeeded.



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"?>
<SetStoreRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <Store> StoreType
    <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 Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetStoreRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
Store StoreType Required Deprecated as of version 1267. Currently ignored.
This container is used to set/modify the configuration of a seller's eBay Store.
Deprecation version: 1267. See also Deprecated Objects.
Store.CustomHeader string Conditional Deprecated as of version 1267. Currently ignored.
Custom header text for the Store.

Note: This field is deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This field will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.
Deprecation version: 1267. See also Deprecated Objects.
Store.CustomHeaderLayout StoreCustomHeaderLayoutCodeType Conditional Deprecated as of version 1267. Currently ignored.
Layout for the Store's custom header.

Note: This field is deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This field will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
CustomHeaderShown
(in/out) Specifies that the Store does have a custom header.
NoHeader
(in/out) Specifies that the Store does not have a custom header.

Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader StoreCustomListingHeaderType Conditional Deprecated as of version 1267. Currently ignored.
Custom listing header for the Store.

Note: This container and its fields are deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This container and its fields will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.
Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader
  .AddToFavoriteStores
boolean Conditional Deprecated as of version 1267. Currently ignored.
Specifies whether the custom header has a link to Add to Favorite Stores.
Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader
  .DisplayType
StoreCustomListingHeaderDisplayCodeType Conditional Deprecated as of version 1267. Currently ignored.
Display type for the custom listing header.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
Full
(in/out) The full custom listing header is displayed.
FullAndLeftNavigationBar
(in/out) The full custom listing header and the left navigation bar is displayed.
None
(in/out) No custom listing header is displayed.

Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader
  .LinkToInclude
StoreCustomListingHeaderLinkType Conditional,
repeatable: [0..*]
Deprecated as of version 1267. Currently ignored.
Link to include in the custom header.
Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader
  .LinkToInclude.LinkID
int Conditional Deprecated as of version 1267. Currently ignored.
Link ID for the listing header link.
Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader
  .LinkToInclude.LinkType
StoreCustomListingHeaderLinkCodeType Conditional Deprecated as of version 1267. Currently ignored.
Type of link to include in the custom listing header.

Applicable values:

AboutMePage
(in/out) Link is to an About Me page.
CustomCategory
(in/out) Link is to a custom category.
CustomCode
(in/out) Reserved for internal or future use.
CustomPage
(in/out) Link is to a custom page.
None
(in/out) No type.

Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader
  .LinkToInclude.Order
int Conditional Deprecated as of version 1267. Currently ignored.
Order in which to show the custom listing header link.
Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader.Logo boolean Conditional Deprecated as of version 1267. Currently ignored.
Specifies whether the custom header has a logo.
Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader
  .SearchBox
boolean Conditional Deprecated as of version 1267. Currently ignored.
Specifies whether the custom header has a search box.
Deprecation version: 1267. See also Deprecated Objects.
Store.CustomListingHeader
  .SignUpForStoreNewsletter
boolean Conditional Deprecated as of version 1267. Currently ignored.
Specifies whether the custom header has a link to Sign up for Store Newsletter.
Deprecation version: 1267. See also Deprecated Objects.
Store.Description string Conditional Deprecated as of version 1267. No longer recommended.
Store description (300 characters maximum).
Deprecation version: 1267. See also Deprecated Objects.
Store.ExportListings boolean Conditional Deprecated as of version 1267. Currently ignored.
Specifies whether to export the Store listings to comparison shopping websites.

Note: This field is deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This field will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.
Deprecation version: 1267. See also Deprecated Objects.
Store.HeaderStyle StoreHeaderStyleCodeType Conditional Deprecated as of version 1267. Currently ignored.
Style for the Store header.

Note: This field is deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This field will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
Full
(in/out) The full Store header is used.
Minimized
(in/out) A minimized Store header is used.

Deprecation version: 1267. See also Deprecated Objects.
Store.HomePage long Conditional Deprecated as of version 1267. Currently ignored.
Page to use as the Store's homepage (default is 0). To change the home page, specify the PageID of one of the Store's custom pages.

Note: This field is deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This field will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.
Deprecation version: 1267. See also Deprecated Objects.
Store.ItemListLayout StoreItemListLayoutCodeType Conditional Deprecated as of version 1267. Currently ignored.
The default layout type to use for the Store items.

Note: This field is deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This field will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.

Applicable values:

CustomCode
(in/out) Reserved for internal or future use.
GalleryView
(in/out) Displays item list in two columns, with larger item pictures.
ListView
(in/out) Displays item list as a single column, with smaller item pictures.

Deprecation version: 1267. See also Deprecated Objects.
Store.ItemListSortOrder StoreItemListSortOrderCodeType Conditional Deprecated as of version 1267. Currently ignored.
The default sort order to use for the items for sale in the Store.

Note: This field is deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This field will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.

Applicable values: See ItemListSortOrder.
Deprecation version: 1267. See also Deprecated Objects.
Store.LastOpenedTime dateTime Conditional Deprecated as of version 1267. No longer recommended.
Indicates the time the store was last opened or reopened.
Deprecation version: 1267. See also Deprecated Objects.
Store.Logo StoreLogoType Conditional Deprecated as of version 1267. Currently ignored.
This container provides information about a Store logo.

Note: The Store.Logo container can no longer be used in a SetStore call to upload a new logo to a store, and the SetStore call will be decommissioned on September 30, 2022.

The GetStore call now only returns the Logo.URL value, but not Logo.LogoID or Logo.Name.

Deprecation version: 1267. See also Deprecated Objects.
Store.Logo.LogoID int Conditional Deprecated as of version 1267. Currently ignored.
The identifier of the seller's store logo.
Deprecation version: 1267. See also Deprecated Objects.
Store.Logo.Name string Conditional Deprecated as of version 1267. Currently ignored.
The name of the seller's store logo.
Deprecation version: 1267. See also Deprecated Objects.
Store.Logo.URL anyURI Conditional Deprecated as of version 1267. Currently ignored.
The URL of the seller's store logo.
Deprecation version: 1267. See also Deprecated Objects.
Store.Name string Conditional Deprecated as of version 1267. No longer recommended.
Name of the eBay Store. The name is shown at the top of the Store page.
Max length: 35.
Deprecation version: 1267. See also Deprecated Objects.
Store.SubscriptionLevel StoreSubscriptionLevelCodeType Optional Deprecated as of version 1267. No longer recommended.
For the GetStore call, the value returned in this field indicates the user's eBay Store subscription level.

For the SetStore call, the user can only cancel the current eBay Store subscription (using the Close enumeration value), and cannot change the subscription level. A seller will have to go to the Subscriptions area of My eBay to change their subscription level. Keep in mind that an early termination fee may apply if a user has a yearly subscription, and then either cancels their subscription, or downgrades their subscription level.

See eBay Stores Subscription Terms of Service (US site).


Deprecation version: 1267. See also Deprecated Objects.
Store.Theme StoreThemeType Conditional Deprecated as of version 1267. Currently ignored.
This container provides information about a Store theme.

Note: This container and its fields are deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This container and its fields will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme StoreColorSchemeType Conditional Deprecated as of version 1267. Currently ignored.
Theme color scheme.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Color StoreColorType Conditional Deprecated as of version 1267. Currently ignored.
Store color set.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Color
  .Accent
string Conditional Deprecated as of version 1267. Currently ignored.
Accent color for the Store. Specified in 6-digit Hex format. For example: F6F6C9
Max length: 6.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Color
  .Primary
string Conditional Deprecated as of version 1267. Currently ignored.
Primary color for the Store. Specified in 6-digit Hex format. For example: F6F6C9
Max length: 6.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Color
  .Secondary
string Conditional Deprecated as of version 1267. Currently ignored.
Secondary color for the Store. Specified in 6-digit Hex format. For example: F6F6C9
Max length: 6.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme
  .ColorSchemeID
int Conditional Deprecated as of version 1267. Currently ignored.
Store color scheme ID.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font StoreFontType Conditional Deprecated as of version 1267. Currently ignored.
Container consisting of the Store's font properties.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font
  .DescColor
string Conditional Deprecated as of version 1267. Currently ignored.
Font color for the Store description. Specified in 6-digit Hex format. For example: F6F6C9
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font
  .DescFace
StoreFontFaceCodeType Conditional Deprecated as of version 1267. Currently ignored.
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.

Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font
  .DescSize
StoreFontSizeCodeType Conditional Deprecated as of version 1267. Currently ignored.
Font size for the Store description.

Applicable values: See DescSize.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font
  .NameColor
string Conditional Deprecated as of version 1267. Currently ignored.
Font color for the Store name. Specified in 6-digit Hex format. For example: F6F6C9
Max length: 6.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font
  .NameFace
StoreFontFaceCodeType Conditional Deprecated as of version 1267. Currently ignored.
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.

Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font
  .NameSize
StoreFontSizeCodeType Conditional Deprecated as of version 1267. Currently ignored.
Font size for the Store name.

Applicable values: See NameSize.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font
  .TitleColor
string Conditional Deprecated as of version 1267. Currently ignored.
Font color for the Store section title. Specified in 6-digit Hex format. For example: F6F6C9
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font
  .TitleFace
StoreFontFaceCodeType Conditional Deprecated as of version 1267. Currently ignored.
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.

Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Font
  .TitleSize
StoreFontSizeCodeType Conditional Deprecated as of version 1267. Currently ignored.
Font size for the Store section title.

Applicable values: See TitleSize.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ColorScheme.Name string Conditional Deprecated as of version 1267. Currently ignored.
Store color scheme name.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.Name string Conditional Deprecated as of version 1267. Currently ignored.
Store theme name. Provides a user-friendly name for the theme.
Deprecation version: 1267. See also Deprecated Objects.
Store.Theme.ThemeID int Conditional Deprecated as of version 1267. Currently ignored.
Store theme ID (use GetStoreOptions to get the list of valid theme IDs).
Deprecation version: 1267. See also Deprecated Objects.
Store.TitleWithCompatibility boolean Optional Deprecated as of version 1267. Currently ignored.
A flag indicating if a Compatibility tab exists for the Store item listing. This field is only applicable to Parts & Accessories listings in eBay US Motors. The Compatibility tab will contain vehicles that are compatible with the part in the listing. The seller specifies this information at listing time.

Note: This field is deprecated, as the new Stores platform no longer supports custom store pages and other store customization functionality. This field will be decommissioned on September 30, 2022, and will be removed from the Trading WSDL at that time.
Deprecation version: 1267. See also Deprecated Objects.
Store.URL anyURI Conditional Deprecated as of version 1267. No longer recommended.
The complete URL of the user's Store. This field is only ever returned, and does not need to be explicitly set.
Deprecation version: 1267. See also Deprecated Objects.
Store.URLPath string Conditional Deprecated as of version 1267. No longer recommended.
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.
Deprecation version: 1267. See also Deprecated Objects.
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"?>
<SetStoreResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Output fields) -->

  <!-- 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>
</SetStoreResponse>
Return Value Type Occurrence Meaning
(No call-specific fields)
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 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 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 Compatible Application Check section of the eBay Features 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

Creates a store definition.

Description

Seller m***************r is just beginning to set up her eBay store, and she makes an intial call to SetStore to begin the process.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<SetStoreRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <DetailLevel>ReturnAll</DetailLevel>
  <LevelLimit>1</LevelLimit>
  <Store>
    <Name>M***********s</Name>
    <SubscriptionLevel>Basic</SubscriptionLevel>
    <Description>Books that take you places.</Description>
  </Store>
</SetStoreRequest>

Output

XML format.
<?xml version="1.0" encoding="utf-8"?>
<SetStoreResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-07T18:19:09.563Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_UNI_API5_19098188_R1</Build>
</SetStoreResponse>



Change History

Change Date Description
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.
0511
2007-05-02
  • Store.CustomListingHeader.BreadCrumb (deprecated): eBay no longer supports this functionality. This field is ignored (regardless of your request version). It has been deleted from the schema as of release 511.
0499
2007-02-07
  • CustomCategories.CategoryID, CustomCategories.ChildrenCategories, CustomCategories.Name, CustomCategories.Order (modified): Deleted previously deprecated objects from the latest schema. Some of these objects are still supported with lower request versions. See Deprecated Objects.
  • 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.
0461
2006-5-17
  • (modified) Several sites (UK, FR, ES, DE, AT, CH, IE) have lifted the feedback restrictions on opening an eBay store for Business Sellers.