eBay Post-Order API Version 2

Error Response

The table below lists all fields that could be included in error response. For more information about a specific error see Errors by Number for the Post-Order API.
{
    "errorMessage": {
        "error": [
            {
                "errorId": int,
                "domain": "string",
                "severity": "string",
                "category": "string",
                "message": "string",
                "parameter": [
                    {
                        "value": "string",
                        "name": "string"
                    }
                ],
                "longMessage": "string",
                "httpStatusCode": "string"
            }
        ]
    }
}
Output Container/Field Occurrence Meaning
errorMessage Conditional Container that returns the error information.
error.errorId Conditional 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.
error.domain Conditional Name of the domain in which the error occurred. For example, cancelErrorDomain or returnErrorDomain.
error.severity Conditional Indicates whether the reported problem is fatal (an error) or is less- severe (a warning). Review the error message details for information regarding the cause.
error.category Conditional Indicates the error category. There are three categories of errors: request errors, application errors, and system errors.

Valid Values:
  • Application
    An error occurred due to a problem with the request, with the most likely source being the application sending the request. For example, the request is missing a required data element or it contains an invalid field. The problem must be corrected before the request can be resent. Inspect the error message to find the cause of the problem. If the problem is due to an application error, modify the application and resend the request. If the error is due to invalid data, the source of the data must be corrected before you resend the resend request to eBay.
  • Request
    An error occurred due to a problem with the request, with the most likely source being missing or invalid data in the request. The problem must be corrected before the request can be retried. Inspect the error message to find the cause of the problem. If the problem is a result of end-user data, alert the end-user to the problem and provide the means for them to correct the problem. Once the problem is resolved, resend the request to eBay.
  • System
    Indicates that an error has occurred on the eBay system side. For example, a database or server could be down. Inspect the error message to find the cause of the problem. If the problem is on the eBay 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.
error.message Conditional Explanation of the error. For example, The query must have at least one keyword or category.
error.parameter Conditional 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.
error.parameter.value Conditional The value of the variable (e.g., the return ID, 5********1)
error.parameter.name Conditional Name of the field that contributed to the error condition (e.g., returnId).
error.longMessage Conditional A more detailed description of the condition that raised the error.
error.httpStatusCode Conditional HTTP status code returned with the error response.