店舗向け
棚・陳列API
棚在庫やフェース数を監視し、欠品を自動検知します。棚レイアウトの登録・管理と補充イベントの記録に対応しています。
api/v1/store/shelves
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/store/shelves/{id}
|
棚詳細を取得
特定の棚の詳細情報を取得します。
|
200 404 |
| GET |
/api/v1/store/shelves/search
|
棚を検索
店舗ID、カテゴリ、キーワードで棚情報を検索します。
|
200 |
| POST |
/api/v1/store/shelves/
|
棚レイアウトを登録・更新（Upsert）
新しい棚レイアウトを作成するか、既存のレイアウトを更新します。
|
200 |
| DELETE |
/api/v1/store/shelves/{id}
|
棚を削除
棚定義と関連する商品レイアウトを削除します。
|
204 404 |
| POST |
/api/v1/store/shelves/restock
|
補充イベントを記録
スタッフが棚に商品を補充した際のイベントを記録します。
|
200 |
エンドポイント詳細
特定の棚の詳細情報を取得します。
完全パス：
GET /api/v1/store/shelves/{id}
レスポンスコード：
200
404
店舗ID、カテゴリ、キーワードで棚情報を検索します。
完全パス：
GET /api/v1/store/shelves/search
レスポンスコード：
200
新しい棚レイアウトを作成するか、既存のレイアウトを更新します。
完全パス：
POST /api/v1/store/shelves/
レスポンスコード：
200
棚定義と関連する商品レイアウトを削除します。
完全パス：
DELETE /api/v1/store/shelves/{id}
レスポンスコード：
204
404
スタッフが棚に商品を補充した際のイベントを記録します。
完全パス：
POST /api/v1/store/shelves/restock
レスポンスコード：
200
リクエスト例
リクエスト
GET /api/v1/store/shelves/search?storeId=store-001
Authorization: Bearer {access_token}
レスポンス
{
"results": [
{
"id": "shelf-A1",
"name": "飲料棚A",
"category": "飲料",
"facings": 24,
"outOfStock": 2
}
]
}
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。