REST Error Handling

Success Codes

Client Error Codes

Server Error Codes

Usage Examples

# 200 OK
curl -X GET '/rest/V1/products/SKU-123'
# Response: 200 with product data

# 201 Created
curl -X POST '/rest/V1/products'
# Response: 201 with created product

# 401 Unauthorized
curl -X GET '/rest/V1/products'
# No token provided

# 404 Not Found
curl -X GET '/rest/V1/products/INVALID'
# Product doesn't exist

# 422 Validation Error
curl -X POST '/rest/V1/products'
# Invalid product data

Standard Error Response

{
    "message": "Invalid product data.",
    "errors": [
        {
            "message": "The SKU is required.",
            "field": "sku",
            "code": 0
        },
        {
            "message": "The price must be greater than 0.",
            "field": "price",
            "code": 0
        }
    ],
    "parameters": {
        "fieldName": "sku"
    }
}

Error Response Fields

Authentication Error

{
    "message": "The consumer isn't authorized to access %resource.",
    "parameters": {
        "resource": "Magento_Catalog::products"
    }
}

Not Found Error

{
    "message": "No such entity with sku = INVALID-SKU"
}

Rate Limit Error

{
    "message": "Too many requests. Please try again later."
}

Validation Error Response

{
    "message": "Invalid product data.",
    "errors": [
        {
            "message": "The SKU is required.",
            "field": "sku",
            "code": 0
        },
        {
            "message": "The price must be greater than 0.",
            "field": "price",
            "code": 0
        },
        {
            "message": "The product name is too long.",
            "field": "name",
            "code": 0
        }
    ]
}

Required Field Errors

{
    "message": "Invalid input data.",
    "errors": [
        {
            "message": "This is a required field.",
            "field": "sku",
            "code": 0
        },
        {
            "message": "This is a required field.",
            "field": "name",
            "code": 0
        }
    ]
}

Format Errors

{
    "message": "Invalid input data.",
    "errors": [
        {
            "message": "Please enter a valid email address.",
            "field": "email",
            "code": 0
        },
        {
            "message": "Please enter a valid phone number.",
            "field": "telephone",
            "code": 0
        }
    ]
}

Business Logic Errors

{
    "message": "The product is out of stock.",
    "errors": [
        {
            "message": "The requested qty is not available.",
            "field": "qty",
            "code": 0
        }
    ]
}

Enable API Logging

// app/etc/di.xml
<config>
    <type name="Magento\Framework\Webapi\Rest\Request">
        <plugin name="api_request_logger" type="Vendor\Module\Plugin\RequestLoggerPlugin"/>
    </type>
</config>

Check Logs

# System logs
tail -f var/log/system.log

# Exception logs
tail -f var/log/exception.log

# API logs (if enabled)
tail -f var/log/api.log

Common Issues

Debug Steps

1. Check Request

   • URL is correct
   • HTTP method is correct
   • Headers are correct
   • Body is valid JSON

2. Check Authentication

   • Token is valid
   • Token has required permissions
   • Token is not expired

3. Check Response

   • HTTP status code
   • Error message
   • Error details

4. Check Server

   • PHP error logs
   • Magento logs
   • Server error logs