仮販売取得
GET /transactions/temporaries/{temporary_id}
仮販売取引情報を取得します。
対象プラン
- スタンダード
- プレミアム
- プレミアムプラス
- フードビジネス
- リテールビジネス
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”仮販売取引ID
Query Parameters
Section titled “Query Parameters ”検索パラメータ(カンマ区切りで指定可)
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可
仮販売取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone)
店舗情報を付加するか(付加する場合はall, しない場合はnone)
会員情報を付加するか(付加する場合はall, しない場合はnone)
客層情報を付加するか(付加する場合はall, しない場合はnone)
スタッフ情報を付加するか(付加する場合はall, しない場合はnone)
Responses
Section titled “ Responses ”取得成功
object
仮販売取引ID
取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]
取引を識別する区分。
(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証)
取引の取消を識別する区分。 (0:通常、1取消)
仮販売のステータス。(0:通常、1:完了、2:取消)
バーコード
連番
仮販売の名称を設定。20文字以内。
取引明細の、値引き前計の合計。明細より自動算出。
※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計
単品値引き小計:取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。
※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。
(例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。)
※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。
4:バンドル (親)
5:セット売り(親)
6:簡易セット(親)
8:バンドル値引(子)
※ ウェイターから生成された仮販売取引では、本項目が0になります。
取引明細の値引き後小計の合計。
取引明細の割引値引対象区分が対象の小計金額
小計の値引き金額を設定。
小計の割引を設定 (単位%) デフォルトは未設定。
設定された場合、小計値引は必須。
※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。
小計値引き/割引時に指定された区分を設定。
管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。
使用ポイント * ポイント還元率。
小計 - 小計値引き - ポイント値引き + 端数値引額 + 外税額 - 免税額 を設定
内税商品計 / 110 * 10。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り
外税商品計 * 10 / 100。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り
販売時の合計金額の端数を丸めるか否かを設定する。
00:なし
11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
99:手入力
端数値引額
取引明細の返品以外の数量の合計 (取引明細区分が2返品以外の数量)
取引明細の返品の数量の合計 (取引明細区分が2返品の数量)
明細の原価計の合計
取引で付与されるポイント。 合計 * ポイント付与率
取引で使用したポイント。
取引前のポイント。
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。
取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。
店舗毎に付与するID。
店舗の端末毎に付与するID。
会員毎に付与するID。
端末で設定された取引ID。
端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
客層ID。客層セクションIDが1の客層IDを設定。
客層ID2。客層セクションIDが2の客層IDを設定。
客層ID3。客層セクションIDが3の客層IDを設定。
客層ID4。客層セクションIDが4の客層IDを設定。
客層ID5。客層セクションIDが5の客層IDを設定。
販売員ID(スタッフID)
AppAccessToken(pos.staffs:read
)
販売員名:販売員名。(スタッフ名)
入出金時のメモなどを設定。 1000文字以内。
レシートに印字するメモを設定。100文字以内。
客数。
客数(男)。
客数(女)。
客数(不明)。
入店日時。[YYYY-MM-DDThh:mm:ssTZD]
免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
※未設定の場合、0:通常販売
内税商品の一般品免税額。
外税商品の一般品免税額。
内税商品の消耗品免税額。
外税商品の消耗品免税額。
レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
※複数ある場合は、カンマ区切りで設定
マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)
マイレージの名称。
0:通常、1:返品販売
取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)
税率 (単位%)
税の丸めを判定。 (0:四捨五入、1:切り捨て、2:切り上げ)
割引の端数を丸める方法を指定する区分。 (0:四捨五入、1:切り捨て、2:切り上げ)
仮販売取引明細
object
仮販売取引ID
ユニーク値取引毎の明細に付与するID。
設定する場合は1〜999まで。
取引明細を指定する場合必須。
紐付く親の取引明細がある場合、その取引明細IDを設定。
※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の取引明細IDを設定しなければならない。
取引明細を識別する区分。
(1:通常、2:返品、3:部門売り)
商品ID
商品コード
商品名
レシート印字商品名
カラー
サイズ
グループコード
税区分。(0:税込、1:税抜、2:非課税)
※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0:税込
※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0円
販売時の単価を設定。
販売単価の値引き金額を設定。
単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て)。
単品の割引率を設定。(単位:%)
※設定された場合、単品値引は必須
単品値引き/割引時に指定された割引区分を設定。
商品原価。整数部分8桁、少数部5桁。
購入数
取引明細を指定する場合必須。
販売価格×数量
単品値引き×数量
※管理画面の取引履歴CSVで対応する項目: 単価値引き計
値引き前計 - 単品値引き計
原価×数量
商品に紐付く部門毎に付与するID。数字9桁以内。
※部門情報が存在しない場合、エラー
※商品IDが設定されている場合、商品情報の部門IDと一致しないとエラー
※省略時、商品IDが設定されている場合、商品マスタの部門IDを設定
商品に紐付く部門名。(85文字以内)
※設定時、そのまま設定。
※省略時、部門IDが設定されている場合、マスタから設定。以外はnull
売上計上するか否かの区分。(0:売上対象、1:売上対象外)
省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:売上対象を設定
商品区分 (0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル (親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値 引(子)、A:プラン(子)、B:コース(子)) ※0, 4, 7, 8のみ許可。商品区分を0, 4にする場合、親取引明細IDは設定不可。 また、商品区分を7, 8にする場合、親取引明細IDにバンドル(親)の取引明細ID の設定が必要 ※A,Bはウェイターでのみ利用する区分。
ポイント対象にするか否かの設定(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。
AppAccessToken(pos.stores:read
) OR UserAccessToken(pos.stores:read
)
店舗コード:店舗コード。半角英数記号20文字以内。
AppAccessToken(pos.stores:read
) OR UserAccessToken(pos.stores:read
)
店舗名:店舗名。(85文字以内)
AppAccessToken(pos.stores:read
) OR UserAccessToken(pos.stores:read
)
店舗名略称:店舗名略称。85文字以内。
AppAccessToken(pos.stores:read
) OR UserAccessToken(pos.stores:read
)
レシート印刷用店舗名:レシート印刷用店舗名。(85文字以内)
AppAccessToken(pos.stores:read
) OR UserAccessToken(pos.stores:read
)
表示順:数字9桁以内。
会員
※現在の会員マスタに登録されている会員情報が設定されます。
object
会員ID
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
会員コード
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
会員番号
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
会員ランク
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
社員ランク
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
名
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
姓
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
名カナ
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
姓カナ
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
性別 0:不明、1:男、2:女
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
生年月日
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
ポイント失効予定日
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
最終来店日時
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
入会日
AppAccessToken(pos.customers:read
) OR UserAccessToken(pos.customers:read
)
退会日
客層
※ 現在の客層マスタに登録されている客層情報が設定されます。
object
客層ID
客層セクションID
ラベル
スタッフ
※現在のスタッフマスタに登録されているスタッフ情報が設定されます。
object
スタッフID
AppAccessToken(pos.staffs:read
)
スタッフコード
AppAccessToken(pos.staffs:read
)
スタッフ名
AppAccessToken(pos.staffs:read
)
ランク
Example
{ "transactionHeadId": "string", "transactionDateTime": "string", "transactionHeadDivision": "string", "cancelDivision": "string", "status": "string", "barcode": "string", "sequentialNumber": "string", "preRegistrationName": "string", "unitNonDiscountsubtotal": "string", "unitDiscountsubtotal": "string", "subtotal": "string", "subtotalForDiscount": "string", "subtotalDiscountPrice": "string", "subtotalDiscountRate": "string", "subtotalDiscountDivision": "string", "pointDiscount": "string", "total": "string", "taxInclude": "string", "taxExclude": "string", "roundingDivision": "string", "roundingPrice": "string", "amount": "string", "returnAmount": "string", "costTotal": "string", "newPoint": "string", "spendPoint": "string", "point": "string", "totalPoint": "string", "storeId": "string", "terminalId": "string", "customerId": "string", "terminalTranId": "string", "terminalTranDateTime": "string", "customerGroupId": "string", "customerGroupId2": "string", "customerGroupId3": "string", "customerGroupId4": "string", "customerGroupId5": "string", "staffId": "string", "staffName": "string", "memo": "string", "receiptMemo": "string", "guestNumbers": "string", "guestNumbersMale": "string", "guestNumbersFemale": "string", "guestNumbersUnknown": "string", "enterDateTime": "string", "taxFreeSalesDivision": "string", "netTaxFreeGeneralTaxInclude": "string", "netTaxFreeGeneralTaxExclude": "string", "netTaxFreeConsumableTaxInclude": "string", "netTaxFreeConsumableTaxExclude": "string", "tags": "string", "mileageDivision": "string", "mileageLabel": "string", "returnSales": "string", "sellDivision": "string", "taxRate": "string", "taxRounding": "string", "discountRoundingDivision": "string", "details": [ { "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", "salesDivision": "string", "productDivision": "string", "pointNotApplicable": "string", "calcDiscount": "string", "taxFreeDivision": "string", "taxFreeCommodityPrice": "string", "taxFree": "string", "productBundleGroupId": "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" } ], "store": { "storeId": "string", "storeCode": "string", "storeName": "string", "storeAbbr": "string", "printReceiptStoreName": "string", "displaySequence": "string" }, "customer": { "customerId": "string", "customerCode": "string", "customerNo": "string", "rank": "string", "staffRank": "string", "firstName": "string", "lastName": "string", "firstKana": "string", "lastKana": "string", "sex": "string", "birthDate": "string", "pointExpireDate": "string", "lastComeDateTime": "string", "entryDate": "string", "leaveDate": "string" }, "customerGroups": [ { "customerGroupId": "string", "customerGroupSectionId": "string", "label": "string" } ], "staff": { "staffId": "string", "staffCode": "string", "staffName": "string", "rank": "string" }}
- 指定した仮販売取引IDが存在しない場合
object
Examples
{ "type": "about:blank", "title": "NotFound", "detail": "指定されたIDのリソースが見つかりません", "status": 404}