eBay Post-Order APIVersion 2.6

ErrorData

This is a complex type that defines an error or warning returned by the service.

Type that uses ErrorData:

Call that uses ErrorData:

Fields



category ( token ) [0..?]
The category type for this error or warning.

The response contains one of three values:
  • APPLICATION: Indicates an exception or error occurred in the application code or at runtime. Examples include catching an exception in a service's business logic, system failures, or request errors from a dependency.
  • SYSTEM: Used when your service or a dependent service refused to continue processing on the resource because of a business rule violation such as "Seller does not ship item to Antarctica" or "Buyer ineligible to purchase an alcoholic item". Business errors are not syntactical input errors.
  • REQUEST: Used when there is an error with the request. Possible culprits are an authentication error or missing headers, syntactical errors, rate limiting factors, and so on.
See the Field Index to learn which calls use category.

domain ( string ) [0..?]
Name of the domain, primary system or service, or application where the error occurred.
See the Field Index to learn which calls use domain.

errorId ( integer ) [0..?]
A positive integer that uniquely identifies the specific 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.

httpStatusCode ( integer ) [0..?]
The HTTP status code that resulted from the request.
See the Field Index to learn which calls use httpStatusCode.

longMessage ( string ) [0..?]
A more detailed explanation of the error than given in the message error field.
See the Field Index to learn which calls use longMessage.

message ( string ) [0..?]
Information on how to correct the problem, where applicable. Its value is at most 50 characters long. If applicable, the value is localized in the locale of the request.
See the Field Index to learn which calls use message.

parameter ( array of ErrorParameter ) [0..?]
This optional list of name/value pairs that contain context-specific ErrorParameter objects, with each item in the list being a parameter (or input field name) that caused an error condition. Each ErrorParameter object consists of two fields, a name and a value.
See the Field Index to learn which calls use parameter.

severity ( token ) [0..?]
The severity can be either a WARNING or an ERROR, where a warning does not stop the processing of the request while an error does.

While you must fix errors before the service will process your request, you should also fix all warnings to ensure your application runs as designed.
See the Field Index to learn which calls use severity.