コンシューマー向け

お気に入り店舗API

コンシューマー（エンドユーザー）向けのお気に入り店舗管理APIです。お気に入りの一覧取得・追加・削除、および特定店舗のお気に入り状態の確認に対応しています。OAuth 2.0のuser.favorites.*スコープが必要です。

api/v1/user/favorites View in API Reference

Endpoints

Method Path Description Response
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

Endpoint details

ログインユーザーがお気に入り登録している店舗の一覧を返します。スコープ: user.favorites.read

Full path: GET /api/v1/user/favorites
Response codes: 200 401 403

指定した店舗がお気に入り登録済みかどうかを返します。スコープ: user.favorites.read

Full path: GET /api/v1/user/favorites/{storeId}
Response codes: 200 401

指定した店舗をお気に入りに追加します。すでに登録済みの場合も安全に呼び出せます（冪等）。スコープ: user.favorites.write

Full path: POST /api/v1/user/favorites/{storeId}
Response codes: 200 401 403

指定した店舗をお気に入りから削除します（論理削除）。スコープ: user.favorites.write

Full path: DELETE /api/v1/user/favorites/{storeId}
Response codes: 204 404 401

Example request

Request 
GET /api/v1/user/favorites
Authorization: Bearer {access_token}
Response 
[
  {
    "userId": "usr-001",
    "storeId": "store-abc",
    "isActive": true,
    "createdAt": "2026-01-10T09:00:00Z",
    "updatedAt": "2026-01-10T09:00:00Z"
  }
]
About authentication

To use this API, the Authorization: Bearer {access_token} header is required. See the authentication guide for how to obtain a token.

View the authentication & access API
To API Reference