エラーガイド

概要

出前館のAPI は、エラーを伝達するために HTTP ステータスコードを使用します。プラットフォームで発生する一般的なエラーの一覧を以下に示します。一般的な目安として、4xx エラーはクライアント側の問題であり、5xx は 出前館側の問題です。

HTTPステータスコード以外の部分に関しましてはAPIリファレンスを参照ください。

HTTPステータスコード一覧

返却されるHTTPステータスコード 説明
400 入力の検証に失敗しました。入力フィールドのいずれかのタイプが正しくないか、必須フィールドが欠落している場合に、このHTTPステータスコードが返却されます。
401 アクセス権限がない場合このHTTPステータスコードが返却されます。
404 対象のリソースが存在しない場合このHTTPステータスコードが返却されます。
409 リクエストが現在のサーバーの状態と競合した場合このHTTPステータスコードが返却されます。
412 対象の操作の前提条件を満たしていない場合このHTTPステータスコードが返却されます。
500 出前館内部でシステムエラーが発生した場合に、このHTTPステータスコードが返却されます。
503
出前館がメンテナンスしている場合に、このHTTPステータスコードが返却されます。
（全APIが以下のbodyの内容でjson形式で返却されます。）
{
    "code": "MAINTENANCE",
    "data": {
        "errorMessage": "現在メンテナンス中です。"
    }
}