BiZOOPe | 連携ファイルフォーマット定義書

ファイルフォーマット

項目	指定フォーマット
文字コード	UTF-8
区切り文字	水平タブ
囲み文字	不要
ヘッダー	なし
改行コード	Lf / CrLf

型

各連携ファイルフォーマットに記載されている型の定義は以下の通りです。以下形式に合致しない値がある行は取り込まれませんのでご注意ください。

型	備考
STRING	任意の文字列。200文字を超える場合、201文字目以降は切り捨てます。
INTEGER	整数。小数点以下の数値が入力されている場合、小数第1位を切捨てます。
NUMERIC	任意の数値。小数第4位を切捨てます。
DATE	YYYYMMDD形式の文字列
DATETIME	YYYYMMDDHHMISS形式の文字列
BOOLEAN	0（=false）または1（=true）

その他の指定フォーマット

項目に依っては使用できる文字、フォーマットが限定されている場合があります。備考に記載されている場合はそちらに従ってください。

キー項目

キー項目（複数の項目で構成される場合もあります）が一致するデータは取込時に上書きされます。ただし、「基幹出力日時」が同一、若しくは新しい場合に限ります。同一ファイル内でキーが重複している場合、「基幹出力日時」新しい行が取り込まれる候補となります。ただし、既存データの「基幹出力日時」より古い場合は取り込まれません。

同一ファイル内でキーが重複しており「基幹出力日時」も同一場合、どの行が取込候補となるかの保証はありません。

必須項目

前後空白（半角スペース）は除去されるため、必須項目に空白文字（半角スペース）のデータは許可されません。

必須項目以外

必須ではない項目であっても項目自体は常に含めてください。

削除フラグ

削除フラグに1(=true)を指定することで、キーが一致するデータを削除することができます。削除は「基幹出力日時」が古い場合でも実行されます。

TIP

データ保持期間外の売上データ（ジャーナル）をお客様ご自身で削除していただく必要はありません。

各連携ファイルのフォーマット

ジャーナル

ファイル名: journal_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	売上日	ymd	DATE	○
2	○	企業コード	company_code	STRING	○
3	○	店舗コード	store_code	STRING	○
4	○	POS番号	pos_no	INTEGER	○
5	○	レシート番号	receipt_code	INTEGER	○
6	○	レシート行番号	receipt_line	INTEGER	○
7		取引時刻	pos_time	STRING		HHMM形式
8		売上区分	sale_type	STRING		支払い区分(現金、カード等)を設定。（未使用）
9		商品区分	item_type	STRING		（未使用）
10		商品コード	item_code	STRING	○
11		買上点数	qty	NUMERIC	○
12		買上金額	amount	NUMERIC	○
13		買上粗利	gross_profit	NUMERIC		（未使用）
14		単品値引金額	discount_amount	NUMERIC		（未使用）
15		特売企画コード	campaign_code	STRING		（未使用）
16		カードID	card_id	STRING		非会員による購買データの場合は空。会員マスタの会員コードと紐づくコード。（匿名化）
17		基幹登録日	host_created_on	DATE
18		基幹更新日	host_updated_on	DATE
19		基幹出力日時	host_output_at	DATETIME	○
20		削除フラグ	is_deleted	BOOLEAN	○

分類マスタ

ファイル名: item_categories_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	企業コード	company_code	STRING	○
2	○	ユニーク分類ボトムコード	category_code	STRING	○
3		ユニーク分類名称	category_name	STRING
4		分類階層1コード	category01_code	STRING
5		分類階層1名称	category01_name	STRING
6		分類階層2コード	category02_code	STRING
7		分類階層2名称	category02_name	STRING
8		分類階層3コード	category03_code	STRING
9		分類階層3名称	category03_name	STRING
10		分類階層4コード	category04_code	STRING
11		分類階層4名称	category04_name	STRING
12		分類階層5コード	category05_code	STRING
13		分類階層5名称	category05_name	STRING
14		分類階層6コード	category06_code	STRING
15		分類階層6名称	category06_name	STRING
16		分類階層7コード	category07_code	STRING
17		分類階層7名称	category07_name	STRING
18		分類階層8コード	category08_code	STRING
19		分類階層8名称	category08_name	STRING
20		分類階層9コード	category09_code	STRING
21		分類階層9名称	category09_name	STRING
22		分類階層10コード	category10_code	STRING
23		分類階層10名称	category10_name	STRING
24		基幹登録日	host_created_on	DATE
25		基幹更新日	host_updated_on	DATE
26		基幹出力日時	host_output_at	DATETIME	○
27		削除フラグ	is_deleted	BOOLEAN	○

補足

階層は下から1->10で、最大10階層までです。

商品マスタ

ファイル名: items_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	企業コード	company_code	STRING	○
2	○	商品コード１	item_code	STRING	○	実績と結びつくコード
3		商品名称１	item_name	STRING	○
4		カナ名称１	item_kana_name	STRING		（未使用）
5		商品コード２	item02_code	STRING		（未使用）
6		商品名称２	item02_name	STRING		（未使用）
7		カナ名称２	item02_kana_name	STRING		（未使用）
8		商品コード３	item03_code	STRING		（未使用）
9		商品名称３	item03_name	STRING		（未使用）
10		カナ名称３	item03_kana_name	STRING		（未使用）
11		管理No	control_no	STRING		（未使用）
12		規格	gauge	STRING		（未使用）
13		分類ボトムコード	category_code	STRING	○
14		換算数	composite_qty	NUMERIC		（未使用）
15		基本売単価	sales_unit_price	NUMERIC		（未使用）
16		基本原単価	original_unit_price	NUMERIC		（未使用）
17		定価	list_price	NUMERIC		（未使用）
18		取扱区分	handle_type	STRING		（未使用）
19		入数	lot_size	NUMERIC		（未使用）
20		発注単位数量	order_unit_qty	NUMERIC		（未使用）
21		取引先コード	supplier_code	STRING		（未使用）
22		メーカーコード	maker_code	STRING
23		発注開始日	order_started_on	DATE		（未使用）
24		発注終了日	order_terminated_on	DATE		（未使用）
25		取扱開始日	handle_started_on	DATE		この日付から3ヶ月以内の商品は「新商品」と判断されます（設定により期間は異なることがあります）。新商品はPOS分析結果表示時に配色変更などが行われます。
26		取扱終了日	handle_terminated_on	DATE		（未使用）
27		税区分	tax_type	STRING		（未使用）
28		発注停止フラグ	is_order_stopped	BOOLEAN		（未使用）
29		商品サイズ幅	size_width	NUMERIC		（未使用）
30		商品サイズ高さ	size_height	NUMERIC		（未使用）
31		商品サイズ奥行	size_depth	NUMERIC		（未使用）
32		基幹登録日	host_created_on	DATE		取扱開始日の指定がない場合、この日付で新商品の判断を行います。
33		基幹更新日	host_updated_on	DATE
34		基幹出力日時	host_output_at	DATETIME	○
35		削除フラグ	is_deleted	BOOLEAN	○

店舗マスタ

ファイル名: stores_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	企業コード	company_code	STRING	○
2	○	店舗コード	store_code	STRING	○
3		店舗名称	store_name	STRING	○
4		売場面積	shop_floor	NUMERIC		（未使用）
5		開店日	open_on	DATE		（未使用）
6		新店フラグ	is_new	BOOLEAN		（未使用）
7		改装日	renovated_on	DATE		（未使用）
8		改装店フラグ	is_renovated	BOOLEAN		（未使用）
9		閉店日	closed_on	DATE		（未使用）
10		閉店フラグ	is_closed	BOOLEAN		（未使用）
11		POS機種コード	pos_machine_code	STRING		（未使用）
12		POS取扱フラグ	use_pos_machine	BOOLEAN		（未使用）
13		郵便番号	zip	STRING		（未使用）
14		住所	address	STRING		（未使用）
15		電話番号	tel	STRING		（未使用）
16		基幹登録日	host_created_on	DATE
17		基幹更新日	host_updated_on	DATE
18		基幹出力日時	host_output_at	DATETIME	○
19		削除フラグ	is_deleted	BOOLEAN	○

店舗グループマスタ

ファイル名: store_groups_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	企業コード	company_code	STRING	○
2	○	店舗コード	store_code	STRING	○
3	○	店舗グループ項目コード	store_group_col_code	STRING	○
4		店舗グループ項目名称	store_group_col_name	STRING
5		店舗グループ01コード	store_group_code01	STRING
6		店舗グループ01名称	store_group_name01	STRING
7		店舗グループ02コード	store_group_code02	STRING
8		店舗グループ02名称	store_group_name02	STRING
9		店舗グループ03コード	store_group_code03	STRING
10		店舗グループ03名称	store_group_name03	STRING
11		店舗グループ04コード	store_group_code04	STRING
12		店舗グループ04名称	store_group_name04	STRING
13		店舗グループ05コード	store_group_code05	STRING
14		店舗グループ05名称	store_group_name05	STRING
15		店舗グループ06コード	store_group_code06	STRING
16		店舗グループ06名称	store_group_name06	STRING
17		店舗グループ07コード	store_group_code07	STRING
18		店舗グループ07名称	store_group_name07	STRING
19		店舗グループ08コード	store_group_code08	STRING
20		店舗グループ08名称	store_group_name08	STRING
21		店舗グループ09コード	store_group_code09	STRING
22		店舗グループ09名称	store_group_name09	STRING
23		店舗グループ10コード	store_group_code10	STRING
24		店舗グループ10名称	store_group_name10	STRING
25		基幹登録日	host_created_on	DATE
26		基幹更新日	host_updated_on	DATE
27		基幹出力日時	host_output_at	DATETIME	○
28		削除フラグ	is_deleted	BOOLEAN	○

補足

店舗グループ（地区や規模でのグループ分け）定義です。

アプリケーションでの店舗選択を容易にするためのマスタです。このマスタがなくても店舗選択は可能です。

例えば、このような連携ファイル内容は（コード項目を一部割愛しています）、

企業コード	店舗G項目名称	店舗G01名称	店舗G02名称	(略)	店舗コード
企業	地区	静岡	東海	〜	店舗01
企業	地区	愛知	東海	〜	店舗02
企業	地区	東京	関東	〜	店舗03
企業	規模	大型店	-	〜	店舗01
企業	規模	小型店	-	〜	店舗02
企業	規模	小型店	-	〜	店舗03

このような階層構造を表しています。

├── 規模
│   ├── 大型店
│   │   └── 店舗01
│   └── 小型店
│       ├── 店舗02
│       └── 店舗03
└── 地区
    ├── 東海
    │   ├── 静岡
    │   │   └── 店舗01
    │   └── 愛知
    │       └── 店舗02
    └── 関東
        └── 東京
            └── 店舗03

階層は下から1->10で、最大10階層までです。

店舗グループ項目内で同一店舗が複数のグループに属することはできません（例えば、店舗01が大型店にも小型店にも属することはできません）。

会員マスタ

ファイル名: customers_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	会員コード	card_id	STRING	○	（匿名化）
2		会員区分	customer_type	STRING		（未使用）
3		カード区分	card_type	STRING		（未使用）
4		入会日	admission_ymd	DATE		（未使用）
5		生年月日	date_of_birth	DATE		アプリケーション上は「年代」に変換されます。
6		性別	sex	STRING	○	1:男　2:女　3:その他（不明、企業等）
7		郵便番号	zip	STRING		ハイフンなし
8		基幹登録日	host_created_on	DATE
9		基幹更新日	host_updated_on	DATE
10		基幹出力日時	host_output_at	DATETIME	○
11		削除フラグ	is_deleted	BOOLEAN	○

日別単品値引データ

ファイル名: discount_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	年月日	ymd	DATE	○
2	○	企業コード	company_code	STRING	○
3	○	店舗コード	store_code	STRING	○
4	○	商品コード	item_code	STRING	○
5	○	取引先コード	supplier_code	STRING
6		数量	qty	NUMERIC	○
7		金額	amount	NUMERIC	○
8		基幹登録日	host_created_on	DATE
9		基幹更新日	host_updated_on	DATE
10		基幹出力日時	host_output_at	DATETIME	○
11		削除フラグ	is_deleted	BOOLEAN	○

日別単品廃棄データ

ファイル名: dispose_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	年月日	ymd	DATE	○
2	○	企業コード	company_code	STRING	○
3	○	店舗コード	store_code	STRING	○
4	○	商品コード	item_code	STRING	○
5	○	取引先コード	supplier_code	STRING
6		数量	qty	NUMERIC	○
7		金額	amount	NUMERIC	○
8		基幹登録日	host_created_on	DATE
9		基幹更新日	host_updated_on	DATE
10		基幹出力日時	host_output_at	DATETIME	○
11		削除フラグ	is_deleted	BOOLEAN	○

商品おまとめコード

ファイル名: omatome_items_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	おまとめコード	omatome_code	STRING	○
2	○	企業コード	company_code	STRING	○
3	○	商品コード	item_code	STRING	○
4		基幹登録日	host_created_on	DATE
5		基幹更新日	host_updated_on	DATE

店舗おまとめコード

ファイル名: omatome_stores_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	おまとめコード	omatome_code	STRING	○
2	○	企業コード	company_code	STRING	○
3	○	店舗コード	store_code	STRING	○
4		基幹登録日	host_created_on	DATE
5		基幹更新日	host_updated_on	DATE

客数データ（日、店舗別）

ファイル名: receipt_count_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	年月日	ymd	DATE	○
2	○	企業コード	company_code	STRING	○
3	○	店舗コード	store_code	STRING	○
4		客数	receipt_count	INTEGER	○
5		基幹登録日	host_created_on	DATE
6		基幹更新日	host_updated_on	DATE
7		基幹出力日時	host_output_at	DATETIME	○
8		削除フラグ	is_deleted	BOOLEAN	○

POS売上（日・店舗・商品サマリ）

ファイル名: sales_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	売上日	ymd	DATE	○
2	○	企業コード	company_code	STRING	○
3	○	店舗コード	store_code	STRING	○
4	○	商品コード	item_code	STRING	○
5	○	取引先コード	supplier_code	STRING
6	○	売上区分	sale_type	STRING
7		売上点数	qty	NUMERIC	○
8		売上金額	amount	NUMERIC	○
9		基幹登録日	host_created_on	DATE
10		基幹更新日	host_updated_on	DATE
11		基幹出力日時	host_output_at	DATETIME	○
12		削除フラグ	is_deleted	BOOLEAN	○

在庫

ファイル名: stock_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	日付	ymd	DATE	○
2	○	企業コード	company_code	STRING	○
3	○	店舗コード	store_code	STRING	○
4	○	商品コード	item_code	STRING	○
5		在庫数	qty	NUMERIC	○
6		在庫金額	amount	NUMERIC	○
7		在庫原価	cost	NUMERIC	○
8		基幹登録日	host_created_on	DATE
9		基幹更新日	host_updated_on	DATE
10		基幹出力日時	host_output_at	DATETIME	○
11		削除フラグ	is_deleted	BOOLEAN	○

取引先マスタ

ファイル名: suppliers_yyyymmddhhmiss.tsv

No	キー	項目名	項目ID	型	必須	備考
1	○	企業コード	company_code	STRING	○
2	○	取引先コード	supplier_code	STRING	○
3		取引先名称	supplier_name	STRING	○
4		仕入先コード	shiiresaki_code	STRING		（未使用）
5		発注方法	ordering_method	STRING		（未使用）
6		基幹登録日	host_created_on	DATE
7		基幹更新日	host_updated_on	DATE
8		基幹出力日時	host_output_at	DATETIME	○
9		削除フラグ	is_deleted	BOOLEAN	○

FAQ

カードIDは自社で管理する番号を送ればいいの？

顧客の識別情報（ハウスカードの番号など）は個人情報と見なされます。BiZOOPeでは、それらの情報は匿名化（元の番号に復元できない文字列に変換）した状態でお送りいただきます。貴社での匿名化対応が難しい場合はご相談ください。

「未使用」って？

「未使用」は現在アプリケーションでは使用していない項目です。将来的な機能追加などで参照される可能性があるため用意しています（ご期待ください！ 🎉 ）。お送りいただいていればスムーズに新機能がご利用いただけます！入力が難しい項目は空でお送りいただいて結構です。