ReCORE.co-api

一般販売ケース

一般販売ケース検索

概要

• 一般販売ケースの検索を行う

基本情報

• リクエストパス: GET /sig_cases
• JWTスコープ: sig_case:index
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

query

key	説明	制約など
ids	ケースID	整数のみ、カンマ区切りで複数指定可能
codes	ケースコード	カンマ区切りで複数指定可能
member_ids	会員ID	整数のみ、カンマ区切りで複数指定可能
statuses	ステータス	カンマ区切りで複数指定可能
payment_statuses	支払ステータス	カンマ区切りで複数指定可能
created_at_from	作成日から	2024-04-12 12:08:38 形式
created_at_to	作成日まで	同上
updated_at_from	更新日から	同上
updated_at_to	更新日まで	同上
done_at_from	完了日から	同上
done_at_to	完了日まで	同上
paid_at_from	支払日から	同上
paid_at_to	支払日まで	同上
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

• Request

GET /sig_cases?codes=SGJ3JJ2RGZL0

• Response

[
  {
    "id": 245,
    "code": "SGJ3JJ2RGZL0",
    "store": {
      "id": 1,
      "name": "本店"
    },
    "staff": {
      "id": 1,
      "name": "スタッフ 太郎"
    },
    "cashier": {
      "id": 2,
      "name": "レジ2"
    },
    "status": "IN_PROGRESS",
    "payment_status": "UNPAID",
    "member_id": 742,
    "customer_note": null,
    "note": "aaa",
    "payment": {
      "id": 1,
      "name": "現金",
      "type": "CASH"
    },
    "done_at": null,
    "paid_at": null,
    "created_at": 1719542383,
    "updated_at": 1727678538,
    "attachments": [
      {
        "id": 179,
        "file_key": "PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg",
        "tag": "GENERAL",
        "file_name": "カタログ_20250523_183452.jpg",
        "url": "https://...",
        "mime_type": "image/jpeg"
      }
    ],
    "goods": [
      {
        "id": 1022,
        "serial": 1,
        "quantity": 1,
        "note": null,
        "unit_price": 2000,
        "unit_adjustment": 0,
        "case_adjustment": -200,
        "tax": 0,
        "included_tax": 163,
        "tax_rate": 10,
        "tax_rate_type": "GENERAL",
        "item_id": 5678,
        "location_id": 1
      }
    ],
    "summary": {
      "quantity": 1,
      "sub_total": 2000,
      "case_adjustment": -200,
      "total": 1800,
      "taxes": [
        {
          "tax_rate_type": "GENERAL",
          "tax_rate": 10,
          "tax": 0,
          "included_tax": 163,
          "taxable_amount": 1800
        }
      ]
    }
  }
]

key	type	説明
*	array<object>	ケース
*.id	int	ケースID
*.code	string	ケースコード
*.store	object	店舗
*.store.id	int	店舗ID
*.store.name	string	店舗名
*.staff	object | null	スタッフ
*.staff.id	int	スタッフID
*.staff.name	string	スタッフ名
*.cashier	object | null	レジ
*.cashier.id	int	レジID
*.cashier.name	string	レジ名
*.status	string	ステータス
*.payment_status	string	支払ステータス
*.member_id	int | null	会員ID
*.customer_note	string | null	顧客メモ
*.note	string | null	ケースメモ
*.payment	object | null	支払方法
*.payment.id	int	支払方法ID
*.payment.name	string	支払方法名
*.payment.type	string	支払方法タイプ
*.done_at	int | null	完了日時
*.paid_at	int | null	支払日時
*.created_at	int | null	作成日時
*.updated_at	int | null	更新日時
*.attachments	array<object>	ファイル
*.attachments.*.id	int	ファイルID
*.attachments.*.file_key	string	ファイルキー
*.attachments.*.tag	string	タグ
*.attachments.*.file_name	string | null	ファイル名
*.attachments.*.url	string	一時URL (*1)
*.attachments.*.mime_type	string	MIMEタイプ
*.goods	array<object>	販売明細
*.goods.*.id	int	販売明細ID
*.goods.*.serial	int	販売明細通し番号
*.goods.*.item_id	int | null	在庫ID
*.goods.*.location_id	int | null	ロケーションID
*.goods.*.quantity	int	数量
*.goods.*.reserved_quantity	int	確保済み数量
*.goods.*.note	string | null	商品メモ
*.goods.*.unit_price	int	販売単価
*.goods.*.unit_adjustment	int	調整単価
*.goods.*.case_adjustment	int	小計調整
*.goods.*.tax	int	外税
*.goods.*.included_tax	int	内税
*.goods.*.tax_rate	int	税率
*.goods.*.tax_rate_type	string	税区分
*.summary	object	ケースサマリー
*.summary.quantity	int	数量合計
*.summary.reserved_quantity	int	確保済み数量合計
*.summary.sub_total	int	小計
*.summary.case_adjustment	int	小計調整合計
*.summary.total	int	合計
*.summary.taxes	array<object>	税
*.summary.taxes.*.tax_rate_type	string	税区分
*.summary.taxes.*.tax_rate	int	税率
*.summary.taxes.*.tax	int	外税
*.summary.taxes.*.included_tax	int	内税
*.summary.taxes.*.taxable_amount	int	課税対象金額

• *1) 一時的なURLなので保存等はしない
• ステータス
  • IN_PROGRESS 進行中
  • DONE 販売完了
• 支払ステータス
  • UNPAID 未払い
  • PAID 支払済み
• 税区分
  • GENERAL 一般
  • RELIEF 軽減税率
  • NO_TAX 非課税

一般販売ケース取得

概要

• 一般販売ケースを1件取得する

基本情報

• リクエストパス: GET /sig_cases/{case_id}
• JWTスコープ: sig_case:show
• 必須個別JWTパラメータ: なし
• レートリミット: 5 rps

例

• Request

GET /sig_cases/44

• Response

一般販売ケース検索のresponse[0]と同様

一般販売ケース作成

概要

• 一般販売ケースを作成する

基本情報

• リクエストパス: POST /sig_cases
• JWTスコープ: sig_case:store
• 必須個別JWTパラメータ: store_id (またはX-Store-Idヘッダ)
• レートリミット: 2 rps

body

key	type	説明	制約など
staff_id	?int | null	スタッフID	-
reserve_mode	?string	在庫確保モード	RESERVE RELEASE
cashier_id	?int | null	レジID	-
member_id	?int | null	会員ID	-
customer_note	?string | null	顧客メモ	-
note	?string | null	ケースメモ	-
case_adjustment	?int	小計調整	99,999,999以下
goods	?array<object>	販売明細	-
goods.*.item_id	int	在庫ID	-
goods.*.location_id	int	ロケーションID	-
goods.*.quantity	int	数量	0以上 9,999以下
goods.*.unit_price	?int	販売単価	0以上 99,999,999以下
goods.*.unit_adjustment	?int	調整単価	-99,999,999以上 99,999,999以下

例

• Request

POST /sig_cases

{
  "note": "メモ",
  "goods": [
    {
      "item_id": 5678,
      "location_id": 1,
      "quantity": 1,
      "unit_price": 2000
    }
  ]
}

• Response

一般販売ケース取得と同様

一般販売ケース更新

概要

• 一般販売ケースを更新する

基本情報

• リクエストパス: PUT /sig_cases/{case_id}
• JWTスコープ: sig_case:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

一般販売ケース作成との差分のみ記載

key	type	説明	制約など
goods.*.action	string	アクション	CREATE UPDATE DELETE
goods.*.id	?int (*1)	販売明細ID	-
goods.*.item_id	?int (*2)	在庫ID	-
goods.*.location_id	?int (*2)	ロケーションID	-
goods.*.quantity	?int (*2)	数量	0以上 9,999以下

• *1) action: UPDATE DELETEの場合必須
• *2) action: CREATEの場合必須
• 在庫確保状態 (reserved_quantityが1以上のgoodsが一つでもある) の場合、下記に該当するリクエストは除外されます
  • action: UPDATEの場合、item_idとlocation_idは常に無視されます
  • action: DELETEの場合、常に無視されます
• status: DONE かつ payment_status: PAID の場合、ケースメモ以外の更新は無視されます
• status: DONE の場合、ケースメモとレジID以外の更新は無視されます
• payment_status: PAID の場合、金額や契約内容が変わるようなカラムと販売明細の更新は無視されます

例

• Request

PUT /sig_cases/44

{
  "note": null,
  "reserve_mode": "RESERVE",
  "goods": [
    {
      "action": "CREATE",
      "item_id": 5679,
      "location_id": 1,
      "quantity": 1,
      "unit_price": 2000
    },
    {
      "action": "UPDATE",
      "id": 234,
      "unit_price": 2200
    },
    {
      "action": "DELETE",
      "id": 235
    }
  ]
}

• Response

一般販売ケース取得と同様

一般販売ケース削除

概要

• 一般販売ケースを削除する

基本情報

• リクエストパス: DELETE /sig_cases/{case_id}
• JWTスコープ: sig_case:destroy
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

例

• Request

DELETE /sig_cases/44

• Response

なし

一般販売チェックアウト実行

概要

• 一般販売ケースを確定する

基本情報

• リクエストパス: PUT /sig_cases/{case_id}/checkout
• JWTスコープ: sig_case:checkout:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

なし

例

• Request

PUT /sig_cases/44/checkout

• Response

一般販売ケース取得と同様

一般販売支払実行

概要

• 一般販売ケースの支払を実行する

基本情報

• リクエストパス: PUT /sig_cases/{case_id}/payment
• JWTスコープ: sig_case:payment:update
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
payment_id	int	支払方法ID	ポイント支払い以外
paid_at	string	支払日時	YYYY-MM-DD HH:MM:SS形式、ケース作成日以降 現在以前

例

• Request

PUT /sig_cases/44/payment

{
  "payment_id": 1,
  "paid_at": "2024-06-28 15:30:00"
}

• Response

一般販売ケース取得と同様

ケースファイル登録

概要

• ファイルを登録する

基本情報

• リクエストパス: POST /sig_cases/{case_id}/attachments
• JWTスコープ: sig_case:attachment:store
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

body

key	type	説明	制約など
file_key	string	ファイルキー (*1)	-
tag	string	タグ	(*2)
file_name	?string | null	ファイル名	100文字まで

• *1) ファイルアップロード(機密ファイル)で取得したファイルキーを使用
• *2) 使用できるタグ
  • GENERAL 一般ファイル

例

• Request

POST /sig_cases/122/attachments

{
  "file_key": "PdoJcUm1wtopvpX5goCSB36GR45FGuRJCrQAsvky.jpg",
  "tag": "GENERAL",
  "file_name": "カタログ_20250523_183452.jpg"
}

• Response

一般販売ケース取得のattachments[0]と同様

ケースファイル削除

概要

• ファイルを削除する

基本情報

• リクエストパス: DELETE /sig_cases/{case_id}/attachments/{attachment_id}
• JWTスコープ: sig_case:attachment:destroy
• 必須個別JWTパラメータ: なし
• レートリミット: 2 rps

例

• Request

DELETE /sig_cases/122/attachments/345

• Response

(なし)