ApiErrorResponse

snowbee.ApiErrorResponse

object · non-null

errorstringnon-nullrequired: Stable error code
Example"INVALID_REQUEST"
messagestringnon-nullrequired: Human-readable error message
Example"Invalid customer ID format"
resolutionstringnon-nullrequired: Suggested next action
Example"Correct the customer ID and retry the request"

View raw schema

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string",
      "description": "Stable error code",
      "example": "INVALID_REQUEST",
      "title": "String"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message",
      "example": "Invalid customer ID format",
      "title": "String"
    },
    "resolution": {
      "type": "string",
      "description": "Suggested next action",
      "example": "Correct the customer ID and retry the request",
      "title": "String"
    }
  },
  "required": [
    "error",
    "message",
    "resolution"
  ],
  "title": "ApiErrorResponse"
}