SetNotificationPreferences

Use this call to manage notification and alert preferences for a user or an application. Notifications and alerts update users and applications about events on the eBay site, and help reduce the number of times your application needs to make API calls to retrieve information.

SetNotificationPreferences sets up event notifications based on event types and preferences that you specify in the request. A successful request subscribes a user or application to notifications about events on the eBay site.

Before using this call, please review the topic Working with Platform Notifications to understand the requirements and limitations of the Platform Notifications feature.

SetNotificationPreferences is part of eBay Platform Notifications, an optional feature that alerts applications and/or users when certain events occur on the eBay site. This feature is used by two separate eBay services:

The eBay Platform Notifications
The eBay Client Alerts API
The eBay Buyer Protection Notifications

Notifications are a great way to get real-time information about events on the eBay site, but you should always use API calls to make sure you are getting the information you need. For example, if you have subscribed to AuctionCheckoutComplete notification, you should also set up periodic polling of GetOrders.

Your application should respond to notifications with a standard HTTP status of 200 OK. After a significant number of unacknowledged notifications, eBay may stop sending notifications to your application.

Testing SetNotificationPreferences

You can test this call in the Sandbox. The preferences that you set in the Sandbox do not apply to Production, so once you have tested the call, you can use the same request to set your preferences in the Production environment.

Related Information

See Working with Platform Notifications.

See also the reference documentation for these calls:

GetNotificationPreferences - Retrieves the requesting application's notification preferences.
GetNotificationsUsage - Retrieves usage information about platform notifications for a given application.

SetNotificationPreferences 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"?>
<SetNotificationPreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ApplicationDeliveryPreferences> ApplicationDeliveryPreferencesType
    <AlertEmail> anyURI </AlertEmail>
    <AlertEnable> EnableCodeType </AlertEnable>
    <ApplicationEnable> EnableCodeType </ApplicationEnable>
    <ApplicationURL> anyURI </ApplicationURL>
    <DeliveryURLDetails> DeliveryURLDetailType
      <DeliveryURL> anyURI </DeliveryURL>
      <DeliveryURLName> string </DeliveryURLName>
      <Status> EnableCodeType </Status>
    </DeliveryURLDetails>
    <!-- ... more DeliveryURLDetails nodes allowed here ... -->
    <DeviceType> DeviceTypeCodeType </DeviceType>
    <NotificationPayloadType> NotificationPayloadTypeCodeType </NotificationPayloadType>
    <PayloadVersion> string </PayloadVersion>
  </ApplicationDeliveryPreferences>
  <DeliveryURLName> string </DeliveryURLName>
  <EventProperty> NotificationEventPropertyType
    <EventType> NotificationEventTypeCodeType </EventType>
    <Name> NotificationEventPropertyNameCodeType </Name>
    <Value> string </Value>
  </EventProperty>
  <!-- ... more EventProperty nodes allowed here ... -->
  <UserData> NotificationUserDataType
    <ExternalUserData> string </ExternalUserData>
    <SMSSubscription> SMSSubscriptionType
      <CarrierID> WirelessCarrierIDCodeType </CarrierID>
      <ErrorCode> SMSSubscriptionErrorCodeCodeType </ErrorCode>
      <ItemToUnsubscribe> ItemIDType (string) </ItemToUnsubscribe>
      <SMSPhone> string </SMSPhone>
      <UserStatus> SMSSubscriptionUserStatusCodeType </UserStatus>
    </SMSSubscription>
    <SummarySchedule> SummaryEventScheduleType
      <EventType> NotificationEventTypeCodeType </EventType>
      <Frequency> SummaryFrequencyCodeType </Frequency>
      <SummaryPeriod> SummaryWindowPeriodCodeType </SummaryPeriod>
    </SummarySchedule>
    <!-- ... more SummarySchedule nodes allowed here ... -->
  </UserData>
  <UserDeliveryPreferenceArray> NotificationEnableArrayType
    <NotificationEnable> NotificationEnableType
      <EventEnable> EnableCodeType </EventEnable>
      <EventType> NotificationEventTypeCodeType </EventType>
    </NotificationEnable>
    <!-- ... more NotificationEnable nodes allowed here ... -->
  </UserDeliveryPreferenceArray>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</SetNotificationPreferencesRequest>

Argument	Type	Occurrence	Meaning

Call-specific Input Fields [Jump to standard fields]

ApplicationDeliveryPreferences	ApplicationDeliveryPreferencesType	Optional	Specifies application-level event preferences that have been enabled, including the URL to which notifications should be delivered and whether notifications should be enabled or disabled (although the UserDeliveryPreferenceArray input property specifies specific notification subscriptions).
ApplicationDeliveryPreferences .AlertEmail	anyURI	Optional	The email address to which eBay sends all application markup and markdown event notifications. When setting the email address, input must be in the format mailto://youremailaddress@yoursite.com. Enable these alerts using the AlertEnable field. Max length: Length of valid email IDs.
ApplicationDeliveryPreferences .AlertEnable	EnableCodeType	Optional	For SetNotificationPreferences: include and set AlertEnable to 'Enable' to receive application markup and markdown alerts, or set to 'Disable' to disable the alerts. If not included, the AlertEnable defaults to its current value. For GetNotificationPreferences: this field's value indicates whether application markup and markdown alerts are enabled or disabled. Applicable values: • CustomCode (in/out) Reserved for future use. • Disable (in/out) The entry is disabled. • Enable (in/out) The entry is enabled.
ApplicationDeliveryPreferences .ApplicationEnable	EnableCodeType	Optional	Enables or disables notifications and alerts. If you disable notifications, the application will not receive them, but its notification preferences are preserved. Applicable values: • CustomCode (in/out) Reserved for future use. • Disable (in/out) The entry is disabled. • Enable (in/out) The entry is enabled.
ApplicationDeliveryPreferences .ApplicationURL	anyURI	Optional	The URL to which eBay delivers all notifications sent to the application. For delivery to a server, the URL begins with http:// or https:// and must be well formed. Use a URL that is functional at the time of the call. For delivery to an email address, the URL begins with mailto:// and specifies a valid email address.
ApplicationDeliveryPreferences .DeliveryURLDetails	DeliveryURLDetailType	Optional, repeatable: [0..*]	Defines settings for notification URLs (including the URL name in DeliveryURLName). You define settings for up to 25 notification URLs (including the URL name in DeliveryURLName) in separate DeliveryURLDetails containers. Associate a user token with notification URLs by using the token in a SetNotificationPreferences request that specifies the URL name or names in SetNotificationPreferencesRequest.DeliveryURLName. Use comma-separated format to specify multiple URL names in SetNotificationPreferencesRequest.DeliveryURLName. Notifications will be sent to these URL(s) if ApplicationDeliveryPreferencesType.ApplicationEnable is set to Enable.
ApplicationDeliveryPreferences .DeliveryURLDetails .DeliveryURL	anyURI	Optional	The address of a notification delivery URL. This address applies to the DeliveryURLName within the same ApplicationDeliveryPreferences.DeliveryURLDetails container. For delivery to a server, the URL begins with http:// or https:// and must be well formed. Use a URL that is functional at the time of the call. For delivery to an email address, the URL begins with mailto: and specifies a valid email address.
ApplicationDeliveryPreferences .DeliveryURLDetails .DeliveryURLName	string	Optional	The name of a notification delivery URL. You can list up to 25 instances of DeliveryURLName, and then subscribe these URLs to notifications by listing them in comma- separated format in the DeliveryURLName element outside of ApplicationDeliveryPreferences.
ApplicationDeliveryPreferences .DeliveryURLDetails.Status	EnableCodeType	Optional	The status of a notification delivery URL. This status applies to the DeliveryURLName and delivery URL within the same ApplicationDeliveryPreferences.DeliveryURLDetails container. If the status is disabled, then notifications will not be sent to the delivery URL. Applicable values: • CustomCode (in/out) Reserved for future use. • Disable (in/out) The entry is disabled. • Enable (in/out) The entry is enabled.
ApplicationDeliveryPreferences .DeviceType	DeviceTypeCodeType	Optional	The means of receipt of notification. In most cases, it is Platform (typical API calls and web interaction), so this is the default, if not specified. For wireless applications, use SMS. Do not test Client Alerts in production if you are currently using Platform Notifications. Applicable values: • ClientAlerts (in/out) Warning: do NOT set this value in production if you currently use Platform Notifications with this application ID. Setting this value will discontinue all platform notifications for this application ID, until this value is reset to Platform. Set this enum value to specify that the notification client is a Client Alerts API client. Alerts will be delivered through the Client Alerts system. • CustomCode (in/out) Reserved for internal or future use. • Platform (in/out) Typical API, web page interaction. • SMS (in/out) For SMS/wireless application. Note that SMS is currently reserved for future use.
ApplicationDeliveryPreferences .NotificationPayloadType	NotificationPayloadTypeCodeType	Optional	If this field is specified, the value must be eBLSchemaSOAP. Applicable values: • CustomCode (in/out) Reserved for internal or future use • eBLSchemaSOAP (in/out) New Schema format (used by the new schema XML API and SOAP API).
ApplicationDeliveryPreferences .PayloadVersion	string	Optional	Use this field to specify the API version for all notifications for the calling application. If you do not specify PayloadVersion in SetNotificationPreferences, the API version for notifications will be based on the API version specified in your SetNotificationPreferences call.
DeliveryURLName	string	Optional	Specifies up to 25 ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName to associate with a user token sent in a SetNotificationPreferences request. To specify multiple DeliveryURLNames, create separate instances of ApplicationDeliveryPreferences.DeliveryURLDetails.DeliveryURLName, and then enable up to 25 DeliveryURLNames by including them in comma-separated format in this field.
EventProperty	NotificationEventPropertyType	Optional, repeatable: [0..*]	Characteristics or details of an event such as type, name and value. Currently can only be set for wireless applications.
EventProperty.EventType	NotificationEventTypeCodeType	Optional	The name of the notification event. Applicable values: See EventType.
EventProperty.Name	NotificationEventPropertyNameCodeType	Optional	Specify property name associated with an particular event. Applicable values: • CustomCode (in/out) Reserved for future use. • TimeLeft (in/out) Property name for WatchedItemEndingSoon events, enabling a user to specify a time in minutes before the end of the listing. Acceptable values: 5, 10, 15, 30, 60, 75, and 180. For example, to receive a WatchedItemEndingSoon notification 30 minutes before the item listing ends, specify 30.
EventProperty.Value	string	Optional	Specifies the value for the property.
UserData	NotificationUserDataType	Optional	Specifies user data for notification settings, such as mobile phone number.
UserData.ExternalUserData	string	Conditional	An application subscribing to notifications can include an XML-compliant string, not to exceed 256 characters, which will be returned in the notification payload. The string can contain user-specific information to identify a particular user. Any sensitive information should be passed with due caution and proper encryption.
UserData.SMSSubscription	SMSSubscriptionType	Conditional	User data related to SMS notifications. SMS is currently reserved for future use.
UserData.SMSSubscription .CarrierID	WirelessCarrierIDCodeType	Optional	The wireless carrier ID. Applicable values: • Alltel • Amena • ATT • CincinnatiBell • Cingular • CustomCode • Dobson • Leap • Movistar • Nextel • Sprint • TMobile • USCellular • Verizon • Vodafone
UserData.SMSSubscription .ErrorCode	SMSSubscriptionErrorCodeCodeType	Optional	Reason for SMS subscription error (postback from thired-party integrator). Applicable values: • CustomCode (in/out) Reserved for internal or future use. • PhoneNumberCarrierChanged (in/out) The carrier has changed. • PhoneNumberChanged (in/out) Phone number has changed. • PhoneNumberInvalid (in/out) Phone number invalid. • SMSAggregatorNotAvailable (in/out) Aggregator not available. • UserRequestedUnregistration (in/out) The user has requested to be unregistered.
UserData.SMSSubscription .ItemToUnsubscribe	ItemIDType (string)	Optional	ID of item to unsubscribe from SMS notification.
UserData.SMSSubscription .SMSPhone	string	Optional	The wireless phone number to be used for receiving SMS messages. Max length of phone number varies by country. Max length: varies by country.
UserData.SMSSubscription .UserStatus	SMSSubscriptionUserStatusCodeType	Optional	Registered/Unregistered/Pending. Applicable values: • CustomCode (in/out) Reserved for internal or future use. (Not all values in SMSSubscriptionUserStatusCodeType apply to this field.)
UserData.SummarySchedule	SummaryEventScheduleType	Conditional, repeatable: [0..*]	User account activity summary alert delivery schedule. Returned if PreferenceLevel is set to UserData in GetNotificationPreferences. See "Working with Platform Notifications" for instructions on "Informational Alerts".
UserData.SummarySchedule .EventType	NotificationEventTypeCodeType	Conditional	The event type associated with this alert. Applicable values: See EventType.
UserData.SummarySchedule .Frequency	SummaryFrequencyCodeType	Conditional	How often the summary is to be delivered. Applicable values: See Frequency.
UserData.SummarySchedule .SummaryPeriod	SummaryWindowPeriodCodeType	Conditional	The period of time for which to create a summary. Applicable values: • CurrentMonth (in/out) The current month. • CurrentWeek (in/out) The current week. • CustomCode (in/out) • Last24Hours (in/out) The last 24 hours. • Last31Days (in/out) The last 31 days. • Last60Days (in/out) The last 60 days. • Last7Days (in/out) The last 7 days. • LastMonth (in/out) The prior month. • LastWeek (in/out) The prior week.
UserDeliveryPreferenceArray	NotificationEnableArrayType	Optional	Specifies events and whether or not they are enabled.
UserDeliveryPreferenceArray .NotificationEnable	NotificationEnableType	Optional, repeatable: [0..*]	Specifies one notification or alert event and whether it is enabled or disabled. Returned if previously set.
UserDeliveryPreferenceArray .NotificationEnable .EventEnable	EnableCodeType	Optional	Whether the event is enabled or disabled. Applicable values: • CustomCode (in/out) Reserved for future use. • Disable (in/out) The entry is disabled. • Enable (in/out) The entry is enabled.
UserDeliveryPreferenceArray .NotificationEnable.EventType	NotificationEventTypeCodeType	Optional	The name of the notification event. Applicable values: See EventType.

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. 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	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., 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: Routing the Request (Gateway URLs) 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.

SetNotificationPreferences 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"?>
<SetNotificationPreferencesResponse 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>
</SetNotificationPreferencesResponse>

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

SetNotificationPreferences Detail Controls

Detail Control: DetailLevel

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

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

Sample: Basic Call

Sets alert and notification preferences.

Description

Magical Bookseller sets her notification preferences so that she can get SOAP notifications emailed to her when her listings undergo events. She wants notifications that confirm her items are listed and that tell her when a buyer has bid on a listed item, that an auction has ended, and that the buyer has left feedback on the sale.

Input

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

<?xml version="1.0" encoding="utf-8"?>
<SetNotificationPreferencesRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<RequesterCredentials>
<eBayAuthToken>ABC...123</eBayAuthToken>
</RequesterCredentials>
<Version>697</Version>
<ApplicationDeliveryPreferences>
<AlertEmail>mailto://magicalbookseller@yahoo.com</AlertEmail>
<AlertEnable>Enable</AlertEnable>
<ApplicationEnable>Enable</ApplicationEnable>
<ApplicationURL>mailto://magicalbookseller@yahoo.com</ApplicationURL>
<DeviceType>Platform</DeviceType>
</ApplicationDeliveryPreferences>
<UserDeliveryPreferenceArray>
<NotificationEnable><EventType>BidReceived</EventType>
<EventEnable>Enable</EventEnable>
</NotificationEnable>
<NotificationEnable><EventType>Feedback</EventType>
<EventEnable>Enable</EventEnable>
</NotificationEnable>
<NotificationEnable><EventType>EndOfAuction</EventType>
<EventEnable>Enable</EventEnable>
</NotificationEnable>
<NotificationEnable><EventType>ItemListed</EventType>
<EventEnable>Enable</EventEnable>
</NotificationEnable>
</UserDeliveryPreferenceArray>
</SetNotificationPreferencesRequest>

Output

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

<?xml version="1.0" encoding="UTF-8"?>
<SetNotificationPreferencesResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2010-12-30T00:24:21.635Z</Timestamp>
  <Ack>Success</Ack>
  <Version>699</Version>
  <Build>E699_CORE_BUNDLED_12457306_R1</Build>
</SetNotificationPreferencesResponse>

SetNotificationPreferences Change History

Version	Description
817 2013-03-27	NotificationEventTypeCodeType (modified): ShoppingCartItemEndingSoon notification added. This notification is sent to the subscribed buyer (or application) when the listing for an unpurchased item in the buyer's cart is about to end.
771 2012-04-25	NotificationEventTypeCodeType.RefundSuccess (added): Notification sent to a subscribed DE/AT seller when a refund for an order going through the new eBay payment process is successful. NotificationEventTypeCodeType.RefundFailure (added): Notification sent to a subscribed DE/AT seller when a refund for an order going through the new eBay payment process fails. NotificationEventTypeCodeType.UnmatchedPaymentReceived (added): Notification sent to the subscribed DE/AT seller when the buyer's EFT payment for an order does not match the original amount at order creation time. NotificationEventTypeCodeType.ReturnClosed (added): Notification sent to the subscribed buyer and seller when an eBay return is closed. NotificationEventTypeCodeType.ReturnCreated (added): Notification sent to the subscribed buyer and seller when an eBay return is created. NotificationEventTypeCodeType.ReturnDelivered (added): Notification sent to the subscribed buyer and seller when the item associated with the return is received by the seller. NotificationEventTypeCodeType.ReturnEscalated (added): Notification sent to the subscribed buyer and seller when an eBay return is escalated to an eBay Buyer Protection case. NotificationEventTypeCodeType.ReturnRefundOverdue (added): Notification sent to the subscribed seller when the seller's refund to the buyer is overdue. NotificationEventTypeCodeType.ReturnSellerInfoOverdue (added): Notification sent to the subscribed buyer and seller when seller information (Return Merchandise Authorization number and/or alternative return shipping address) due to the buyer is overdue. NotificationEventTypeCodeType.ReturnShipped (added): Notification sent to the subscribed buyer and seller when the item associated with the return is return shipped from the buyer back to the seller. NotificationEventTypeCodeType.ReturnWaitingForSellerInfo (added): Notification sent to the subscribed seller when an eBay return is waiting for the seller to provide an Return Merchandise Authorization number and/or an alternative return shipping address to the buyer.
731 2011-07-20	NotificationEventTypeCodeType.ReadyForPayout (added): New Seller Payout notification sent to a German or Austrian seller when eBay has released the hold on a seller's funds. NotificationEventTypeCodeType.ReadyToShip (added): New Seller Payout notification sent to a German or Austrian seller when the buyer has paid for the order.
687 2010-09-15	NotificationEventTypeCodeType.EBPAppealedCase (added): New eBay Buyer Protection notification. NotificationEventTypeCodeType.EBPClosedAppeal (added): New eBay Buyer Protection notification. NotificationEventTypeCodeType.EBPClosedCase (added): New eBay Buyer Protection notification. NotificationEventTypeCodeType.EBPEscalatedCase (added): New eBay Buyer Protection notification. NotificationEventTypeCodeType.EBPMyPaymentDue (added): New eBay Buyer Protection notification. NotificationEventTypeCodeType.EBPMyResponseDue (added): New eBay Buyer Protection notification. NotificationEventTypeCodeType.EBPOtherPartyResponseDue (added): New eBay Buyer Protection notification. NotificationEventTypeCodeType.EBPPaymentDone (added): New eBay Buyer Protection notification.
685 2010-08-1	NotificationEventTypeCodeType.MyMessagesAlertMessage (deprecated): Only returned for versions lower than 685. Replaced by MyMessagesHighPriorityMessage. NotificationEventTypeCodeType.MyMessagesAlertMessageHeader (deprecated): Only returned for versions lower than 685. Replaced by MyMessagesHighPriorityMessageHeader.
677 2010-07-07	NotificationEventTypeCodeType.MyMessagesHighPriorityMessage (added): New notification. NotificationEventTypeCodeType.MyMessagesHighPriorityMessageHeader (added): New notification.
601 2009-01-21	NotificationEventTypeCodeType.ItemMarkedPaid (added): New User Alert notifications added for buyers.
583 2008-09-17	NotificationUserDataType.ExternalUserData (added): String that can be returned with notification payload.
569 2008-06-11	DeviceTypeCodeType.ClientAlerts (added): Switches delivery protocol from Platform Notifications to Client Alerts.
567 2008-05-28	ApplicationDeliveryPreferences.DeliveryURLDetails (added): Container for delivery URL information. NotificationEventTypeCodeType (modified): Inaccurate note that call does not work in Sandbox removed.
553 2008-02-20	NotificationEventTypeCodeType.ItemAddedToWatchList (added): New notification added. NotificationEventTypeCodeType.FeedbackLeft (added): New notification added. NotificationEventTypeCodeType.FeedbackReceived (added): New notification added. NotificationEventTypeCodeType.BestOfferPlaced (added): New notification added. NotificationEventTypeCodeType.BestOfferDeclined (added): New notification added. NotificationEventTypeCodeType.CounterOfferReceived (added): New notification added. NotificationEventTypeCodeType.BidPlaced (added): New notification added. NotificationEventTypeCodeType.BidReceived (added): New notification added. NotificationEventTypeCodeType.ItemWon (added): New notification added. NotificationEventTypeCodeType.ItemLost (added): New notification added. NotificationEventTypeCodeType.ItemSold (added): New notification added. NotificationEventTypeCodeType.ItemRemovedFromWatchList (added): New notification added. NotificationEventTypeCodeType.ItemUnsold (added): New notification added. NotificationEventTypeCodeType.FeedbackStarChanged (added): New notification added. NotificationEventTypeCodeType.ItemAddedToBidList (added): New notification added. NotificationEventTypeCodeType.ItemRemovedFromBidList (added): New notification added.
535 2007-10-17	ApplicationDeliveryPreferences.PayloadVersion (added): The API version for all notifications for the calling application.
435 2005-11-16	(modified) Use of notifications in the production environment is no longer restricted to certain membership tiers.
425 2005-9-7	(added) Additional ItemNotReceived notifications can be subscribed to using SetNotificationPreferences. See "INR (ItemNotReceived) Notifications" for information on the ItemNotReceived notifications.
423 2005-8-24	(added) Additional MyMessages notifications can be subscribed to using SetNotificationPreferences. See "MyMessages Notification" for information on the MyMessages notifications.

User-Contributed Notes

eBay Trading API Call Reference Version 821