店舗向け

在庫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を見る