組織向け

店舗・商品マスタAPI

ビジネスアカウントに属する店舗と、その商品マスタを取得します。外部システムとマスタを突き合わせる際の起点です。

api/v1/me/organizations/{organizationId}/stores APIリファレンスで確認

エンドポイント一覧

メソッド パス 説明 レスポンス
GET /api/v1/me/organizations/{organizationId}/stores/ 店舗を一覧取得
ログイン中の利用者が属するビジネスアカウントの店舗を返します。
200
GET /api/v1/me/organizations/{organizationId}/stores/{storeId} 店舗詳細を取得
住所・営業時間・連絡先を含む店舗情報を返します。
200 404
GET /api/v1/me/organizations/{organizationId}/stores/../../../products 商品を一覧取得
商品マスタを取得します(/api/v1/products)。
200
GET /api/v1/me/organizations/{organizationId}/stores/../../../products/{productId} 商品詳細を取得
バリエーションを含む商品情報を返します。
200 404

エンドポイント詳細

ログイン中の利用者が属するビジネスアカウントの店舗を返します。

完全パス: GET /api/v1/me/organizations/{organizationId}/stores/
レスポンスコード: 200

住所・営業時間・連絡先を含む店舗情報を返します。

完全パス: GET /api/v1/me/organizations/{organizationId}/stores/{storeId}
レスポンスコード: 200 404

商品マスタを取得します(/api/v1/products)。

完全パス: GET /api/v1/me/organizations/{organizationId}/stores/../../../products
レスポンスコード: 200

バリエーションを含む商品情報を返します。

完全パス: GET /api/v1/me/organizations/{organizationId}/stores/../../../products/{productId}
レスポンスコード: 200 404

リクエスト例

リクエスト
GET /api/v1/me/organizations/{organizationId}/stores
Authorization: Bearer {access_token}
レスポンス
{
  "count": 2,
  "stores": [
    { "storeId": "21cc…", "name": "レストランABC" }
  ]
}
認証について

このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。トークンの取得方法は認証ガイドをご確認ください。

認証・アクセスAPIを見る