Aurora API: Errors

There are a wide range of errors returned by the Aurora API to describe different occurrences of problems that occur. You should check for these error when they are present for help resolving problems with your Integration.

This article attempts to provide some support for users of the Aurora API when errors occur, providing tips regarding the possible causes and possible solutions.

Suggest Edits

Introduction

If an error occurs in the Aurora API, then it will always be reported using the same common XML elements, as shown below.

<?xml version="1.0" encoding="utf-8"?>
<AuroraResponseEnvelope>
	<Header>
		<Version>head</Version>
		<Timestamp>2015-12-01T15:50:14+00:00</Timestamp>
		<RequestDetails></RequestDetails>
		<Summary>
			<Ack>FATAL</Ack>
			<RequestsProcessed>1</RequestsProcessed>
			<RequestsSucceeded>0</RequestsSucceeded>
			<RequestErrors>1</RequestErrors>
		</Summary>
	</Header>
	<Responses>
		<Response>
			<RequestID>1</RequestID>
			<Ack>FATAL</Ack>
			<Errors>
				<Error>
					<Code>-1</Code>
					<Message>The requested Path is not a valid Product listing Path.</Message>
					<Severity>FATAL</Severity>
					<Data></Data>
				</Error>
			</Errors>
		</Response>
	</Responses>
</AuroraResponseEnvelope>

In the event that an error occurs, the Header > RequestErrors element will display a count of the number of errors that have occurred. You can check this field for the presence of errors in the request.

Response fields

Field	Values	API Version	Description	Detail Levels
`<br>Responses.Response.Errors.Error<br>`	Container	1.1+	This contains any number of errors and warnings that occurred during the request.	Minimum +
`<br>Responses.Response.Errors.Error.Code<br>`	Integer	1.1+	This is the internal Aurora API Error code for the occurrence.	Minimum +
`<br>Responses.Response.Errors.Error.Message<br>`	String	1.1+	This is a short description of the issue that has occurred.	Minimum +
`<br>Responses.Response.Errors.Error.Severity<br>`	FATAL \| WARNING	1.1+	This described the nature of the errors, i.e. is the error reporting a complete failure that could not be recovered, or were there some issues that merely produced an advisory warning? Aurora will always assume a request has been successful if no fatal errors occurred (even if there were warnings). Warnings can normally be ignored completely and are often only helpful when debugging an issue.	Minimum +
`<br>Responses.Response.Errors.Error.Data<br>`	Variable	1.1+	This can contain anything pertinent to the error in question and can vary from one Method to the next. You would only be expected to make use of this information on very rare occasions, and most of the time this field is just empty.	Minimum +

Updated over 2 years ago