取引明細一覧CSV作成
POST /transactions/details/out_file_async
POST
/transactions/details/out_file_async
取引明細情報一覧CSVファイルを作成します。
※ 取引明細CSVの作成処理は非同期で実行されます。処理完了後、指定されたコールバックURLに取得結果のCSVファイル(圧縮済み)をダウンロードするURLがWebhook通知されます。
※ Webhookで通知されるCSVダウンロードURLの期限は1時間です。
※ 取得件数の上限はありませんが、検索条件の取引日時(From)〜取引日時(To)の範囲を31日以内にする必要があります。
対象プラン
- スタンダード
- プレミアム
- プレミアムプラス
- フードビジネス
- リテールビジネス
Authorizations
Section titled “Authorizations ”Request Body
Section titled “Request Body ”object
fields
検索パラメータ
検索パラメータ（カンマ区切りで指定可）
CSV出力項目(ResponsesのcallbackUrl説明欄参照)を指定可能
string format: string
sort
並び順
並び順（カンマ区切りで指定可）
指定可能なパラメータ
- transactionHeadId：取引ID
- transactionDetailId：取引明細ID
- transactionDetailDivision：取引明細区分
- transactionDateTime：取引日時
- transactionHeadDivision：取引区分
- storeId：店舗ID
- terminalId：端末ID
- customerId：会員ID
- terminalTranId：端末取引ID
- terminalTranDateTime：端末取引日時
- sumDate：締め日
- updDateTime：更新日時
string format: string
transactionHeadIdFrom
取引ID(From)
取引ID(From)
string format: string
transactionHeadIdTo
取引ID(To)
取引ID(To)
string format: string
transactionDateTimeFrom
required
取引日時(From)
取引日時(From)：サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]
※指定必須。取引日時(From)〜取引日時(To)の期間は最大31日。
string format: string
transactionDateTimeTo
required
取引日時(To)
取引日時(To)：サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD]
※指定必須。取引日時(From)〜取引日時(To)の期間は最大31日。
string format: string
transactionHeadDivision
取引区分
取引区分(1:通常,2:入金,3:出金,4:預かり金,5:預かり金返金,6:ポイント加算,7:ポイント減算,8:ポイント失効,9:回数券,10:取置き,11:チップ,13:マイル加算,14:マイル減算,15：バリューカード入金,16：領収証)
※ 1:通常、10:取置き のみ対応しています。
string
storeId
店舗ID
店舗ID
string format: string
terminalTranDateTimeFrom
端末取引日時(From)
端末取引日時(From)：端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
string format: string
terminalTranDateTimeTo
端末取引日時(To)
端末取引日時(From)：端末で設定された取引日時。[YYYY-MM-DDThh:mm:ssTZD]
string format: string
sumDate
締め日
締め日 [YYYY-MM-DD]
string format: string
sumDateFrom
締め日(From)
締め日(From) [YYYY-MM-DD]
string format: string
sumDateTo
締め日(To)
締め日(To) [YYYY-MM-DD]
string format: string
customerSaleDivision
取引区分
会員販売区分(0:非会員販売,1:会員販売)
string
updDateTimeFrom
更新日時(From)
更新日時(From)：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
string format: string
updDateTimeTo
更新日時(To)
更新日時(To)：登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD]
string format: string
callbackUrl
required
取引明細CSV作成完了通知URL
取引明細CSVの作成処理が完了、もしくはエラーとなった際に、結果をWebhook通知するURL
string format: string
state
完了通知ステートメント
リクエストヘッダ
リクエストボディ
※ callbackUrlに通知される生成されたファイルのドメインは予告なく変更される場合があります。
取引明細CSV作成完了通知URLに完了通知する際に設定できる任意の文字列
クエリパラメータとして同時に通知されます
リクエスト例：
リクエストヘッダ
| key | value |
|---|---|
| Content-Type | application/json |
| Request-Code | 問い合わせ用コード。弊社への問い合わせの際にご利用ください。 |
| key | value |
|---|---|
| file_url | ダウンロードURL。成功時のみ付与 |
| status | success:成功, failed:失敗 |
| message | メッセージ(成功時:空欄,取得データなし:no data,失敗時:500 internal error) |
| proc_name | get_transaction_detail_list |
| state | stateで指定した文字列 |
| request_code | 問い合わせ用コード。弊社への問い合わせの際にご利用ください。 |
string format: string
Example
{ "fields": "string", "sort": "string", "transactionHeadIdFrom": "string", "transactionHeadIdTo": "string", "transactionDateTimeFrom": "string", "transactionDateTimeTo": "string", "transactionHeadDivision": "1", "storeId": "string", "terminalTranDateTimeFrom": "string", "terminalTranDateTimeTo": "string", "sumDate": "string", "sumDateFrom": "string", "sumDateTo": "string", "customerSaleDivision": "0", "updDateTimeFrom": "string", "updDateTimeTo": "string", "callbackUrl": "string", "state": "string"}Responses
Section titled “ Responses ”取得成功
object
callbackUrl
取引明細一覧の取得が完了した際に、取得結果のCSVファイル(圧縮済み)をWebhook通知するURL
圧縮方式
■圧縮方式：gzip■解凍コマンド例：gzip -d (ダウンロードしたgzファイル)
CSVフォーマット
■文字コード：UTF-8■ヘッダ有無：有
■セパレータ：カンマ（,）
■囲み文字：ダブルクオート（"）
■改行コード：LF
項目一覧
※ REQUEST BODY SCHEMAのfieldsで指定された項目が出力されます(fields未指定時は全項目)| 項目名 | 型 | 説明 |
|---|---|---|
| transactionHeadId | string | 取引ID：数値型。 |
| transactionDateTime | string | 取引日時：取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD] |
| transactionHeadDivision | string | 取引区分：取引を識別する区分。 （1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、9:回数券、10:取置き、11:チップ、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証） |
| storeId | string | 店舗ID：店舗毎に付与するID。 |
| terminalId | string | 端末ID：店舗の端末毎に付与するID。 |
| customerId | string | 会員ID：会員毎に付与するID。数字10桁以内。 |
| terminalTranDateTime | string | 端末取引ID：端末で設定された取引ID。 |
| sumDate | string | 締め日：締めをしたら年月日が入る。 [YYYY-MM-DD] |
| updDateTime | string | 更新日時：取引履歴の更新日時。作成時／修正時に日付が設定されます。[YYYY-MM-DDThh:mm:ssTZD] |
| transactionDetailId | string | 取引明細ID：数値型。 |
| parentTransactionDetailId | string | 親取引明細ID：紐付く親の取引明細がある場合、その取引明細IDを設定。 ない場合、NULLを設定。 ※商品区分が、0（通常販売）, 4（バンドル(親)）の場合は設定できず、7（バンドル子）, 8（バンドル値引）の時は、バンドル(親)の 取引明細IDを設定しなければならない。 |
| transactionDetailDivision | string | 取引明細区分：（1：通常、2：返品、3：部門売り）。 |
| productId | string | 商品ID：数字15桁以内。 |
| productCode | string | 商品コード：半角英数記号64文字以内(2段バーコード利用時は最大64桁、それ以外は20桁)。 |
| productName | string | 商品名：85文字以内。 |
| printReceiptProductName | string | レシート印字商品名：レシートに印字する商品名。64文字以内。 |
| color | string | カラー：85文字以内。 |
| size | string | サイズ：85文字以内。 |
| groupCode | string | グループコード：関連商品として紐付ける為のグループコードを設定。 例えば、AとBの商品に同じグループコード001を設定すると、AとBは関連商品となります。サイズ、カラーが異なる場合などに使用してください。 |
| taxDivision | string | 税区分：(0：税込、1：税抜、2：非課税)。 |
| price | string | 商品単価：当時の商品マスタの商品単価。数値型。 |
| salesPrice | string | 販売単価：販売時の単価を設定。デフォルトは商品単価。 |
| unitDiscountPrice | string | 単品値引：販売単価の値引き金額を設定。 単品割引率が設定された場合、その割合から値引き金額を設定。（切捨て）。 |
| unitDiscountRate | string | 単品割引：単品の割引率を設定。（単位：％）。 |
| unitDiscountDivision | string | 単品値引き/割引区分：単品値引き/割引時に指定された区分を設定。 |
| cost | string | 原価：数字8桁以内(少数5桁まで)。未設定の場合0を設定。 |
| quantity | string | 数量：数値型。 |
| unitNonDiscountSum | string | 値引き前計：販売価格×数量。 |
| unitDiscountSum | string | 単品値引き計：単品値引き×数量。 ※管理画面の取引履歴CSVで対応する項目: 単価値引き計 |
| unitDiscountedSum | string | 値引き後計：値引き前計 - 単品値引き計。 |
| costSum | string | 原価計：数字8桁以内(少数5桁まで)。未設定の場合0を設定。 |
| categoryId | string | 部門ID：数字9桁以内。 |
| categoryName | string | 部門名：85文字以内。 |
| discriminationNo | string | 識別番号：20桁以内。 |
| salesDivision | string | 売上区分：（0：売上対象、1：売上対象外）。 |
| productDivision | string | 商品区分：(0：通常、1：回数券、2：オプション商品、3：部門販売、4：バンドル(親)、5：セット売(親)、6：簡易セット(親)、7：バンドル商品(子)、8：バンドル値引(子)、A：プラン(子)、B：コース(子))。 |
| inventoryReservationDivision | string | 在庫引当区分：在庫引当商品か否かの区分（0：通常商品 1：在庫引当商品）。 |
| pointNotApplicable | string | ポイント対象：ポイント対象にするか否かの設定（0：ポイント対象、1：ポイント対象外）。 |
| calcDiscount | string | 値引割引計算対象：小計値引／割引(クーポン、ポイント値引き含む)の対象かどうかを設定（0:対象外、1:対象）。 |
| taxFreeDivision | string | 免税区分：(0：対象外、1：一般品、2：消耗品)。 |
| taxFreeCommodityPrice | string | 免税対象額：数値型。 |
| taxFree | string | 免税額：数値型。 |
| productBundleGroupId | string | 商品バンドルグループID：商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。 商品バンドルグループに存在するIDを指定しなければならない。 この項目を設定する明細の商品区分は「4：バンドル(親)」でなければならない。 |
| 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 | 社員販売割引区分：社員販売時のみ設定 １ビット目：商品マスタの社員販売最大値引率を考慮（する or しない） ２ビット目：セール価格と社員販売割引を掛け合わせて適用（する or しない） ３ビット目：セール価格と社員販売価格を比較して安い方を適用（する or しない） ４ビット目：セール価格と社員販売価格を比較して高い方を適用（する or しない） ８ビット目：セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用（する or しない）。 |
| applyStaffDiscountRate | string | 適用社員販売割引率：社員販売時のみ設定。 |
| applyStaffDiscountPrice | string | 適用社員値引き額：社員販売時のみ設定。 |
| bargainId | string | セールID：セール販売時のみ設定。 |
| bargainName | string | セール名称：セール販売時のみ設定。 |
| bargainDivision | string | セール区分：セール販売時のみ設定。 |
| bargainValue | string | セール値：セール販売時のみ設定。 |
| applyBargainValue | string | 適用セール値：セール販売時のみ設定。 |
| applyBargainDiscountPrice | string | 適用セール値引き額：セール販売時のみ設定。 |
| taxRate | string | 適用税率：（明細毎に税率変更可能な為）。 |
| standardTaxRate | string | 標準税率：（明細毎に税率変更可能な為）。 |
| modifiedTaxRate | string | 修正税率：6,3。 |
| reduceTaxId | string | 軽減税率ID（税設定）：軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。 軽減:10000001 (特定商品の軽減税率適用） 選択[標準]:10000002（状態による適用[適用しない]） 選択[軽減]:10000003（状態による適用[適用する]） 選択[選択]:10000004（状態による適用[都度選択する]） |
| reduceTaxName | string | 軽減税率名：軽減税率販売時のみ設定。 |
| reduceTaxRate | string | 軽減税率：軽減税率販売時のみ設定。 |
| reduceTaxPrice | string | 軽減税率用商品単価：軽減税率販売時のみ設定。 |
| reduceTaxMemberPrice | string | 軽減税率用会員商品単価：軽減税率販売時のみ設定。 |
string
state
取引明細一覧取得完了通知URLに完了通知する際に設定できる任意の文字列
クエリパラメータとして同時に通知されます
string
requestCode
問い合わせ用コード。弊社への問い合わせの際にご利用ください。
string
Example
{ "callbackUrl": "string", "state": "string", "requestCode": "string"}- 取引ID(From)と取引ID(To)の範囲指定が不正な場合
- 取引日時(From)と取引日時(To)の範囲指定が不正な場合
- 取引日時(From)と取引日時(To)の範囲が31日を超える場合
- 端末取引日時(From)と端末取引日時(To)の範囲指定が不正な場合
- 締め日(From)と締め日(To)の範囲指定が不正な場合
- 締め日に締め日(From)と締め日(To)の範囲外の日付が指定された場合
- 更新日時(From)と更新日時(To)の範囲指定が不正な場合
object
type
required
string
title
required
string
detail
string
status
integer
Examples
{ "type": "about:blank", "title": "Bad Request", "detail": "取引ID(To)は取引ID(From)以上になるように指定してください。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "取引日時(To)は取引日時(From)以降になるように指定してください。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "取引日時(From)と取引日時(From) は、31日以内の範囲で入力してください。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "端末取引日時(To)は端末取引日時(From)以降になるように指定してください。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "締め日(To)は締め日(From)以降になるように指定してください。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "締め日に締め日(From)-締め日(To)の範囲外の日付は指定はできません。", "status": 400}{ "type": "about:blank", "title": "Bad Request", "detail": "更新日時(To)は更新日時(From)以降になるように指定してください。", "status": 400}