コンテンツにスキップ

仮販売一覧取得

GET
/transactions/temporaries

仮販売取引情報一覧を取得します。

対象プラン

  • スタンダード
  • プレミアム
  • プレミアムプラス
  • フードビジネス
  • リテールビジネス
fields
array

検索パラメータ(カンマ区切りで指定可)
Response項目を指定可能
※一部項目(withで指定する項目、2階層目以降の項目)については指定不可

sort
string

並び順(カンマ区切りで指定可)

指定可能なパラメータ

  • transactionHeadId:取引ID
  • transactionDateTime:取引日時
  • barcode:バーコード
  • terminalId:端末ID
  • customerId:会員ID
  • terminalTranId:端末取引ID
  • terminalTranDateTime:端末取引日時
limit
integer

上限数

page
integer

ページ

transaction_head_id-from
string

仮販売取引ID(From)

transaction_head_id-to
string

仮販売取引ID(To)

transaction_date_time-from
string

取引日時(From):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)のうち1つ以上を必ず指定してご利用ください


※ 頻繁に仮販売データにアクセスしたい、または、長期間にわたる大量の仮販売データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

transaction_date_time-to
string

取引日時(To):サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)のうち1つ以上を必ず指定してご利用ください


※ 頻繁に仮販売データにアクセスしたい、または、長期間にわたる大量の仮販売データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

store_id
integer

店舗ID

terminal_tran_date_time-from
string

端末取引日時(From):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)のうち1つ以上を必ず指定してご利用ください


※ 頻繁に仮販売データにアクセスしたい、または、長期間にわたる大量の仮販売データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

terminal_tran_date_time-to
string

端末取引日時(To):端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)のうち1つ以上を必ず指定してご利用ください


※ 頻繁に仮販売データにアクセスしたい、または、長期間にわたる大量の仮販売データを扱いたい場合は、別途データベースをご用意いただき、取得した取引を保存する運用をお勧めいたします

customer_code
string

会員コード

status
string format: string
Allowed values: 0 1 2

ステータス:仮販売のステータス。(0:通常、1:完了、2:取消)

barcode
string

バーコード

with_details
string
default: none
Allowed values: all summary none

仮販売取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone)

取得成功

Array<object>
object
transactionHeadId

仮販売取引ID

string
transactionDateTime

取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]

string
transactionHeadDivision

取引を識別する区分。
(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証)

string
cancelDivision

取引の取消を識別する区分。 (0:通常、1取消)

string
status

仮販売のステータス。(0:通常、1:完了、2:取消)

string
barcode

バーコード

string
sequentialNumber

連番

string
preRegistrationName

仮販売の名称を設定。20文字以内。

string
unitNonDiscountsubtotal

取引明細の、値引き前計の合計。明細より自動算出。
※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計

string
unitDiscountsubtotal

単品値引き小計:取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。

※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。
(例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。)
※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。
4:バンドル (親)
5:セット売り(親)
6:簡易セット(親)
8:バンドル値引(子)
※ ウェイターから生成された仮販売取引では、本項目が0になります。

string
subtotal

取引明細の値引き後小計の合計。

string
subtotalForDiscount

取引明細の割引値引対象区分が対象の小計金額

string
subtotalDiscountPrice

小計の値引き金額を設定。

string
subtotalDiscountRate

小計の割引を設定 (単位%) デフォルトは未設定。
設定された場合、小計値引は必須。
※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。

string
subtotalDiscountDivision

小計値引き/割引時に指定された区分を設定。
管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。

string
pointDiscount

使用ポイント * ポイント還元率。

string
total

小計 - 小計値引き - ポイント値引き + 端数値引額 + 外税額 - 免税額 を設定

string
taxInclude

内税商品計 / 110 * 10。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string
taxExclude

外税商品計 * 10 / 100。
※税率が10%の場合
※小数点以下は税の丸め方式で指定の通り

string
roundingDivision

販売時の合計金額の端数を丸めるか否かを設定する。
00:なし
11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上
21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上
31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上
41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上
99:手入力

string
roundingPrice

端数値引額

string
amount

取引明細の返品以外の数量の合計 (取引明細区分が2返品以外の数量)

string
returnAmount

取引明細の返品の数量の合計 (取引明細区分が2返品の数量)

string
costTotal

明細の原価計の合計

string
newPoint

取引で付与されるポイント。 合計 * ポイント付与率

string
spendPoint

取引で使用したポイント。

string
point

取引前のポイント。
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。

string
totalPoint

取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。
※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。

string
storeId

店舗毎に付与するID。

string
storeCode

店舗コード

string
terminalId

店舗の端末毎に付与するID。

string
customerId

会員毎に付与するID。

string
customerCode

会員コード

string
terminalTranId

端末で設定された取引ID。

string
terminalTranDateTime

端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]

string
customerGroupId

客層ID。客層セクションIDが1の客層IDを設定。

string
customerGroupId2

客層ID2。客層セクションIDが2の客層IDを設定。

string
customerGroupId3

客層ID3。客層セクションIDが3の客層IDを設定。

string
customerGroupId4

客層ID4。客層セクションIDが4の客層IDを設定。

string
customerGroupId5

客層ID5。客層セクションIDが5の客層IDを設定。

string
staffId

販売員ID(スタッフID)

string
staffCode

販売員コード

string
staffName

AppAccessToken(pos.staffs:read)
販売員名(スタッフ名)

string
memo

入出金時のメモなどを設定。 1000文字以内。

string
receiptMemo

レシートに印字するメモを設定。100文字以内。

string
guestNumbers

客数。

string
guestNumbersMale

客数(男)。

string
guestNumbersFemale

客数(女)。

string
guestNumbersUnknown

客数(不明)。

string
enterDateTime

入店日時。[YYYY-MM-DDThh:mm:ssTZD]

string
taxFreeSalesDivision

免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))
※未設定の場合、0:通常販売

string
netTaxFreeGeneralTaxInclude

内税商品の一般品免税額。

string
netTaxFreeGeneralTaxExclude

外税商品の一般品免税額。

string
netTaxFreeConsumableTaxInclude

内税商品の消耗品免税額。

string
netTaxFreeConsumableTaxExclude

外税商品の消耗品免税額。

string
tags

レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。
※複数ある場合は、カンマ区切りで設定

string
mileageDivision

マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)

string
mileageLabel

マイレージの名称。

string
returnSales

0:通常、1:返品販売

string
sellDivision

取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)

string
taxRate

税率 (単位%)

string
taxRounding

税の丸めを判定。 (0:四捨五入、1:切り捨て、2:切り上げ)

string
discountRoundingDivision

割引の端数を丸める方法を指定する区分。 (0:四捨五入、1:切り捨て、2:切り上げ)

string
details

仮販売取引明細

Array<object>
object
transactionHeadId

仮販売取引ID

string
transactionDetailId

ユニーク値取引毎の明細に付与するID。
設定する場合は1〜999まで。
取引明細を指定する場合必須。

string
parentTransactionDetailId

紐付く親の取引明細がある場合、その取引明細IDを設定。
※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の取引明細IDを設定しなければならない。

string
transactionDetailDivision

取引明細を識別する区分。
(1:通常、2:返品、3:部門売り)

string
productId

商品ID

string
productCode

商品コード

string
productName

商品名

string
printReceiptProductName

レシート印字商品名

string
color

カラー

string
size

サイズ

string
groupCode

グループコード

string
taxDivision

税区分。(0:税込、1:税抜、2:非課税)
※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0:税込

string
price

※設定時そのまま設定
※省略時、商品IDが設定されている場合、マスタから設定。以外は0円

string
salesPrice

販売時の単価を設定。

string
unitDiscountPrice

販売単価の値引き金額を設定。
単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て)。

string
unitDiscountRate

単品の割引率を設定。(単位:%)
※設定された場合、単品値引は必須

string
unitDiscountDivision

単品値引き/割引時に指定された割引区分を設定。

string
cost

商品原価。整数部分8桁、少数部5桁。

string
quantity

購入数
取引明細を指定する場合必須。

string
unitNonDiscountSum

販売価格×数量

string
unitDiscountSum

単品値引き×数量
※管理画面の取引履歴CSVで対応する項目: 単価値引き計

string
unitDiscountedSum

値引き前計 - 単品値引き計

string
costSum

原価×数量

string
categoryId

商品に紐付く部門毎に付与するID。数字9桁以内。
※部門情報が存在しない場合、エラー
※商品IDが設定されている場合、商品情報の部門IDと一致しないとエラー
※省略時、商品IDが設定されている場合、商品マスタの部門IDを設定

string
categoryName

商品に紐付く部門名。(85文字以内)
※設定時、そのまま設定。
※省略時、部門IDが設定されている場合、マスタから設定。以外はnull

string
salesDivision

売上計上するか否かの区分。(0:売上対象、1:売上対象外)
省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:売上対象を設定

string
productDivision

商品区分 (0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル (親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値 引(子)、A:プラン(子)、B:コース(子)) ※0, 4, 7, 8のみ許可。商品区分を0, 4にする場合、親取引明細IDは設定不可。 また、商品区分を7, 8にする場合、親取引明細IDにバンドル(親)の取引明細ID の設定が必要 ※A,Bはウェイターでのみ利用する区分。

string
pointNotApplicable

ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外)
自動で設定します。商品IDが設定されている場合、商品マスタから設定。以外は0:ポイント対象を設定

string
calcDiscount

小計値引/割引(クーポン、ポイント値引き含む)の対象かどうかを設定(0:対象外、1:対象)。

string
taxFreeDivision

免税区分の設定。(0:対象外、1:一般品、2:消耗品)
省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:対象外を設定

string
taxFreeCommodityPrice

免税後の税抜金額を設定。(税抜価格x数量)
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string
taxFree

免税額を設定。(免税対象額 x 税率)
※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。

string
productBundleGroupId

商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。
商品バンドルグループに存在するIDを指定しなければならない。
この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない

string
productStaffDiscountRate

社員販売時のみ設定 商品の社販販売割引率

string
staffRank

社員販売時のみ設定 社員ランクのコードを設定

string
staffRankName

社員販売時のみ設定 社員ランクの名称を設定

string
staffDiscountRate

社員販売時のみ設定 社員販売の割引率

string
staffDiscountDivision

社員販売時のみ設定 1ビット目: 商品マスタの社員販売最大値引率を考慮(する or しない) 2ビット目: セール価格と社員販売割引を掛け合わせて適用(する or しない) 3ビット目: セール価格と社員販売価格を比較して安い方を適用(する or しない) 4ビット目: セール価格と社員販売価格を比較して高い方を適用(する or しない) 8ビット目: セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用(する or しない)

string
applyStaffDiscountRate

セール販売時のみ設定 適用した社員販売の割引率

string
applyStaffDiscountPrice

セール販売時のみ設定 適用した社員販売の値引き額

string
bargainId

セール販売時のみ設定。適用したセールのID
※セール商品ID(bargainProductId)の値が設定されます。

string
bargainName

セール販売時のみ設定 適用したセールの名称

string
bargainDivision

セール販売時のみ設定 (1:割引、2:値引、3:価格指定)

string
bargainValue

セール販売時のみ設定 割引、値引、価格指定の値

string
applyBargainValue

セール販売時のみ設定 適用したセール販売の割引、値引き、価格指定の値

string
applyBargainDiscountPrice

セール販売時のみ設定 適用したセール販売の値引き額

string
taxRate

適用した税率
軽減税率IDがある場合、軽減税率マスタの税率を設定。以外は、取引ヘッダの税率を設定

string
standardTaxRate

標準税率
取引ヘッダの税率を設定

string
modifiedTaxRate

修正した税率(設定不可)

string
reduceTaxId

軽減税率ID(税設定):軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。
軽減:10000001 (特定商品の軽減税率適用)
選択[標準]:10000002(状態による適用[適用しない])
選択[軽減]:10000003(状態による適用[適用する])
選択[選択]:10000004(状態による適用[都度選択する])

string
reduceTaxName

軽減税率IDがある場合、軽減税率マスタの軽減税率名を設定。

string
reduceTaxRate

軽減税率IDがある場合、軽減税率マスタの軽減税率を設定。

string
reduceTaxPrice

商品IDがある場合、商品マスタの軽減税率用商品単価を設定。

string
reduceTaxMemberPrice

商品IDがある場合、商品マスタの軽減税率用会員商品単価を設定。

string
memo

返品販売時などのメモなどを設定。 1000文字以内。

string
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",
"storeCode": "string",
"terminalId": "string",
"customerId": "string",
"customerCode": "string",
"terminalTranId": "string",
"terminalTranDateTime": "string",
"customerGroupId": "string",
"customerGroupId2": "string",
"customerGroupId3": "string",
"customerGroupId4": "string",
"customerGroupId5": "string",
"staffId": "string",
"staffCode": "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"
}
]
}
]