店舗向け

在庫API

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

api/v1/inventory View in API Reference

Endpoints

Method Path Description Response
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

Endpoint details

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

Full path: GET /api/v1/inventory
Response codes: 200

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

Full path: GET /api/v1/inventory/locations
Response codes: 200

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

Full path: GET /api/v1/inventory/{locationId}/{productId}
Response codes: 200 404

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

Full path: POST /api/v1/inventory/adjust
Response codes: 200 400

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

Full path: GET /api/v1/inventory/movements
Response codes: 200

Example request

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

{
  "locationId": "loc-001",
  "productId": "prd-001",
  "quantityDelta": 24,
  "reason": "restock"
}
Response 
{
  "locationId": "loc-001",
  "productId": "prd-001",
  "quantity": 124
}
About authentication

To use this API, the Authorization: Bearer {access_token} header is required. See the authentication guide for how to obtain a token.

View the authentication & access API
To API Reference