ReCORE.co-api

在庫廃棄

在庫廃棄検索

概要

• 在庫廃棄の検索を行う

基本情報

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

query

key	説明	制約など
ids	ケースID	整数のみ、カンマ区切りで複数指定可能
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
note	備考	部分一致検索
item_ids	廃棄在庫ID	整数のみ、カンマ区切りで複数指定可能
ca_*	ケース属性	(*1)
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

• *1) 「*」部分にケース属性のキーを指定することで、その属性値に一致するケースを検索できる。
  • 例: ca_custom_xxx=値

例

• Request

GET /items/disposals

• Response

[
  {
    "id": 1,
    "store": {
      "id": 1,
      "name": "main"
    },
    "staff": {
      "id": 1,
      "name": "山田 太郎",
      "kana": "ヤマダ タロウ"
    },
    "note": "廃棄メモ",
    "details": [
      {
        "item": {
          "id": 23,
          "code": "ITBC0PV0VJPA",
          "alias_code": null,
          "store": {
            "id": 1,
            "name": "main"
          },
          "price": 33,
          "grade": {
            "id": 2,
            "name": "中古A"
          },
          "condition_note": null,
          "condition_tags": [
            {
              "id": 1,
              "name": "喫煙あり"
            }
          ],
          "note": null,
          "stocks": [
            {
              "location": {
                "id": 1,
                "type": "DEFAULT",
                "name": "デフォルト"
              },
              "status": "DISPOSED",
              "quantity": 0,
              "cost_price": 20
            }
          ],
          "image_url": "https://...",
          "racks": [],
          "product_id": 7,
          "created_at": 1673411650,
          "updated_at": 1673411650
        },
        "quantity": 1,
        "cost_price": 20
      }
    ],
    "created_at": 1673411700
  }
]

key	type	説明
*	array<object>	在庫廃棄ケース
*.id	int	ケースID
*.store	object	店舗
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.staff	object | null	担当スタッフ
*.staff.id	int	スタッフID
*.staff.name	string	スタッフ名
*.note	string | null	備考
*.attribute	object | null	ケース属性
*.details	array<object>	廃棄明細
*.details.*.item	object	廃棄した在庫 (在庫入庫と同様)
*.details.*.quantity	int	廃棄数量
*.details.*.cost_price	int	移動原価
*.created_at	int | null	ケース作成日時

在庫廃棄実行

概要

• 既存の在庫から廃棄する

基本情報

• リクエストパス: PUT /items/disposals
• スコープ: item:disposal:update
• 店舗IDの指定: 必要なし
• 基本制限レート: 2 rps

body

key	type	説明	制約など
staff_id	?int | null	スタッフID	-
location_id	int	ロケーションID	-
status	string	廃棄ステータス	PENDING ACTIVE
items	array<object>	廃棄在庫	1件以上 1000件まで
items.*.id	int	在庫ID	-
items.*.quantity	int	廃棄数量	1以上
note	?string | null	内部メモ	-
attribute	?object	ケース属性	-

例

• Request

PUT /items/inbounds

{
  "location_id": 1,
  "status": "ACTIVE",
  "items": [
    {
      "id": 12,
      "quantity": 3
    }
  ]
}

• Response

[在庫入庫](/ReCORE.co-api/spec/item_inbound.html)と同様

在庫廃棄取得

概要

• 在庫廃棄を1件取得する

基本情報

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

例

• Request

GET /items/disposals/1

• Response

在庫廃棄検索のresponse[0]と同様