SetStorePreferences

Use this call to set the preferences for a user's eBay Store. Store preferences include the ability for the Store owner to indicate that they are currently away on vacation, and options on how to handle current listings during a vacation, such as by hiding fixed price items for the duration.

For more information on using this call, including a table of the preferences that can be set, see Managing a User's Store Preferences.

You can test this call in the Sandbox. To test SetStorePreferences, first create an eBay Store with a test user on the Sandbox web site. Next, call SetStorePreferences to set the preferences for a store. Call GetStorePreferences to retrieve the user's preferences for that store and check that they were set correctly. After they have been set, you can browse to the store in the Sandbox web site and observe how the Store preference affects the Store (if at all).

See Managing eBay Store Preferences.

See also the reference documentation for this call:

• GetStorePreferences - This call is used to retrieve an eBay seller's Store preferences.

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"?>
<SetStorePreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <StorePreferences> StorePreferencesType
    <VacationPreferences> StoreVacationPreferencesType
      <DisplayMessageStoreCustomText> boolean </DisplayMessageStoreCustomText>
      <MessageItem> boolean </MessageItem>
      <MessageStore> boolean </MessageStore>
      <MessageStoreCustomText> string </MessageStoreCustomText>
      <OnVacation> boolean </OnVacation>
      <ReturnDate> dateTime </ReturnDate>
    </VacationPreferences>
  </StorePreferences>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetStorePreferencesRequest>

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"?>
<SetStorePreferencesResponse 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>
</SetStorePreferencesResponse>

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.

Sets the eBay store preferences, indicating the owner is on vacation.

Description

This sample shows how to specify that you are on vacation. The specified message text will be displayed on each store page, and a standard message will be displayed with all your active item listings.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<SetStorePreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <StorePreferences>
    <VacationPreferences>
      <OnVacation>true</OnVacation>
      <ReturnDate>2016-10-28T00:00:00</ReturnDate>
      <DisplayMessageStoreCustomText>true</DisplayMessageStoreCustomText>
      <MessageStoreCustomText>
        I'm on vacation right now. I will return in late October to process
        your order and answer all your questions.
      </MessageStoreCustomText>
      <MessageItem>true</MessageItem>
    </VacationPreferences>
  </StorePreferences>
</SetStorePreferencesRequest>

Output

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

Change History