店舗向け

在庫API

保管場所ごとの在庫数を取得し、入出庫を記録します。棚卸しや補充の判断に使います。


端點清單

方法 路徑 說明 回應
GET /api/v1/inventory 在庫を一覧取得
保管場所・商品で在庫数を取得します。
200
GET /api/v1/inventory/locations 保管場所を一覧取得
倉庫・バックヤードなど在庫を持つ場所を返します。
200
GET /api/v1/inventory/{locationId}/{productId} 在庫数を取得
指定の場所・商品の在庫数を返します。
200 404
POST /api/v1/inventory/adjust 在庫を調整
入庫・出庫・棚卸し差異を記録し、在庫数を更新します。
200 400
GET /api/v1/inventory/movements 入出庫履歴を取得
いつ・どこで・いくつ動いたかを新しい順に返します。
200

端點詳細資訊

保管場所・商品で在庫数を取得します。

完整路徑: GET /api/v1/inventory
回應碼: 200

倉庫・バックヤードなど在庫を持つ場所を返します。

完整路徑: GET /api/v1/inventory/locations
回應碼: 200

指定の場所・商品の在庫数を返します。

完整路徑: GET /api/v1/inventory/{locationId}/{productId}
回應碼: 200 404

入庫・出庫・棚卸し差異を記録し、在庫数を更新します。

完整路徑: POST /api/v1/inventory/adjust
回應碼: 200 400

いつ・どこで・いくつ動いたかを新しい順に返します。

完整路徑: GET /api/v1/inventory/movements
回應碼: 200

請求範例

請求
POST /api/v1/inventory/adjust
Authorization: Bearer {access_token}

{
  "locationId": "loc-001",
  "productId": "prd-001",
  "quantityDelta": 24,
  "reason": "restock"
}
回應
{
  "locationId": "loc-001",
  "productId": "prd-001",
  "quantity": 124
}
關於驗證

使用此 API 需要 Authorization: Bearer {access_token} 標頭。取得權杖的方式請參閱驗證指南。

查看驗證與存取 API