ErrorResponse

A single problem with a request. Errors arrive as an array under errorResponse.errors.

  • Identifiers of the entities this error relates to, where the error is about specific records rather than a field. Omitted when not applicable.

  • Stable machine-readable identifier for the error. This is the value to branch on. null for framework-level field validation, where errorField and errorMessage carry the detail instead.

  • Which input caused the problem. null when the error is not tied to one field. For nested request objects this is a path, for example UserDetails.City.

  • Human-readable description of what went wrong. Safe to log. Wording can change between releases, so branch on errorCode rather than on this string.

  • Numeric form of errorCode, and equally stable. null when errorCode is null or is not one of the catalogued codes. See the Errors and Rate Limits guide for the full list.

  • What the buyer would have to enter to search again. Omitted entirely when there is nothing to carry, so an answer that never had a search looks exactly as it does today. Whether searching again is worth offering is carried by Chaiz.Domain.ErrorResponse.ErrorCode, not by the presence of this.

    Properties: 9
  • What to do about this error, when Chaiz can suggest something concrete. Omitted entirely when there is no suggestion, so treat it as optional. Designed to be actionable without interpretation, which makes it useful for AI agents and automated integrations.

    Properties: 3