取引更新
const url = 'https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/transactions/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"customerGroupId":"123456789","customerGroupId2":"123456789","customerGroupId3":"123456789","customerGroupId4":"123456789","customerGroupId5":"123456789","staffId":"123456789","memo":"string","receiptMemo":"string","guestNumbers":"1234","guestNumbersMale":"1234","guestNumbersFemale":"1234","guestNumbersUnknown":"1234","tags":"string"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.smaregi.dev/TARGET-CONTRACT-ID/pos/transactions/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "customerGroupId": "123456789", "customerGroupId2": "123456789", "customerGroupId3": "123456789", "customerGroupId4": "123456789", "customerGroupId5": "123456789", "staffId": "123456789", "memo": "string", "receiptMemo": "string", "guestNumbers": "1234", "guestNumbersMale": "1234", "guestNumbersFemale": "1234", "guestNumbersUnknown": "1234", "tags": "string" }'取引情報を更新します。
※ 会員情報の更新は、取引会員更新をご利用ください。
対象プラン
- スタンダード
- プレミアム
- プレミアムプラス
- フードビジネス
- リテールビジネス
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”取引ID
Request Body
Section titled “Request Body”object
客層ID。客層セクションIDが1の客層IDを設定。 ※客層情報が存在しない場合エラー
客層ID2。客層セクションIDが2の客層IDを設定。 ※客層情報が存在しない場合エラー
客層ID3。客層セクションIDが3の客層IDを設定。 ※客層情報が存在しない場合エラー
客層ID4。客層セクションIDが4の客層IDを設定。 ※客層情報が存在しない場合エラー
客層ID5。客層セクションIDが5の客層IDを設定。 ※客層情報が存在しない場合エラー
スタッフID
※スタッフ情報が存在しない場合エラー
※ ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗のスタッフIDを指定してください。
入出金時のメモなどを設定。 1000文字以内。
レシートに印字するメモを設定。100文字以内。
客数。
客数(男)。
客数(女)。
客数(不明)。
レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。 ※1取引タグは最大64文字。複数ある場合は、カンマ区切りで設定。
Example
{ "customerGroupId": "123456789", "customerGroupId2": "123456789", "customerGroupId3": "123456789", "customerGroupId4": "123456789", "customerGroupId5": "123456789", "staffId": "123456789", "memo": "string", "receiptMemo": "string", "guestNumbers": "1234", "guestNumbersMale": "1234", "guestNumbersFemale": "1234", "guestNumbersUnknown": "1234", "tags": "string"}Responses
Section titled “Responses”更新成功
object
取引ID
取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]
取引を識別する区分。
1: 通常2: 入金3: 出金4: 預かり金5: 預かり金返金6: ポイント加算7: ポイント減算8: ポイント失効10: 取置き13: マイル加算14: マイル減算15: バリューカード入金16: 領収証
※ 10:取置きについては、取置き登録APIをご使用ください。
※ 8:ポイント失効、9:回数券、11:チップ、15:バリューカード入金、16:領収証は対応しておりません。
取引の取消を識別する区分。 (0:通常、1取消)
取引明細の、値引き前計の合計。明細より自動算出。 ※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計
単品値引き小計:取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。
※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。
(例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。)
※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。
4: バンドル (親)5: セット売り(親)6: 簡易セット(親)8: バンドル値引(子)
単品社員販売値引き計
単品セール販売値引き計
取引明細の値引き後小計の合計。
取引明細の割引値引対象区分が対象の小計金額
小計の値引き金額を設定。
小計の割引を設定 (単位%) デフォルトは未設定。
設定された場合、小計値引は必須。
※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。
小計値引き/割引時に指定された区分を設定。
管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。
使用ポイント * ポイント還元率。
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン値引き:その取引で使用された各クーポンの値引き・割引額の合計値。
小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定
内税商品計 / 110 * 10。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り
外税商品計 * 10 / 100。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り
販売時の合計金額の端数を丸めるか否かを設定する。
00:なし
11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
99:手入力
端数値引額
合計金額の内訳 (現金払い)
合計金額の内訳 (クレジット払い)
会計時に預かった金額。
会計時に預かった現金金額。
※paymentsを参照してください。
会計時に預かったクレジット金額。 ※paymentsを参照してください。
釣銭。
※paymentsを参照してください。
現金チップ
クレジットチップ
取引明細の返品以外の数量の合計 (取引明細区分が2返品以外の数量)
取引明細の返品の数量の合計 (取引明細区分が2返品の数量)
明細の原価計の合計。
※移動平均法(計上日基準)かつ sumDivision:2 以外の場合、空文字 “” が返されます。
売上明細に売上対象外商品を含むか否かの区分。 (0:売上対象のみ、1:売上対象外含む)
売上対象商品の内税販売合計金額。 内税販売の場合は、税込・税抜き商品を対象。
売上対象商品の外税販売の税抜き商品合計金額
売上対象商品の非課税商品の合計金額。
売上対象外商品の合計。 外税販売の場合、税を含まない。
売上対象外商品の外税合計。
売上対象外商品の内税合計。
売上対象外商品の免税額合計。
売上対象外商品の原価合計。
※移動平均法(計上日基準)かつ sumDivision:2 以外の場合、空文字 “” が返されます。
取引明細の返品以外かつ売上対象外の数量の合計。 (取引明細区分が2返品以外の数量)
取引明細の返品かつ売上対象外の数量の合計。 (取引明細区分が2返品の数量)
取引で付与されるポイント。 合計 * ポイント付与率
取引で使用したポイント。
取引前のポイント。
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。
取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。
現在マイル。取引前のマイル
※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。
※ 会員販売でない場合、nullが返されます。
獲得マイル。取引で付与されるマイル
合計 * ポイント付与率
※ 会員販売でない場合、nullが返されます。
合計マイル。取引後のマイル
現在マイル + 獲得マイル + 調整マイル
※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。
※ 会員販売でない場合、nullが返されます。
調整マイル。取引で手動で付与されるマイル
※ 会員販売でない場合、nullが返されます。
調整マイル区分。
1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)
2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」)
3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)
4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」
※ 会員販売でない場合、nullが返されます。
調整マイル区分値
※ 会員販売でない場合、nullが返されます。
店舗毎に付与するID。
※店舗情報が存在しない場合エラー
※休止中の店舗IDを指定するとエラー
店舗の端末毎に付与するID。
※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みに設定する必要あり)
会員毎に付与するID。
※設定されている場合、会員販売とみなし会員ポイント情報を更新します。
※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。
端末で設定された取引ID。
端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
締め処理を実施したかの区分。 (0:未処理、1:精算処理済み、2:締め処理済み)
精算をしたら日時が入る。[YYYY-MM-DDThh:mm:ssTZD]
締めをしたら年月日が入る。 [YYYY-MM-DD]
会員ランク。管理画面の[設定]→[会員設定]→[会員ランク]で設定したコードを設定してください。
客層ID。客層セクションIDが1の客層IDを設定。
客層ID2。客層セクションIDが2の客層IDを設定。
客層ID3。客層セクションIDが3の客層IDを設定。
客層ID4。客層セクションIDが4の客層IDを設定。
客層ID5。客層セクションIDが5の客層IDを設定。
スタッフID
スタッフIDがある場合、スタッフマスタのスタッフ名を設定
クレジット区分:クレジット会社を識別する区分
- 11: Smaregi Payment (ScanJacket)
- 12: Smaregi Payment (shuttle)
- 13: Smaregi Payment (IC)
- 14: Smaregi Payment (VEGA3000)
- 15: PAYGATE Station
- 21: ペイメント・マイスター for FLIGHT
- 22: ペイメント・マイスター
- 23: ペイメント・マイスター for Thincacloud
- 24: ペイメント・マイスター for FG-Center
- 31: 楽天
- 41: STORES (Coiney)
- 51: スクエア
- 61: JET-S (CATS300/CATS330)
- 62: JET-S (JT-C17U)
- 71: J-Mups (JT-C30L)
- 72: JET-S Cloud (JT-C31W)
- 73: JET-S Cloud (JT-VT10)
- 81: おてがるPay クレジット
- 82: おてがるPay 電子マネー
- 83: J-Mups II Pocket
- 91: INFOX (JT-C16U)
- A1: VEGA3000 Mobile2
- B1: stera terminal
- C1: SATURN1000E/SATURN1000L (CAFIS Arch)
クレジットの支払回数。
※ゼウス、ペイメントマイスターご利用時
(1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い)
※paymentsを参照してください。
クレジットの伝票番号。
※paymentsを参照してください。
クレジットの取消伝票番号。
※paymentsを参照してください。
クレジットの承認番号。
※paymentsを参照してください。
クレジットのセンター処理日。
※paymentsを参照してください。
クレジットカード会社 例) VISA、JCB、MASTER、AMEX、DINERSなど
※paymentsを参照してください。
11:磁気クレジットカード、12:ICクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー
※ペイメント・マイスターで使用
入出金時のメモなどを設定。 1000文字以内。
レシートに印字するメモを設定。100文字以内。
EC連携用送料。
EC連携用手数料。
客数。
客数(男)。
客数(女)。
客数(不明)。
入店日時。[YYYY-MM-DDThh:mm:ssTZD]
免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
※未設定の場合、0:通常販売
内税商品の一般品免税額。
外税商品の一般品免税額。
内税商品の消耗品免税額。
外税商品の消耗品免税額。
レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
※複数ある場合は、カンマ区切りで設定
1:税額を含める + 利用ポイント分を含める、
2:税額を含めない + 利用ポイント分を含める、
3:税額を含める + 利用ポイント分を含めない、
4:税額を含めない + 利用ポイント分を含めない
※省略時、店舗マスタから設定。
ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円)
(例10円ごとに0.2ポイントの場合、10)
※未設定の場合は店舗マスタから設定。
ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
(例10円ごとに0.2ポイントの場合、0.2)
※未設定の場合は店舗マスタから設定。
ポイント利用時の税を含む/含まない、対価の値引き/対価の値引きでないを判定。
1: 「小計 + 外税 の金額から差し引く」かつ「対価への充当」2: 「小計から差し引く」かつ「対価の値引き」3: 「小計 + 外税 の金額から差し引く」かつ「対価の値引き」 ※未設定の場合は店舗マスタから設定。
マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
※未設定の場合は店舗マスタから設定。 初期値:0。
マイレージの名称。未設定の場合は「マイル」
自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。
0:通常、1:返品販売
0:通常、1:返品取消元、2:返品取消
※0:通常と2:返品取消のみ設定可能(省略時は0:通常を設定)
※返品取消取引の場合、取引明細区分は、(通常、部門売り)→返品に変換させて設定してください。
返品取消元取引ID
※返品取消区分が2の場合必須
※返品取消元取引IDが存在しない場合エラー。省略時はnullを設定
取消/返品取消の場合自動設定。[YYYY-MM-DDThh:mm:ssTZD]
取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)
※省略時は0:内税販売を設定
税率 (単位%)
※省略時は、スマレジに設定されている消費税を設定(端末取引日時より算出)
税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時はスマレジに設定されている税の丸め方式を設定
割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ
※省略時はスマレジに設定されている税の丸め方式を設定
レシートに印字する番号。
※省略時は、1970年から計算した現在秒の末尾9桁+端末IDゼロ詰め4桁
引換券番号
有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。
仮販売のバーコード。
※ 複数ある場合はカンマ区切り。
登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
取引明細
object
取引ID
ユニーク値 取引毎の明細に付与するID。
設定する場合は1〜999まで。
取引明細を指定する場合必須。
紐付く親の取引明細がある場合、その取引明細IDを設定。
※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の取引明細IDを設定しなければならない。
取引明細を識別する区分。
(1:通常、2:返品、3:部門売り)
商品ID
商品コード
商品名
レシート印字商品名
カラー
サイズ
グループコード
品番
税区分。(0:税込、1:税抜、2:非課税)
※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0:税込
※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0円
販売時の単価を設定。
販売単価の値引き金額を設定。
単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て)。
単品の割引率を設定。(単位:%)
※設定された場合、単品値引は必須
単品値引き/割引時に指定された割引区分を設定。
商品原価。整数部分8桁、少数部5桁。
※移動平均法(計上日基準)かつ sumDivision:2 以外の場合、空文字 “” が返されます。
購入数
取引明細を指定する場合必須。
販売価格×数量
単品値引き×数量
※管理画面の取引履歴CSVで対応する項目: 単価値引き計
値引き前計 - 単品値引き計
原価×数量。
※移動平均法(計上日基準)かつ sumDivision:2 以外の場合、空文字 “” が返されます。
商品に紐付く部門毎に付与するID。数字9桁以内。
※部門情報が存在しない場合、エラー
※商品IDが設定されている場合、商品情報の部門IDと一致しないとエラー
※省略時、商品IDが設定されている場合、商品マスタの部門IDを設定
商品に紐付く部門名。(85文字以内)
※設定時、そのまま設定。
※省略時、部門IDが設定されている場合、マスタから設定。以外はnull
明細行を識別できる番号。
売上計上するか否かの区分。(0:売上対象、1:売上対象外)
省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:売上対象を設定
商品区分。
- 0:通常
- 1:回数券
- 2:オプション商品
- 3:部門販売
- 4:バンドル売り(親)
- 5:セット売り(親)
- 6:簡易バンドル販売(親)
- 7:バンドル商品(子)
- 8:バンドル値引(子)
- A:プラン(子)
- B:コース(子)
※ A:プラン(子), B:コース(子)はウェイターから登録された取引でのみ設定される。
在庫引当商品か否かの区分(0:通常商品、1:在庫引当商品)
自動で設定します。商品IDが設定されている場合、商品マスタから設定。以外は0:通常商品を設定
ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外)
自動で設定します。商品IDが設定されている場合、商品マスタから設定。以外は0:ポイント対象を設定
小計値引/割引(クーポン、ポイント値引き含む)の対象かどうかを設定(0:対象外、1:対象)。
免税区分の設定。(0:対象外、1:一般品、2:消耗品)
省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:対象外を設定
免税後の税抜金額を設定。(税抜価格x数量)
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。
免税額を設定。(免税対象額 x 税率)
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。
商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。
商品バンドルグループに存在するIDを指定しなければならない。
この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない
端数処理は銀行丸め。誤差は最終行で調整。
端数処理は銀行丸め。誤差は最終行で調整。
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン値引き按分:クーポン値引きの按分を設定。端数処理は銀行丸め。誤差は最終行で調整します。
端数処理は銀行丸め。誤差は按分時に誤差が多きものから順に調整。
端数処理は銀行丸め。誤差は按分時に誤差が多きものから順に調整。
端数処理は銀行丸め。誤差は最終行で調整。
端数処理は銀行丸め。誤差は最終行で調整。
端数処理は銀行丸め。誤差は最終行で調整。
端数処理は銀行丸め。誤差は最終行で調整。
社員販売時のみ設定 商品の社販販売割引率
社員販売時のみ設定 社員ランクのコードを設定
社員販売時のみ設定 社員ランクの名称を設定
社員販売時のみ設定 社員販売の割引率
社員販売時のみ設定 1ビット目: 商品マスタの社員販売最大値引率を考慮(する or しない) 2ビット目: セール価格と社員販売割引を掛け合わせて適用(する or しない) 3ビット目: セール価格と社員販売価格を比較して安い方を適用(する or しない) 4ビット目: セール価格と社員販売価格を比較して高い方を適用(する or しない) 8ビット目: セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用(する or しない)
セール販売時のみ設定 適用した社員販売の割引率
セール販売時のみ設定 適用した社員販売の値引き額
セール販売時のみ設定。適用したセールのID ※セール商品ID(bargainProductId)の値が設定されます。
セール販売時のみ設定 適用したセールの名称
セール販売時のみ設定 (1:割引、2:値引、3:価格指定)
セール販売時のみ設定 割引、値引、価格指定の値
セール販売時のみ設定 適用したセール販売の割引、値引き、価格指定の値
セール販売時のみ設定 適用したセール販売の値引き額
適用した税率
軽減税率IDがある場合、軽減税率マスタの税率を設定。以外は、取引ヘッダの税率を設定
標準税率
取引ヘッダの税率を設定
修正した税率(設定不可)
軽減税率ID(税設定):軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。
軽減:10000001 (特定商品の軽減税率適用)
選択[標準]:10000002(状態による適用[適用しない])
選択[軽減]:10000003(状態による適用[適用する])
選択[選択]:10000004(状態による適用[都度選択する])
軽減税率IDがある場合、軽減税率マスタの軽減税率名を設定。
軽減税率IDがある場合、軽減税率マスタの軽減税率を設定。
商品IDがある場合、商品マスタの軽減税率時の商品単価を設定。
商品IDがある場合、商品マスタの軽減税率時の会員価格を設定。
返品販売時などのメモなどを設定。 1000文字以内。
支払情報リスト
object
取引ID:取引毎に付与するID。
その他支払方法ID:各支払方法に紐づくID。
支払方法コード:半角英数記号20文字以内。
支払方法名
受取金額:会計時に預かった金額。
(例:500円商品券2枚の場合、1000)
釣銭:現金の返却金額。
(例:1000円で700円の商品を購入した場合、300)
実際の支払金額:受取金額から釣銭を引いた金額。
(例:受取金額1000円、釣銭300円の場合、700)
※個別アプリ専用支払方法登録APIで登録した支払方法でのみ指定必須です
※個別アプリ専用支払方法登録APIで登録した支払方法でのみ指定可能です
支払金種コード対応表
支払金種コード対応表
| 支払金種コード | 支払金種名 | カード会社名指定(可: ○、不可: ×) |
|---|---|---|
| CREDIT | クレジット | ◯ |
| DEBIT | デビット | ◯ |
| JDEBIT | J-Debit | × |
| PREPAID | プリペイド | ◯ |
| STORE | ストアカード | ◯ |
| UNIONPAY | 銀聯 | ◯ |
| CONTACTLESS | タッチ決済 | ◯ |
| SUICA | 交通系IC | × |
| PITAPA | PiTaPa | × |
| SAPICA | SAPICA | × |
| QUICPAY | QUICPay | × |
| ID | iD | × |
| WAON | WAON | × |
| RAKUTENEDY | 楽天Edy | × |
| NANACO | nanaco | × |
| AEONPAY | AEON Pay | × |
| ALIPAY | Alipay+ | × |
| AMAZONPAY | Amazon Pay | × |
| ATONEPAY | atone | × |
| AUPAY | au PAY | × |
| BANKIT | BANKIT | × |
| BANKPAY | Bank Pay | × |
| DPAY | d払い | × |
| EGIFTEE | e街ギフト | × |
| FAMIPAY | FamiPay | × |
| GINKOPAY | 銀行Pay | × |
| GLNPAY | GLN Pay | × |
| GOTOEAT | GoToEat | × |
| JCOINPAY | J-Coin Pay | × |
| JKOPAY | JKO Pay | × |
| LINEPAY | LINE Pay | × |
| MBBANK | MBBank | × |
| MERPAY | メルペイ | × |
| MICROPAY | WeChat Pay | × |
| NISSENREN | 日専連 | × |
| ORIGAMIPAY | Origami Pay | × |
| PAYPAY | PayPay | × |
| PROMPTPAY | PromptPay | × |
| QUOPAY | Quo カード Pay | × |
| RAKUTENPAY | 楽天ペイ | × |
| SGTDASH | VIA-Dash | × |
| SGTGLB | VIA-MPay(Global Pay) | × |
| SMARTCODE | Smart Code | × |
| UPICPM | 銀聯 QR コード | × |
| ATOKARA | アトカラ | × |
| TOTTEIPAY | TOTTEI PAY | × |
| WESMO | Wesmo! | × |
支払金種名。詳細は、支払金種コードの「支払金種コード対応表」をご参照ください
※その他支払いの場合はnullが返ります。
支払回数:クレジットの支払回数。
(1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い)
承認番号:クレジットの承認番号。
センター処理日:クレジットのセンター処理日。
KID:カード会社番号。
クレジットカード会社名
伝票番号
取消伝票番号
単価:商品券のように1枚あたりの価格が決まっている場合に設定。
(例:500円商品券2枚の場合、500)
釣銭フラグ
0: 釣銭なし1: 釣銭あり
支払方法マスタの支払方法分類を自動設定。
有価証券フラグ
0: 有価証券以外1: 有価証券
ポイント付与単位(金額):ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)
(例10円ごとに0.2ポイントの場合、10)
ポイント付与単位(ポイント):ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
(例10円ごとに0.2ポイントの場合、0.2)
前受金の場合(今回受け取ったものではない場合)はtrue、それ以外の場合はfalse。
※paymentsを参照してください。
object
取引ID
1から順番に設定してください。最大3まで
支払い方法マスタのID
支払方法コード。半角英数字20文字以内。
支払方法マスタの支払方法名を自動設定。
会計時に預かった金額
単価の設定の有無により、スマレジアプリでのその他支払いの預り金の入力方式が変わります。単価を設定しない場合、支払方法に応じた金額を入力します。(例 5,000円商品券 10,000円)
単価を設定する場合、支払方法の利用枚数を入力します。(例 5,000円商品券 2枚)※単価は支払方法の利用枚数の計算に用いられます。変更した場合、利用枚数の計算が正しく行われなくなります。
支払方法マスタの単価を自動設定。
支払方法マスタの釣銭フラグを自動設定。
0: 釣銭なし1: 釣銭あり
支払方法マスタの支払方法分類を自動設定。
(0:有価証券以外、1:有価証券)
支払方法マスタの有価証券フラグを自動設定。
支払金種(名称がそのまま入る)※未設定
※個別アプリ専用支払方法登録APIで登録した支払方法でのみ指定必須です
※個別アプリ専用支払方法登録APIで登録した支払方法でのみ指定可能です
支払金種コード対応表
支払金種コード対応表
| 支払金種コード | 支払金種名 | カード会社名指定(可: ○、不可: ×) |
|---|---|---|
| CREDIT | クレジット | ◯ |
| DEBIT | デビット | ◯ |
| JDEBIT | J-Debit | × |
| PREPAID | プリペイド | ◯ |
| STORE | ストアカード | ◯ |
| UNIONPAY | 銀聯 | ◯ |
| CONTACTLESS | タッチ決済 | ◯ |
| SUICA | 交通系IC | × |
| PITAPA | PiTaPa | × |
| SAPICA | SAPICA | × |
| QUICPAY | QUICPay | × |
| ID | iD | × |
| WAON | WAON | × |
| RAKUTENEDY | 楽天Edy | × |
| NANACO | nanaco | × |
| AEONPAY | AEON Pay | × |
| ALIPAY | Alipay+ | × |
| AMAZONPAY | Amazon Pay | × |
| ATONEPAY | atone | × |
| AUPAY | au PAY | × |
| BANKIT | BANKIT | × |
| BANKPAY | Bank Pay | × |
| DPAY | d払い | × |
| EGIFTEE | e街ギフト | × |
| FAMIPAY | FamiPay | × |
| GINKOPAY | 銀行Pay | × |
| GLNPAY | GLN Pay | × |
| GOTOEAT | GoToEat | × |
| JCOINPAY | J-Coin Pay | × |
| JKOPAY | JKO Pay | × |
| LINEPAY | LINE Pay | × |
| MBBANK | MBBank | × |
| MERPAY | メルペイ | × |
| MICROPAY | WeChat Pay | × |
| NISSENREN | 日専連 | × |
| ORIGAMIPAY | Origami Pay | × |
| PAYPAY | PayPay | × |
| PROMPTPAY | PromptPay | × |
| QUOPAY | Quo カード Pay | × |
| RAKUTENPAY | 楽天ペイ | × |
| SGTDASH | VIA-Dash | × |
| SGTGLB | VIA-MPay(Global Pay) | × |
| SMARTCODE | Smart Code | × |
| UPICPM | 銀聯 QR コード | × |
| ATOKARA | アトカラ | × |
| TOTTEIPAY | TOTTEI PAY | × |
| WESMO | Wesmo! | × |
支払金種名。詳細は、支払金種コードの「支払金種コード対応表」をご参照ください
※現状、個別アプリ専用支払方法ID利用時のみ対応
クレジットカード会社名
※現状、個別アプリ専用支払方法ID利用時のみ対応
伝票番号
ポイント付与単位(金額):ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)
(例10円ごとに0.2ポイントの場合、10)
ポイント付与単位(ポイント):ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
(例10円ごとに0.2ポイントの場合、0.2)
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポン明細
object
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポンID
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
端末取引クーポンID
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポンID
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン名
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン区分:クーポン区分(0:通常、1:giftee)
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン番号:端末側でのクーポンの入力にはこちらが用いられます。
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
特典タイプ:そのクーポンのタイプ。(1:値引、2:割引、3:商品付与、P1:0ポイント、P2:ポイント指定(上書き)、P3:ポイント追加(加算)、P4:ポイントN倍、M1:0マイル、M2:マイル指定(上書き)、M3:マイル追加(加算)、M4:マイルN倍)
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
特典値: 特典タイプが値引きの場合は値引き額[円]、割引の場合は割引率[%]、商品付与の場合は0が入ります。
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
値引額:その取引でのクーポン値引き・割引額の合計。
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポン商品付与明細
object
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポン明細ID
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引クーポンID
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
端末取引クーポンID
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
取引明細ID
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポンアイテムID
取置き情報:取置き時の詳細情報
※ with_layawaysを利用するようにしてください。
object
取引ID:取引毎に付与するID。サーバー側で付与する。
引取日
ステータス:取置取引のステータス(1:引取済み)
前受金 ※paymentsを参照してください。
前受金区分(1:現金、2:クレジット) ※paymentsを参照してください。
引取取引ヘッダーID
変更不可能設定:変更不可能設定(0:変更可、 1:変更不可)
取置き情報:取置き時の詳細情報
object
取引ID:取引毎に付与するID。サーバー側で付与する。
引取日
ステータス:取置取引のステータス(1:引取済み)
前受金
※paymentsを参照してください。
前受金区分(1:現金、2:クレジット) ※paymentsを参照してください。
引取取引ヘッダーID
変更不可能設定:変更不可能設定(0:変更可、 1:変更不可)
取置き引取情報:取置き引取時の詳細情報
※ with_layaway_pick_upsを利用するようにしてください。
object
取引ID
取置き取引ID:取置きの取引ID
受領済金額:取置きの内金/手付金(現金) ※paymentsを参照してください。
受領済クレジット金額:取置きの内金/手付金(クレジット) ※paymentsを参照してください。
取置き引取情報:取置き引取時の詳細情報
object
取引ID
取置きの取引ID:取置きの取引ID
受領済金額:取置きの内金/手付金(現金) ※paymentsを参照してください。
受領済クレジット金額:取置きの内金/手付金(クレジット) ※paymentsを参照してください。
Example
{ "transactionHeadId": "string", "transactionDateTime": "string", "transactionHeadDivision": "string", "cancelDivision": "string", "unitNonDiscountsubtotal": "string", "unitDiscountsubtotal": "string", "unitStaffDiscountsubtotal": "string", "unitBargainDiscountsubtotal": "string", "subtotal": "string", "subtotalForDiscount": "string", "subtotalDiscountPrice": "string", "subtotalDiscountRate": "string", "subtotalDiscountDivision": "string", "pointDiscount": "string", "couponDiscount": "string", "total": "string", "taxInclude": "string", "taxExclude": "string", "roundingDivision": "string", "roundingPrice": "string", "cashTotal": "string", "creditTotal": "string", "deposit": "string", "depositCash": "string", "depositCredit": "string", "change": "string", "tipCash": "string", "tipCredit": "string", "amount": "string", "returnAmount": "string", "costTotal": "string", "salesHeadDivision": "string", "inTaxSalesTotal": "string", "outTaxSalesTotal": "string", "nonTaxSalesTotal": "string", "nonSalesTargetTotal": "string", "nonSalesTargetInTaxTotal": "string", "nonSalesTargetOutTaxTotal": "string", "nonSalesTargetTaxFreeTotal": "string", "nonSalesTargetCostTotal": "string", "nonSalesTargetAmount": "string", "nonSalesTargetReturnAmount": "string", "newPoint": "string", "spendPoint": "string", "point": "string", "totalPoint": "string", "currentMile": "string", "earnMile": "string", "totalMile": "string", "adjustmentMile": "string", "adjustmentMileDivision": "string", "adjustmentMileValue": "string", "storeId": "string", "terminalId": "string", "customerId": "string", "terminalTranId": "string", "terminalTranDateTime": "string", "sumDivision": "string", "adjustmentDateTime": "string", "sumDate": "string", "customerRank": "string", "customerGroupId": "string", "customerGroupId2": "string", "customerGroupId3": "string", "customerGroupId4": "string", "customerGroupId5": "string", "staffId": "string", "staffName": "string", "creditDivision": "11", "paymentCount": "string", "slipNumber": "string", "cancelSlipNumber": "string", "authNumber": "string", "authDate": "string", "cardCompany": "string", "denomination": "string", "memo": "string", "receiptMemo": "string", "carriage": "string", "commission": "string", "guestNumbers": "string", "guestNumbersMale": "string", "guestNumbersFemale": "string", "guestNumbersUnknown": "string", "enterDateTime": "string", "taxFreeSalesDivision": "string", "netTaxFreeGeneralTaxInclude": "string", "netTaxFreeGeneralTaxExclude": "string", "netTaxFreeConsumableTaxInclude": "string", "netTaxFreeConsumableTaxExclude": "string", "tags": "string", "pointGivingDivision": "string", "pointGivingUnitPrice": "string", "pointGivingUnit": "string", "pointSpendDivision": "string", "mileageDivision": "string", "mileageLabel": "string", "customerPinCode": "string", "returnSales": "string", "disposeDivision": "string", "disposeServerTransactionHeadId": "string", "cancelDateTime": "string", "sellDivision": "string", "taxRate": "string", "taxRounding": "string", "discountRoundingDivision": "string", "transactionUuid": "string", "exchangeTicketNo": "string", "giftReceiptValidDays": "string", "barcode": "string", "updDateTime": "string", "details": [ { "transactionHeadId": "string", "transactionDetailId": "string", "parentTransactionDetailId": "string", "transactionDetailDivision": "string", "productId": "string", "productCode": "string", "productName": "string", "printReceiptProductName": "string", "color": "string", "size": "string", "groupCode": "string", "supplierProductNo": "string", "taxDivision": "string", "price": "string", "salesPrice": "string", "unitDiscountPrice": "string", "unitDiscountRate": "string", "unitDiscountDivision": "string", "cost": "string", "quantity": "string", "unitNonDiscountSum": "string", "unitDiscountSum": "string", "unitDiscountedSum": "string", "costSum": "string", "categoryId": "string", "categoryName": "string", "discriminationNo": "string", "salesDivision": "string", "productDivision": "string", "inventoryReservationDivision": "string", "pointNotApplicable": "string", "calcDiscount": "string", "taxFreeDivision": "string", "taxFreeCommodityPrice": "string", "taxFree": "string", "productBundleGroupId": "string", "discountPriceProportional": "string", "discountPointProportional": "string", "discountCouponProportional": "string", "taxIncludeProportional": "string", "taxExcludeProportional": "string", "productBundleProportional": "string", "staffDiscountProportional": "string", "bargainDiscountProportional": "string", "roundingPriceProportional": "string", "productStaffDiscountRate": "string", "staffRank": "string", "staffRankName": "string", "staffDiscountRate": "string", "staffDiscountDivision": "string", "applyStaffDiscountRate": "string", "applyStaffDiscountPrice": "string", "bargainId": "string", "bargainName": "string", "bargainDivision": "string", "bargainValue": "string", "applyBargainValue": "string", "applyBargainDiscountPrice": "string", "taxRate": "string", "standardTaxRate": "string", "modifiedTaxRate": "string", "reduceTaxId": "10000001", "reduceTaxName": "string", "reduceTaxRate": "string", "reduceTaxPrice": "string", "reduceTaxMemberPrice": "string", "memo": "string" } ], "payments": [ { "transactionHeadId": "string", "no": 1, "paymentMethodId": "string", "paymentMethodCode": "string", "paymentMethodName": "string", "receivedAmount": 123456789, "changeAmount": 123456789, "paidAmount": 123456789, "denominationCode": "CREDIT", "denominationName": "string", "paymentCount": "123", "authNumber": "string", "authDate": "string", "cardCompanyId": "string", "cardCompanyName": "string", "slipNumber": "string", "cancelSlipNumber": "string", "paymentUnitPrice": 1, "paymentChangeFlag": "0", "paymentDivision": "string", "paymentSecuritiesFlag": "0", "pointGivingUnitPrice": 12345, "pointGivingUnit": 99999.99, "isAdvanceReceived": true } ], "depositOthers": [ { "transactionHeadId": "string", "no": "string", "paymentMethodId": "string", "paymentMethodCode": "string", "paymentMethodName": "string", "depositOthers": "string", "paymentUnitPrice": "string", "paymentChangeFlag": "string", "paymentDivision": "string", "paymentSecuritiesFlag": "string", "denomination": "string", "denominationCode": "CREDIT", "denominationName": "string", "cardCompanyName": "string", "slipNumber": "string", "pointGivingUnitPrice": "string", "pointGivingUnit": "string" } ], "coupons": [ { "transactionCouponId": "string", "terminalTranCouponId": "string", "couponId": "string", "couponName": "string", "couponDivision": "string", "serialNumber": "string", "awardType": "string", "awardValue": "string", "discountPrice": "string" } ], "couponItems": [ { "transactionCouponDetailId": "string", "transactionCouponId": "string", "terminalTranCouponId": "string", "transactionDetailId": "string", "couponItemId": "string" } ], "layaway": { "transactionHeadId": "string", "pickUpDate": "string", "status": "string", "partPayment": "string", "partPaymentClass": "string", "pickUpTransactionHeadId": "string", "disabledEdit": "string" }, "layaways": [ { "transactionHeadId": "string", "pickUpDate": "string", "status": "string", "partPayment": "string", "partPaymentClass": "string", "pickUpTransactionHeadId": "string", "disabledEdit": "string" } ], "layawayPickUp": { "transactionHeadId": "string", "layawayServerTransactionHeadId": "string", "receivedDepositCash": "string", "receivedDepositCredit": "string" }, "layawayPickUps": [ { "transactionHeadId": "string", "layawayServerTransactionHeadId": "string", "receivedDepositCash": "string", "receivedDepositCredit": "string" } ]}- 指定された取引の取引区分が 1:通常 でない場合
- 更新する項目が指定されていない場合
- 客層IDが指定した客層セクションに存在しない場合
- 存在しないスタッフIDを指定した場合
- 客数と客数(男)、客数(女)、客数(不明)の合計が一致しない場合
- 1取引タグが64文字を超える場合
- 取消済みの取引IDが指定された場合
- 削除済み店舗の取引IDが指定された場合
- 休止店舗の取引IDが指定された場合
- バリューカードを伴う取引IDが指定された場合
object
Examples
{ "type": "about:blank", "title": "Bad Request", "detail": "取引は通常取引のみ指定できます。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "更新する項目を指定してください。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "客層セクションIDが1(2,3,4,5)のセクションに存在しない客層IDです。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "存在しないスタッフIDです。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "客数と客数(男)、客数(女)、客数(不明)の合計が一致しません。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "1つの取引タグは64文字以下である必要があります。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "取消済みの取引は更新できません。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "削除した店舗の取引は更新できません。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "休止中店舗の取引は更新できません。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "バリューカード取引は更新できません。", "status": 400}- URI指定の取引IDが存在しない場合
object
Examples
{ "type": "about:blank", "title": "NotFound", "detail": "指定されたIDのリソースが見つかりません", "status": 404}