ReCORE.co-api

在庫店舗変更

在庫店舗変更ケース検索

概要

• 在庫店舗変更ケースの検索を行う

基本情報

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

query

key	説明	制約など
ids	ケースID	整数のみ、カンマ区切りで複数指定可能
statuses	ステータス	カンマ区切りで複数指定可能
sub_statuses	サブステータス	カンマ区切りで複数指定可能
ca_*	ケース属性	(*1)
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

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

例

• Request

GET /items/change_stores

• Response

[
  {
    "id": 123,
    "store": {
      "id": 1,
      "name": "main"
    },
    "status": "IN_PROGRESS",
    "sub_status": null,
    "location": {
      "id": 1,
      "type": "DEFAULT",
      "name": "デフォルト"
    },
    "item_status": "ACTIVE",
    "src_store": {
      "id": 1,
      "name": "main"
    },
    "dist_store": {
      "id": 2,
      "name": "branch"
    },
    "note": "サンプル",
    "created_staff": {
      "id": 1,
      "name": "山田 太郎"
    },
    "issued_staff": null,
    "done_staff": null,
    "details": [
      {
        "id": 456,
        "src_item": {
          "id": 23,
          "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": [
            {
              "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": null,
        "issued_quantity": 1,
        "received_quantity": 0,
        "cost_price": 20
      }
    ],
    "created_at": 1673411650,
    "issued_at": null,
    "done_at": null
  }
]

key	type	説明
*	array<object>	在庫店舗変更ケース
*.id	int	ID
*.store	object	店舗
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.status	string	ステータス
*.sub_status	string | null	サブステータス
*.location	object	ロケーション
*.location.id	int	ロケーションID
*.location.type	string	ロケーションタイプ
*.location.name	string	ロケーション名
*.item_status	string	在庫ステータス (*1)
*.src_store	object	移動元店舗情報
*.src_store.id	int	移動元店舗ID
*.src_store.name	string	移動元店舗名
*.dist_store	object	移動先店舗情報
*.dist_store.id	int	移動先店舗ID
*.dist_store.name	string	移動先店舗名
*.created_staff	object | null	作成担当者
*.created_staff.id	int	作成担当者ID
*.created_staff.name	string	作成担当者名
*.issued_staff	object | null	出庫担当者
*.issued_staff.id	int	出庫担当者ID
*.issued_staff.name	string	出庫担当者名
*.done_staff	object | null	完了担当者
*.done_staff.id	int	完了担当者ID
*.done_staff.name	string	完了担当者名
*.note	string | null	備考
*.attribute	object | null	ケース属性
*.details	array<object>	詳細
*.details.*.id	int	詳細ID
*.details.*.src_item	object	移動元在庫 (在庫入庫と同様)
*.details.*.dist_item	object | null	移動先在庫 (在庫入庫と同様)
*.details.*.issued_quantity	int	出庫数量
*.details.*.received_quantity	int	入庫数量
*.details.*.cost_price	int	コスト
*.created_at	int | null	作成日時
*.issued_at	int | null	出庫日時
*.done_at	int | null	完了日時

• ステータス
  • IN_PROGRESS 処理中
  • ISSUED 出庫済み
  • RECEIVED 入庫済み
  • CANCELED キャンセル

在庫店舗変更ケース取得

概要

• 在庫店舗変更ケースを1件取得する

基本情報

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

例

• Request

GET /items/change_stores/123

• Response

在庫店舗変更ケース検索のresponse[0]と同様

在庫店舗変更ケース作成

概要

• 在庫店舗変更ケースを作成する

基本情報

• リクエストパス: POST /items/change_stores
• スコープ: item:change_store:store
• 店舗IDの指定: 必要あり
• 基本制限レート: 2 rps

body

key	type	説明	制約など
staff_id	?int | null	スタッフID	-
sub_status	?string | null	サブステータス	30文字まで
location_id	int	ロケーションID	-
item_status	string	在庫ステータス	PENDING ACTIVE
src_store_id	int	移動元店舗ID	-
dist_store_id	int	移動先店舗ID	-
note	?string | null	備考	-
attribute	?object	ケース属性	-
details	array<object>	詳細情報	1件以上 1000件まで
details.*.src_item_id	int	移動元在庫ID	-
details.*.issued_quantity	?int	出庫数量	1以上
details.*.received_quantity	?int	入庫数量	0以上

例

• Request

POST /items/change_stores

{
  "staff_id": 1,
  "location_id": 1,
  "item_status": "ACTIVE",
  "src_store_id": 1,
  "dist_store_id": 2,
  "note": null,
  "details": [
    {
      "src_item_id": 23,
      "issued_quantity": 1,
      "received_quantity": 0
    }
  ]
}

• Response

在庫店舗変更ケース取得と同様

在庫店舗変更ケース更新

概要

• 在庫店舗変更ケースを更新する

基本情報

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

body

在庫店舗変更ケース作成との差分のみ記載

key	type	説明	制約など
details.*.action	string	アクション	CREATE UPDATE DELETE
details.*.id	?int (*2)	詳細ID	-
details.*.src_item_id	?int (*1)	移動元在庫ID	-
details.*.issued_quantity	?int	出庫数量	1以上
details.*.received_quantity	?int	入庫数量	0以上

• *1) action: CREATEの場合必須
• *2) action: UPDATEの場合必須

例

• Request

PUT /items/change_stores/123

{
  "note": null,
  "details": [
    {
      "action": "UPDATE",
      "id": 456,
      "issued_quantity": 2,
      "received_quantity": 1
    },
    {
      "action": "CREATE",
      "src_item_id": 24,
      "issued_quantity": 1,
      "received_quantity": 0
    }
  ]
}

• Response

在庫店舗変更ケース取得と同様

在庫店舗変更ケース削除

概要

• 在庫店舗変更ケースを削除する

基本情報

• リクエストパス: DELETE /items/change_stores/{case_id}
• スコープ: item:change_store:destroy
• 店舗IDの指定: 必要なし
• 基本制限レート: 2 rps

例

• Request

DELETE /items/change_stores/123

• Response

(なし)

在庫店舗変更ステータス更新

概要

• 在庫店舗変更ケースのステータスを更新する

基本情報

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

body

key	type	説明	制約など
staff_id	?int | null	スタッフID	-
status	string	ステータス	(*1)

• *1) ステータス遷移の制約:
  • IN_PROGRESS → ISSUED
  • ISSUED → RECEIVED CANCELED
  • RECEIVED CANCELED: 他のステータスへ変更不可

例

• Request

PUT /items/change_stores/123/status

{
  "staff_id": 1,
  "status": "ISSUED"
}

• Response

在庫店舗変更ケース取得と同様