コンテンツにスキップ

取引一覧取得

GET
/transactions

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

対象プラン

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

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

sort
string

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

  • 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します。

指定可能なパラメータ

  • transactionHeadId:取引ID
  • transactionDateTime:取引日時
  • transactionHeadDivision:取引区分
  • storeId:店舗ID
  • terminalId:端末ID
  • customerId:会員ID
  • terminalTranId:端末取引ID
  • terminalTranDateTime:端末取引日時
  • sumDate:締め日
  • updDateTime:更新日時
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)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


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

transaction_date_time-to
string

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

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


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

transaction_head_division
string
Allowed values: 1 2 3 4 5 6 7 8 9 11 13 14 15 16

取引区分(1:通常,2:入金,3:出金,4:預かり金,5:預かり金返金,6:ポイント加算,7:ポイント減算,8:ポイント失効,9:回数券,11:チップ,13:マイル加算,14:マイル減算,15:バリューカード入金,16:領収証)

store_id
integer

店舗ID

terminal_tran_date_time-from
string

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

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


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

terminal_tran_date_time-to
string

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

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


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

adjustment_date_time
string

精算日時 [YYYY-MM-DDThh:mm:ssTZD]

sum_date
string

締め日 [YYYY-MM-DD]

sum_date-from
string

締め日(From)[YYYY-MM-DD]

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


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

sum_date-to
string

締め日(To)[YYYY-MM-DD]

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


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

customer_code
string

会員コード

transaction_uuid
string

レシート番号:指定した値を完全一致で検索します

barcode
string

バーコード:指定したバーコードの仮販売データに紐づく、取引データを取得します。

upd_date_time-from
string

更新日時(From):登録時・更新時の日時。締め日(From)[YYYY-MM-DD]

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


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

upd_date_time-to
string

更新日時(To):登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]

※ From〜Toの期間は最大31日までの指定でご利用ください
※ 取引日時(From)(To)、端末取引日時(From)(To)、締め日(From)(To)、更新日時(From)(To)のうち1つ以上を必ず指定してご利用ください
※ 期間指定したパラメータ(複数指定した場合はそのうちのいずれか)をsortの最初に指定することを推奨します


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

with_details
string
default: none
Allowed values: all summary none

取引明細情報を付加するか(全項目付加する場合はall, 一部項目を付加する場合はsummary, しない場合はnone)
※ none以外に設定する場合、limitは100以下のみ設定可能。
大量に取引及び取引明細データを取得する際のご注意
with_detailsに none 以外を指定して、下記のケースのような大量の取引データの取得処理を実行すると、弊社サーバが高負荷になり、処理に影響が出る場合がございます。
  ・大量の取引・取引明細の取得
  ・日次バッチなど、毎日定まった期間の取引を取得する処理

上記のようなケースについては、
  ・取引についてはwith_details=noneで本APIを複数回コールして取得(最大で1コールで1000件取得)
  ・取引明細については取引明細一覧CSV作成APIで必要期間分コールして取得 (取引明細データを最大1ヶ月分取得)

上記の2つのAPIを組み合わせてご利用いただきますようお願いいたします。

with_deposit_others
string
default: none
Allowed values: all none

その他支払い情報を付加するか(付加する場合はall, しない場合はnone)

with_layaway
string
default: none
Allowed values: all none

(非推奨)取置き情報を付加するか(付加する場合はall, しない場合はnone)
※ with_layawaysを活用するようにしてください。
※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。
※ 既存のwith_layaway: "all" を指定して取得できる取置きデータには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置きデータしか返りません。

with_layaways
string
default: none
Allowed values: all none

取置き情報を付加するか(付加する場合はall, しない場合はnone)

with_layaway_pick_up
string
default: none
Allowed values: all none

(非推奨)取置き引取情報を付加するか(付加する場合はall, しない場合はnone)
※ with_layaway_pick_upsを活用するようにしてください。
※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。
※ 既存のwith_layaway_pick_up: "all" を指定して取得できる取置き引取データには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置き引取データしか返りません。

with_layaway_pick_ups
string
default: none
Allowed values: all none

取置き引取情報を付加するか(付加する場合はall, しない場合はnone)

with_money_control
string
default: none
Allowed values: all none

取引金操作情報を付加するか(付加する場合はall, しない場合はnone)

with_detail_product_attributes
string
default: none
Allowed values: all none

販売時の商品属性情報を付加するか(付加する場合はall, しない場合はnone)

取得成功

Array<object>
object
transactionHeadId

取引ID:取引毎に付与するID。

string
transactionDateTime

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

string
transactionHeadDivision

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

string
cancelDivision

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

string
unitNonDiscountsubtotal

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

string
unitDiscountsubtotal

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

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

string
unitStaffDiscountsubtotal

単品社員販売値引き計

string
unitBargainDiscountsubtotal

単品セール販売値引き計

string
subtotal

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

string
subtotalForDiscount

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

string
subtotalDiscountPrice

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

string
subtotalDiscountRate

小計割引率:小計の割引を設定 (単位:%) デフォルトは未設定。
設定された場合、小計計値引きに自動的に設定(切り捨て)
集計は、小計値引きしか見ない。

string
subtotalDiscountDivision

小計値引き/割引区分:小計値引き/割引時に指定された区分を設定。

string
pointDiscount

ポイント値引き:使用ポイント * ポイント還元率。
※消費税含む

string
couponDiscount

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン値引き:その取引で使用された各クーポンの値引き・割引額の合計値。

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
cashTotal

内現金支払金額:合計金額の内訳 (現金払い)

string
creditTotal

内クレジット支払金額:合計金額の内訳 (クレジット払い)

string
deposit

預かり金:会計時に預かった金額。

string
depositCash

預かり金現金:会計時に預かった現金金額。

string
depositCredit

預かり金クレジット:会計時に預かったクレジット金額。

string
change

釣銭:預かり金 - 合計。

string
tipCash

現金チップ

string
tipCredit

クレジットチップ

string
amount

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

string
returnAmount

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

string
costTotal

原価合計:明細の原価計の合計

string
salesHeadDivision

売上ヘッダ区分:売上明細に売上対象外商品を含むか否かの区分。 (0:売上対象のみ、1:売上対象外含む)

string
inTaxSalesTotal

内税対象額:売上対象商品の内税販売合計金額。 内税販売の場合は、税込・税抜き商品を対象。

string
outTaxSalesTotal

外税対象額:売上対象商品の外税販売の税抜き商品合計金額

string
nonTaxSalesTotal

非課税対象額:売上対象商品の非課税商品の合計金額。

string
nonSalesTargetTotal

売上対象外合計:売上対象外商品の合計。 外税販売の場合、税を含まない。

string
nonSalesTargetOutTaxTotal

売上対象外外税合計:売上対象外商品の外税合計。

string
nonSalesTargetInTaxTotal

売上対象外内税合計:売上対象外商品の内税合計。

string
nonSalesTargetTaxFreeTotal

売上対象外免税額合計:売上対象外商品の免税額合計。

string
nonSalesTargetCostTotal

売上対象外原価合計:売上対象外商品の原価合計。

string
nonSalesTargetAmount

売上対象外数量合計:取引明細の返品以外かつ売上対象外の数量の合計。 (取引明細区分が2:返品以外の数量)

string
nonSalesTargetReturnAmount

売上対象外返品数量合計:取引明細の返品かつ売上対象外の数量の合計。 (取引明細区分が2:返品の数量)

string
newPoint

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

string
spendPoint

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

string
point

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

string
totalPoint

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

string
currentMile

現在マイル:取引前のマイル。
※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。
※ 会員販売でない場合、nullが返されます。

string
earnMile

獲得マイル:取引で付与されるマイル。 合計 * ポイント付与率
※ 会員販売でない場合、nullが返されます。

string
totalMile

合計マイル:取引後のマイル。 現在マイル + 獲得マイル - 調整マイル
※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。
※ 会員販売でない場合、nullが返されます。

string
adjustmentMile

調整マイル:取引で手動で付与されるマイル。
※ 会員販売でない場合、nullが返されます。

string
adjustmentMileDivision

調整マイル区分:調整マイルの区分。
1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)、
2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」)、
3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)、
4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」
※ 会員販売でない場合、nullが返されます。

string
adjustmentMileValue

調整マイル区分値:調整マイルの入力値。
※ 会員販売でない場合、nullが返されます。

string
storeId

店舗ID:店舗毎に付与するID。

string
storeCode

店舗コード

string
terminalId

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

string
customerId

会員ID:会員毎に付与するID。数字10桁以内。

string
customerCode

会員コード

string
terminalTranId

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

string
terminalTranDateTime

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

string
sumDivision

締め区分:締め処理を実施したかの区分。 (0:未処理、1:精算処理済み、2:締め処理済み)

string
adjustmentDateTime

精算日時:精算をしたら日時が入る。[YYYY-MM-DDThh:mm:ssTZD]

string
sumDate

締め日:締めをしたら年月日が入る。 [YYYY-MM-DD]

string
customerRank

会員ランク:汎用マスタの「会員ランク」で登録しているコードを設定してください。 汎用マスタに登録されていないコードを設定するとエラーになります。

string
customerGroupId

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

string
customerGroupId2

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

string
customerGroupId3

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

string
customerGroupId4

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

string
customerGroupId5

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

string
staffId

販売員ID:販売員ID。(スタッフID)

string
staffCode

販売員コード

string
staffName

販売員名:販売員名。(スタッフ名)

string
creditDivision

クレジット区分:クレジット会社を識別する区分

  • 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)
  • 81: おてがるPay クレジット
  • 82: おてがるPay 電子マネー
  • 83: J-Mups II Pocket
  • 91: INFOX (JT-C16U)
  • A1: VEGA3000 Mobile2
  • B1: stera terminal
  • C1: SATURN1000E/SATURN1000L (CAFIS Arch)
string
Allowed values: 11 12 13 14 15 21 22 23 24 31 41 51 61 62 71 81 82 83 91 A1 B1 C1
paymentCount

支払回数:クレジットの支払回数。
※ゼウス、ペイメントマイスターご利用時
(1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い)

string
slipNumber

伝票番号:クレジットの伝票番号。

string
cancelSlipNumber

取消伝票番号:クレジットの取消伝票番号。

string
authNumber

承認番号:クレジットの承認番号。

string
authDate

センター処理日:クレジットのセンター処理日。

string
cardCompany

取扱カード会社:クレジットカード会社 例) VISA、JCB、MASTER、AMEX、DINERSなど

string
denomination

金種:(11:磁気クレジットカード、12:ICクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー)など

string
memo

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

string
receiptMemo

レシートメモ:レシートに印字するメモを設定。

string
carriage

送料:EC連携用送料。

string
commission

手数料:EC連携用手数料。

string
guestNumbers

客数:客数。

string
guestNumbersMale

客数(男):客数(男)。

string
guestNumbersFemale

客数(女):客数(女)。

string
guestNumbersUnknown

客数(不明):客数(不明)。

string
enterDateTime

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

string
taxFreeSalesDivision

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

string
netTaxFreeGeneralTaxInclude

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

string
netTaxFreeGeneralTaxExclude

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

string
netTaxFreeConsumableTaxInclude

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

string
netTaxFreeConsumableTaxExclude

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

string
tags

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

string
pointGivingDivision

ポイント付与区分:
1:税額を含める + 利用ポイント分を含める、
2:税額を含めない + 利用ポイント分を含める、
3:税額を含める + 利用ポイント分を含めない、
4:税額を含めない + 利用ポイント分を含めない

string
pointGivingUnitPrice

ポイント付与単位(金額):ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲:1円~99999円)
(例:10円ごとに2ポイントの場合、10円)

string
pointGivingUnit

ポイント付与単位(ポイント):ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲:0.00ポイント~99999.99ポイント)
(例:10円ごとに0.2ポイントの場合、0.2ポイント)

string
pointSpendDivision

ポイント利用区分:ポイント利用時の税を含む/含まないを判定。
1:ポイント利用を現金として扱う (税を含む値引き)
2:ポイント利用を値引として扱う (税を含まない値引き)
※未設定の場合、店舗のポイント利用区分に従う

string
mileageDivision

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

string
mileageLabel

マイレージ名称:マイレージの名称。例:rejiマイル

string
customerPinCode

PINコード:自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。

string
returnSales

返品取引区分:(0:通常、1:返品販売)

string
disposeDivision

打消区分:0:通常、1:打消元レコード、2:打消レコード

string
disposeServerTransactionHeadId

打消元取引ID:打消元取引ID、打消先取引ID。

string
cancelDateTime

取消日時:取消したサーバー日時を設定。[YYYY-MM-DDThh:mm:ssTZD]

string
sellDivision

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

string
taxRate

税率:税率 (単位:%)

string
taxRounding

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

string
discountRoundingDivision

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

string
transactionUuid

レシート番号:レシートに印字する番号。
※スマレジアプリの採番方法(1970年から計算した現在秒9桁+端末IDゼロ詰め4桁)

string
exchangeTicketNo

引換券番号

string
giftReceiptValidDays

ギフトレシート有効日数:ギフトレシートの有効日数。 有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。

string
barcode

仮販売のバーコード。
※ 複数ある場合はカンマ区切り。

string
updDateTime

更新日時:取引履歴の更新日時。作成時/修正時に日付が設定されます。[YYYY-MM-DDThh:mm:ssTZD]

string
details

取引詳細

Array<object>
object
transactionHeadId

取引ID:数値型。

string
transactionDetailId

取引明細ID:数値型。

string
parentTransactionDetailId

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

string
transactionDetailDivision

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

string
productId

商品ID:数字15桁以内。

string
productCode

商品コード:半角英数記号64文字以内(2段バーコード利用時は最大64桁、それ以外は20桁)。

string
productName

商品名:85文字以内。

string
printReceiptProductName

レシート印字商品名:レシートに印字する商品名。64文字以内。
“summary” 指定時省略

string
color

カラー:85文字以内。

string
size

サイズ:85文字以内。

string
groupCode

グループコード:関連商品として紐付ける為のグループコードを設定。 例えば、AとBの商品に同じグループコード001を設定すると、AとBは関連商品となります。サイズ、カラーが異なる場合などに使用してください。

string
taxDivision

税区分:(0:税込、1:税抜、2:非課税)。

string
price

商品単価:当時の商品マスタの商品単価。数値型。

string
salesPrice

販売単価:販売時の単価を設定。デフォルトは商品単価。

string
unitDiscountPrice

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

string
unitDiscountRate

単品割引:単品の割引率を設定。(単位:%)。
“summary” 指定時省略

string
unitDiscountDivision

単品値引き/割引区分:単品値引き/割引時に指定された区分を設定。
“summary” 指定時省略

string
cost

原価:数字8桁以内(少数5桁まで)。未設定の場合0を設定。

string
quantity

数量:数値型。

string
unitNonDiscountSum

値引き前計:販売価格×数量。
“summary” 指定時省略

string
unitDiscountSum

単品値引き計:単品値引き×数量。
“summary” 指定時省略
※管理画面の取引履歴CSVで対応する項目: 単価値引き計

string
unitDiscountedSum

値引き後計:値引き前計 - 単品値引き計。

string
costSum

原価計:数字8桁以内(少数5桁まで)。未設定の場合0を設定。
“summary” 指定時省略

string
categoryId

部門ID:数字9桁以内。

string
categoryName

部門名:85文字以内。

string
discriminationNo

識別番号:20桁以内。
“summary” 指定時省略

string
salesDivision

売上区分:(0:売上対象、1:売上対象外)。

string
productDivision

商品区分:(0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル(親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値引(子)、A:プラン(子)、B:コース(子))。

string
inventoryReservationDivision

在庫引当区分:在庫引当商品か否かの区分(0: 通常商品 1: 在庫引当商品)。
“summary” 指定時省略

string
pointNotApplicable

ポイント対象:ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外)。
“summary” 指定時省略

string
calcDiscount

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

string
taxFreeDivision

免税区分:(0:対象外、1:一般品、2:消耗品)。
“summary” 指定時省略

string
taxFreeCommodityPrice

免税対象額:数値型。
“summary” 指定時省略

string
taxFree

免税額:数値型。
“summary” 指定時省略

string
productBundleGroupId

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

string
discountPriceProportional

小計値引き按分:小計値引きの按分を設定
端数処理は銀行丸め。誤差は最終行で調整。
“summary” 指定時省略

string
discountPointProportional

ポイント値引き按分:ポイント値引きの按分を設定。端数処理は銀行丸め。誤差は最終行で調整。
“summary” 指定時省略

string
discountCouponProportional

対象プラン プレミアム/プレミアムプラス/フードビジネス/リテールビジネス
クーポン値引き按分:クーポン値引きの按分を設定。端数処理は銀行丸め。誤差は最終行で調整します。
“summary” 指定時省略

string
taxIncludeProportional

内税按分:内税を按分した金額を設定
端数処理は銀行丸め。誤差は最終行で調整。
“summary” 指定時省略

string
taxExcludeProportional

外税按分:外税を按分した金額を設定。端数処理は銀行丸め。誤差は最終行で調整。
“summary” 指定時省略

string
productBundleProportional

商品バンドル値引按分:商品バンドル値引きを按分した金額を設定。
端数処理は銀行丸め。誤差は最終行で調整。
“summary” 指定時省略

string
staffDiscountProportional

社員値引き按分:社員販売時のみ設定。
“summary” 指定時省略

string
bargainDiscountProportional

セール値引き按分:セール販売時のみ設定。
“summary” 指定時省略

string
roundingPriceProportional

端数値引額按分:端数値引額の按分した金額を設定
端数処理は銀行丸め。誤差は最終行で調整。
“summary” 指定時省略

string
productStaffDiscountRate

商品毎の社員割引率:社員販売時のみ設定。
“summary” 指定時省略

string
staffRank

社員ランクコード:社員販売時のみ設定。
“summary” 指定時省略

string
staffRankName

社員ランク名:社員販売時のみ設定。
“summary” 指定時省略

string
staffDiscountRate

社員販売割引率:社員販売時のみ設定。
“summary” 指定時省略

string
staffDiscountDivision

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

string
applyStaffDiscountRate

適用社員販売割引率:社員販売時のみ設定。
“summary” 指定時省略

string
applyStaffDiscountPrice

適用社員値引き額:社員販売時のみ設定。
“summary” 指定時省略

string
bargainId

セールID:セール販売時のみ設定。
“summary” 指定時省略
※セール商品ID(bargainProductId)の値が設定されます。

string
bargainName

セール名称:セール販売時のみ設定。
“summary” 指定時省略

string
bargainDivision

セール区分:セール販売時のみ設定。
“summary” 指定時省略

string
bargainValue

セール値:セール販売時のみ設定。
“summary” 指定時省略

string
applyBargainValue

適用セール値:セール販売時のみ設定。
“summary” 指定時省略

string
applyBargainDiscountPrice

適用セール値引き額:セール販売時のみ設定。
“summary” 指定時省略

string
taxRate

適用税率:(明細毎に税率変更可能なため)。

string
standardTaxRate

標準税率:(明細毎に税率変更可能なため)。
“summary” 指定時省略

string
modifiedTaxRate

修正税率: 修正した税率(明細毎に税率変更可能なため)。
“summary” 指定時省略

string
reduceTaxId

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

string
reduceTaxName

軽減税率名:軽減税率販売時のみ設定。
“summary” 指定時省略

string
reduceTaxRate

軽減税率:軽減税率販売時のみ設定。
“summary” 指定時省略

string
reduceTaxPrice

軽減税率用商品単価:軽減税率販売時のみ設定。
“summary” 指定時省略

string
reduceTaxMemberPrice

軽減税率用会員商品単価:軽減税率販売時のみ設定。
“summary” 指定時省略

string
memo

返品販売時などのメモなどを設定。 1000文字以内。
“summary” 指定時省略

string
productAttributes

取引時の商品属性情報

Array<object>
object
transactionHeadId

取引ID

string
transactionDetailId

取引明細ID

string
code

コード:数字9桁以内。

string
name

名称:30文字以内

string
rfidTags

RFIDタグリスト。スマレジ・アプリでRFIDタグを用いて取引登録した場合、取引明細に紐付くRFIDタグリストを取得することができます。
“summary” 指定時省略

Array<string>
depositOthers

その他支払方法

Array<object>
object
transactionHeadId

取引ID:取引毎に付与するID。

string
no

項番

string
paymentMethodId

その他支払方法ID:各支払方法に紐づくID。

string
paymentMethodCode

支払方法コード:半角英数記号20文字以内。

string
paymentMethodName

支払方法名:支払方法名。85文字以内。

string
depositOthers

預り金その他:会計時に預かった金額。
(例:500円商品券2枚の場合、1000)

string
paymentUnitPrice

単価:商品券のように1枚あたりの価格が決まっている場合に設定。
(例:500円商品券2枚の場合、500)

string
paymentChangeFlag

釣銭フラグ:釣銭フラグ(0:釣銭なし、1:釣銭あり)

string
Allowed values: 0 1
paymentDivision

支払方法マスタの支払方法分類を自動設定。

string
paymentSecuritiesFlag

有価証券フラグ:有価証券フラグ(0:有価証券以外,1:有価証券)

string
Allowed values: 0 1
denominationCode
支払金種コード

※個別アプリ専用支払方法登録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! ×
string
Allowed values: CREDIT DEBIT JDEBIT PREPAID STORE UNIONPAY CONTACTLESS SUICA PITAPA SAPICA QUICPAY ID WAON RAKUTENEDY NANACO AEONPAY ALIPAY AMAZONPAY ATONEPAY AUPAY BANKIT BANKPAY DPAY EGIFTEE FAMIPAY GINKOPAY GLNPAY GOTOEAT JCOINPAY JKOPAY LINEPAY MBBANK MERPAY MICROPAY NISSENREN ORIGAMIPAY PAYPAY PROMPTPAY QUOPAY RAKUTENPAY SGTDASH SGTGLB SMARTCODE UPICPM ATOKARA TOTTEIPAY WESMO
denominationName

支払金種名。詳細は、支払金種コードの「支払金種コード対応表」をご参照ください
※現状、個別アプリ専用支払方法ID利用時のみ対応

string
cardCompanyName

クレジットカード会社名
※現状、個別アプリ専用支払方法ID利用時のみ対応

string
slipNumber

伝票番号

string
cancelSlipNumber

取消伝票番号

string
pointGivingUnitPrice

ポイント付与単位(金額):ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)
(例10円ごとに2ポイントの場合、10円)

string
pointGivingUnit

ポイント付与単位(ポイント):ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)
(例10円ごとに0.2ポイントの場合、0.2ポイント)

string
layaway

(非推奨)取置き時の詳細情報
※ with_layawaysを活用するようにしてください。
※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。
※ 既存のwith_layaway: "all" を指定して取得できる取置きデータには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置きデータしか返りません。

object
transactionHeadId

取引ID:取引毎に付与するID。サーバー側で付与する。

string
pickUpDate

受取日

string
status

ステータス:取置取引のステータス(1:引取済み)

string
partPayment

前受金

string
partPaymentClass

前受金区分(1:現金、2:クレジット)

string
pickUpTransactionHeadId

引取取引ヘッダーID

string
disabledEdit

変更不可能設定:変更不可能設定(0:変更可、 1:変更不可)

string
layaways

取置き時の詳細情報

Array<object>
object
transactionHeadId

取引ID:取引毎に付与するID。サーバー側で付与する。

string
pickUpDate

受取日

string
status

ステータス:取置取引のステータス(1:引取済み)

string
partPayment

前受金

string
partPaymentClass

前受金区分(1:現金、2:クレジット)

string
pickUpTransactionHeadId

引取取引ヘッダーID

string
disabledEdit

変更不可能設定:変更不可能設定(0:変更可、 1:変更不可)

string
layawayPickUp

(非推奨)取置き引取時の詳細情報
※ with_layaway_pick_upsを活用するようにしてください。
※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。
※ 既存のwith_layaway_pick_up: "all" を指定して取得できる取置き引取データには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置き引取データしか返りません。

object
transactionHeadId

取引ID

string
layawayServerTransactionHeadId

取置きの取引ID

string
receivedDepositCash

受領済金額:取置きの内金/手付金(現金)

string
receivedDepositCredit

受領済クレジット金額:取置きの内金/手付金(クレジット)

string
layawayPickUps

取置き引取時の詳細情報

Array<object>
object
transactionHeadId

取引ID

string
layawayServerTransactionHeadId

取置きの取引ID

string
receivedDepositCash

受領済金額:取置きの内金/手付金(現金)

string
receivedDepositCredit

受領済クレジット金額:取置きの内金/手付金(クレジット)

string
moneyControl

取引金操作情報:入出金区分の詳細情報

object
transactionHeadId

取引ID

string
attributeDivision

属性区分:入出金の区分値。属性区分名ごとに採番されるコード

string
attributeDivisionName

属性区分名:入出金区分の名称

string
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",
"nonSalesTargetOutTaxTotal": "string",
"nonSalesTargetInTaxTotal": "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",
"storeCode": "string",
"terminalId": "string",
"customerId": "string",
"customerCode": "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",
"staffCode": "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",
"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",
"productAttributes": [
{
"transactionHeadId": "string",
"transactionDetailId": "string",
"code": "string",
"name": "string"
}
],
"rfidTags": [
"string"
]
}
],
"depositOthers": [
{
"transactionHeadId": "string",
"no": "string",
"paymentMethodId": "string",
"paymentMethodCode": "string",
"paymentMethodName": "string",
"depositOthers": "string",
"paymentUnitPrice": "string",
"paymentChangeFlag": "0",
"paymentDivision": "string",
"paymentSecuritiesFlag": "0",
"denominationCode": "CREDIT",
"denominationName": "string",
"cardCompanyName": "string",
"slipNumber": "string",
"cancelSlipNumber": "string",
"pointGivingUnitPrice": "string",
"pointGivingUnit": "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"
}
],
"moneyControl": {
"transactionHeadId": "string",
"attributeDivision": "string",
"attributeDivisionName": "string"
}
}
]
  • with_detailsがnone以外で、limitに100を超える値が設定された場合
  • with_detailsがnoneで、with_detail_product_attributesにnone以外が設定された場合
  • 必須検索条件の設定が必要で、必須検索条件が1つも設定されていない場合
  • 必須検索条件の設定が必要で、範囲指定の必須検索条件のうちFrom/To片方しか設定されていない場合
  • 必須検索条件の設定が必要で、範囲指定の必須検索条件におけるFrom-Toの範囲が上限を超えている場合
    object
    type
    required
    string
    title
    required
    string
    detail
    string
    status
    integer
    Examples
    {
    "type": "about:blank",
    "title": "Bad Request",
    "detail": "with_detailsをnone以外に設定する場合、limitには100以下の値を設定して下さい。(limit-{limit})",
    "status": 400
    }