コンシューマー向け
お気に入り店舗API
コンシューマー（エンドユーザー）向けのお気に入り店舗管理APIです。お気に入りの一覧取得・追加・削除、および特定店舗のお気に入り状態の確認に対応しています。OAuth 2.0のuser.favorites.*スコープが必要です。
api/v1/user/favorites
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/user/favorites/
|
お気に入り店舗一覧を取得
ログインユーザーがお気に入り登録している店舗の一覧を返します。スコープ: user.favorites.read
|
200 401 403 |
| GET |
/api/v1/user/favorites/{storeId}
|
お気に入り状態を確認
指定した店舗がお気に入り登録済みかどうかを返します。スコープ: user.favorites.read
|
200 401 |
| POST |
/api/v1/user/favorites/{storeId}
|
店舗をお気に入りに追加
指定した店舗をお気に入りに追加します。すでに登録済みの場合も安全に呼び出せます（冪等）。スコープ: user.favorites.write
|
200 401 403 |
| DELETE |
/api/v1/user/favorites/{storeId}
|
お気に入りから削除
指定した店舗をお気に入りから削除します（論理削除）。スコープ: user.favorites.write
|
204 404 401 |
エンドポイント詳細
ログインユーザーがお気に入り登録している店舗の一覧を返します。スコープ: user.favorites.read
完全パス：
GET /api/v1/user/favorites/
レスポンスコード：
200
401
403
指定した店舗がお気に入り登録済みかどうかを返します。スコープ: user.favorites.read
完全パス：
GET /api/v1/user/favorites/{storeId}
レスポンスコード：
200
401
指定した店舗をお気に入りに追加します。すでに登録済みの場合も安全に呼び出せます（冪等）。スコープ: user.favorites.write
完全パス：
POST /api/v1/user/favorites/{storeId}
レスポンスコード：
200
401
403
指定した店舗をお気に入りから削除します（論理削除）。スコープ: user.favorites.write
完全パス：
DELETE /api/v1/user/favorites/{storeId}
レスポンスコード：
204
404
401
リクエスト例
リクエスト
GET /api/v1/user/favorites
Authorization: Bearer {access_token}
レスポンス
[
{
"userId": "usr-001",
"storeId": "store-abc",
"isActive": true,
"createdAt": "2026-01-10T09:00:00Z",
"updatedAt": "2026-01-10T09:00:00Z"
}
]
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。