棚卸在庫一覧取得

GET

/stocktaking/{stocktaking_info_id}/details/{base_date}

• サンドボックス
• 本番

棚卸在庫一覧を取得します。

棚卸在庫一覧とは、指定した棚卸の棚卸在庫数をもとに、指定日時点の在庫数量の計算結果を取得する機能です。

対象プラン

• リテールビジネス

Authorizations

• AppAccessToken
  pos.stocktaking:read

Parameters

Path Parameters

stocktaking_info_id

required

string

棚卸情報ID

Example

4

base_date

required

string

基準日(YYYY-MM-DD)

Example

2025-02-01

Query Parameters

fields

array

検索パラメータ（カンマ区切りで指定可）
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

Example

stocktakingInfoId,productId

sort

string

並び順（カンマ区切りで指定可）

指定可能なパラメータ

• productId：商品ID：棚卸対象の商品IDを設定。
• categoryId：部門ID：棚卸対象の商品の部門IDを設定。

Example

productId

limit

integer

上限数

Example

10

page

integer

ページ

Example

2

product_id

string

商品ID

Example

8000001

category_id

string

部門ID

Example

8000001

Responses

200

取得成功

Array<object>

object

stocktakingInfoId

棚卸情報ID

string

4

productId

商品ID

string

8000001

categoryId

部門ID：現在の商品マスタの部門ID

string

8000001

stockQuantity

在庫数：基準日時点の在庫数。

string

3

stockMoney

在庫金額：基準日時点の在庫金額。

string

300.00000

transportationQuantity

積送在庫数：基準日時点の積送在庫数。

string

2

transportationMoney

積送在庫金額：基準日時点の積送在庫金額。

string

200.00000

layawayQuantity

取置在庫数：基準日時点の取置在庫数。

string

1

layawayMoney

取置在庫金額：基準日時点の取置在庫金額。

string

100.00000

storeId

店舗ID：棚卸を行った店舗ID。

string

1

Example

[
  {
    "stocktakingInfoId": "4",
    "productId": "8000001",
    "categoryId": "8000001",
    "stockQuantity": "3",
    "stockMoney": "300.00000",
    "transportationQuantity": "2",
    "transportationMoney": "200.00000",
    "layawayQuantity": "1",
    "layawayMoney": "100.00000",
    "storeId": "1"
  }
]