取引明細取得
GET /transactions/{transaction_id}/details
取引明細情報を取得します。
対象プラン
- スタンダード
- プレミアム
- プレミアムプラス
- フードビジネス
- リテールビジネス
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”取引ID
Query Parameters
Section titled “Query Parameters ”検索パラメータ(カンマ区切りで指定可)
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可
並び順(カンマ区切りで指定可)
指定可能なパラメータ
- transactionHeadId:取引ID
- transactionDetailId:取引明細ID
- transactionDetailDivision:取引明細区分
上限数
ページ
単品値引/割引の値引区分や割引区分情報を付加するか(付加する場合はall, しない場合はnone)
販売時の商品属性情報を付加するか(付加する場合はall, しない場合はnone)
Responses
Section titled “ Responses ”取得成功
object
取引ID:数値型。
取引明細ID:数値型。
親取引明細ID:紐付く親の取引明細がある場合、その取引明細IDを設定。
ない場合、NULLを設定。
※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の 取引明細IDを設定しなければならない。
取引明細区分:(1:通常、2:返品、3:部門売り)。
商品ID:数字15桁以内。
商品コード:半角英数記号64文字以内(2段バーコード利用時は最大64桁、それ以外は20桁)。
商品名:85文字以内。
レシート印字商品名:レシートに印字する商品名。64文字以内。
カラー:85文字以内。
サイズ:85文字以内。
グループコード:関連商品として紐付ける為のグループコードを設定。 例えば、AとBの商品に同じグループコード001を設定すると、AとBは関連商品となります。サイズ、カラーが異なる場合などに使用してください。
税区分:(0:税込、1:税抜、2:非課税)。
商品単価:当時の商品マスタの商品単価。数値型。
販売単価:販売時の単価を設定。デフォルトは商品単価。
単品値引:販売単価の値引き金額を設定。
単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て)。
単品割引:単品の割引率を設定。(単位:%)。
単品値引き/割引区分:単品値引き/割引時に指定された区分を設定。
原価:数字8桁以内(少数5桁まで)。未設定の場合0を設定。
数量:数値型。
値引き前計:販売価格×数量。
単品値引き計:単品値引き×数量。
※管理画面の取引履歴CSVで対応する項目: 単価値引き計
値引き後計:値引き前計 - 単品値引き計。
原価計:数字8桁以内(少数5桁まで)。未設定の場合0を設定。
部門ID:数字9桁以内。
部門名:85文字以内。
識別番号:20桁以内。
売上区分:(0:売上対象、1:売上対象外)。
商品区分:(0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル(親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値引(子)、A:プラン(子)、B:コース(子))。
在庫引当区分:在庫引当商品か否かの区分(0:通常商品 1:在庫引当商品)。
ポイント対象:ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外)。
値引割引計算対象:小計値引/割引(クーポン、ポイント値引き含む)の対象かどうかを設定(0:対象外、1:対象)。
免税区分:(0:対象外、1:一般品、2:消耗品)。
免税対象額:数値型。
免税額:数値型。
商品バンドルグループID:商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。
商品バンドルグループに存在するIDを指定しなければならない。
この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない。
小計値引き按分:小計値引きの按分を設定
端数処理は銀行丸め。誤差は最終行で調整。
ポイント値引き按分:ポイント値引きの按分を設定。端数処理は銀行丸め。誤差は最終行で調整。
対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン値引き按分:クーポン値引きの按分を設定。端数処理は銀行丸め。誤差は最終行で調整します。
内税按分:内税を按分した金額を設定
端数処理は銀行丸め。誤差は最終行で調整。
外税按分:外税を按分した金額を設定。端数処理は銀行丸め。誤差は最終行で調整。
商品バンドル値引按分:商品バンドル値引きを按分した金額を設定。
端数処理は銀行丸め。誤差は最終行で調整。
社員値引き按分:社員販売時のみ設定。
セール値引き按分:セール販売時のみ設定。
端数値引額按分:端数値引額の按分した金額を設定
端数処理は銀行丸め。誤差は最終行で調整。
商品毎の社員割引率:社員販売時のみ設定。
社員ランクコード:社員販売時のみ設定。
社員ランク名:社員販売時のみ設定。
社員販売割引率:社員販売時のみ設定。
社員販売割引区分:社員販売時のみ設定
1ビット目:商品マスタの社員販売最大値引率を考慮(する or しない)
2ビット目:セール価格と社員販売割引を掛け合わせて適用(する or しない)
3ビット目:セール価格と社員販売価格を比較して安い方を適用(する or しない)
4ビット目:セール価格と社員販売価格を比較して高い方を適用(する or しない)
8ビット目:セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用(する or しない)。
適用社員販売割引率:社員販売時のみ設定。
適用社員値引き額:社員販売時のみ設定。
セールID:セール販売時のみ設定。
※セール商品ID(bargainProductId)の値が設定されます。
セール名称:セール販売時のみ設定。
セール区分:セール販売時のみ設定。
セール値:セール販売時のみ設定。
適用セール値:セール販売時のみ設定。
適用セール値引き額:セール販売時のみ設定。
適用税率:(明細毎に税率変更可能なため)。
標準税率:(明細毎に税率変更可能なため)。
修正税率: 修正した税率(明細毎に税率変更可能なため)。
軽減税率ID(税設定):軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。
軽減:10000001 (特定商品の軽減税率適用)
選択[標準]:10000002(状態による適用[適用しない])
選択[軽減]:10000003(状態による適用[適用する])
選択[選択]:10000004(状態による適用[都度選択する])
軽減税率名:軽減税率販売時のみ設定。
軽減税率:軽減税率販売時のみ設定。
軽減税率用商品単価:軽減税率販売時のみ設定。
軽減税率用会員商品単価:軽減税率販売時のみ設定。
返品販売時などのメモなどを設定。 1000文字以内。
単品値引/割引の詳細情報
object
取引ID
取引明細ID:取引毎の明細に付与するID。
取引値引区分 (2:単品)
値引/割引区分: 値引/割引時に指定された区分を設定。
値引/割引区分名称
特典タイプ:(1:値引・値増、2:割引)。
特典値:特典タイプに応じた値を設定。
特典タイプ | 設定値 |
---|---|
1:値引 | 値引額[円](※) |
2:割引 | 割引率[%] |
※ 値引は正の数、値増は負の数が設定されます
値引額
※ 値引は正の数、値増は負の数が設定されます
取引時の商品属性情報
object
取引ID
取引明細ID
コード:数字9桁以内。
名称:30文字以内
RFIDタグリスト。スマレジ・アプリでRFIDタグを用いて取引登録した場合、取引明細に紐付くRFIDタグリストを取得することができます。
“summary” 指定時省略
Example
[ { "transactionHeadId": "string", "transactionDetailId": "string", "parentTransactionDetailId": "string", "transactionDetailDivision": "string", "productId": "string", "productCode": "string", "productName": "string", "printReceiptProductName": "string", "color": "string", "size": "string", "groupCode": "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", "discounts": [ { "transactionHeadId": "string", "transactionDetailId": "string", "transactionDiscountDivision": "string", "discountDivision": "string", "discountDivisionName": "string", "awardType": "string", "awardValue": "string", "discountPrice": "string" } ], "productAttributes": [ { "transactionHeadId": "string", "transactionDetailId": "string", "code": "string", "name": "string" } ], "rfidTags": [ "string" ] }]