eBay Return Management APIVersion 1.1.0
 

ErrorData

A container for error details.

Type that uses ErrorData:

Calls that use ErrorData:

Fields



category ( ErrorCategory ) [1]
There are three categories of errors: request errors, application errors, and system errors.
See the Field Index to learn which calls use category.

domain ( string ) [1]
Name of the domain in which the error occurred.
See the Field Index to learn which calls use domain.

errorId ( long ) [1]
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 Field Index to learn which calls use errorId.

exceptionId ( token ) [0..1]
Unique identifier for an exception associated with an error.
See the Field Index to learn which calls use exceptionId.

message ( string ) [1]
A detailed description of the condition that caused the error.
See the Field Index to learn which calls use message.

parameter ( ErrorParameter (string) ) [0..*]
Various warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.
See the Field Index to learn which calls use parameter.

severity ( ErrorSeverity ) [1]
Indicates whether the reported problem is fatal (an error) or is less severe (a warning). Review the error message details for information on the cause.

If the request fails and the application is the source of the error (for example, a required element is missing), update the application before you retry the request. If the problem is due to incorrect user data, 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, resend the request to eBay.

If the source of the problem is on eBay's side, you can retry the request a reasonable number of times (eBay recommends you try the request twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, you can resend the request in its original form.

If a warning occurs, warning information is returned in addition to the business data. Normally, you do not need to resend the request (as the original request was successful). However, depending on the cause of the warning, you might need to contact the end user, or eBay, to effect a long term solution to the problem.
See the Field Index to learn which calls use severity.

subdomain ( string ) [0..1]
Name of the subdomain in which the error occurred.
See the Field Index to learn which calls use subdomain.