ReCORE.co-api

店頭販売ケース

店頭販売ケース検索

概要

• 店頭販売ケースの検索を行う

基本情報

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

query

key	説明	制約など
ids	ケースID	整数のみ、カンマ区切りで複数指定可能
codes	ケースコード	カンマ区切りで複数指定可能
member_ids	会員ID	整数のみ、カンマ区切りで複数指定可能
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	完了日まで	同上
page	ページ	整数のみ、デフォルト:1
limit	1ページあたりの件数	整数のみ、デフォルト:50、最大: 250
cursor	ページカーソル	-

例

• Request

GET /sas_cases?codes=SSZ3LI21AHAS

• Response

[
  {
    "id": 70,
    "code": "SSZ3LI21AHAS",
    "store":{
      "id": 1,
      "name": "本店"
    },
    "staff": {
      "id": 1,
      "name": "スタッフ 太郎"
    },
    "cashier":{
      "id": 2,
      "name": "レジ2"
    },
    "status": "IN_PROGRESS",
    "member_id": 215,
    "note": null,
    "customer_note": null,
    "done_at": null,
    "created_at": 1721682260,
    "updated_at": 1727496728,
    "tf_sales_type": null,
    "tf_name": null,
    "tf_birthdate": null,
    "tf_document_code": null,
    "tf_document_number": null,
    "tf_nationality": null,
    "tf_residence_status": null,
    "tf_landing_date": null,
    "coupons":[
      {
        "amount": -2500,
        "coupon_id": 3
      }
    ],
    "goods":[
      {
        "id": 98,
        "serial": 1,
        "item_id": 324,
        "location_id": 1,
        "unit_price": 5000,
        "unit_adjustment": 0,
        "case_adjustment": -2000,
        "coupon_adjustment": -2500,
        "tax": 0,
        "included_tax": 45,
        "exempted_tax": 0,
        "tax_rate": 10,
        "tax_rate_type": "GENERAL",
        "tax_free_type": "GENERAL",
        "quantity": 1,
        "reserved_quantity": 1,
        "earned_point": 0
      }
    ],
    "summary":{
      "quantity": 1,
      "reserved_quantity": 1,
      "sub_total": 5000,
      "case_adjustment": -2000,
      "coupon_adjustment": -2500,
      "total": 500,
      "earned_point": 0,
      "taxes":[
        {
          "tax_rate_type": "GENERAL",
          "tax_rate": 10,
          "tax": 0,
          "included_tax": 45,
          "taxable_amount": 500
        }
      ],
      "exempted_taxes":[]
    }
  }
]

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	ステータス
*.member_id	int | null	会員ID
*.note	string | null	ケースメモ
*.customer_note	string | null	顧客メモ
*.done_at	int | null	完了日
*.created_at	int | null	作成日時
*.updated_at	int | null	更新日時
*.tf_sales_type	string | null	免税販売区分
*.tf_name	string | null	免税書類_氏名
*.tf_birthdate	string | null	免税書類_生年月日
*.tf_document_code	string | null	免税書類_旅券等の種類
*.tf_document_number	string | null	免税書類_旅券番号
*.tf_nationality	string | null	免税書類_国籍
*.tf_residence_status	string | null	免税書類_在留資格
*.tf_landing_date	string | null	免税書類_上陸年月日
*.coupons	array<object>	クーポン
*.coupons.*.coupon_id	int	クーポンID
*.coupons.*.amount	int	適用額
*.goods	array<object>	販売明細
*.goods.*.id	int	販売明細ID
*.goods.*.serial	int	販売明細通し番号
*.goods.*.item_id	int	在庫ID
*.goods.*.location_id	int	ロケーションID
*.goods.*.unit_price	int	販売単価
*.goods.*.unit_adjustment	int	調整単価
*.goods.*.case_adjustment	int	小計調整
*.goods.*.coupon_adjustment	int	クーポン調整
*.goods.*.tax	int	外税
*.goods.*.included_tax	int	内税
*.goods.*.exempted_tax	int	免税額
*.goods.*.tax_rate	int	税率
*.goods.*.tax_rate_type	string	税区分
*.goods.*.tax_free_type	string	免税区分
*.goods.*.quantity	int	数量
*.goods.*.reserved_quantity	int	在庫確保済み数量
*.goods.*.earned_point	int	獲得ポイント
*.summary	object	ケースサマリー
*.summary.quantity	int	数量合計
*.summary.reserved_quantity	int	在庫確保済み数量合計
*.summary.sub_total	int	小計
*.summary.case_adjustment	int	小計調整合計
*.summary.coupon_adjustment	int	クーポン調整合計
*.summary.total	int	合計
*.summary.earned_point	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	課税対象金額
*.summary.exempted_taxes	array<object>	免税
*.summary.exempted_taxes.*.tax_rate_type	string	免税区分
*.summary.exempted_taxes.*.exempted_tax	int	免税額
*.summary.exempted_taxes.*.exemptible_amount	int	免税対象金額

• ステータス
  • IN_PROGRESS 進行中
  • DONE 販売完了
• 税区分
  • GENERAL 一般
  • RELIEF 軽減税率
  • NO_TAX 非課税
• 免税区分
  • GENERAL 一般
  • CONSUMPTION 消耗品
  • INELIGIBLE 適用外
• 免税販売区分 (tf_sales_type)
  • DEFAULT 免税販売（自動）
  • COMBINED 免税販売（自動・合算）
  • ONLY_GENERAL 一般品のみ免税
  • ONLY_CONSUMPTION 消耗品のみ免税
• 免税書類_旅券等の種類 (tf_document_code)
  • PASSPORT 旅券（パスポート）
  • SHIP_LANDING_W 船舶観光上陸許可書（旅券の写しあり）
  • SHIP_LANDING_WO 船舶観光上陸許可書（旅券の写しなし）
  • CREW_MEMBERS 乗員上陸許可書
  • EMERGENCY 緊急上陸許可書
  • DISTRESS 遭難による上陸許可書
• 免税書類_在留資格 (tf_residence_status)
  • TEMPORARY 短期滞在
  • DIPLOMAT 外交
  • OFFICIAL 公用
  • ARTIST 芸術
  • RELIGIOUS 宗教
  • JOURNALIST 報道
  • LEGAL_ACCOUNTING 法律・会計業務
  • MEDICAL 医療
  • ENTERTAINER 興行
  • CULTURAL 文化活動
  • STUDENT 留学
  • TRAINEE 研修
  • DEPENDENT 家族滞在
  • DESIGNATED 特定活動
  • SCJN 日本人の配偶者等
  • SCPR 永住者の配偶者等
  • SHIP_LANDING 上陸許可書による入国
  • NON_RESIDENT_JPN 非居住者に該当する日本国籍の者
  • OTHERS その他

店頭販売ケース取得

概要

• 店頭販売ケースを1件取得する

基本情報

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

例

• Request

GET /sas_cases/44

• Response

店頭販売ケース検索のresponse[0]と同様

店頭販売ケース作成

概要

• 店頭販売ケースを作成する

基本情報

• リクエストパス: POST /sas_cases
• JWTスコープ: sas_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以下
coupon_ids	?array<int>	クーポンID	-
goods	?array<object>	販売明細	-
goods.*.item_id	int	在庫ID	-
goods.*.location_id	int	ロケーションID	-
goods.*.quantity	int	数量	-
goods.*.unit_price	?int	販売単価	0以上 99,999,999以下
goods.*.unit_adjustment	?int	調整単価	-99,999,999以上 99,999,999以下
tf_sales_type	?string | null	免税販売区分	前述の免税販売区分一覧参照
tf_name	?string | null	免税書類_氏名	大文字英字とスペースのみ、1-39文字
tf_birthdate	?string | null	免税書類_生年月日	YYYY-MM-DD形式
tf_document_code	?string | null	免税書類_旅券等の種類	前述の旅券等の種類一覧参照
tf_document_number	?string | null	免税書類_旅券番号	旅券種類により制約が異なる
tf_nationality	?string | null	免税書類_国籍	大文字英字3文字（ISO国コード）
tf_residence_status	?string | null	免税書類_在留資格	前述の在留資格一覧参照
tf_landing_date	?string | null	免税書類_上陸年月日	YYYY-MM-DD形式

例

• Request

POST /sas_cases

{
  "reserve_mode": "RESERVE",
  "staff_id": null,
  "cashier_id": null,
  "note": null,
  "goods": [
    {
      "item_id": 12,
      "location_id": 1,
      "quantity": 1
    }
  ]
}

• Response

店頭販売ケース取得と同様

店頭販売ケース更新

概要

• 店頭販売ケースを更新する

基本情報

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

body

店頭販売ケース作成との差分のみ記載

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

• *1) action: CREATEの場合必須
• *2) action: UPDATE DELETEの場合必須
• 在庫確保状態 (reserved_quantityが1以上のgoodsが一つでもある) の場合、下記に該当するリクエストは除外されます
  • action: UPDATEの場合、item_idとlocation_idは常に無視されます
  • action: DELETEの場合、常に無視されます
• status: DONEの場合、ケースメモ以外の更新は無視されます

例

• Request

PUT /sas_cases/44

{
  "reserve_mode": "RESERVE",
  "note": null,
  "staff_id": 1,
  "cashier_id": 1,
  "goods": [
    {
      "action": "CREATE",
      "item_id": 12,
      "location_id": 1,
      "quantity": 1
    },
    {
      "action": "UPDATE",
      "id": 234,
      "quantity": 2
    },
    {
      "action": "DELETE",
      "id": 235
    }
  ]
}

• Response

店頭販売ケース取得と同様

店頭販売ケース削除

概要

• 店頭販売ケースを削除する

基本情報

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

例

• Request

DELETE /sas_cases/44

• Response

なし

店頭販売チェックアウト確認

概要

• 店頭販売ケースの確定情報を確認する

基本情報

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

例

• Request

GET /sas_cases/44/checkout

• Response

{
  "charges": [
    {
      "payment": {
        "id": 1,
        "name": "現金",
        "type": "CASH"
      },
      "amount": 1554,
      "change": 10
    }
  ]
}

key	type	説明
charges	array<object>	入金
charges.*.payment	object	金種
charges.*.payment.id	int	金種ID
charges.*.payment.name	string	金種名
charges.*.payment.type	string	金種タイプ
charges.*.amount	int	金額
charges.*.change	int	お釣り

店頭販売チェックアウト

概要

• 店頭販売ケースを確定する

基本情報

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

body

key	type	説明	制約など
charges	array<object>	入金	-
charges.*.payment_id	int	金種ID	-
charges.*.amount	int	金額	1以上

例

• Request

PUT /sas_cases/44/checkout

{
  "charges": [
    {
      "payment_id": 1,
      "amount": 1100
    }
  ]
}

• Response

店頭販売チェックアウト確認と同様