Error response schema
The error response schema is also documented in Errors & Conventions with the full error code catalog. This page is the schema reference.
Error Response
ErrorResponse
Standard error response format. Every FirmlyError serializes to this envelope — there is no message or details field.
-
code(integer, required) — Numeric HTTP status code (for example,404,422). -
error(string, required) — The PascalCase error identifier (for example,ProductNotFound,CartNotFound,CreditCardDeclined). See Errors & Conventions for the full catalog. -
description(string, required) — Human-readable description of the error.
Every FirmlyError carries exactly these three fields — no additional or domain-specific fields.
{"code": 404,"error": "ProductNotFound","description": "Product variant was not found"}
Schema Evolution
Related
- Errors & Conventions — full error code catalog with recovery patterns
- Schemas overview