ReCORE.co-api

棚卸し

棚卸しケース検索

概要

棚卸しケースの検索を行う

基本情報

リクエストパス: GET /items/stocktaking
スコープ: item:stocktaking:index
店舗IDの指定: 必要なし
基本制限レート: 5 rps

query

key	説明	制約など
ids	ケースID	整数のみ、カンマ区切りで複数指定可能
created_at_from	作成日時から	2024-04-12 12:08:38 形式
created_at_to	作成日時まで	同上
updated_at_from	更新日時から	同上
updated_at_to	更新日時まで	同上
done_at_from	確定日時から	同上、未確定のケースは対象外となる
done_at_to	確定日時まで	同上
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250

例

Request

GET /items/stocktaking

Response

[
  {
    "id": 1,
    "store": {
      "id": 1,
      "name": "main"
    },
    "status": "IN_PROGRESS",
    "type": "SIMUL",
    "target_date": 1673366400,
    "location": {
      "id": 1,
      "type": "DEFAULT",
      "name": "デフォルト"
    },
    "note": "定期棚卸し",
    "done_staff": null,
    "created_at": 1673366400,
    "updated_at": 1673366400,
    "done_at": null
  }
]

key	type	説明
*	array<object>	棚卸しケース
*.id	int	ケースID
*.store	object	店舗
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.status	string	ステータス。`IN_PROGRESS`(進行中) `CONFIRMING`(確認中) `DONE`(確定済み)
*.type	string	種別。`SIMUL`(一斉棚卸し) `CYCLE`(循環棚卸し)
*.target_date	int	対象日
*.location	object	ロケーション
*.location.id	int	ロケーションID
*.location.type	string	ロケーションタイプ
*.location.name	string	ロケーション名
*.note	string \| null	備考
*.done_staff	object \| null	確定処理者
*.done_staff.id	int	確定処理者ID
*.done_staff.name	string	確定処理者名
*.created_at	int \| null	作成日時
*.updated_at	int \| null	更新日時
*.done_at	int \| null	確定日時

棚卸しケース取得

概要

棚卸しケースを1件取得する

基本情報

リクエストパス: GET /items/stocktaking/{case_id}
スコープ: item:stocktaking:show
店舗IDの指定: 必要なし
基本制限レート: 5 rps

例

Request

GET /items/stocktaking/1

Response

棚卸しケース検索のresponse[0]と同様

棚卸し分割検索

概要

棚卸し分割の検索を行う

基本情報

リクエストパス: GET /items/stocktaking/{case_id}/divides
スコープ: item:stocktaking:divide:index
店舗IDの指定: 必要なし
基本制限レート: 5 rps

query

key	説明	制約など
ids	分割ID	整数のみ、カンマ区切りで複数指定可能
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250

例

Request

GET /items/stocktaking/1/divides

Response

[
  {
    "id": 1,
    "rack_number": "A-1",
    "note": null,
    "created_staff": {
      "id": 1,
      "name": "山田 太郎"
    },
    "updated_staff": {
      "id": 1,
      "name": "山田 太郎"
    },
    "summary": {
      "item_count": 12,
      "error_count": 0
    }
  }
]

key	type	説明
*	array<object>	棚卸し分割
*.id	int	分割ID
*.rack_number	string \| null	棚番号
*.note	string \| null	備考
*.created_staff	object \| null	作成者
*.created_staff.id	int	作成者ID
*.created_staff.name	string	作成者名
*.updated_staff	object \| null	更新者
*.updated_staff.id	int	更新者ID
*.updated_staff.name	string	更新者名
*.summary	object	サマリ
*.summary.item_count	int	読込商品数
*.summary.error_count	int	読取エラー数

棚卸し分割取得

概要

棚卸し分割を1件取得する

基本情報

リクエストパス: GET /items/stocktaking/{case_id}/divides/{divide_id}
スコープ: item:stocktaking:divide:show
店舗IDの指定: 必要なし
基本制限レート: 5 rps

例

Request

GET /items/stocktaking/1/divides/1

Response

{
  "id": 1,
  "rack_number": "A-1",
  "note": null,
  "created_staff": {
    "id": 1,
    "name": "山田 太郎"
  },
  "updated_staff": {
    "id": 1,
    "name": "山田 太郎"
  },
  "summary": {
    "item_count": 12,
    "error_count": 0
  },
  "details": [
    {
      "id": 1,
      "item_id": 23,
      "keyword": "ITBC0PV0VJPA",
      "quantity": 1,
      "created_at": 1673366400,
      "updated_at": 1673366400
    }
  ]
}

key	type	説明
id	int	分割ID
rack_number	string \| null	棚番号
note	string \| null	備考
created_staff	object \| null	作成者
created_staff.id	int	作成者ID
created_staff.name	string	作成者名
updated_staff	object \| null	更新者
updated_staff.id	int	更新者ID
updated_staff.name	string	更新者名
summary	object	サマリ
summary.item_count	int	読込商品数
summary.error_count	int	読取エラー数
details	array<object>	分割明細
details.*.id	int	明細ID
details.*.item_id	int \| null	在庫ID(キーワードが在庫と突合できた場合のみ設定される)
details.*.keyword	string	入力キーワード(商品コード等)
details.*.quantity	int	数量
details.*.created_at	int \| null	作成日時
details.*.updated_at	int \| null	更新日時

棚卸し在庫調整対象検索

概要

棚卸しケースにおいて、理論在庫数と実棚卸し数量にズレがあり在庫調整が必要な商品を検索する
理論値と調整数量が一致し、かつ上書き調整数量も未入力の商品は結果に含まれない(ケースに含まれる全商品を返すAPIではない)

基本情報

リクエストパス: GET /items/stocktaking/{case_id}/details
スコープ: item:stocktaking:detail:index
店舗IDの指定: 必要なし
基本制限レート: 5 rps

query

key	説明	制約など
ids	明細ID	整数のみ、カンマ区切りで複数指定可能
keyword	商品コード/エイリアスコード	完全一致。`IT`+10桁の大文字英数字の場合は商品コード、それ以外はエイリアスコードとして検索
is_checked	確認済みフラグ	boolean
product_category_id	商品カテゴリID	指定カテゴリの子孫カテゴリに属する商品も対象に含まれる
is_adjustable	在庫調整可否	boolean。trueの場合、この調整を適用しても対象ロケーションの在庫数がマイナスにならない商品のみに絞り込む(falseはその逆)
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250

例

Request

GET /items/stocktaking/1/details

Response

[
  {
    "id": 1,
    "item": {
      "id": 23,
      "product_id": 7,
      "code": "ITBC0PV0VJPA",
      "is_tracked": true,
      "alias_code": null,
      "store": {
        "id": 1,
        "name": "main"
      },
      "price": 33,
      "grade": {
        "id": 2,
        "name": "中古A"
      },
      "condition_note": null,
      "condition_tags": [],
      "note": null,
      "stocks": [
        {
          "location": {
            "id": 1,
            "type": "DEFAULT",
            "name": "デフォルト"
          },
          "status": "PENDING",
          "quantity": 1,
          "cost_price": 20
        }
      ],
      "image_url": "https://...",
      "racks": [],
      "created_at": 1673411650,
      "updated_at": 1673411650
    },
    "logical_quantity": 1,
    "logical_quantity_at": 1673366400,
    "adj_quantity": -1,
    "ovr_adj_quantity": null,
    "after_quantity": 0,
    "is_checked": false,
    "note": null,
    "divide_ids": [1],
    "rack_numbers": ["A-1"]
  }
]

key	type	説明
*	array<object>	在庫調整対象商品
*.id	int	明細ID
*.item	object	在庫 (在庫入庫と同様)
*.logical_quantity	int	理論在庫数
*.logical_quantity_at	int	理論在庫数算出日時
*.adj_quantity	int	調整数量
*.ovr_adj_quantity	int \| null	上書き調整数量
*.after_quantity	int	棚卸し後の在庫数
*.is_checked	bool	確認済みフラグ
*.note	string \| null	備考
*.divide_ids	array<int>	紐づく分割ID
*.rack_numbers	array<string>	棚番号