Errors

The Admin API uses HTTP status codes to indicate the success or failure of an API request. In general:

• 2xx range indicates success
• 3xx range indicates a redirect
• 4xx range indicates a failure caused by the provided information
• 5xx range indicates a problem with our servers

If an error occurs, the API responds with an error response containing a list of errors. In most cases, the list will contain a single error. However, some endpoints might return multiple errors.

The status codes, error responses, and error entities are provided in the tables below.

HTTP Status Codes

200s status codes

400s status codes

500s status codes

Complete list of HTTP status codes.

Error Response

Error Entity

Error Handling

When using a SDK to consume the Admin API endpoints, it is good practice to catch possible errors.

PHPJavaNodeJS

Copy

try {
    $productCollection = $adminApi->products->all();
} catch (ApiErrorException $apiException) {
    // Get the first error
    echo $apiException->getFirstError()->getMessage();

    // Get all errors
    foreach ($apiException->getErrors() as $error) {
        echo $error->getMessage();
    }
} catch (Exception $exception) {
    // e.g. Connection problems
}