店舗向け
在庫管理(WMS)API
倉庫・店舗の在庫をロケーション単位で管理します。在庫照会・調整・移動履歴に対応。Shopify ロケーションと対応付けされている場合、調整は自動的に Shopify にも反映されます。スコープ: store.inventory.read / store.inventory.write
api/v1/inventory
APIリファレンスで確認
エンドポイント一覧
| メソッド | パス | 説明 | レスポンス |
|---|---|---|---|
| GET |
/api/v1/inventory/
|
在庫一覧
ロケーション×商品ごとの在庫行を返します。locationId / productId / lowStock=true で絞り込みできます。
|
200 403 |
| GET |
/api/v1/inventory/{locationId}/{productId}
|
在庫詳細を取得
特定ロケーションの特定商品の在庫行を返します。
|
200 404 |
| GET |
/api/v1/inventory/locations
|
ロケーション一覧
倉庫・店舗バックヤード・売場のロケーションを一覧します。
|
200 |
| POST |
/api/v1/inventory/adjust
|
在庫を調整
符号付きの数量変化(+10 入荷、-3 廃棄など)と理由を指定します。移動履歴に記録され、Shopify 連携時は自動反映されます。
|
200 400 404 |
| GET |
/api/v1/inventory/movements
|
在庫移動履歴
入荷・移動・棚卸し・調整(Shopify 同期由来を含む)の履歴を新しい順に返します。
|
200 |
エンドポイント詳細
ロケーション×商品ごとの在庫行を返します。locationId / productId / lowStock=true で絞り込みできます。
完全パス:
GET /api/v1/inventory/
レスポンスコード:
200
403
特定ロケーションの特定商品の在庫行を返します。
完全パス:
GET /api/v1/inventory/{locationId}/{productId}
レスポンスコード:
200
404
倉庫・店舗バックヤード・売場のロケーションを一覧します。
完全パス:
GET /api/v1/inventory/locations
レスポンスコード:
200
符号付きの数量変化(+10 入荷、-3 廃棄など)と理由を指定します。移動履歴に記録され、Shopify 連携時は自動反映されます。
完全パス:
POST /api/v1/inventory/adjust
レスポンスコード:
200
400
404
入荷・移動・棚卸し・調整(Shopify 同期由来を含む)の履歴を新しい順に返します。
完全パス:
GET /api/v1/inventory/movements
レスポンスコード:
200
リクエスト例
リクエスト
POST /api/v1/inventory/adjust
Authorization: Bearer {access_token}
Content-Type: application/json
{
"locationId": "loc-001",
"productId": "prd-001",
"quantityChange": -3,
"reason": "破損廃棄"
}
レスポンス
{
"locationId": "loc-001",
"productId": "prd-001",
"productName": "有機マンゴージュース",
"quantity": 47,
"availableQuantity": 45,
"isLowStock": false
}
認証について
このAPIを利用するには、Authorization: Bearer {access_token} ヘッダーが必要です。
トークンの取得方法は認証ガイドをご確認ください。