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:
Output Detail Controls Samples Change History |
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>
Argument | Type | Occurrence | Meaning |
---|
Call-specific Input Fields [Jump to standard fields] |
StorePreferences | StorePreferencesType | Required | This container is used to set the eBay Store's preferences. Currently, the only applicable eBay Store preferences are Store vacation preferences. |
StorePreferences .VacationPreferences |
StoreVacationPreferencesType | Optional | Store vacation hold preferences. |
StorePreferences .VacationPreferences .DisplayMessageStoreCustomText |
boolean | Optional |
In a SetStorePreferences call, this field should be included in the request and set to true if the eBay store owner wants a custom message regarding a vacation to display on store pages. For this field to have an affect, the seller will create their custom message regarding the vacation through the MessageStoreCustomText field. If this field is turned off (or false ), instead of a custom message, a generic 'On Vacation' message and the return date (if available) will be posted to the Store pages. In a GetStorePreferences call, this field is returned as true if the seller wants a customized vacation message to be displayed on the store page, or returned as false if the seller wants the generic 'On Vacation' message and the return date (if available) to be posted to the Store pages.
|
StorePreferences .VacationPreferences .MessageItem |
boolean | Optional |
In a SetStorePreferences call, this field should be included in the request and set to true if the eBay store owner wants information regarding the vacation to be posted on all of the seller's active listings. The following information will be displayed if this field is set to true :
false , no information regarding the seller's vacation will appear on active listings. In a GetStorePreferences call, this field is returned as true if information regarding the vacation is being displayed on active listings, or returned as false if no information regarding the vacation is being displayed on active listings.Default: True. |
StorePreferences .VacationPreferences .MessageStore |
boolean | Optional |
In a SetStorePreferences call, this field should be included in the request and set to true if the eBay store owner wants information regarding the vacation to be posted on store pages. The following information will be displayed if this field is set to true :
true if information regarding the vacation is being displayed on the store page, or returned as false if no information regarding the vacation is being displayed on the store page.
|
StorePreferences .VacationPreferences .MessageStoreCustomText |
string | Optional |
In a SetStorePreferences call, this field should be included in the request, and the seller will create the customized vacation message in this field. HTML markup can be used in this field. This vacation message will appear on store pages as long as the DisplayMessageStoreCustomText field is set to true . If the DisplayMessageStoreCustomText field is set to false , any text provided through the MessageStoreCustomText will not be displayed on store pages. In a GetStorePreferences call, this field is returned if it is set. Max length: 10000. |
StorePreferences .VacationPreferences .OnVacation |
boolean | Optional |
In a SetStorePreferences call, this field should be included in the request and set to true if the eBay store owner is going on vacation and wants to temporarily turn off all active listings. Conversely, if the eBay store owner is back from vacation, this field can be included and set to false to turn off the vacation setting. If the 'On Vacation' setting is turned on for an eBay store owner, all of the store owner's listings will be hidden from search, and shoppers can not buy any items from that store. In a GetStorePreferences call, this field is returned as true if the 'On Vacation' setting is turned on, or returned as false if the 'On Vacation' setting is turned off.
|
StorePreferences .VacationPreferences .ReturnDate |
dateTime | Optional |
In a SetStorePreferences call, this field should be included in the request if the eBay store owner wants to inform shoppers when he/she will return from vacation. The seller should make sure they use the proper date-time format, as specified in the dateTime simple type. If a date is specified in this field, the following behavior can be expected:
|
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.
|
||||||||||||||||||||||||||||||||||||||||
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:
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:
|
||||||||||||||||||||||||||||||||||||||||
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 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 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. |
Input Detail Controls Samples Change History |
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>
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: (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: 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: If the source of the problem is within the application (such as a missing required element), change the application before you retry the request.
See the Compatible Application Check section of the eBay Features Guide for more information. 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. |
Input Output Samples Change History |
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
Input Output Detail Controls Change History |
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>
Input Output Detail Controls Samples |
Change Date | Description |
---|
Copyright © 2005–2021 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.