GetNotificationPreferences

Retrieves the requesting application's notification preferences. Details are only returned for events for which a preference has been set. For example, if you enabled notification for the EndOfAuction event and later disabled it, the GetNotificationPreferences response would cite the EndOfAuction event preference as Disabled. Otherwise, no details would be returned regarding EndOfAuction.

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

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.

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.

You can use the OutputSelector field to restrict the data returned by a call. This field can make the call response easier to manage, especially when a large payload is returned. If you use the OutputSelector field, the output data will only include the field(s) you specified in the request, as well as all of its child fields (if a field is a container) and its parent fields (if any). Note that it is possible that a field included through an OutputSelector field may still not be returned if it is not applicable, or if it is not found based on other criteria set up in the request payload.

For example, if you are using GetItem and you only want to retrieve the URL of the View Item page (emitted in ViewItemURL field) and the item's Buy It Now price (emitted in BuyItNowPrice field), you would include two separate OutputSelector fields and set the value for each one as ViewItemURL and BuyItNowPrice as in the following example:

The version number of the API code that you are programming against (e.g., 859). 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.)

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.

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 the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The 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". Note that the AlertEnable field must be set to Enable for alert emails to be sent.

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) This enumeration value indicates that an application/URL/device is disabled, or being blocked from receiving notifications, or to indicate that a specific notification event is disabled.

Enable

(in/out) This enumeration value indicates that an application/URL/device is enabled to receive notifications, or to indicate that a specific notification event is enabled.

Code so that your app gracefully handles any future changes to this list.

This field allows the user to enable or disable Platform Notifications and Client Alerts. Notice that disabling Platform Notifications and Client Alerts will not affect others preferences set in this container.

Applicable values:

CustomCode

(in/out) Reserved for future use.

Disable

(in/out) This enumeration value indicates that an application/URL/device is disabled, or being blocked from receiving notifications, or to indicate that a specific notification event is disabled.

Enable

(in/out) This enumeration value indicates that an application/URL/device is enabled to receive notifications, or to indicate that a specific notification event is enabled.

Code so that your app gracefully handles any future changes to this list.

The URL to which eBay delivers all Platform Notifications and Client Alerts sent to the application. For delivery to a server, the URL begins with "http://" or "https://" and must be well formed. For delivery to an email address, the URL begins with ""mailto://" and specifies a valid email address.

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.

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.

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.

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) This enumeration value indicates that an application/URL/device is disabled, or being blocked from receiving notifications, or to indicate that a specific notification event is disabled.

Enable

(in/out) This enumeration value indicates that an application/URL/device is enabled to receive notifications, or to indicate that a specific notification event is enabled.

Code so that your app gracefully handles any future changes to this list.

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) This enumeration value indicates that buyer/seller notifications will be delivered through the Client Alerts system.

CustomCode

(in/out) Reserved for internal or future use.

Platform

(in/out) This enumeration value indicates that buyer/seller notifications will be delivered through the Platform Notifications system.

SMS

(in/out) This enumeration value indicates that buyer/seller notifications will be delivered through the SMS system to a wireless device.

Code so that your app gracefully handles any future changes to this list.

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.

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

Code so that your app gracefully handles any future changes to this list.

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.

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

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.

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.

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.

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.

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.

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.

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

An application subscribing to notifications can include an XML-compliant string, not to exceed 256 characters, which will be returned. The string can identify a particular user. Any sensitive information should be passed with due caution.

To subscribe to and receive eBay Buyer Protection notifications, this field is required, and you must pass in 'eBP notification' as a string.

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.

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.

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.

Change History

Change Date

Description

9912016-10-21

NotificationEventTypeCodeType (modified): The following five new notification event types were added: OrderInquiryOpened, OrderInquiryReminderForEscalation, OrderInquiryProvideShipmentInformation, OrderInquiryClosed, and OrderInquiryEscalatedToCase.

9292015-06-26

NotificationEventTypeCodeType.BuyerCancelRequested (added): This Added enumeration value indicates that a buyer has requested an order cancellation.

9092015-02-16

NotificationEventTypeCodeType (doc change): Clarified in the docs that the 'ItemClosed' notification is triggered when a fixed-price listing ends with or without sales. Clarified that the 'AuctionCheckoutComplete' notification is also applicable to fixed-price listings and not just auctions.

8852014-07-29

NotificationEventTypeCodeType (modified): M2MMessageStatusChange notification added. This notification is sent to a subscribed buyer or seller (or application) when a member-to-member (M2M) message is either deleted or marked as read in the InBox.

8552013-12-31

NotificationEventTypeCodeType (modified): EBNOrderPickedUp and EBNOrderCanceled notifications added. These notifications are sent to a subscribed merchant (or application) when an eBay Now order has been picked up (from the store by an eBay Now valet) or canceled, respectively.

8532013-12-05

NotificationEventTypeCodeType (modified): PaymentReminder notification added. This notification is sent to a subscribed buyer (or application) when that buyer has yet to pay for their order.

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

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

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