Skip to main content
Published: January 30 2006, 5:24:00 PMUpdated: November 28 2020, 1:54:14 PM

You can use the GetNotificationsUsage call to recieve summary and detailed information on your applications notifications status. Below is a sample request and response, with an explanation of the response fields. Use this call to check the overall status of your notifications deliveries, or check status on a particular item.

---------------------------------------------------------------------------------------------------------------

A sample request:

<?xml version="1.0" encoding="utf-8"?>
<GetNotificationsUsageRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<Version>445</Version>
<RequesterCredentials>
<eBayAuthToken>TOKEN</eBayAuthToken>
</RequesterCredentials>
<StartTime>2006-01-24T22:42:18.625Z</StartTime>
<EndTime>2006-01-25T22:42:18.625Z</EndTime>
<ItemID>6842492913</ItemID>
</GetNotificationsUsageRequest>

* StartTime cannot be more than 72 hours from the present time
* Default StartTime and EndTime is 24 hours
* ItemID is optional. If not used, only summary data will be returned



----------------------------------------------------------------------------------------------------------------------
A sample response

Below is a response in which there was a notification failure.

<GetNotificationsUsageResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2006-01-25T23:22:48.859Z</Timestamp>
<Ack>Success</Ack>
<Version>445</Version>
<Build>e445_core_Bundled_2339600_R1</Build>
<StartTime>2006-01-24T22:42:18.625Z</StartTime>
<EndTime>2006-01-25T22:42:18.625Z</EndTime>
<NotificationDetailsArray>
<NotificationDetails>
<DeliveryURL>http://www.samplelistener.com/platformnotification.asp</DeliveryURL>
<ReferenceID>6842492913:6152974</ReferenceID>
<ExpirationTime>2006-01-26T21:42:33.000Z</ExpirationTime>
<Type>EndOfAuction</Type>
<Retries>1</Retries>
<DeliveryStatus>Failed</DeliveryStatus>
<NextRetryTime>2006-01-26T07:42:37.000Z</NextRetryTime>
<ErrorMessage>|[Notification HttpEventSender Error:
com.ebay.kernel.service.invocation.client.exception.ReceivingTimeoutException: Socket read from
www.samplelistener.com timed out after 3,000 milli-seconds.] </ErrorMessage>
</NotificationDetails>
</NotificationDetailsArray>
<MarkUpMarkDownHistory/>
<NotificationStatistics>
<DeliveredCount>2586</DeliveredCount>
<QueuedNewCount>0</QueuedNewCount>
<QueuedPendingCount>0</QueuedPendingCount>
<ExpiredCount>0</ExpiredCount>
<ErrorCount>180</ErrorCount>
</NotificationStatistics>
</GetNotificationsUsageResponse>

--------------------------------------------------------------------------------------------------------------------

Below is a response in which there was a delivery failure and then a successful delivery upon retry

<?xml version="1.0" encoding="UTF-8"?>
<GetNotificationsUsageResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<Timestamp>2006-01-26T21:03:26.477Z</Timestamp>
<Ack>Warning</Ack>
<Version>445</Version>
<Build>e445_core_Bundled_2339600_R1</Build>
<StartTime>2006-01-25T21:03:14.336Z</StartTime>
<EndTime>2006-01-26T21:03:14.336Z</EndTime>
<NotificationDetailsArray>
<NotificationDetails>
<DeliveryURL>http://www.samplelistener.com/platformnotification.asp</DeliveryURL>
<ReferenceID>5464274151:6152974</ReferenceID>
<ExpirationTime>2006-01-26T22:17:44.000Z</ExpirationTime>
<Type>EndOfAuction</Type>
<Retries>2</Retries>
<DeliveryStatus>Delivered</DeliveryStatus>
<NextRetryTime>2006-01-26T08:17:47.000Z</NextRetryTime>
<DeliveryTime>2006-01-26T08:17:48.000Z</DeliveryTime>
<ErrorMessage>
ception.ReceivingTimeoutException: Socket read from www.samplelistener.com timed out
after 3,000 milli-seconds.] |[Notification HttpEventSender: URL
http://www.samplelistener.com/platformnotification.asp: HTTP Client returned
'Success' (HTTP status: 200, 'OK')]
</ErrorMessage>
</NotificationDetails>
</NotificationDetailsArray>
<MarkUpMarkDownHistory/>
<NotificationStatistics>
<DeliveredCount>1954</DeliveredCount>
<QueuedNewCount>0</QueuedNewCount>
<QueuedPendingCount>0</QueuedPendingCount>
<ExpiredCount>0</ExpiredCount>
<ErrorCount>62</ErrorCount>
</NotificationStatistics>
</GetNotificationsUsageResponse>

Explanation of the response fields:
<DeliveryURL> - The URL to which the notification delivery attempt was made
<ReferenceID> - Internal Reference ID of the notification event.
<ExpirationTime> - Time after which the event is considered expired and no delivery attempt will be made
<Type> - Notification Event Type
<Retries> - Number of delivery retries attempted thus far
<DeliveryStatus> - Current status
<NextRetryTime> - Time at which the the next retry will be attempted ( if Status is not Delivered )
<ErrorMessage> - Error which occured upon delivery attempt

How well did this answer your question?
Answers others found helpful