コンシューマー向け

お気に入り店舗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} 標頭。取得權杖的方式請參閱驗證指南。

查看驗證與存取 API