​

Error Handling

​

Merchant API Error Format

{
  "message": "Product not found: 999",
  "data": null,
  "api": "rmz.shawarma",
  "timestamp": 1699999999,
  "error": true
}

​

Storefront API Error Format

{
  "success": false,
  "message": "Error message",
  "data": null
}

​

License API Error Format

{
  "success": false,
  "error": "LICENSE_NOT_FOUND",
  "message": "License not found"
}

​

HTTP Status Codes

​

Validation Errors

{
  "message": "The given data was invalid.",
  "errors": {
    "products": ["The products field is required."],
    "products.0.identifier": ["The products.0.identifier field is required."]
  }
}

​

Best Practices

1. Check status codes — do not assume every response is successful
2. Parse error messages — they contain actionable information
3. Handle validation errors — iterate the errors object to display field-specific messages
4. Log errors — include the timestamp and request details for debugging
5. Handle network errors — timeouts and connection failures are not JSON responses