GetNotificationsUsage - Call Reference - eBay Trading Web Services

GetNotificationsUsage

Retrieves usage information about platform notifications for a given application. You can use this notification information to troubleshoot issues with platform notifications. You can call this up to 50 times per hour for a given application.

See Working with Platform Notifications.

GetNotificationsUsage 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 may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetNotificationsUsageRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <EndTime> dateTime </EndTime>
  <ItemID> ItemIDType (string) </ItemID>
  <StartTime> dateTime </StartTime>
</GetNotificationsUsageRequest>

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific 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	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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: HTTP Headers (XML API Only) 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.
Call-specific Input Fields
EndTime	dateTime	Conditional	Specifies the end date and time for which notification information will be retrieved. EndTime is optional. If no EndTime is specified, the current time (the time the call is made) is used. If no EndTime is specified or if an invalid EndTime is specified, date range errors are returned in the response. For an EndTime to be valid, it must be no more than 72 hours before the time the of the call, it cannot be before the StartTime, and it cannot be later than the time of the call. If an invalid EndTime is specified, the current time is used.
ItemID	ItemIDType (string)	Conditional	Specifies an item ID for which detailed notification information will be retrieved. ItemID is optional. If no ItemID is specified, the response will not include any individual notification details. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
StartTime	dateTime	Conditional	Specifies the start date and time for which notification information will be retrieved. StartTime is optional. If no StartTime is specified, the default value of 24 hours prior to the call time is used. If no StartTime is specified or if an invalid StartTime is specified, date range errors are returned in the response. For a StartTime to be valid, it must be no more than 72 hours before the time of the call, it cannot be more recent than the EndTime, and it cannot be later than the time of the call. If an invalid StartTime is specified, the default value is used.

GetNotificationsUsage Output

The box below lists all fields that might be returned in the call 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).

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetNotificationsUsageResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- 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 here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <EndTime> dateTime </EndTime>
  <MarkUpMarkDownHistory> MarkUpMarkDownHistoryType 
    <MarkUpMarkDownEvent> MarkUpMarkDownEventType 
      <Reason> string </Reason>
      <Time> dateTime </Time>
      <Type> MarkUpMarkDownEventTypeCodeType </Type>
    </MarkUpMarkDownEvent>
    <!-- ... more MarkUpMarkDownEvent nodes 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 here ... -->
  </NotificationDetailsArray>
  <NotificationStatistics> NotificationStatisticsType 
    <DeliveredCount> int </DeliveredCount>
    <ErrorCount> int </ErrorCount>
    <ExpiredCount> int </ExpiredCount>
    <QueuedNewCount> int </QueuedNewCount>
    <QueuedPendingCount> int </QueuedPendingCount>
  </NotificationStatistics>
  <StartTime> dateTime </StartTime>
</GetNotificationsUsageResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific 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	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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 (repeatable)	Conditionally	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.
Errors.ErrorParameters	ErrorParameterType (repeatable)	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 [ 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, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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.
Call-specific Output Fields
EndTime	dateTime	Always	Returns the end date and time for the notification information that is returned by this call. The default is Now.
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 (repeatable)	Conditionally	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.
NotificationDetailsArray	NotificationDetailsArrayType	Conditionally	List of notification objects representing the notifications sent to an application for the given time period. It will only be returned if ItemID was specified in the input request.
NotificationDetailsArray .NotificationDetails	NotificationDetailsType (repeatable)	Conditionally	List of notifications, if there are any, for the given ItemID and given time period.
NotificationDetailsArray .NotificationDetails .DeliveryStatus	NotificationEventStateCodeType	Conditionally	Returns the notification status. Possible values include Delivered, Failed, Rejected, and MarkedDown. Applicable values: • Canceled (out) Status indicating the notification was cancelled • CustomCode (out) Reserved for future internal or external use • Delivered (out) Status indicating the notification was successfully delivered • Failed (out) Status indicating the notification was failed • FailedPending (out) Status indicating the notification is failed pending • MarkedDown (out) Status indicating the end user application is marked down • MarkedDownPending (out) Status indicating the notification is marked down pending • New (out) Status indicating the notification is newly created • Pending (out) Status indicating the notification is pending • Rejected (out) Status indicating the notification was rejected • Undeliverable (out) Status indicating the notification was unable to deliver
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	Returns the notification type. Possible values include: AskSellerQuestion, AuctionCheckoutComplete, BestOffer, CheckoutBuyerRequestTotal, EndOfAuction, Feedback, FixedPriceEndOfTransaction, FixedPriceTransaction, ItemNotReceived, MyMessages, OutBid, SecondChanceOffer, UPIBuyerResponseDispute, UPISellerClosedDispute, UPISellerOpenedDispute, and UPISellerRespondedToDispute. Applicable values: See Type.
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. The oldest date allowed for this field is Now-3days. Default is Now-1day.

GetNotificationsUsage Detail Controls

Detail Control: DetailLevel

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

GetNotificationsUsage Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetNotificationsUsage.

GetNotificationsUsage Change History

Version	Description
567 2008-05-28	NotificationDetailsArray.NotificationDetails.DeliveryURLName (added): Returns the destination URL delivery detail name for the notification. This is the value set using SetNotificationPreferences.
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.

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Trading API Call Reference Version 585

eBay Trading API
Call Reference Version 585