Common Error HTTP Codes in Magento Rest API in Magento 2

Today I will introduce you about Common Error HTTP Codes in Magento Rest API.

Today I will introduce you about 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.

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

Enjoyed the tutorial? Spread it to your friends!

magento-2-tutorial
common
error
http
codes
rest
api

Sam Thomas
Sam Thomas

CEO and Founder of Mageplaza. Pursueing a simple and healthy lifestyle. A friend, a husband and a dad of two children, a trainer and a wanna-be influencer. He is a big fan of sports and travel, also.

People also searched for

  • magento 2 common error http codes rest api
  • Magento 2 API Error HTTP Codes
  • magento 2 api http error codes
  • magento 2 api error http code
  • magento 2 rest api error http code
  • magento 2 invalid response line returned from server: http2 200
  • magento 2 payment-information 400 bad request
  • exception 0 (magento framework exception nosuchentityexception): no linked stock found
  • magento 2 throw exception
  • magento 2 requested product doesn't exist
  • this product doesn't exist. magento 2
  • invalid response line returned from server: http2 401
  • class magento webapi model cache type webapi interceptor does not exist
  • magento 2 web api report location
  • invalid state change requested magento 2
  • magento 2 web api log
  • magento 2 invalid state change requested
  • internal error. details are available in magento log file
  • http error 500 magento 2
  • magento http error 500
  • internal error. details are available in magento log file. report id: webapi
  • magento 2 api error http codes
  • 2.2.x, 2.3.x