Common Error HTTP Codes in Magento Rest API in Magento 2

Today I will introduce you to Common Error HTTP Codes in Magento 2 Rest API. Firstly, you also need to know what HTTP is? HTTP stands for Hyper Text Transfer Protocol, the default protocol on the website. During using that protocol, maybe there are some common errors which are called as HTTP error codes.

The below includes a list of the codes and the meaning of each the common error HTTP code in Magento 2 Rest API for the better understanding. To avoid facing these errors, you need to first understand each of them fully.

HTTP Error 400

• Constant: Magento\Framework\Webapi\Exception::HTTP_BAD_REQUEST

• Description: The request data is invalid.

HTTP Error 401

• Constant: Magento\Framework\Webapi\Exception::HTTP_UNAUTHORIZED

• Description: The authorization is failed.

HTTP Error 403

• Constant: Magento\Framework\Webapi\Exception::HTTP_FORBIDDEN

• Description: Access denied.

HTTP Error 404

• Constant: Magento\Framework\Webapi\Exception::HTTP_NOT_FOUND

• Description: Resource not found.

HTTP Error 405

• Constant: Magento\Framework\Webapi\Exception::HTTP_METHOD_NOT_ALLOWED

• Description: Resource does not support method. / Resource method not implemented yet.

HTTP Error 406

• Constant: Magento\Framework\Webapi\Exception::HTTP_NOT_ACCEPTABLE

• Description: The requested resource doesn’t accept the request.

HTTP Error 500

• Constant: Magento\Framework\Webapi\Exception::HTTP_INTERNAL_ERROR

• Description: Resource internal error.

Next, I will give you the example to get some of the error HTTP codes.

If you run an exception in your API method:

if (!$productId) {
 
throw new \Magento\Framework\Exception\NoSuchEntityException(__('Requested product doesn\'t exist'));
 
}

At that time, the HTTP Error 404 will show in the response.

Or you can use exception classes which Magento provides in Magento\Framework\Exception, or use general exception class \Exception:

if (!$productId) {
 
throw new \Exception(__('Requested product doesn\'t exist'));
 
}

Ensure that the error code always is 500 (Magento\Framework\Webapi\Exception::HTTP_INTERNAL_ERROR).

You may get this error message: Exception printing is disabled by default for security reasons

That’s all we want to talk about common errot HTTP codes in Magento 2 in today’s post. If you have any questions or want to discuss more about this topic, feel free to contact us anytime, we will reach to you as soon as possible.