❌ 共通エラーレスポンス

ハレコード API 全体で共通の HTTP エラー仕様です。
認証やベースURLは 基本情報・認証仕様 を参照してください。


共通エラーレスポンス定義

HTTPステータスエラー発生条件レスポンス時の主な挙動
400 Bad RequestJSONのパースエラー、必須パラメータの欠落、型不正、ビジネスロジック上のバリデーション違反。エラーが発生した詳細な原因や不整合パスを返却。
401 Unauthorized リクエストヘッダーに x-api-key が指定されていない。 認証エラーメッセージ。
403 Forbidden 指定されたAPIキーが無効、期限切れ、または自店舗以外のドキュメント( docId )へアクセスを試みた。 アクセス拒否。
404 Not Found 単一取得時に、指定された docId に対応するドキュメントがデータベースに存在しない。 対象リソースなし。
405 Method Not Allowed 本APIの対応外である HTTP メソッド( PUT , DELETE 等)でリクエストが行われた。 不正メソッドエラー。
500 Internal Server Errorサーバー内部エラー、またはデータベースのタイムアウト。システムエラーメッセージ。
503 Service Unavailableインフラのメンテナンス等に起因する一時的なサービス停止。サービス利用不可メッセージ。