eBay Trading APIVersion 1371


Type used by the ApplicationDeliveryPreferences container to control/indicate where and how Platform Notifications and/or Client Alerts are delivered to a user application, server, and/or email address.

Types that use ApplicationDeliveryPreferencesType:

Calls that use ApplicationDeliveryPreferencesType:


AlertEmail ( anyURI ) [0..1]
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.
See the Field Index to learn which calls use AlertEmail.

AlertEnable ( EnableCodeType ) [0..1]
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.
See the Field Index to learn which calls use AlertEnable.

ApplicationEnable ( EnableCodeType ) [0..1]
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.
See the Field Index to learn which calls use ApplicationEnable.

ApplicationURL ( anyURI ) [0..1]
The URL to which eBay delivers all Platform Notifications and Client Alerts sent to the application. For delivery to a server, the URL must begin with "https://" and must be well formed.
See the Field Index to learn which calls use ApplicationURL.

DeliveryURLDetails ( DeliveryURLDetailType ) [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.
See the Field Index to learn which calls use DeliveryURLDetails.

DeviceType ( DeviceTypeCodeType ) [0..1]
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.
See the Field Index to learn which calls use DeviceType.

NotificationPayloadType ( NotificationPayloadTypeCodeType ) [0..1]
The value in this field indicates the type of schema to use for notification payloads. The only supported value is eBLSchemaSOAP, so this field no longer has to be included in a SetNotificationPreferences call, since it defaults toeBLSchemaSOAP.
See the Field Index to learn which calls use NotificationPayloadType.

PayloadVersion ( string ) [0..1]
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.
See the Field Index to learn which calls use PayloadVersion.