ReCORE.co-api

在庫振替

在庫振替検索

概要

• 在庫振替の検索を行う

基本情報

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

query

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

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

例

• Request

GET /items/transfers

• Response

[
  {
    "id": 1,
    "store": {
      "id": 1,
      "name": "main"
    },
    "staff": {
      "id": 1,
      "name": "山田 太郎",
      "kana": "ヤマダ タロウ"
    },
    "note": "振替メモ",
    "details": [
      {
        "src_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": "PENDING",
              "quantity": 1,
              "cost_price": 20
            }
          ],
          "image_url": "https://...",
          "racks": [],
          "product_id": 7,
          "created_at": 1673411650,
          "updated_at": 1673411650
        },
        "dist_item": {
          "id": 24,
          "code": "ITBC0PV0VJPB",
          "alias_code": null,
          "store": {
            "id": 1,
            "name": "main"
          },
          "price": 1500,
          "grade": {
            "id": 1,
            "name": "新品"
          },
          "condition_note": null,
          "condition_tags": [],
          "note": null,
          "stocks": [
            {
              "location": {
                "id": 1,
                "type": "DEFAULT",
                "name": "デフォルト"
              },
              "status": "ACTIVE",
              "quantity": 2,
              "cost_price": 10
            }
          ],
          "image_url": null,
          "racks": [],
          "product_id": 8,
          "created_at": 1673411700,
          "updated_at": 1673411700
        },
        "price_ratio": 0.5,
        "quantity_ratio": 0.5,
        "cost_price": 10
      }
    ],
    "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.*.src_item	object	振替元在庫 (在庫入庫と同様)
*.details.*.dist_item	object	振替先在庫 (在庫入庫と同様)
*.details.*.price_ratio	float	価格比率 (*1)
*.details.*.quantity_ratio	float	数量比率 (*2)
*.details.*.cost_price	int	原価
*.created_at	int | null	ケース作成日時

• *1) price_ratio: 振替元商品の総価値（価格×数量）に対する各商品の価値割合。例) 商品A(100円×2個=200円)と商品B(200円×2個=400円)の場合、Aは0.333、Bは0.667となる
• *2) quantity_ratio: 振替先商品の総数量に対する各振替元商品の数量割合。振替元の数量配分を振替先全体の規模に対して正規化した値

在庫振替実行

概要

• 在庫を別の商品に振替する

基本情報

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

body

key	type	説明	制約など
staff_id	?int | null	担当スタッフID	-
location_id	int	振替先ロケーションID	-
status	string	ステータス	PENDING ACTIVE
note	?string | null	備考	-
attribute	?object	ケース属性	-
src_items	array<object>	振替元在庫	1件以上 1000件まで (*1)
src_items.*.id	int	振替元在庫ID	-
src_items.*.quantity	int	振替元数量	1以上
dist_items	array<object>	振替先在庫	1件以上 1000件まで (*1)
dist_items.*.product_id	int	振替先商品ID	-
dist_items.*.quantity	int	振替先数量	1以上
dist_items.*.price	int	振替先価格	0以上
dist_items.*.grade_id	int	振替先グレードID	-
dist_items.*.condition_note	?string | null	振替先コンディション詳細	-
dist_items.*.condition_tag_ids	?array<int>	コンディションタグIDリスト	-
dist_items.*.cost_price	?int | null	原価	0以上 (*2)

• *1) 振替元在庫と振替先在庫の組み合わせ上限は2500件まで
• *2) 振替先在庫の原価を指定しない場合、振替元在庫の原価残を振替先数量・価格で按分した値を原価に自動適用

例

• Request

PUT /items/transfers

{
  "location_id": 1,
  "status": "ACTIVE",
  "src_items": [
    {
      "id": 1001,
      "quantity": 2
    }
  ],
  "dist_items": [
    {
      "product_id": 2001,
      "quantity": 2,
      "price": 1500,
      "grade_id": 1
    },
    {
      "product_id": 2002,
      "quantity": 2,
      "price": 1500,
      "grade_id": 2
    }
  ]
}

• Response

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

在庫振替取得

概要

• 在庫振替を1件取得する

基本情報

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

例

• Request

GET /items/transfers/1

• Response

在庫振替検索のresponse[0]と同様