ロカオプ予約 API リファレンス

application/json

Schema: ListShopsResponse

レスポンス例: success

{
  "shops": [
    {
      "id": 2383,
      "uid": "ginza",
      "name": "銀座店"
    },
    {
      "id": 2384,
      "uid": "shibuya",
      "name": "渋谷店"
    }
  ]
}

application/json

Schema: ErrorResponse

レスポンス例: unauthorized

{
  "message": "Unauthorized"
}

application/json

Schema: ErrorResponse

レスポンス例: forbidden

{
  "message": "必要な scope がありません"
}

application/json

Schema: ErrorResponse

レスポンス例: tooManyRequests

{
  "message": "Too Many Requests"
}

application/json

Schema: ErrorResponse

レスポンス例: internalServerError

{
  "message": "Internal server error"
}

application/json

Schema: ListReservationsResponse

レスポンス例: success

{
  "reservations": [
    {
      "reservationId": 1001,
      "courseId": 20,
      "courseName": "初回カウンセリング",
      "reservationDate": "2026-05-13",
      "reservationHour": 10,
      "reservationMinute": 30,
      "status": "active",
      "customer": {
        "id": 3001,
        "name": "山田 太郎",
        "nameKana": "ヤマダ タロウ",
        "email": "taro@example.com",
        "tel": "09012345678",
        "lineDisplayName": "山田"
      },
      "note": "予約メモ",
      "inflowSource": {
        "uid": "web",
        "name": "Web"
      },
      "labels": [
        {
          "id": 1,
          "name": "重要"
        }
      ],
      "resources": [
        {
          "id": 5,
          "name": "個室 A"
        }
      ],
      "minutesRequired": 60,
      "createdAt": "2026-05-01 09:00:00",
      "updatedAt": "2026-05-01 09:10:00",
      "deletedAt": null,
      "formResponse": {
        "fields": [
          {
            "uid": "2tEOYE",
            "name": "お名前",
            "type": "name",
            "values": [
              "山田 太郎"
            ]
          },
          {
            "uid": "xtJppM",
            "name": "電話番号",
            "type": "tel",
            "values": [
              "09012345678"
            ]
          },
          {
            "uid": "a8KpQ2",
            "name": "メールアドレス",
            "type": "email",
            "values": [
              "taro@example.com"
            ]
          },
          {
            "uid": "Bn72xR",
            "name": "生年月日",
            "type": "birthDate",
            "values": [
              "1990-01-23"
            ]
          },
          {
            "uid": "mQ4zLp",
            "name": "来店理由",
            "type": "text",
            "values": [
              "Web サイトを見て予約しました"
            ]
          },
          {
            "uid": "V7nDk3",
            "name": "相談内容",
            "type": "textarea",
            "values": [
              "肩こりが気になります"
            ]
          },
          {
            "uid": "rT9wXb",
            "name": "希望メニュー",
            "type": "radio",
            "values": [
              {
                "uid": "Lp4Qz9",
                "text": "メニュー A"
              }
            ]
          },
          {
            "uid": "hY8kNc",
            "name": "気になる症状",
            "type": "checkbox",
            "values": [
              {
                "uid": "P0mXa2",
                "text": "肩こり"
              },
              {
                "uid": "zR6tWq",
                "text": "頭痛"
              }
            ]
          },
          {
            "uid": "cE3uHs",
            "name": "来店人数",
            "type": "number",
            "values": [
              "2"
            ]
          },
          {
            "uid": "nK5pVa",
            "name": "希望日",
            "type": "date",
            "values": [
              "2026-05-20"
            ]
          },
          {
            "uid": "X4gTq1",
            "name": "任意メモ",
            "type": "text",
            "values": []
          }
        ]
      }
    }
  ],
  "limit": 50,
  "nextCursor": null
}

application/json

Schema: ErrorResponse

レスポンス例: invalidDate

{
  "message": "startDate は YYYY-MM-DD 形式で指定してください"
}

application/json

Schema: ErrorResponse

レスポンス例: unauthorized

{
  "message": "Unauthorized"
}

application/json

Schema: ErrorResponse

レスポンス例: forbidden

{
  "message": "必要な scope がありません"
}

application/json

Schema: ErrorResponse

レスポンス例: tooManyRequests

{
  "message": "Too Many Requests"
}

application/json

Schema: ErrorResponse

レスポンス例: internalServerError

{
  "message": "Internal server error"
}