共通インフラ

マスタ・連携API

店舗・商品・カテゴリのマスタデータを外部システムと同期し、POSやCRMと統合します。同期ステータスの確認にも対応しています。

api/v1/organization/master APIリファレンスで確認

エンドポイント一覧

メソッド パス 説明 レスポンス
GET /api/v1/organization/master/stores マスタ店舗一覧
マスタデータベースに登録されたすべての店舗(POS / EC)を取得します。
200
POST /api/v1/organization/master/stores マスタ店舗を登録・更新
新しい店舗を登録するか、IDを指定して既存店舗を更新します。
200
GET /api/v1/organization/master/products マスタ商品一覧
店舗や広告キャンペーンにまたがる登録済み商品を取得します。
200
POST /api/v1/organization/master/products マスタ商品を登録・更新
マスタカタログの商品情報を作成・更新します。
200
GET /api/v1/organization/master/categories マスタカテゴリ一覧
統一分類のための商品カテゴリを取得します。
200
POST /api/v1/organization/master/categories マスタカテゴリを登録・更新
システム横断で使用する商品カテゴリを追加・更新します。
200
GET /api/v1/organization/master/sync/status 同期ステータスを取得
マスタデータの最終同期タイムスタンプと保留中のアイテム数を返します。
200

エンドポイント詳細

マスタデータベースに登録されたすべての店舗(POS / EC)を取得します。

完全パス: GET /api/v1/organization/master/stores
レスポンスコード: 200

新しい店舗を登録するか、IDを指定して既存店舗を更新します。

完全パス: POST /api/v1/organization/master/stores
レスポンスコード: 200

店舗や広告キャンペーンにまたがる登録済み商品を取得します。

完全パス: GET /api/v1/organization/master/products
レスポンスコード: 200

マスタカタログの商品情報を作成・更新します。

完全パス: POST /api/v1/organization/master/products
レスポンスコード: 200

統一分類のための商品カテゴリを取得します。

完全パス: GET /api/v1/organization/master/categories
レスポンスコード: 200

システム横断で使用する商品カテゴリを追加・更新します。

完全パス: POST /api/v1/organization/master/categories
レスポンスコード: 200

マスタデータの最終同期タイムスタンプと保留中のアイテム数を返します。

完全パス: GET /api/v1/organization/master/sync/status
レスポンスコード: 200

リクエスト例

リクエスト
GET /api/v1/organization/master/sync/status
Authorization: Bearer {access_token}
レスポンス
{
  "lastSyncAt": "2025-03-20T08:00:00Z",
  "pendingStores": 0,
  "pendingProducts": 3,
  "pendingCategories": 0,
  "status": "synced"
}
認証について

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

認証・アクセスAPIを見る