Skip to main content
The Chariow API uses conventional HTTP response codes to indicate success or failure.

HTTP Status Codes

CodeDescription
200Success
201Created
400Bad Request
401Unauthorised
403Forbidden
404Not Found
422Validation Error
429Rate Limited
500Server Error

Error Response Format

{
  "message": "Error description",
  "data": [],
  "errors": {
    "field_name": ["Validation error message"]
  }
}

Common Errors

Validation Error (422)

{
  "message": "The given data was invalid.",
  "data": [],
  "errors": {
    "email": ["The email field is required."],
    "product_id": ["The selected product_id is invalid."]
  }
}

Not Found (404)

{
  "message": "No query results for model [App\\Models\\Product].",
  "data": [],
  "errors": []
}

Rate Limited (429)

{
  "message": "Rate limit exceeded. Please retry after 60 seconds.",
  "data": [],
  "errors": []
}