GetNotificationsUsage

Use this call to retrieve information about platform notifications sent to a given application. Use GetNotificationsUsage to confirm you are being sent all the platform notifications to which you have subscribed or to troubleshoot problems with notification delivery.

Before using this call, review the Platform Notifications Guide to understand the requirements and limitations of the Platform Notifications feature.

The following information is included in the response:

Start of time period-the beginning of the time period for which notification information is being retrieved.
End of time period-the end of the time period for which notification information being retrieved.
Notification details-information about individual notifications triggered by events associated with the specified item. You must specify ItemID to get this information. Notification details include:

Delivery URL
Reference identifier for the notification
Scheduled expiration time for the notification
Type of notification
Number of times eBay has attempted to deliver a notification after initially failing
Delivery status
Time for the next scheduled delivery attempt
Error message for the notification

Communication history-if a significant number of notification deliveries fail, the application will be automatically marked as down, and eBay will stop sending notifications subscribed to by the application. When an application is marked as down, eBay will ping the application periodically to check if communication has been restored. When communication is restored, eBay will mark the application as up.
Summary notification statistics-for the given time period, the following statistics are provided:

Number of notifications that were delivered successfully
Number of new notifications that were queued
Number of pending notifications remain in the queue
Number of scheduled notifications that expired
Number of notification deliveries that failed

Usage Details

In the request, you can use StartTime and EndTime to specify a time period for which to retrieve notification activity. StartTime can be set to any time up to 72 hours prior to the time you make the call, and EndTime can be set to any time later than the StartTime, up to the time the call is make. By default, StartTime is set to 24 hours prior to making the call, and EndTime is set to the time of the call. Therefore, if StartTime and EndTime are not specified, GetNotificationsUsage retrieves notification usage information for the 24 hours prior to making the call.

The use of GetNotificationsUsage is limited to 50 calls per application, per hour.

Working with the Response

When ItemID is specified, and notifications were triggered during the given time period for events associated with the item, the GetNotificationsUsage response includes a NotificationDetailsArray containing details the individual notifications. This information may help you troubleshoot problems with your notification preferences.

The call response always includes MarkUpMarkDownHistory and NotificationStatistics. MarkUpMarkDownHistory contains a list of any mark-up or mark-down events that occurred during the given time period for your application. If eBay does not receive the required response when it sends a notification (HTTP status 200 OK), eBay assumes the notification delivery failed. If a significant number of notification deliveries fail, the application will be automatically marked as down, and eBay will stop sending notifications subscribed to by the application. If your application stays marked down for an extended period, or if eBay has manually marked the application as down, contact Developer Support to have your application status marked up.

NotificationStatistics lists summary quantities for notification status types. This information gives you a quick overview of notification usage for your application.

Managing the Volume of the Response

Max Records Submitted/Returned
There is currently no limit on the amount of notification usage information returned. You can reduce the time period for the call to limit the size of the response.

Detail Levels
GetNotificationsUsage does not support multiple detail levels. It is not necessary to specify a detail level for this call.

Pagination
GetNotificationsUsage does not require or support pagination.

Data Filters
GetNotificationsUsage does not provide data filters for reducing the volume of the response.

Reducing the Number of Calls You Make
GetNotificationsUsage use for a given application is limited to 50 calls per hour. Take care in specifying the ItemID and date/time range to ensure you get the data you are interested in.

Related Information

See Platform Notifications Guide.

Input Output Detail Controls Samples Change History

Input

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"?>
<GetNotificationsUsageResponse xmlns="urn:ebay:apis:eBLBaseComponents">
 <!-- Call-specific Output Fields -->
 <EndTime> dateTime </EndTime>
 <MarkUpMarkDownHistory> MarkUpMarkDownHistoryType
 <MarkUpMarkDownEvent> MarkUpMarkDownEventType
 <Reason> string </Reason>
 <Time> dateTime </Time>
 <Type> MarkUpMarkDownEventTypeCodeType </Type>
 </MarkUpMarkDownEvent>
 <!-- ... more MarkUpMarkDownEvent nodes allowed here ... -->
 </MarkUpMarkDownHistory>
 <NotificationDetailsArray> NotificationDetailsArrayType
 <NotificationDetails> NotificationDetailsType
 <DeliveryStatus> NotificationEventStateCodeType </DeliveryStatus>
 <DeliveryTime> dateTime </DeliveryTime>
 <DeliveryURL> anyURI </DeliveryURL>
 <DeliveryURLName> string </DeliveryURLName>
 <ErrorMessage> string </ErrorMessage>
 <ExpirationTime> dateTime </ExpirationTime>
 <NextRetryTime> dateTime </NextRetryTime>
 <Retries> int </Retries>
 <Type> NotificationEventTypeCodeType </Type>
 </NotificationDetails>
 <!-- ... more NotificationDetails nodes allowed here ... -->
 </NotificationDetailsArray>
 <NotificationStatistics> NotificationStatisticsType
 <DeliveredCount> int </DeliveredCount>
 <ErrorCount> int </ErrorCount>
 <ExpiredCount> int </ExpiredCount>
 <QueuedNewCount> int </QueuedNewCount>
 <QueuedPendingCount> int </QueuedPendingCount>
 </NotificationStatistics>
 <StartTime> dateTime </StartTime>
 <!-- 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>
</GetNotificationsUsageResponse>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

EndTime dateTime Always Returns the end date and time for the notification information that is returned by this call.

MarkUpMarkDownHistory MarkUpMarkDownHistoryType Always List of objects representing MarkUp or MarkDown history for a given appID and for given StartTime and EndTime. This node will always be returned.

MarkUpMarkDownHistory
.MarkUpMarkDownEvent MarkUpMarkDownEventType Conditionally,
repeatable: [0..*] Details for a MarkDown or MarkUp event.

MarkUpMarkDownHistory
.MarkUpMarkDownEvent.Reason string Conditionally Describes how the application was marked down, automatically or manually. When an application is automatically marked down, eBay will ping the application periodically, and if communication is restored, eBay will automatically mark the application up. If your application is marked down manually, you must contact eBay Developer Support to get your application marked up. A Reason is not provided for mark up events.

MarkUpMarkDownHistory
.MarkUpMarkDownEvent.Time dateTime Conditionally Time when the application was marked up or marked down.

MarkUpMarkDownHistory
.MarkUpMarkDownEvent.Type MarkUpMarkDownEventTypeCodeType Conditionally Whether the application has been marked up or marked down.

Applicable values:

CustomCode

(out) Reserved for future internal or external use.

MarkDown

(out) Status indicating the application was marked down.

MarkUp

(out) Status indicating the application was or is marked up.

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

NotificationDetailsArray NotificationDetailsArrayType Always List of notification objects representing the notifications sent to an application for the given time period.

NotificationDetailsArray
.NotificationDetails NotificationDetailsType Conditionally,
repeatable: [0..*] Each NotificationDetails container consists of detailed information about one notification. NotificationDetails container(s) are only returned if there were one or more notifications related to this listing during the specified time range.

NotificationDetailsArray
.NotificationDetails
.DeliveryStatus NotificationEventStateCodeType Conditionally Returns the notification status. Possible values include Delivered, Failed, Rejected, and MarkedDown.

Applicable values: See DeliveryStatus.
Code so that your app gracefully handles any future changes to this list.

NotificationDetailsArray
.NotificationDetails
.DeliveryTime dateTime Conditionally Returns the time when the notification was delivered.

NotificationDetailsArray
.NotificationDetails
.DeliveryURL anyURI Conditionally Returns the destination address for the notification. This is the value set using SetNotificationPreferences.

NotificationDetailsArray
.NotificationDetails
.DeliveryURLName string Conditionally Returns the delivery URL name for the notification. This is the value set using SetNotificationPreferences.

NotificationDetailsArray
.NotificationDetails
.ErrorMessage string Conditionally Returns the error message.

NotificationDetailsArray
.NotificationDetails
.ExpirationTime dateTime Conditionally Date and time when this notification will be removed from the eBay system.

NotificationDetailsArray
.NotificationDetails
.NextRetryTime dateTime Conditionally Returns the time when the notification is scheduled for retry. This won't be included if the DeliveryStatus is Delivered.

NotificationDetailsArray
.NotificationDetails.Retries int Conditionally Returns the total number of retries for the given notification.

NotificationDetailsArray
.NotificationDetails.Type NotificationEventTypeCodeType Conditionally The returned enumeration value indicates the type of platform notification,

Applicable values: See Type.
Code so that your app gracefully handles any future changes to this list.

NotificationStatistics NotificationStatisticsType Always Summary information about number of notifications that were successfully delivered, queued, failed, connection attempts made, connection timeouts, http errors for the given appID and given time period. By default, statistics for only one day (Now-1day) is included. Maximum time duration allowed is 3 days (Now-3days).

NotificationStatistics
.DeliveredCount int Always Returns the number of notifications delivered successfully during the given time period.

NotificationStatistics
.ErrorCount int Always Returns the number of notifications for which there were delivery errors during the given time period.

NotificationStatistics
.ExpiredCount int Always Returns the number of notifications that permanently failed during the given time period.

NotificationStatistics
.QueuedNewCount int Always Returns the number of new notifications that were queued during the given time period.

NotificationStatistics
.QueuedPendingCount int Always Returns the number of pending notifications in the queue during the given time period.

StartTime dateTime Always Returns the start date and time for the notification information that is returned by this call.

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:

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.

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

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.

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 Errors By Number.

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:

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.

See the Error handling section of the Making a Trading API call guide for more information.

Warning

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

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 Detail Controls Samples Change History

Detail Controls

DetailLevel

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

Input Output Detail Controls Samples Change History

Samples

Code samples not yet added for this call's documentation.

Input Output Detail Controls Samples Change History

Change History

Change Date	Description
1421 2025年07月15日	NotificationEventTypeCodeType (modified): The following notification event enumerated values were decommissioned: `AccountSuspended`, `BuyerNoShow`, `AccountSummary`, `AccountSuspended`, `EBNOrderCanceled`, `EBNOrderPickedUp`, `EmailAddressChanged`, `None`, `PasswordChanged`, `PasswordHintChanged`, `PaymentDetailChanged`, and `WebnextMobilePhotoSync`.
1323 2018年08月25日	NotificationEventTypeCodeType (modified): The following seven notification event enumerated values were deprecated: `OrderInquiryClosed`, `OrderInquiryOpened`, `INRBuyerOpenedDispute`, `OrderInquiryProvideShipmentInformation`, `OrderInquiryEscalatedToCase`, `INRBuyerClosedDispute`, and `INRSellerRespondedToDispute`.
0991 2016年10月21日	NotificationEventTypeCodeType (modified): The following five new notification event types were added: `OrderInquiryOpened`, `OrderInquiryReminderForEscalation`, `OrderInquiryProvideShipmentInformation`, `OrderInquiryClosed`, and `OrderInquiryEscalatedToCase`.
0929 2015年06月26日	NotificationEventTypeCodeType.BuyerCancelRequested (added): This Added enumeration value indicates that a buyer has requested an order cancellation.
0909 2015年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.
0885 2014年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.
0855 2013年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.
0853 2013年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.
0817 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.
0771 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.
0731 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.
0687 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.
0567 2008年05月28日	NotificationDetailsArray.NotificationDetails.DeliveryURLName (added): Returns the destination URL delivery detail name for the notification. This is the value set using SetNotificationPreferences.
0553 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.
0535 2007年10月17日	ApplicationDeliveryPreferences.PayloadVersion (added): The API version for all notifications for the calling application.