CData Sync App は、Smaregi データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Smaregi コネクタはCData Sync アプリケーションから使用可能で、Smaregi からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App は、Smaregi API を使用してSmaregi への双方向アクセスを実現します。
必須プロパティについては、設定タブを参照してください。
通常必須ではない接続プロパティについては、高度な設定タブを参照してください。
スマレジドライバーには、ContractId およびAccessToken パラメータが必要です。
スマレジにログイン後、[設定]->[システム連携]->[スマレジAPI 設定]に移動します。
[API受信設定]セクションにある[受信機能を利用する]を[利用する]に変更し、[アクセストークンの生成]をクリックし、AccessToken を取得します。
次に必要なAPI アクセスを有効にするため、[機能設定]セクションで必要な機能を[利用する]に変更します。
ContractId: アカウントの契約ID。これは受信設定セクションでも確認できます。
AccessToken: 受信設定セクションのアクセストークン。
このセクションでは、Smaregi Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Smaregi にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、Smaregi API へのSQL の実行について詳しく説明します。
テーブル では、利用可能なテーブルを説明します。テーブルは、Products、Customers、Shippings などを静的にモデル化するように定義されています。
ビュー では、利用可能なビューを説明します。ビューは、Stores、ShippingDetails などを静的にモデル化するように定義されています。ビューは変更できませんが、テーブルへのクエリを補足するために使用できます。
Sync App はSmaregi のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
Name | Description |
BargainProducts | セール情報:セール商品 |
Bargains | セール情報:セール |
BargainStores | セール情報:セール店舗 |
Categories | 部門情報:部門 |
Customers | 会員情報:会員 |
Losses | ロス情報:ロス |
ProductInventoryReservations | 商品情報:在庫引当商品 |
ProductPrices | 商品情報:商品価格 |
ProductReserveItemLabels | 商品情報:商品予備項目ラベル |
ProductReserveItems | 商品情報:商品予備項目 |
Products | 商品情報:商品 |
ProductStores | 商品情報:商品取扱店舗 |
Receivings | 入庫検品:入庫 |
Shipments | 出荷情報:出荷 |
Shippings | 出庫情報:出庫 |
Staff | Category: スタッフ情報 Staff Information ; TableName: スタッフ Staff |
Stocks | 在庫情報:在庫 |
StorageInfo | 発注情報:発注 |
Storages | 入荷情報:入荷 |
Stores | 店舗情報:店舗 |
TransactionHeads | 取引情報:取引 |
セール情報:セール商品
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT BargainId, TargetId FROM BargainProducts SELECT * FROM BargainProducts WHERE BargainId > 3 AND TargetId >= 1004 SELECT * FROM BargainProducts WHERE BargainId > 3 AND TargetId >= 1004 ORDER BY BargainProductId DESC SELECT * FROM BargainProducts WHERE TargetId LIKE '10%' ORDER BY BargainProductId ASC
BargainProduct を追加するには、BargainId、TargetDivision、TargetId、Division およびValue フィールドを指定します。
INSERT INTO BargainProducts (bargainId, targetDivision, targetId, division, value) VALUES (6, 2, 8, 1, 44) INSERT INTO BargainProducts (BargainProductId, bargainId, targetDivision, targetId, division, value) VALUES (7, 6, 2, 6, 1, 43)
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
BargainProduct を追加 / 更新するには、BargainId、TargetDivision、TargetId、Division およびValue フィールドを指定します。
UPSERT INTO BargainProducts (BargainId, TargetDivision, TargetId, Division, Value) VALUES (6, 2, 1007, 1, 44) UPSERT INTO BargainProducts (BargainProductId, bargainId, targetDivision, targetId, division, value) VALUES (7, 6, 2, 6, 1, 43)
複数のBargainProduct を追加 / 更新するには、BargainId、TargetDivision、TargetId、Division およびValue フィールドを指定します。
INSERT INTO BargainProducts#TEMP (bargainId, targetDivision, targetId, division, value) VALUES (6, 2, 2, 1, 44) INSERT INTO BargainProducts#TEMP (bargainId, targetDivision, targetId, division, value) VALUES (7, 2, 2, 1, 44) UPSERT INTO BargainProducts (bargainId, targetDivision, targetId, division, value) SELECT bargainId, targetDivision, targetId, division, value FROM BargainProducts#TEMP
スマレジはBargainId、TargetDivision、TargetId、Division およびValue カラムのUPDATE を許容します。
UPDATE BargainProducts SET BargainId = 3, TargetDivision = 3, TargetId = 1008, Value = 400, Division = 3 WHERE BargainProductId = 48
BargainProducts は、BargainProductId を指定することで削除できます。
DELETE FROM BargainProducts WHERE BargainProductId = 2
INSERT INTO BargainProducts#TEMP (BargainProductId) VALUES (3) INSERT INTO BargainProducts#TEMP (BargainProductId) VALUES (4) DELETE FROM BargainProducts WHERE EXISTS SELECT BargainProductId FROM BargainProducts#TEMP
Name | Type | ReadOnly | References | Description |
BargainProductId [KEY] | Long | False |
セール商品ID (PK) : 同一のセール商品IDがテーブルに存在する場合、対象のデータを更新。数字15桁以内。更新時、セール商品IDが未設定の場合自動採番します。 | |
BargainId | Integer | False |
Bargains.BargainId |
セールID : 数字9桁以内。数字9桁以内。存在しないセールIDを指定するとエラー。 |
TargetDivision | Integer | False |
対象区分 : 1:カテゴリー, 2:商品, 3:グループコードのいずれかを設定。 | |
TargetId | String | False |
対象ID : カテゴリーID, 商品ID, グループコードのいずれかを設定。存在しない対象IDを指定するとエラー。 | |
Division | Integer | False |
割引区分 : 1:割引 2:値引 3:価格指定のいずれかを設定。 | |
Value | Decimal | False |
値 : 割引、値引き、価格指定の値 |
セール情報:セール
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT BargainName, TermStart FROM Bargains SELECT BargainName, TermStart FROM Bargains WHERE BargainName LIKE 'TestBargain%' ORDER BY TermStart
Bargain を追加するには、すべてのフィールドを指定します。
INSERT INTO Bargains (BargainId, BargainName, TermStart, TermEnd) VALUES (91, 'TestBargain91', '2019-06-28', '2019-09-28')
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
Bargain を追加 / 更新するには、すべてのフィールドを指定します。
UPSERT INTO Bargains (BargainId, BargainName, TermStart, TermEnd) VALUES (8, 'TestBargain9', '2019-06-28', '2019-09-28')
複数のBargain を追加 / 更新するには、すべてのフィールドを指定します。
INSERT INTO Bargains#TEMP (bargainId, BargainName, TermStart, TermEnd) VALUES (1, 'TestBargain1', '2019-06-28', '2019-09-28') INSERT INTO Bargains#TEMP (bargainId, BargainName, TermStart, TermEnd) VALUES (3, 'TestBargain3', '2019-02-28', '2019-03-28') UPSERT INTO Bargains (bargainId, BargainName, TermStart, TermEnd) SELECT bargainId, BargainName, TermStart, TermEnd FROM Bargains#TEMP
スマレジは、BargainName、TermStart およびTermEnd カラムの更新を許容します。
UPDATE Bargains SET BargainName = 'Sample', TermStart = '2019-06-25', TermEnd = '2019-11-25' WHERE BargainId = 8
Bargains は、BargainId を指定することで削除できます。
DELETE FROM Bargains WHERE BargainId = 1
INSERT INTO Bargains#TEMP (BargainId) VALUES (90) INSERT INTO Bargains#TEMP (BargainId) VALUES (91) DELETE FROM Bargains WHERE EXISTS SELECT BargainId FROM Bargains#TEMP
Name | Type | ReadOnly | References | Description |
BargainId [KEY] | Integer | False |
セールID (PK) : 同一のセールIDがテーブルに存在する場合、対象のデータを更新。数字9桁以内。セールIDは必ず設定してください。 | |
BargainName | String | False |
セール名称 : セール名称。 | |
TermStart | Date | False |
適用開始日 : セールの開始日。(YYYYーMMーDD形式) | |
TermEnd | Date | False |
適用終了日 : セールの終了日。(YYYY-MM-DD形式) |
セール情報:セール店舗
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT StoreId FROM BargainStores WHERE BargainStoreId != 22 AND BargainId >= 23
BargainStore を追加するには、BargainId およびStoreId フィールドを指定します。
INSERT INTO BargainStores (BargainId, StoreId) VALUES (1, 1) INSERT INTO BargainStores (BargainStoreId, BargainId, StoreId) VALUES (5, 1, 1)
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
BargainStore を追加 / 更新するには、BargainId およびStoreId フィールドを指定します。
UPSERT INTO BargainStores (BargainStoreId, BargainId, StoreId) VALUES (4, 2, 1)
複数のBargainStore を追加 / 更新するには、BargainId およびStoreId フィールドを指定します。
INSERT INTO BargainStores#TEMP (BargainId, StoreId) VALUES (4, 1) INSERT INTO BargainStores#TEMP (BargainId, StoreId) VALUES (5, 1) UPSERT INTO BargainStores (BargainId, StoreId) SELECT BargainId, StoreId FROM BargainStores#TEMP
スマレジはBargainId およびStoreId カラムの更新を許容します。
UPDATE BargainStores SET BargainId = 3, StoreId = 3 WHERE BargainStoreId = 4
BargainStores は、BargainProductId を指定することで削除できます。
DELETE FROM BargainStores WHERE BargainStoreId = 4
INSERT INTO BargainStores#TEMP (BargainStoreId) VALUES (5) INSERT INTO BargainStores#TEMP (BargainStoreId) VALUES (6) DELETE FROM BargainStores WHERE EXISTS SELECT BargainStoreId FROM BargainStores#TEMP
Name | Type | ReadOnly | References | Description |
BargainStoreId [KEY] | Long | False |
セール店舗ID (PK) : 同一の商品IDがテーブルに存在する場合、対象のデータを更新。数字15桁以内。更新時、セール商品IDが未設定の場合自動採番します。 | |
BargainId | Integer | False |
Bargains.BargainId |
セールID : セールID。数字9桁以内。存在しないセールIDを指定するとエラー。 |
StoreId | Integer | False |
店舗ID : 店舗ID。数字9桁以内。存在しない店舗IDを指定するとエラー。※倉庫の店舗IDを指定するとエラー(ver.2.7.0で追加) |
部門情報:部門
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT CategoryName, CategoryCode FROM Categories ORDER BY CategoryCode
Category を追加するには、CategoryId、CategoryCode およびCategoryName フィールドを指定します。
INSERT INTO Categories (CategoryId, CategoryCode, CategoryName) VALUES (10, 'CategoryCode10', 'CategoryName10')
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
Category を追加 / 更新するには、CategoryId、CategoryCode およびCategoryName フィールドを指定します。
UPSERT INTO Categories (CategoryId, CategoryCode, CategoryName) VALUES (6, 'CategoryCode', 'CategoryName')
複数のCategory を追加 / 更新するには、CategoryId、CategoryCode およびCategoryName フィールドを指定します。
INSERT INTO Categories#TEMP (CategoryId, CategoryCode, CategoryName) VALUES (11, 'CategoryCode11', 'CategoryName11') INSERT INTO Categories#TEMP (CategoryId, CategoryCode, CategoryName) VALUES (12, 'CategoryCode12', 'CategoryName12') UPSERT INTO Categories (CategoryId, CategoryCode, CategoryName) SELECT CategoryId, CategoryCode, CategoryName FROM Categories#TEMP
スマレジは、CategoryCode、CategoryName、CategoryAbbr、CategoryGroupId、ParentCategoryId、DisplaySequence、DisplayFlag、PointNotApplicable、TaxFreeDivision、Color およびTag カラムのUPDATE を許容します。
UPDATE Categories SET CategoryCode = 'CatCode', CategoryName = 'Updated', CategoryAbbr = 'CatAbbr', CategoryGroupId = 2, ParentCategoryId = 1, DisplaySequence = 1, DisplayFlag = 0, PointNotApplicable = 1, TaxFreeDivision = 1, Tag = 'test' WHERE CategoryId = 13
Categories は、CategoryId を指定することで削除できます。
DELETE FROM Categories WHERE CategoryId = 2
INSERT INTO Categories#TEMP (CategoryId) VALUES (11) INSERT INTO Categories#TEMP (CategoryId) VALUES (12) DELETE FROM Categories WHERE EXISTS SELECT CategoryId FROM Categories#TEMP
Name | Type | ReadOnly | References | Description |
CategoryId [KEY] | Integer | False |
部門ID (PK) : 同一の部門IDがテーブルに存在する場合、対象のデータを更新。数字9桁以内。部門IDは必ず設定してください。 | |
CategoryCode | String | False |
部門コード : 半角英数記号20文字以内。部門コード | |
CategoryName | String | False |
部門名 : 85文字以内。部門名 | |
CategoryAbbr | String | False |
部門名略称 : 85文字以内。部門名略称 | |
CategoryGroupId | Integer | False |
部門グループ : 部門グループIDを設定してください。(ver.2.0.0で追加)存在しない部門グループIDを指定するとエラー。 | |
ParentCategoryId | Integer | False |
親部門 : 親部門IDを設定してください。(ver.2.0.0で追加)存在しない親部門IDを指定するとエラー。3階層まで親部門を設定することができます。 | |
Level | Integer | True |
階層レベル : 階層レベルは自動で設定されます。階層レベルは1?3になります。親部門が未設定の場合は1になります。 | |
DisplaySequence | Integer | False |
表示順 : 数字9桁以内。表示順 | |
DisplayFlag | Integer | False |
端末表示 : スマレジ端末に表示するか否かの判定。(ver.2.0.0で追加)未設定の場合1を設定。(0:表示しない、1:表示する) | |
PointNotApplicable | Integer | False |
ポイント対象 : ポイント対象にするか否かの設定。未設定の場合0を設定。(ver.2.0.0で追加)(0:ポイント対象、1:ポイント対象外) | |
TaxFreeDivision | Integer | False |
免税区分 : 免税区分の設定。未設定の場合0を設定。(ver.2.1.0で追加)(0:対象外、1:一般品、2:消耗品)免税機能を利用しない場合は「対象外」としてください「対象外」免税対象ではない商品「一般品」電化製品、服、着物、カバンなど「消耗品」酒、食品類、薬品類、化粧品類など※部門の免税区分よりも、商品の免税区分を優先します。(部門売りで適用されます。) | |
Color | String | False |
端末表示カラー : 端末に表示するカラー (HTMLカラーコード形式)(ver.2.1.0で追加)例) #000000 | |
Tag | String | False |
タグ : 85文字以内。複数ある場合は、カンマで区切り。 | |
InsDateTime | Datetime | True |
作成日時 : 登録時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
UpdDateTime | Datetime | True |
更新日時 : 登録時・更新時の日時。 (YYYY-MM-DD HH:MM:SS形式) |
会員情報:会員
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT CustomerCode, CustomerNo FROM Customers WHERE FirstName LIKE 'Na%'
Customer を追加するには、CustomerId、CustomerCode、FirstName、LastName、FirstKana、LastKana およびSex フィールドを指定します。
INSERT INTO Customers (CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana, Sex) VALUES (123, 'CustomerCode123', 'Name123', 'Surname123', 'KanaName123', 'KanaSurname123', '2')
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
Customer を追加 / 更新するには、CustomerId、CustomerCode、FirstName、LastName、FirstKana、LastKana およびSex フィールドを指定します。
UPSERT INTO Customers (CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana, Sex) VALUES (216, 'CustomerCode', 'Name', 'Surname', 'KanaName', 'KanaSurname', '2')
複数のCustomer を追加 / 更新するには、CustomerId、CustomerCode、FirstName、LastName、FirstKana、LastKana およびSex フィールドを指定します。
INSERT INTO Customers#TEMP (CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana, Sex) VALUES (123, 'CustomerCode123', 'Name123', 'Surname123', 'KanaName123', 'KanaSurname123', '2') INSERT INTO Customers#TEMP (CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana, Sex) VALUES (124, 'CustomerCode124', 'Name124', 'Surname124', 'KanaName124', 'KanaSurname124', '2') UPSERT INTO Customers (CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana, Sex) SELECT CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana, Sex FROM Customers#TEMP
スマレジは、すべての非キーカラムの更新を許容します。
UPDATE Customers SET CustomerCode = 'CustomerCode2', CustomerNo = 3 WHERE CustomerId = 216
Customers は、CustomerId を指定することで削除できます。
DELETE FROM Customers WHERE CustomerId = 2
INSERT INTO Customers#TEMP (CustomerId) VALUES (123) INSERT INTO Customers#TEMP (CustomerId) VALUES (124) DELETE FROM Customers WHERE EXISTS SELECT CategoryId FROM Customers#TEMP
Name | Type | ReadOnly | References | Description |
CustomerId [KEY] | Long | False |
会員ID (PK) : 数字10桁以内。 | |
CustomerCode | String | False |
会員コード : 半角英数記号20文字以内。ユニークキーとなる為重複不可。 | |
CustomerNo | String | False |
会員番号 : 半角英数記号20文字以内。※会員必須項目設定の設定内容が必須の場合、必須。 | |
Rank | String | False |
会員ランク : 汎用マスタの「会員ランク」で登録しているコードを設定してください。汎用マスタに登録されていないコードを設定するとエラーになります。 | |
StaffRank | String | False |
社員ランク : 汎用マスタの「社員ランク」で登録しているコードを設定してください。汎用マスタに登録されていないコードを設定するとエラーになります。 | |
LastName | String | False |
姓 : 85文字以内。 | |
FirstName | String | False |
名 : 85文字以内。 | |
LastKana | String | False |
姓カナ : 全角カナ85文字以内。(半角英数)※会員必須項目設定の設定内容が必須の場合、必須。 | |
FirstKana | String | False |
名カナ : 全角カナ85文字以内。(半角英数)※会員必須項目設定の設定内容が必須の場合、必須。 | |
PostCode | String | False |
郵便番号 : 半角英数記号10文字以内。※会員必須項目設定の設定内容が必須の場合、必須。 | |
Address | String | False |
住所 : 85文字以内 ハイフン付き。※会員必須項目設定の設定内容が必須の場合、必須。 | |
PhoneNumber | String | False |
電話番号 : 半角数字記号20文字以内 ハイフン付き。※会員必須項目設定の設定内容が必須の場合、必須。 | |
FaxNumber | String | False |
FAX番号 : 半角数字記号20文字以内 ハイフン付き。※会員必須項目設定の設定内容が必須の場合、必須。 | |
MobileNumber | String | False |
携帯電話番号 : 半角数字記号20文字以内 ハイフン付き。※会員必須項目設定の設定内容が必須の場合、必須。 | |
MailAddress | String | False |
メールアドレス : 半角英数記号255文字以内。※会員必須項目設定の設定内容が必須の場合、必須。 | |
MailAddress2 | String | False |
メールアドレス2 : 半角英数記号255文字以内。 | |
MailAddress3 | String | False |
メールアドレス3 : 半角英数記号255文字以内。 | |
CompanyName | String | False |
会社名 : 85文字以内。 | |
DepartmentName | String | False |
部署名 : 85文字以内。 | |
ManagerialPosition | String | False |
役職 : 85文字以内。 | |
Sex | Integer | False |
性別 : 数字1桁。(0:不明、1:男、2:女) | |
BirthDate | Date | False |
生年月日 : YYYY-MM-DD形式。※会員必須項目設定の設定内容が必須の場合、必須。 | |
Mile | Integer | False |
マイル : 9桁以内。(ver.2.3.0で追加) | |
Point | Integer | False |
ポイント : 9桁以内。 | |
PointExpireDate | Date | False |
ポイント失効予定日 : ポイントが失効する日を設定。YYYY-MM-DD形式。※会員必須項目設定の設定内容が必須の場合、必須。 | |
LastComeDateTime | Datetime | False |
最終来店日時 : YYYY-MM-DD HH:MM:SS形式。 | |
EntryDate | Date | False |
入会日 : YYYY-MM-DD形式。※会員必須項目設定の設定内容が必須の場合、必須。 | |
LeaveDate | Date | False |
退会日 : YYYY-MM-DD形式。会員状態区分が利用可以外の場合、設定してください。 | |
PointGivingUnitPrice | Integer | False |
ポイント付与単位(金額) : ポイント付与の設定 n円をnポイントの「n円」の部分(設定範囲:1円?99999円)(例:10円ごとに2ポイントの場合、10円) | |
PointGivingUnit | Decimal | False |
ポイント付与単位(ポイント) : ポイント付与の設定 n円をnポイントの「nポイント」の部分(設定範囲:0.00ポイント?99999.99ポイント)(例:10円ごとに0.2ポイントの場合、0.2ポイント) | |
PinCode | String | False |
PINコード : 自由な文字列PINコードなど会員を識別する任意の文字列を設定してください。※会員必須項目設定の設定内容が必須の場合、必須。 | |
PassportNo | String | False |
旅券番号 : パスポート番号。会員販売時、免税帳票の「旅券番号」に表示します。半角英数記号32桁 | |
Nationality | String | False |
国籍 : 国籍。会員販売時、免税帳票の「国籍」に表示します。85文字以内 | |
AlphabetName | String | False |
アルファベット氏名 : アルファベット氏名。会員販売時、免税帳票の「購入者氏名」に表示します。85文字以内 | |
MailReceiveFlag | Integer | False |
案内メール受取許可フラグ : 数字1桁。(0:拒否、1:許可)未設定の場合0を設定。 | |
Note | String | False |
備考 : 1,000文字以内。 | |
Note2 | String | False |
備考2 : 1,000文字以内。 | |
FavoriteList | String | False |
お気に入りリスト : 1,000文字以内。(スマレジAPIからのみ登録可能。商品コードをカンマ区切りで | |
BrowsingList | String | False |
閲覧履歴リスト : 1,000文字以内。(スマレジAPIからのみ登録可能。商品コードをカンマ区切りで | |
Status | Integer | False |
会員状態区分 : 数字1桁。(0:利用可、1:利用停止、2:紛失、3:退会、4:名寄せ)未設定の場合0を設定。 | |
StoreId | Integer | False |
対象店舗ID : 数字5桁以内。 | |
InsDateTime | Datetime | False |
作成日時 : 登録時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
UpdDateTime | Datetime | False |
更新日時 : 登録時・更新時の日時。 (YYYY-MM-DD HH:MM:SS形式) |
ロス情報:ロス
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT Division FROM Losses ORDER BY LossId DESC SELECT * FROM Losses WHERE LossId != 5
Loss を追加するには、StoreId、Division、Memo、IdentificationNo、Token、LossDatetime およびDetailAggregate を指定します。
テンポラリテーブルの使用
INSERT INTO LossDetails#TEMP (productCode, color, productId, size, quantity) VALUES (4, 'White', 6, 'S', 2) INSERT INTO Losses (StoreId, Division, Memo, IdentificationNo, Token, LossDatetime, DetailAggregate) VALUES (1, '01', 'Memo', 'loss32', '764956r6f694344r3r332465', '2020-01-17 02:05:45', 'LossDetails#TEMP')
集計の使用
INSERT INTO Losses (StoreId, Division, Memo, IdentificationNo, LossDatetime, DetailAggregate) VALUES (1, '02', 'Memo', 'loss32', '2020-01-17 02:05:45', ' { "table_name": "LossDetail", "rows": [ { "productCode": "2000001000045", "color": "White", "productId": "4", "size": "S", "quantity": "2", } ] } ')
アップサートは、このテーブルではサポートされていません。
スマレジはDivision、Memo、LossDatetime、IdentificationNo、Token およびDetailAggregate カラムのUPDATE を許容します。
UPDATE Losses SET Memo = 'UpdatedMemo5', Division = '02' WHERE LossId = 1DetailAggregate カラムのUPDATE クエリの変更は、LossDetails ビューに反映されます。
テンポラリテーブルの使用
INSERT INTO LossDetails#TEMP (LossId, productCode, color, productId, size, quantity) VALUES (21, 6, 'White', 5, 'S', 2) INSERT INTO LossDetails#TEMP (LossId, productCode, color, productId, size, quantity) VALUES (21, 5, 'White', 7, 'S', 2) UPDATE Losses SET DetailAggregate = 'LossDetails#TEMP' WHERE LossId = 21
集計の使用
UPDATE Losses set DetailAggregate = ' { "table_name": "LossDetail", "rows": [ { "lossId": "21", "productCode": "2000001000045", "color": "White", "productId": "9", "size": "S", "quantity": "2", } ] } ' WHERE LossId = 21
Losses は、ProductId を指定することで削除できます。
DELETE FROM Losses WHERE LossId = 12
INSERT INTO Losses#TEMP (LossId) VALUES (11) INSERT INTO Losses#TEMP (LossId) VALUES (12) INSERT INTO Losses#TEMP (LossId) VALUES (13) INSERT INTO Losses#TEMP (LossId) VALUES (22) DELETE FROM Losses WHERE EXISTS SELECT LossId FROM Losses#TEMP
Name | Type | ReadOnly | References | Description |
LossId [KEY] | Integer | False |
ロスID (PK) : ロス毎に付与するID。【自動更新】自動採番登録時不要。更新、削除必須。 | |
StoreId | Integer | True |
Stores.StoreId |
店舗ID : 数字9桁以内。変更不可のため、更新時に登録内容と異なる日時が指定するとエラー。 |
Division | String | False |
ロス区分 : ロス区分を設定。01:廃棄、02:盗難、99:その他 | |
Memo | String | False |
メモ : 1000文字以内。ロス理由などを設定。 | |
LossDatetime | Datetime | False |
ロス発生日時 : ロスの発生日時を設定。(YYYY-MM-DD HH:MM:SS形式)登録時必須。変更不可のため、更新時に登録内容と異なる日時が指定するとエラー。 | |
IdentificationNo | String | False |
識別番号 : ロス情報を管理するための任意の文字列を設定出来る項目。 | |
Modified | Datetime | True |
更新日時 : ロスの更新日時。 (YYYY-MM-DD HH:MM:SS形式) | |
Token | String | False |
トークン : リクエストを一意に識別するためのトークン文字列を設定。重複するトークン文字列が指定された場合、スルーします。設定例:リクエスト日時(YYYYMMDDHHMMSS)+2桁の連番 | |
DetailAggregate | String | False |
A JSON aggregate of details associated with the loss. |
商品情報:在庫引当商品
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT ReservationAmount FROM ProductInventoryReservations SELECT * FROM ProductInventoryReservations WHERE ReservationProductId <= 1005;
ProductInventoryReservation を追加するには、すべてのフィールドを指定します。
INSERT INTO ProductInventoryReservations (ProductId, ReservationProductId, ReservationAmount) VALUES (1005, 4, 5)
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
ProductInventoryReservation を追加 / 更新するには、すべてのフィールドを指定します。
UPSERT INTO ProductInventoryReservations (ProductId, ReservationProductId, ReservationAmount) VALUES (1005, 4, 5)
複数のProductInventoryReservation を追加 / 更新するには、すべてのフィールドを指定します。
INSERT INTO ProductInventoryReservations#TEMP (ProductId, ReservationProductId, ReservationAmount) VALUES (7, 4, 5) INSERT INTO ProductInventoryReservations#TEMP (ProductId, ReservationProductId, ReservationAmount) VALUES (9, 4, 5) UPSERT INTO ProductInventoryReservations (ProductId, ReservationProductId, ReservationAmount) SELECT ProductId, ReservationProductId, ReservationAmount FROM ProductInventoryReservations#TEMP
スマレジはReservationAmount カラムの更新を許容します。
UPDATE ProductInventoryReservations SET ReservationAmount = 2 WHERE ProductId = 1005 AND ReservationProductId = 15
ProductInventoryReservations は、ProductId およびReservationProductId を指定することで削除できます。
DELETE FROM ProductInventoryReservations WHERE ProductId = 1005 AND ReservationProductId = 15
INSERT INTO ProductInventoryReservations#TEMP (ProductId, ReservationProductId) VALUES (9, 4) INSERT INTO ProductInventoryReservations#TEMP (ProductId, ReservationProductId) VALUES (4, 4) DELETE FROM ProductInventoryReservations WHERE EXISTS SELECT ProductId, ReservationProductId FROM ProductInventoryReservations#TEMP
Name | Type | ReadOnly | References | Description |
ProductId [KEY] | Long | False |
Products.ProductId |
商品ID (PK) : 数字15桁以内。商品IDは必ず設定してください。 |
ReservationProductId [KEY] | Long | False |
引当商品商品ID (PK) : 数字15桁以内。引当商品商品IDは必ず設定してください。 | |
ReservationAmount | Integer | False |
引当数 : 数字3桁以内。引当数は必ず1以上で設定してください。 |
商品情報:商品価格
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProductPrices WHERE ProductId = 45345 SELECT ProductId, StoreId, Price FROM ProductPrices
ProductPrice を追加するには、ProductId、StoreId、PriceDivision、Price およびStartDate フィールドを指定します。
INSERT INTO ProductPrices (productId, storeId, priceDivision, price, StartDate) VALUES (864684, '1', 1, 100, '2019-09-30')
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
ProductPrice を追加 / 更新するには、ProductId、StoreId、PriceDivision、Price およびStartDate フィールドを指定します。
UPSERT INTO ProductPrices (ProductId, StoreId, PriceDivision, Price, StartDate) VALUES (45345, 1, 2, 550, '2019/02/02')
複数のProductPrice を追加 / 更新するには、ProductId、StoreId、PriceDivision、Price およびStartDate フィールドを指定します。
INSERT INTO ProductPrices#TEMP (productId, storeId, priceDivision, price, StartDate) VALUES (45, 1, 2, 550, '2019/02/02') INSERT INTO ProductPrices#TEMP (productId, storeId, priceDivision, price, StartDate) VALUES (56, 1, 2, 350, '2019/02/06') UPSERT INTO ProductPrices (productId, storeId, priceDivision, price, StartDate) SELECT productId, storeId, priceDivision, price, StartDate FROM ProductPrices#TEMP
スマレジはPriceDivision、StartDate、EndDate およびPrice カラムの更新を許容します。
UPDATE ProductPrices SET PriceDivision = 1, EndDate = '2019-12-02', StartDate = '2019/12/02' WHERE ProductId = 45345
ProductPrices は、ProductId およびStoreId を指定することで削除できます。
DELETE FROM ProductPrices WHERE ProductId = 18 AND StoreId = 1
INSERT INTO ProductPrices#TEMP (productId) VALUES (45) INSERT INTO ProductPrices#TEMP (productId) VALUES (56) DELETE FROM ProductPrices WHERE EXISTS SELECT ProductId FROM ProductPrices#TEMP
Name | Type | ReadOnly | References | Description |
ProductId [KEY] | Long | False |
Products.ProductId |
商品ID (PK) : 同一の商品IDがテーブルに存在する場合、対象のデータを更新。数字15桁以内。商品IDは必ず設定してください。 |
StoreId [KEY] | String | False |
Stores.StoreId |
店舗ID (PK) : 数字9桁以内。全店の場合「_ALL_」を設定(内部で-1に置換える) |
PriceDivision [KEY] | Integer | False |
価格区分 (PK) : 1:商品単価、2:会員価格 | |
StartDate [KEY] | Date | False |
適用開始日 (PK) : 適用開始日 (YYYY-MM-DD形式)※適用期間が重複する場合は、適用開始日が新しい日を優先します。 | |
EndDate | Date | False |
適用終了日 : 適用終了日 (YYYY-MM-DD形式)※未設定の場合、有効期限なしとして適用されます。 | |
Price | Decimal | False |
商品単価 : 商品単価 数字8桁以内 | |
InsDateTime | Datetime | True |
作成日時 : 登録時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
UpdDateTime | Datetime | True |
更新日時 : 登録時・更新時の日時。 (YYYY-MM-DD HH:MM:SS形式) |
商品情報:商品予備項目ラベル
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT Label FROM ProductReserveItemLabels SELECT * FROM ProductReserveItemLabels WHERE No != 2
ProductReserveItemLabel を追加するには、すべてのフィールドを指定します。
INSERT INTO ProductReserveItemLabels (No, Label) VALUES (84, 1)
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
ProductReserveItemLabel を追加 / 更新するには、両方のフィールドを指定します。
UPSERT INTO ProductReserveItemLabels (No, Label) VALUES (84, 1)
複数のProductReserveItemLabel を追加 / 更新するには、すべてのフィールドを指定します。
INSERT INTO ProductReserveItemLabels#TEMP (No, Label) VALUES (84, 1) INSERT INTO ProductReserveItemLabels#TEMP (No, Label) VALUES (83, 1) UPSERT INTO ProductReserveItemLabels (No, Label) SELECT No, Label FROM ProductReserveItemLabels#TEMP
スマレジはNo およびLabel カラムの更新を許容します。
UPDATE ProductReserveItemLabels SET Label = 2 WHERE No = 84
ProductReserveItemLabels は、No を指定することで削除できます。
DELETE FROM ProductReserveItemLabels WHERE No = 4
INSERT INTO ProductReserveItemLabels#TEMP (No) VALUES (83) INSERT INTO ProductReserveItemLabels#TEMP (No) VALUES (84) DELETE FROM ProductReserveItemLabels WHERE EXISTS SELECT No FROM ProductReserveItemLabels#TEMP
Name | Type | ReadOnly | References | Description |
No [KEY] | Integer | False |
項目番号 (PK) : 1-99 の項目番号。 | |
Label | String | False |
ラベル : 85文字以内。予備項目の値。 |
商品情報:商品予備項目
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT Value FROM ProductReserveItems SELECT * FROM ProductReserveItems WHERE No > 5
ProductReserveItem を追加するには、すべてのフィールドを指定します。
INSERT INTO ProductReserveItems (ProductId, No, Value) VALUES (45345, 2, 1)
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
ProductReserveItemを追加 / 更新するには、すべてのフィールドを指定します。
UPSERT INTO ProductReserveItems (ProductId, No, Value) VALUES (45345, 2, 1)
複数のProductReserveItem を追加 / 更新するには、すべてのフィールドを指定します。
INSERT INTO ProductReserveItems#TEMP (ProductId, No, Value) VALUES (45345, 2, 1) INSERT INTO ProductReserveItems#TEMP (ProductId, No, Value) VALUES (45347, 2, 1) UPSERT INTO ProductReserveItems (ProductId, No, Value) SELECT ProductId, No, Value FROM ProductReserveItems#TEMP
スマレジはValue カラムの更新を許容します。
UPDATE ProductReserveItems SET Value = 0 WHERE ProductId = 7 AND No = 2
ProductReserveItems は、ProductId およびNo を指定することで削除できます。
DELETE FROM ProductReserveItems WHERE ProductId = 7 AND No = 4
INSERT INTO ProductReserveItems#TEMP (ProductId, No) VALUES (45345, 2) INSERT INTO ProductReserveItems#TEMP (ProductId, No) VALUES (45346, 2) DELETE FROM ProductReserveItems WHERE EXISTS SELECT ProductId, NO FROM ProductReserveItems#TEMP
Name | Type | ReadOnly | References | Description |
ProductId [KEY] | Long | False |
Products.ProductId |
商品ID (PK) : 同一の商品IDがテーブルに存在する場合、対象のデータを更新。数字15桁以内。商品IDは必ず設定してください。 |
No [KEY] | Integer | False |
項目番号 (PK) : 1-99 の項目番号。 | |
Value | String | False |
値 : 85文字以内。予備項目の値。 |
商品情報:商品
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Products WHERE updDateTime = '2019-08-29 17:30:51.0' SELECT * FROM Products WHERE ProductId = 2 SELECT * FROM Products WHERE ProductName LIKE '%S%' AND CategoryId > 3 ORDER BY ProductId DESC
Product を追加するには、ProductId、categoryId、productCode、ProductName、taxDivision、price、cost およびtaxFreeDivision フィールドを指定します。
INSERT INTO Products (ProductId, categoryId, productCode, ProductName, taxDivision, price, cost, taxFreeDivision) VALUES (68899, 3, 4453452, '58432InsertedProduct', 0, 500, 450, 0)
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
Product を追加 / 更新するには、ProductId、categoryId、productCode、ProductName、taxDivision、price、cost およびtaxFreeDivision フィールドを指定します。
UPSERT INTO Products (ProductId, categoryId, productCode, ProductName, price) VALUES (45346, 3, 44534520, '58432InsertedProduct', 500)
複数のProduct を追加 / 更新するには、ProductId、categoryId、productCode、ProductName、taxDivision、price、cost およびtaxFreeDivision フィールドを指定します。
INSERT INTO Products#TEMP (ProductId, categoryId, productCode, ProductName, taxDivision, price, cost, taxFreeDivision) VALUES (78899, 3, 4453456, '58434InsertedProduct', 0, 500, 450, 0) INSERT INTO Products#TEMP (ProductId, categoryId, productCode, ProductName, taxDivision, price, cost, taxFreeDivision) VALUES (77899, 3, 4453455, '58433InsertedProduct', 0, 500, 450, 0) UPSERT INTO Products (ProductId, categoryId, productCode, ProductName, taxDivision, price, cost, taxFreeDivision) SELECT ProductId, categoryId, productCode, ProductName, taxDivision, price, cost, taxFreeDivision FROM Products#TEMP
スマレジはCOL1 およびCOL2 カラムの更新を許容します。
UPDATE Products SET CategoryId = '2', ProductCode = '2343', ProductKana = 'Kana', TaxDivision = '2', ProductPriceDivision = '2', Price = 455, CustomerPrice = 505, Cost = 444, Attribute = 'Attr', Description = 'Desc', CatchCopy = 'Copy', Size = 'XL', Color = 'Grey', Tag = 'tag', GroupCode = '43' WHERE ProductId = '45345'
Products は、ProductId を指定することで削除できます。
DELETE FROM Products WHERE ProductId = 5843055
INSERT INTO Products#TEMP (ProductId) VALUES (68899) INSERT INTO Products#TEMP (ProductId) VALUES (77899) INSERT INTO Products#TEMP (ProductId) VALUES (78899) DELETE FROM Products WHERE EXISTS SELECT ProductId FROM Products#TEMP
Name | Type | ReadOnly | References | Description |
ProductId [KEY] | Long | False |
商品ID (PK) : 同一の商品IDがテーブルに存在する場合、対象のデータを更新。数字15桁以内。商品IDは必ず設定してください。 | |
CategoryId | Integer | False |
Categories.CategoryId |
部門ID : 部門ID。数字9桁以内。存在しない部門IDを指定するとエラー。 |
ProductCode | String | False |
商品コード : 半角英数記号20文字以内。重複する場合エラー。商品コード未設定で商品登録を行う場合、商品コード自動採番ONの設定になっていると自動採番された商品コードで登録。 | |
ProductName | String | False |
商品名 : 85文字以内。 | |
ProductKana | String | False |
商品カナ : 全角カナ85文字以内。 | |
TaxDivision | String | False |
税区分 : 商品価格の消費税の扱いに関する設定。未設定の場合0を設定。(0:内税、1:外税、2:非課税) | |
ProductPriceDivision | String | False |
商品価格区分 : 商品をオープン価格販売するかどうか設定。未設定の場合1を設定。(1:通常価格、2:オープン価格)(ver.2.10.0で追加) | |
Price | Decimal | False |
商品単価 : 数字8桁以内。販売価格を設定。 | |
CustomerPrice | Decimal | False |
会員価格 : 数字8桁以内。会員価格を設定。 | |
Cost | Decimal | False |
原価 : 数字8桁以内(少数5桁まで)。未設定の場合0を設定。 | |
Attribute | String | False |
規格 : 1000文字以内。商品のカラー・サイズなどを設定。 | |
Description | String | False |
説明 : 1000文字以内。商品説明などを設定。 | |
CatchCopy | String | False |
キャッチコピー : 1000文字以内。商品のキャッチコピーなどを設定。 | |
Size | String | False |
サイズ : 85文字以内。 | |
Color | String | False |
カラー : 85文字以内。 | |
Tag | String | False |
タグ : 85文字以内。複数ある場合は、カンマで区切り。 | |
GroupCode | String | False |
グループコード : 関連商品として紐付ける為のグループコードを設定。例えば、AとBの商品に同じグループコード001を設定すると、AとBは関連商品となります。サイズ、カラーが異なる場合などに使用してください。 | |
Url | String | False |
URL : 255文字以内。スマレジ端末でWEBページを表示したい場合設定。 | |
PrintReceiptProductName | String | False | ||
DisplaySequence | Integer | False |
表示順 : 数字9桁以内。表示順 | |
SalesDivision | String | False |
売上区分 : 取引時に売上計上するか否かの設定。未設定の場合0を設定。(0:売上対象、1:売上対象外) | |
StockControlDivision | String | False |
在庫管理区分 : 棚卸対象商品とするか否かの設定。未設定の場合0を設定。(0:在庫管理対象、1:在庫管理対象外) | |
DisplayFlag | String | False |
表示フラグ : スマレジ端末に表示するか否かの判定。未設定の場合1を設定。(0:表示しない、1:表示する) | |
Division | String | False |
商品区分 : 商品の種類を設定。未設定の場合0を設定。(0:通常商品、1:回数券(*1)、2:オプション商品) | |
ProductOptionGroupId | Integer | False |
オプショングループID : 使用するオプショングループのIDを設定。未設定の場合は未使用。 | |
PointNotApplicable | String | False |
ポイント対象 : ポイント対象にするか否かの設定。未設定の場合0を設定。(0:ポイント対象、1:ポイント対象外)(ver.2.0.0で追加) | |
TaxFreeDivision | String | False |
免税区分 : 免税区分の設定。未設定の場合0を設定。(ver.2.1.0で追加)(0:対象外、1:一般品、2:消耗品)免税機能を利用しない場合は「対象外」としてください「対象外」免税対象ではない商品「一般品」電化製品、服、着物、カバンなど「消耗品」酒、食品類、薬品類、化粧品類など※部門の免税区分よりも、商品の免税区分を優先します。(部門売りで適用されます。) | |
CalcDiscount | String | False | ||
SupplierProductNo | String | False |
品番 : 85文字以内。 | |
StaffDiscountRate | Integer | False |
社員販売割引率 : 数字3桁以内。社員販売時の割引率を設定。 | |
UseCategoryReduceTax | Integer | False | ||
ReduceTaxId | Integer | False | ||
ReduceTaxPrice | Decimal | False | ||
ReduceTaxCustomerPrice | Decimal | False | ||
AppStartDateTime | Datetime | False |
適用開始日時 : 商品が端末に適用される日時を設定。未設定の場合は未使用。(ver.2.7.0で追加)(YYYY-MM-DD HH:MM:SS形式) | |
InsDateTime | Datetime | False |
作成日時 : 登録時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
UpdDateTime | Datetime | False |
更新日時 : 登録時・更新時の日時。 (YYYY-MM-DD HH:MM:SS形式) |
商品情報:商品取扱店舗
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ProductStores WHERE AssignDivision > 0
ProductStore を追加するには、すべてのフィールドを指定します。
INSERT INTO ProductStores (ProductId, StoreId, AssignDivision) VALUES (45345, 1, 1)
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
ProductStore を追加 / 更新するには、すべてのフィールドを指定します。
UPSERT INTO ProductStores (ProductId, StoreId, AssignDivision) VALUES (45345, 1, 1)
複数のProductStore を追加 / 更新するには、すべてのフィールドを指定します。
INSERT INTO ProductStores#TEMP (ProductId, StoreId, AssignDivision) VALUES (47, 1, 1) INSERT INTO ProductStores#TEMP (ProductId, StoreId, AssignDivision) VALUES (48, 1, 1) UPSERT INTO ProductStores (ProductId, StoreId, AssignDivision) SELECT ProductId, StoreId, AssignDivision FROM ProductStores#TEMP
スマレジはAssignDivision カラムのUPDATE を許容します。
UPDATE ProductStores SET AssignDivision = 0 WHERE ProductId = 84 AND StoreId = 2
削除はこのテーブルではサポートされていません。
Name | Type | ReadOnly | References | Description |
ProductId [KEY] | Long | False |
Products.ProductId |
商品ID (PK) : 数字15桁以内。商品IDは必ず設定してください。 |
StoreId [KEY] | Integer | False |
Stores.StoreId |
店舗ID (PK) : 数字9桁以内。 |
AssignDivision | Integer | False |
取扱区分 : 0:販売する/1:販売しない |
入庫検品:入庫
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Receivings WHERE ReceivingId = 3 SELECT ReceivingId, ShippingStoreId, Memo FROM Receivings ORDER BY ReceivingId
挿入は、このテーブルではサポートされていません。
アップサートは、このテーブルではサポートされていません。
スマレジはShippingId、ShippingStoreId、ReceivingStoreId、ReceivingDate、Memo、Status、IdentificationNo、Token およびDetailAggregate カラムの更新を許容します。
UPDATE Receivings SET Memo = 'ChangedMemo' WHERE ReceivingId = 1DetailAggregate カラムの更新クエリの変更は、ReceivingDetails ビューに反映されます。
テンポラリテーブルの使用
INSERT INTO ReceivingDetails#TEMP (ReceivingId, ProductId, InspectionQuantity, StockoutQuantity, StockoutReason, InspectionDate) VALUES (14, 8, 3, 1, 'Memo', '2019-09-28') INSERT INTO ReceivingDetails#TEMP (ReceivingId, ProductId, InspectionQuantity, StockoutQuantity, StockoutReason, InspectionDate) VALUES (14, 9, 43, 2, 'Memo', '2019-09-28') UPDATE Receivings SET ReceivingDate = '2019-09-28', Memo = 'ChangedMemo', DetailAggregate = 'ReceivingDetails#TEMP' WHERE ReceivingId = 14
集計の使用
UPDATE Receivings SET DetailAggregate = '{ "table_name": "ReceivingDetail", "rows": [ { "receivingId": "14", "productId": "17", "inspectionQuantity": "33", } ] } ' WHERE ReceivingId = 14
削除はこのテーブルではサポートされていません。
Name | Type | ReadOnly | References | Description |
ReceivingId [KEY] | Integer | False |
入庫ID (PK) : 入庫毎に付与するID。 | |
ShippingId | Integer | False |
Shippings.ShippingId |
出庫ID : 数字10桁以内。 |
ShippingStoreId | Integer | False |
出庫店舗ID : 数字9桁以内。 | |
ReceivingStoreId | Integer | False |
入庫店舗ID : 数字9桁以内。 | |
ReceivingDate | Date | False |
入庫日 : 入庫日を設定。(YYYY-MM-DD形式)指定しない場合、更新日を設定。 | |
Memo | String | False |
入庫/出庫メモ : 1000文字以内。 | |
Status | Integer | False |
状態 : 検品状況によって自動更新する。0:未入庫、1:検品中、2:入庫完了 | |
IdentificationNo | String | False |
識別番号 : 出庫/入庫情報を管理するための任意の文字列を設定出来る項目。 | |
Modified | Datetime | True |
更新日時 : 入庫の更新日時。 (YYYY-MM-DD HH:MM:SS形式) | |
Token | String | False |
トークン : リクエストを一意に識別するためのトークン文字列を設定。重複するトークン文字列が指定された場合、スルーします。設定例:リクエスト日時(YYYYMMDDHHMMSS)+2桁の連番 | |
DetailAggregate | String | False |
A JSON aggregate of details associated with the receiving. |
出荷情報:出荷
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Shipments WHERE ShipmentId = 5 SELECT RecipientId, RecipientName FROM Shipments
Shipment を追加するには、ShipmentStoreId、RecipientType、RecipientName、ShipmentDivision、ShipmentDate、Status およびDetailAggregate フィールドを指定します。
テンポラリテーブルの使用:
INSERT INTO ShipmentDetails#TEMP (productId, quantity) VALUES (84, 1) INSERT INTO ShipmentDetails#TEMP (productId, quantity) VALUES (83, 1) INSERT INTO Shipments (ShipmentStoreId, RecipientType, RecipientName, ShipmentDivision, ShipmentDate, Status, DetailAggregate) VALUES (1, 3, 'TestName3113', 2, '2057-07-20', 0, 'ShipmentDetails#TEMP')
集計の使用:
INSERT INTO Shipments (ShipmentStoreId, RecipientType, RecipientName, ShipmentDivision, ShipmentDate, Status, DetailAggregate) VALUES (1, 3, 'TestName3113', 2, '2057-07-20', 0, ' { "table_name": "ShipmentDetail", "rows": [ { "productId": "65", "quantity": "3" } ] } ')
アップサートは、このテーブルではサポートされていません。
スマレジはRecipientType、RecipientId、RecipientName、ShipmentDivision、ShipmentDate、Status、IdentificationNo、Token およびDetailAggregate カラムの更新を許容します。
UPDATE Shipments SET IdentificationNo = '333543' WHERE ShipmentId = 5DetailAggregate カラムの更新クエリの変更は、ShipmentDetails ビューに反映されます。
テンポラリテーブルの使用
INSERT INTO ShipmentDetails#TEMP (ShipmentId, productId, quantity) VALUES (9, 7, 1) INSERT INTO ShipmentDetails#TEMP (ShipmentId, productId, quantity) VALUES (9, 8, 1) UPDATE Shipments SET DetailAggregate = 'ShipmentDetails#TEMP' WHERE ShipmentId = 9
集計の使用
UPDATE Shipments SET DetailAggregate = ' { "table_name": "ShipmentDetail", "rows": [ { "shipmentId": "9", "productId": "7", "quantity": "1" } ] } ' WHERE ShipmentId = 21
Shipments は、ShipmentId を指定することで削除できます。
DELETE FROM Shipments WHERE ShipmentId = 4
INSERT INTO Shipments#TEMP (ShipmentId) VALUES (2) INSERT INTO Shipments#TEMP (ShipmentId) VALUES (3) DELETE FROM Shipments WHERE EXISTS SELECT ShipmentId FROM Shipments#TEMP
Name | Type | ReadOnly | References | Description |
ShipmentId [KEY] | Integer | False |
出荷ID (PK) : 出荷毎に付与するID。【自動更新】自動採番更新、削除必須。 | |
ShipmentStoreId | Integer | False |
出荷店舗ID : 数字9桁以内。 | |
RecipientType | Integer | False |
受取先タイプ : 受取先タイプを設定。1:仕入先、3:その他 | |
RecipientId | Integer | False |
受取先ID : 数字10文字以内。受取先タイプに仕入先を指定する場合、仕入先IDを設定。存在しない仕入先を指定するとエラー。受取先タイプに仕入先を設定した場合、値を未設定にするとエラー。受取先タイプに仕入先以外を設定した場合、値を設定するとエラー。 | |
RecipientName | String | False |
受取先名 : 85文字以内。受取先タイプにその他を指定する場合、受取先名を設定。受取先タイプにその他を設定した場合、値を未設定にするとエラー。受取先タイプにその他以外を設定した場合、値を設定するとエラー。 | |
ShipmentDivision | String | False |
出荷区分 : 出荷区分を設定。0:出荷、1:返品、2:販促品 | |
ShipmentDate | Date | False |
出荷日 : 出荷日を設定。(YYYY-MM-DD形式) | |
Memo | String | False | ||
Status | Integer | False |
状況 : 状況を設定。0:未出荷、2:出荷完了 | |
ApprovalStatus | Integer | False | ||
ApprovalDateTime | Datetime | True | ||
IdentificationNo | String | False |
識別番号 : 出荷情報を管理するための任意の文字列を設定出来る項目。 | |
Modified | Datetime | True |
更新日時 : 出荷の更新日時。 (YYYY-MM-DD HH:MM:SS形式) | |
Token | String | False |
トークン : リクエストを一意に識別するためのトークン文字列を設定。重複するトークン文字列が指定された場合、スルーします。設定例:リクエスト日時(YYYYMMDDHHMMSS)+2桁の連番 | |
DetailAggregate | String | False |
A JSON aggregate of details associated with the shipment. |
出庫情報:出庫
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Shippings WHERE Status != 0 SELECT ShippingId, ShippingStoreId, StorageStoreId FROM Shippings WHERE ShippingId <= 4
Shipping を追加するには、StorageStoreId、ShippingStoreId、Status、ShippingDate、StorageDesiredDate およびDetailAggregate フィールドを指定します。
テンポラリテーブルの使用:
INSERT INTO ShippingDetails#TEMP (productId, requestQuantity) VALUES (8, 3) INSERT INTO Shippings (StorageStoreId, ShippingStoreId, Status, ShippingDate, StorageDesiredDate, DetailAggregate) VALUES (1, 2, 0, '2019/10/10', '2019/10/10', 'ShippingDetails#TEMP')
集計の使用:
INSERT INTO Shippings (StorageStoreId, ShippingStoreId, Status, Memo, ShippingDate, StorageExpectedDateFrom, StorageDesiredDate, DetailAggregate) VALUES (1, 2, 0, 'Changed', '2019/10/10', '2019/10/10', '2019/10/10', ' { "table_name": "ShippingDetail", "rows": [ { "productId": "8", "productName": "ProdName", "quantity": "3", "requestQuantity": "1" } ] }')
アップサートは、このテーブルではサポートされていません。
スマレジはShippingStoreId、StorageStoreId、StorageExpectedDateFrom、StorageExpectedDateTo、ShippingDate StorageDesiredDate、Memo、Status、ModificationRequestStatus、ModificationRequestDateTime、ModificationRequestCheckedDateTime、IdentificationNo、Token およびDetailAggregate カラムの更新を許容します。
UPDATE Shippings SET Memo = 'UpdatedMemo', status = 1, storageExpectedDateFrom = '2019/02/02', modificationRequestStatus = 1, storageExpectedDateTo = '2019/02/02' WHERE ShippingId = 9
Shippings は、ShippingId を指定することで削除できます。
DELETE FROM Shippings WHERE ShippingId = 6
INSERT INTO Shippings#TEMP (ShippingId) VALUES (3) INSERT INTO Shippings#TEMP (ShippingId) VALUES (4) INSERT INTO Shippings#TEMP (ShippingId) VALUES (5) DELETE FROM Shippings WHERE EXISTS SELECT ShippingId FROM Shippings#TEMP
Name | Type | ReadOnly | References | Description |
ShippingId [KEY] | Integer | False |
出庫ID (PK) : 出庫毎に付与するID。【自動更新】自動採番状態が未出庫、未入庫のもののみ削除可。状態が未出庫、未入庫のもの以外を削除しようとした場合エラー。※更新は、未出庫、未入庫、出庫修正依頼ありのもののみ可能。 | |
ShippingStoreId | Integer | False |
出庫店舗ID : 数字9文字以内。登録時必須。存在しない店舗IDを指定するとエラー。変更不可のため、更新時に登録内容と異なる日時が指定するとエラー。 | |
ReceivingStoreId | Integer | False | ||
ReceivingExpectedDateFrom | Date | False | ||
ReceivingExpectedDateTo | Date | False | ||
ShippingDate | Date | False |
出庫日 : 出庫日を設定。(YYYY-MM-DD形式) | |
ReceivingDesiredDate | Date | False | ||
Memo | String | False |
入庫/出庫メモ : 1000文字以内。 | |
Status | Integer | False |
状態 : 状況を指定する。0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了登録時は未出庫、未入庫のみ指定可能。更新時は未出庫のものにかぎり、未出庫、未入庫のみ指定可能。上記以外の状況の場合は更新不可。 | |
ApprovalStatus | Integer | False | ||
ApprovalDateTime | Datetime | True | ||
ModificationRequestStatus | Integer | False | ||
ModificationRequestDateTime | Datetime | False | ||
ModificationRequestCheckedDateTime | Datetime | False | ||
IdentificationNo | String | False |
識別番号 : 出庫/入庫情報を管理するための任意の文字列を設定出来る項目。 | |
Modified | Datetime | True |
更新日時 : 出庫の更新日時。 (YYYY-MM-DD HH:MM:SS形式) | |
Token | String | False |
トークン : リクエストを一意に識別するためのトークン文字列を設定。重複するトークン文字列が指定された場合、スルーします。設定例:リクエスト日時(YYYYMMDDHHMMSS)+2桁の連番 | |
DetailAggregate | String | False |
A JSON aggregate of details associated with the shipping. |
Category: スタッフ情報 Staff Information ; TableName: スタッフ Staff
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Staff WHERE StaffId = 2 SELECT * FROM Staff WHERE StaffName LIKE '%S%' AND StaffId > 3 ORDER BY StaffId DESC
Staff を追加するには、StaffId、StaffCode、 StaffName、 StaffKana、 Rank、 Pincode、 DisplayFlag、 DisplaySequence、 MailAddress、 LoginIpAddress、 RoleId および DetailAggregate フィールドを指定します。
テンポラリテーブルの使用
INSERT INTO StaffStores#TEMP (StaffId, StoreId, ControlDivision) VALUES (9, 1, 1) INSERT INTO StaffStores#TEMP (StaffId, StoreId, ControlDivision) VALUES (9, 2, 1) INSERT INTO Staff (StaffId, StaffCode, StaffName, StaffKana, Rank, StoresAggregate) VALUES (9, '09', 'StaffNameSample', 'StaffNameKanaSample', 'B', 'StaffStores$TEMP')
集計の使用
INSERT INTO Staff (StaffId, StaffCode, StaffName, StaffKana, Rank, StoresAggregate) VALUES (9, '09', 'StaffNameSample', 'StaffNameKanaSample', 'B', '{ "table_name": "StaffStore", "rows": [ { "staffId": "9", "storeId": "1", "controlDivision": "1" }, { "staffId": "9", "storeId": "2", "controlDivision": "0" } ] }')
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
Staff を追加 / 更新するには、StaffId、StaffCode、 StaffName、 StaffKana、 Rank、 Pincode、 DisplayFlag、 DisplaySequence、 MailAddress、 LoginIpAddress、 RoleId および DetailAggregate フィールドを指定します。
INSERT INTO StaffStores#TEMP (StaffId, StoreId, ControlDivision) VALUES (9, 1, 1) INSERT INTO StaffStores#TEMP (StaffId, StoreId, ControlDivision) VALUES (9, 2, 1) UPSERT INTO Staff(StaffId, StaffCode, StaffName, StaffKana, Rank, StoresAggregate) VALUES (9, '09', 'StaffNameSample', 'StaffNameKanaSample', 'B', 'StaffStores$TEMP')
Staff を更新するには、StaffId、StaffCode、 StaffName、 StaffKana、 Rank、 Pincode、 DisplayFlag、 DisplaySequence、 MailAddress、 LoginIpAddress、 RoleId および StoresAggregate フィールドを指定します。
UPDATE Staff SET StaffCode = '2', StaffName = '2343', StaffKana = 'Kana' WHERE StaffId = '1'
Staff は、StaffId を指定することで削除できます。
DELETE FROM Staff WHERE StaffId = 1
Name | Type | ReadOnly | References | Description |
StaffId [KEY] | Integer | False |
スタッフID (PK) : 同一のスタッフIDがテーブルに存在する場合、対象のデータを更新。数字9桁以内。 | |
StaffCode | String | False |
スタッフコード : スタッフコード。半角英数20文字以内。※重複不可 | |
StaffName | String | False |
スタッフ名 : スタッフ名。50文字以内。 | |
StaffKana | String | False |
フリガナ : スタッフカナ。50文字以内。 | |
Rank | String | False |
ランク : スタッフの役職 (主任など)85文字以内。 | |
Pincode | String | False |
パスコード : パスコード。数値4桁-6桁。アプリ「販売設定」「取引開始時にスタッフ選択画面を表示」または「仮取引開始時にスタッフ選択画面を表示」をオンにしている場合、スタッフを選択後、パスコード入力画面が表示されます。ただし、パスコードが入力されていない場 合、入力画面は表示されません。 | |
DisplayFlag | Integer | False |
端末表示 : スマレジ端末に表示するか否かの判定。未設定の場合0を設定。(0:表示しない、1:表示する) | |
DisplaySequence | Integer | False |
表示順 : 表示順序。数値9桁以内。 | |
MailAddress | String | False |
メールアドレス : 認証メール送信アドレス。255文字以内。ログインできるユーザーを追加する場合指定してください。登録完了後、このメールアドレスに認証メールが送信されます。認証メールに記載されているURLにアクセスすると登録手続きが完了します。※認証後、メールアドレスの更新はできません。例)[email protected] | |
LoginIpAddress | String | False |
ログイン許可IPアドレ : ログイン許可IPアドレス。255文字以内。ログインを許可するグローバルIPアドレスを指定してください。複数の場合はカンマ区切りで指定してください。(IPアドレスチェック判定は前方一致なので、192.169.0. のような指定でもOKです) | |
RoleId | Integer | False |
役職ID : 役割・役職IDを指定します。存在しない役割・役職IDを指定するとエラーになります。メールアドレスを指定している場合指定してください。 未設定の場合未設定のままとなります。 | |
StoresAggregate | String | False |
A JSON aggregate of details associated with the staff. |
在庫情報:在庫
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT ProductId, StoreId, StockAmount, StockDivision FROM Stocks ORDER BY StockDivision SELECT ProductId, StoreId, StockAmount, StockDivision FROM Stocks WHERE StockDivision = 5 SELECT * FROM Stocks WHERE StockAmount < -1
Stock を追加するには、ProductId、StoreId、StockDivision およびStockAmount フィールドを指定します。
INSERT INTO Stocks (ProductId, StoreId, StockDivision, StockAmount) VALUES (45, 1, 05, 1)
Stock を追加 / 更新するには、ProductId、StoreId、StockDivision およびStockAmount フィールドを指定します。
UPSERT INTO Stocks (ProductId, StoreId, StockDivision, StockAmount) VALUES (45, 1, 05, 1)
テンポラリテーブルの使用:
INSERT INTO Stocks#TEMP (ProductId, StoreId, StockDivision, StockAmount) VALUES (46, 2, 02, 1) INSERT INTO Stocks#TEMP (ProductId, StoreId, StockDivision, StockAmount) VALUES (47, 2, 02, 1) INSERT INTO Stocks#TEMP (ProductId, StoreId, StockDivision, StockAmount) VALUES (48, 2, 02, 1) INSERT INTO Stocks#TEMP (ProductId, StoreId, StockDivision, StockAmount) VALUES (49, 2, 02, 1) UPSERT INTO Stocks (ProductId, StoreId, StockDivision, StockAmount) SELECT ProductId, StoreId, StockDivision, StockAmount FROM Stocks#TEMP
スマレジはStockAmount およびStockDivision カラムの更新を許容します。
UPDATE Stocks SET StockAmount = 5, StockDivision = '02' WHERE ProductId = 1 UPDATE Stocks SET StockAmount = 110, StockDivision = 10, AmountType = 'Absolute' WHERE ProductId = 13 AND StoreId = 4
削除はこのテーブルではサポートされていません。
Name | Type | ReadOnly | References | Description |
ProductId [KEY] | Long | False |
Products.ProductId |
商品ID (PK) : 数字15桁以内。 |
StoreId [KEY] | Integer | False |
Stores.StoreId |
店舗ID (PK) : 数字5桁以内。 |
StockAmount | Integer | False |
在庫数 : 更新する在庫数を設定。(相対値/絶対値) | |
UpdDatetime | Datetime | True | ||
StockDivision | String | False |
在庫区分 : 在庫を更新理由となる区分を設定。01:マスタ、02:売上、03:仕入、04:出庫、05:入庫、06:レンタル、07:取置、08:棚卸、09:調整、10:出荷、11:EC連携、12:返品、13:販促品、14:ロス、15:スマレジAPI連携、16:売上引当、17:入庫欠品※在庫履歴の区分に表示される区分です。注意して区分の設定を行ってください。※通常は15:スマレジAPI連携を設定する事を推奨します。 | |
Memo | String | False |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description |
AmountType | String |
If you want to update the stockAmount with an absolute value use 'Absolute' and if you want to add or subtract some value from stockAmount use 'Relative' 使用できる値は次のとおりです。Absolute, Relative デフォルト値はAbsoluteです。 |
発注情報:発注
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM StorageInfo WHERE StorageInfoId = 8 SELECT OrderedDate FROM StorageInfo WHERE Status = 2
StorageInfo を追加するには、Status、IdentificationNo、DeliveryAggregate およびDeliveryProductAggregate フィールドを指定します。
テンポラリテーブルの使用:
INSERT INTO StorageInfoDeliveries#TEMP (StorageStoreId, storageExpectedDateTo, StorageExpectedDateFrom) VALUES (2, '2019-10-11', '2019-10-1') INSERT INTO StorageInfoDeliveryProducts#TEMP (StoreId, ProductId, Quantity) VALUES (2, 1, 12) INSERT INTO StorageInfo (Status, IdentificationNo, DeliveryAggregate, DeliveryProductAggregate) VALUES (2, 'test1', 'StorageInfoDeliveries#TEMP', 'StorageInfoDeliveryProducts#TEMP')
集計の使用:
INSERT INTO StorageInfo (Status, IdentificationNo, DeliveryAggregate, DeliveryProductAggregate, ProductAggregate) VALUES (2, '2111', ' { "table_name": "StorageInfoDelivery", "rows": [ { "storageExpectedDateFrom": "2019-10-21", "storageExpectedDateTo": "2019-12-21", "storageStoreId": "1" } ] } ', ' { "table_name": "StorageInfoDeliveryProduct", "rows": [ { "storeId": "1", "productId": "1", "quantity": "1" } ] } ', ' { "table_name": "StorageInfoProduct", "rows": [ { "productId": "1", "cost": "324" } ] } ')
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
アップサートは、このテーブルではサポートされていません。
スマレジはRecipientOrderId、OrderedDate、Status およびIdentificationNo カラムの更新を許容します。
INSERT INTO StorageInfoDeliveries#TEMP (StorageInfoId, StorageStoreId, storageExpectedDateTo, StorageExpectedDateFrom) VALUES (22, 1, '2019-12-11', '2019-12-1') UPDATE StorageInfo SET IdentificationNo = 'Updated', status = 2, DeliveryAggregate = 'StorageInfoDeliveries#TEMP' WHERE StorageInfoId = 22
StorageInfo は、StorageInfoId を指定することで削除できます。
DELETE FROM StorageInfo WHERE StorageInfoId = 7
INSERT INTO StorageInfo#TEMP (StorageInfoId) VALUES (9); INSERT INTO StorageInfo#TEMP (StorageInfoId) VALUES (6); DELETE FROM StorageInfo WHERE EXISTS SELECT StorageInfoId FROM StorageInfo#TEMP
Name | Type | ReadOnly | References | Description |
StorageInfoId [KEY] | Integer | False |
発注ID (PK) : 発注毎に付与するID。【自動更新】自動採番状態が仮発注、商品分配済のもののみ削除可。状態が商品配分済の場合、発注商品の原価のみ編集可。状態が仮発注の場合、すべての項目の編集可。上記以外の状態のものを編集、削除するとエラー。 | |
RecipientOrderId | Integer | False |
発注先ID : 数字10文字以内。発注先となる仕入先IDを設定。存在しない仕入先を指定するとエラー。仮発注の場合のみ、更新可。 | |
OrderedDate | Date | False |
発注日 : 発注日を設定。(YYYY-MM-DD形式)登録時必須。仮発注の場合のみ、更新可。 | |
Status | Integer | False |
状態 : 状態を設定。2:商品分配済、3:入荷検品中、4:入荷完了、5:仮発注商品分配済, 仮発注以外を設定するとエラー。商品分配済を設定すると入荷情報を作成する。仮発注の場合のみ、更新可。 | |
Memo | String | False | ||
IdentificationNo | String | False |
識別番号 : 発注情報を管理するための任意の文字列を設定出来る項目。 | |
Modified | Datetime | True |
更新日時 : 発注の更新日時。 (YYYY-MM-DD HH:MM:SS形式) | |
Token | String | False |
トークン : リクエストを一意に識別するためのトークン文字列を設定。重複するトークン文字列が指定された場合、スルーします。設定例:リクエスト日時(YYYYMMDDHHMMSS)+2桁の連番 | |
DeliveryAggregate | String | False |
A JSON aggregate of deliveries associated with the storage info. | |
ProductAggregate | String | False |
A JSON aggregate of products associated with the storage info product. | |
DeliveryProductAggregate | String | False |
A JSON aggregate of products associated with the storage info delivery. |
入荷情報:入荷
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Storages WHERE StorageId = 3 SELECT StorageInfoId, SupplierId, StorageStoreId, StorageExpectedDateFrom FROM Storages WHERE StorageId = 3
Storage を追加するには、SupplierId、StorageStoreId およびDetailAggregate フィールドを指定します。
テンポラリテーブルの使用:
INSERT INTO StorageDetails#TEMP (productId, inspectionQuantity) VALUES (1, 4) INSERT INTO Storages (SupplierId, StorageStoreId, DetailAggregate) VALUES (1, 1, 'StorageDetails#TEMP')
集計の使用:
INSERT INTO Storages (StorageId, StorageInfoId, SupplierId, StorageStoreId, Memo, DetailAggregate) VALUES (21, 2, 1, 1, 'chand2233445', ' { "table_name": "StorageDetail", "rows": [ { "productId": "5", "inspectionQuantity": "3" } ] } ')
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
アップサートは、このテーブルではサポートされていません。
スマレジはStorageInfoId、SupplierId、StorageStoreId、StorageExpectedDateFrom、StorageExpectedDateTo、StorageDate、Memo、Status、IdentificationNo、Token およびDetailAggregate カラムの更新を許容します。
UPDATE Storages SET Memo = 'updated2' WHERE StorageId = 18
削除はこのテーブルではサポートされていません。
Name | Type | ReadOnly | References | Description |
StorageId [KEY] | Integer | False |
入荷ID (PK) : 入荷毎に付与するID。【自動更新】自動採番 | |
StorageInfoId | Integer | False |
StorageInfo.StorageInfoId |
発注ID : 数字10桁以内。 |
SupplierId | Integer | False |
仕入先ID : 数字10文字以内。存在しない仕入先を指定するとエラー。 | |
StorageStoreId | Integer | False |
入荷店舗ID : 数字9桁以内。存在しない店舗を指定するとエラー。 | |
StorageExpectedDateFrom | Date | False | ||
StorageExpectedDateTo | Date | False |
入荷予定日To : 入荷日予定日を設定。(YYYY-MM-DD形式) | |
StorageDate | Date | False |
入荷日 : 入荷日を設定。(YYYY-MM-DD形式)指定しない場合、更新日を設定。 | |
Memo | String | False |
メモ : 1000文字以内。 | |
Status | Integer | False |
状態 : 検品状況によって自動更新する。0:未入荷、1:検品中、2:入荷完了 | |
IdentificationNo | String | False |
識別番号 : 入荷情報を管理するための任意の文字列を設定出来る項目。 | |
Modified | Datetime | True |
更新日時 : 入荷の更新日時。 (YYYY-MM-DD HH:MM:SS形式) | |
Token | String | False |
トークン : リクエストを一意に識別するためのトークン文字列を設定。重複するトークン文字列が指定された場合、スルーします。設定例:リクエスト日時(YYYYMMDDHHMMSS)+2桁の連番 | |
DetailAggregate | String | False |
A JSON aggregate of details associated with the storage. |
店舗情報:店舗
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM Stores WHERE StoreId = 2 SELECT StoreName, StoreCode, PostCode FROM Stores ORDER BY StoreId
To add a Store, specify the StoreId, StoreCode and StoreName.
INSERT INTO Stores (StoreId, StoreCode, StoreName) VALUES (35, 'YSM', 'TATA')
Smaregi allows updates for the StoreCode, StoreName, StoreAbbr, PostCode, Address, PhoneNumber, FaxNumber, MailAddress, Homepage, TempTranMailAddress, PriceChangeFlag, SellDivision, SumProcDivision, SumDateChangeTime, SumRefColumn, PointNotApplicable, TaxFreeDivision, MaxBundleProductCount, RoundingDivision and DiscountRoundingDivision.
UPDATE Stores SET StoreCode = 'YM', StoreName = 'TATASONS' WHERE StoreId = 35
Name | Type | ReadOnly | References | Description |
StoreId [KEY] | Integer | True |
店舗ID (PK) : 店舗毎に付与するID。 | |
StoreCode | String | False |
店舗コード : 店舗コード(ver.2.0.0で追加) | |
StoreName | String | False |
店舗名 : 店舗名。 | |
StoreAbbr | String | False |
店舗名略称 : 店舗名略称。 | |
Division | Integer | False |
店舗区分 : 店舗区分(1:通常店舗、2:倉庫)(ver.2.0.0で追加) | |
PostCode | String | False |
郵便番号 : 店舗郵便番号 (ハイフンあり)。 | |
Address | String | False |
住所 : 店舗住所 | |
PhoneNumber | String | False |
電話番号 : 店舗電話番号 (ハイフン付)。 | |
FaxNumber | String | False |
FAX番号 : 店舗FAX番号 (ハイフン付)。 | |
MailAddress | String | False |
メールアドレス : 店舗メールアドレス。 | |
Homepage | String | False |
ホームページ : 店舗ホームページ。 | |
TempTranMailAddress | String | False |
仮取引登録時送信先アドレス : 仮取引登録時に送信するメールアドレス。 | |
PriceChangeFlag | Integer | False |
端末価格変更許可フラ : iPod,iPadで販売価格を変更可能か否かの区分。(0:変更不可、) | |
SellDivision | Integer | False |
販売区分 : 店舗での販売時の消費税の扱いを指定する区分。(0:内税販売、1:外税販売) | |
SumProcDivision | Integer | False |
締め方式区分 : 締め方法を指定する区分。(0:締め処理を利用する、1:締め処理を利用しない) | |
SumDateChangeTime | String | False |
締め日付変更時間 : 日付変更時間。締め処理時に使用 (HHMM形式)締め方式区分が1:リアルタイム方式の場合必須 | |
SumRefColumn | String | False |
締め参照時間項目 : 締め処理を行う時に参照する時間。締め処理時に使用。 | |
PointNotApplicable | Integer | False |
ポイント対象区分 : ポイント対象区分(0:ポイント対象、1:ポイント対象外) | |
TaxFreeDivision | Integer | False |
免税区分 : 免税区分(0:対象外、1:一般品、2:消耗品) | |
MaxBundleProductCount | Integer | False | ||
RoundingDivision | String | False |
端数値引区分 : 販売時の合計金額の端数を丸めるか否かを設定する(ver.2.5.0で追加)00:なし11:一の位を四捨五入,12:一の位を切捨,13:一の位を切上21:十の位を四捨五入,22:十の位を切捨,23:十の位を切上31:百の位を四捨五入,32:百の位を切捨,33:百の位を切上41:千の位を四捨五入,42:千の位を切捨,43:千の位を切上99:手入力 | |
DiscountRoundingDivision | String | False | ||
PauseFlag | Boolean | True |
休止フラグ : 数字1桁。休止フラグ(0:通常、1:休止)(ver.2.5.0で追加) | |
PointUseDivision | Integer | True |
ポイント使用 : ポイント機能を使用するか。(0:使用しない、1:使用する)(ver.2.0.0で追加) | |
InsDateTime | Datetime | True |
作成日時 : 登録時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
UpdDateTime | Datetime | True |
更新日時 : 登録時・更新時の日時。 (YYYY-MM-DD HH:MM:SS形式) |
取引情報:取引
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。 =、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。 例えば、次のクエリはサーバー側で処理されます。
NOTE::リクエストには、以下のフィルタリング条件のうち1つ以上が必要です。デフォルトのフィルタリング条件は、過去30日分のUpdDateTime に設定されています。
SELECT * FROM TransactionHeads WHERE TransactionHeadId >= 1 AND TransactionHeadId <= 100000 SELECT * FROM TransactionHeads WHERE TransactionDateTime >= '2021/03/01 00:00:00' AND TransactionDateTime <= '2021/03/31 00:00:00' SELECT * FROM TransactionHeads WHERE TerminalTranDateTime >= '2021/03/01 00:00:00' AND TerminalTranDateTime <= '2021/03/31 00:00:00' SELECT * FROM TransactionHeads WHERE SumDateTime >= '2021/03/01 00:00:00' AND SumDateTime <= '2021/03/31 00:00:00' SELECT * FROM TransactionHeads WHERE UpdDateTime >= '2021/03/01 00:00:00' AND UpdDateTime <= '2021/03/31 00:00:00'
Storage を追加するには、SupplierId、StorageStoreId およびDetailAggregate フィールドを指定します。
テンポラリテーブルの使用:
INSERT INTO TransactionDetails#TEMP (TransactionDetailId, ParentTransactionDetailId, TransactionDetailDivision, SalesPrice, Quantity) VALUES (1, 1, 2, 400, 4) INSERT INTO TransactionHeads (SumDivision, SumDateTime, StoreId, TerminalId, TerminalTranId, CancelDivision, TransactionDateTime, TerminalTranDateTime, TransactionHeadDivision, Subtotal, Total, DetailAggregate) VALUES (2, '2019/08/06 00:00:00', 1, 23, 6, 0, '2019/08/21', '2019-08-11', '1',-1600,-1600, 'TransactionDetails#TEMP')
集計の使用:
INSERT INTO TransactionHeads (SumDivision, SumDateTime, StoreId, TerminalId, TerminalTranId, CancelDivision, TransactionDateTime, TerminalTranDateTime, TransactionHeadDivision, Subtotal, Total, DetailAggregate) VALUES (2, '2019/08/06 00:00:00', 1, 23, 6, 0, '2019/08/21', '2019-08-14', '1', 159, 159, ' { "table_name": "TransactionDetail", "rows": [ { "parentTransactionDetailId": "1", "transactionDetailDivision": "1", "salesPrice": "159", "quantity": "1" } ] } ')
NOTE:レコードがすでに存在する場合、挿入は成功せず、ドライバーは影響を受けた行を0 行返します。
アップサートは、このテーブルではサポートされていません。
UPDATE は、このテーブルではサポートされていません。
削除はこのテーブルではサポートされていません。
Name | Type | ReadOnly | References | Description |
TransactionHeadId | Long | True |
取引ID : 取引毎に付与するID。【自動更新】自動採番 | |
TransactionDateTime | Datetime | True |
取引日時 : 取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。【自動更新】サーバー時間 | |
TransactionHeadDivision | String | False |
取引区分 : 取引を識別する区分。(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、 7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、 14:マイル減算)※1:取引、10:取置きの場合、取引明細が必要。以外は不要(無視する) | |
CancelDivision | Integer | False |
取消区分 : 取引の取消を識別する区分。(0:通常、1:取消) | |
UnitNonDiscountsubtotal | Decimal | True | ||
UnitDiscountsubtotal | Decimal | True |
単価値引き小計 : 取引明細の、マイナス値の単価値引きの合計。【自動更新】明細より自動算出 | |
Subtotal | Decimal | False |
小計 : 取引明細の値引き後小計の合計。※明細合計と異なる場合エラー | |
SubtotalDiscountPrice | Decimal | False |
小計値引き : 小計の値引き金額を設定。単価割引率が設定された場合、その割合から値引き金額を設定。(切捨て) | |
SubtotalDiscountRate | Decimal | False |
小計割引率 : 小計の割引を設定 (単位:%)デフォルトは未設定。集計は、小計値引きしか見ない。※設定された場合、小計計値引きは必須 | |
SubtotalDiscountDivision | Integer | True | ||
PointDiscount | Decimal | False |
ポイント値引き : 使用ポイント * ポイント還元率。※消費税含む | |
Total | Decimal | False |
合計 : 小計 - 小計値引き - ポイント引き + 外税額 + 手数料 + 送料 を設定※算出合計と異なる場合エラー | |
TaxExclude | Decimal | False |
外税額 : 外税商品計 * 5 / 100。 ※税率が5%の場合※ 省略時は0を設定※ 小数点以下は税の丸め方式で指定の通り | |
TaxInclude | Decimal | False |
内税額 : 合計 / 105 * 5。※税率が5%の場合※省略時は0を設定※ver.2.0.0でtaxはtaxIncludeに項目名が変更になりました。※小数点以下は税の丸め方式で指定の通り | |
RoundingDivision | String | True |
端数値引区分 : 販売時の合計金額の端数を丸めるか否かを設定する(ver.2.5.0で追加)00:なし【初期値】11:一の位を四捨五入,12:一の位を切捨,13:一の位を切上21:十の位を四捨五入,22:十の位を切捨,23:十の位を切上31:百の位を四捨五入,32:百の位を切捨,33:百の位を切上41:千の位を四捨五入,42:千の位を切捨,43:千の位を切上99:手入力 | |
RoundingPrice | Decimal | True |
端数値引額 : 端数値引金額(ver.2.5.0で追加) | |
CashTotal | Decimal | True |
内現金支払金額 : 合計金額の内訳 (現金払い)【自動更新】※預かり金現金 - 釣銭 | |
CreditTotal | Decimal | True |
内クレジット支払金額 : 合計金額の内訳 (クレジット払い)【自動更新】※預かり金クレジット | |
Deposit | Decimal | False |
預かり金 : 会計時に預かった金額。(預かり金現金 + 預かり金クレジット + 預かり金その他1-3)※預かり金を正しく設定しないと、日報が正しく表示されません。 | |
DepositCash | Decimal | False |
預かり金現金 : 会計時に預かった現金金額。※現金支払の場合必ず設定。(預かり金現金 - 釣銭)が現金支払額に設定されます。 | |
DepositCredit | Decimal | False |
預かり金クレジット : 会計時に預かったクレジット金額。※クレジット払いの場合必ず設定。預かり金クレジットが内クレジット支払金額に設定されます。※預かり金を正しく設定しないと、日報が正しく表示されません。 | |
Charge | Decimal | False |
釣銭 : 現金の返却金額※預かり金を正しく設定しないと、日報が正しく表示されません。 | |
ChangeDifference | Decimal | True |
釣銭差額 : 合計 + 釣銭 ー 会計時に預かった金額 (ver.2.7.0で追加) | |
Amount | Integer | True |
数量合計 : 取引明細の返品以外の数量の合計(取引明細区分が2:返品以外の数量)【自動更新】 | |
ReturnAmount | Integer | True |
返品数量合計 : 取引明細の返品の数量の合計(取引明細区分が2:返品の数量)【自動更新】 | |
CostTotal | Decimal | True |
原価合計 : 明細の原価計の合計【自動更新】明細より算出 | |
SalesHeadDivision | Integer | True |
売上ヘッダ区分 : 売上明細に売上対象がい商品を含むか否かの区分。(0:売上対象のみ、1:売上対象外含む)【自動更新】明細より算出 | |
InTaxSalesTotal | Decimal | True |
内税対象額 : 売上対象商品の内税販売合計金額内税販売の場合は、税込・税抜き商品を対象 | |
OutTaxSalesTotal | Decimal | True |
外税対象額 : 売上対象外商品の合計外税販売の税抜き商品を対象 | |
NonTaxSalesTotal | Decimal | True |
非課税対象額 : 売上対象外商品の合計非課税商品の合計を対象 | |
NonSalesTargetTotal | Decimal | True |
売上対象外合計 : 売上対象外商品の合計外税販売の場合、税を含まない | |
NonSalesTargetOutTaxTotal | Decimal | True |
売上対象外外税合計 : 売上対象外商品の外税合計 | |
NonSalesTargetInTaxTotal | Decimal | True |
売上対象外内税合計 : 売上対象外商品の内税合計(ver.2.0.0で追加) | |
NonSalesTargetTaxFreeTotal | Decimal | True | ||
NonSalesTargetCostTotal | Decimal | True |
売上対象外原価合計 : 売上対象外商品の原価合計 | |
NonSalesTargetAmount | Integer | True |
売上対象外数量合計 : 取引明細の返品以外かつ売上対象外の数量の合計(取引明細区分が2:返品以外の数量) | |
NonSalesTargetReturnAmount | Integer | True | ||
NewPoint | Decimal | False |
付与ポイント : 取引で付与されるポイント。合計 * ポイント率会員IDが設定されている場合、会員情報を更新。※省略時は0を設定※取置区分が10:取置きの場合、設定不可。 | |
SpendPoint | Decimal | False |
使用ポイント : 取引で使用したポイント。会員IDが設定されている場合、会員情報に更新。※省略時は0を設定 | |
Point | Decimal | False |
現在ポイント : 取引前のポイント※取引データには設定した値がそのまま設定されます。(変更前のスマレジの会員ポイントに上書き設定されません。) | |
TotalPoint | Decimal | False |
合計ポイント : 取引後のポイント現在ポイント + 付与ポイント - 使用ポイント。※取引データには設定した値がそのまま設定されます。(変更後のスマレジの会員ポイントに上書き設定されません。) | |
CurrentMile | Decimal | False |
現在マイル : 取引前のマイル(ver.2.3.0で追加) | |
EarnMile | Decimal | False |
獲得マイル : 取引で付与されるマイル(ver.2.3.0で追加)合計 * ポイント付与率 | |
TotalMile | Decimal | False |
合計マイル : 取引後のマイル(ver.2.3.0で追加)現在マイル + 獲得マイル + 調整マイル | |
AdjustmentMile | Decimal | False |
調整マイル : 取引で手動で付与されるマイル(ver.2.3.0で追加) | |
AdjustmentMileDivision | Integer | False |
調整マイル区分 : 調整マイルの区分(ver.2.3.0で追加)1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」) 3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」 | |
AdjustmentMileValue | Integer | False |
調整マイル区分値 : 調整マイルの入力値(ver.2.3.0で追加) | |
StoreId [KEY] | Integer | False |
店舗ID (PK) : 店舗毎に付与するID。※店舗情報が存在しない場合エラー※休止中の店舗IDを指定するとエラー(ver.2.7.0で追加) | |
StoreCode | String | True |
店舗コード : 店舗コード(ver.2.1.1で追加)※店舗マスタの店舗コードを参照 | |
TerminalId [KEY] | Integer | False |
端末ID (PK) : 店舗の端末毎に付与するID。※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みにする必要がある。) | |
CustomerId | Long | False |
会員ID : 会員毎に付与するID。数字10桁以内。※設定されている場合、会員取引とみなし、会員情報を更新します。※存在しない会員IDの場合、会員情報を更新しません。 | |
CustomerCode | String | True |
会員コード : 半角英数記号20文字以内。ユニークキーとなる為重複不可。(2013/5/1追加) | |
TerminalTranId [KEY] | String | False |
端末取引ID (PK) : 端末で設定された取引ID。(連携元システムで採番してください。) | |
TerminalTranDateTime [KEY] | Datetime | False |
端末取引日時 (PK) : 端末で設定された取引日時。(連携元システムで処理日時を設定してください。) | |
SumDivision | Integer | False |
締め区分 : 締め処理を実施したかの区分。(0:未処理、1:精算処理済み、2:締め処理済み)※省略時は0を設定※1:精算処理済みは、店舗の締め方式区分が「利用する」のときのみ設定可能(ver.2.10.0で追記)※存在しない端末IDの場合、2:締め処理済みとする事 | |
AdjustmentDateTime | Datetime | True |
精算日時 : 精算をしたら日時が入る。 | |
SumDateTime | Datetime | False |
締め日時 : 締めをしたら日時が入る。(YYYY-MM-DD形式)※締め区分を2に設定した場合必須。締め区分を0の場合null | |
CustomerRank | String | False |
会員ランク : 汎用マスタの「会員ランク」で登録しているコードを設定してください。汎用マスタに登録されていないコードを設定するとエラーになります。 | |
CustomerGroupId | Integer | False |
客層ID : 客層ID。客層セクションIDが1の客層IDを設定。※客層情報が存在しない場合エラー | |
CustomerGroupId2 | Integer | False |
客層ID2 : 客層ID2。客層セクションIDが2の客層IDを設定。※客層情報が存在しない場合エラー | |
CustomerGroupId3 | Integer | False |
客層ID3 : 客層ID3。客層セクションIDが3の客層IDを設定。※客層情報が存在しない場合エラー | |
CustomerGroupId4 | Integer | False |
客層ID4 : 客層ID4。客層セクションIDが4の客層IDを設定。※客層情報が存在しない場合エラー | |
CustomerGroupId5 | Integer | False |
客層ID5 : 客層ID5。客層セクションIDが5の客層IDを設定。※客層情報が存在しない場合エラー | |
StaffId | Integer | False |
販売員ID : 販売員ID。※販売員情報が存在しない場合エラー | |
StaffName | String | True |
販売員名 : 販売員名。【自動更新】販売員情報より自動設定 | |
StaffCode | String | True |
販売員コード : 販売員コード(ver.2.1.2で追加)※販売員マスタの販売員コードを参照 | |
PaymentCount | String | True |
支払回数 : クレジットの支払回数。※ゼウス、ペイメントマイスターご利用時(1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い) | |
SlipNumber | String | True |
伝票番号 : クレジットの伝票番号。 | |
CancelSlipNumber | String | True |
取消伝票番号 : クレジットの取消伝票番号。 | |
AuthNumber | String | True |
承認番号 : クレジットの承認番号。 | |
AuthDate | String | True |
センター処理日 : クレジットのセンター処理日。 | |
CardCompany | String | True |
取扱カード会社 : クレジットカード会社例) VISA、JCB、MASTER、AMEX、DINERSなど | |
Memo | String | False |
メモ : 入出金時のメモなどを設定。1000文字以内 | |
ReceiptMemo | String | False |
レシートメモ : レシートに印字するメモを設定(ver.2.7.0で追加) | |
PaymentMethodId1 | Integer | False |
支払方法ID1 : 支払方法ID1。※支払情報が存在しない場合エラー | |
PaymentMethodName1 | String | True |
支払方法名1 : 支払方法名1。【自動更新】支払方法情報より自動設定 | |
DepositOthers1 | Decimal | False |
預かり金その他1 : 会計時に預かった金額 支払方法は支払方法1。※支払方法ID1が設定されている場合必須※取置区分が10:取置きの場合、設定不可。 | |
PaymentMethodId2 | Integer | False |
支払方法ID2 : 支払方法ID2。※支払情報が存在しない場合エラー | |
PaymentMethodName2 | String | True |
支払方法名2 : 支払方法名2。【自動更新】支払方法情報より自動設定 | |
DepositOthers2 | Decimal | False |
預かり金その他2 : 会計時に預かった金額 支払方法は支払方法2。※支払方法ID2が設定されている場合必須※取置区分が10:取置きの場合、設定不可。 | |
PaymentMethodId3 | Integer | False |
支払方法ID3 : 支払方法ID3。※支払情報が存在しない場合エラー | |
PaymentMethodName3 | String | True |
支払方法名3 : 支払方法名3。【自動更新】支払方法情報より自動設定 | |
DepositOthers3 | Decimal | False |
預かり金その他3 : 会計時に預かった金額 支払方法は支払方法3。※支払方法ID3が設定されている場合必須※取置区分が10:取置きの場合、設定不可。 | |
Carriage | Decimal | False |
送料 : EC連携用送料。 | |
Commission | Decimal | False |
手数料 : EC連携用手数料。 | |
GuestNumbers | Integer | False |
客数 : 客数。(0以上の整数値)※省略時は0を設定 | |
TaxFreeSalesDivision | Integer | False |
免税販売区分 : 免税販売区分(0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算)) | |
NetTaxFreeGeneralTaxInclude | Decimal | False | ||
NetTaxFreeGeneralTaxExclude | Decimal | False | ||
NetTaxFreeConsumableTaxInclude | Decimal | False | ||
NetTaxFreeConsumableTaxExclude | Decimal | False | ||
Tags | String | False |
取引タグ : レジ端末よりクイックコマンドを押下した値を設定。和名を設定する。※複数ある場合は、カンマ区切りで設定 | |
PointGivingDivision | Integer | False |
ポイント付与区分 : (1:税額を含める + 利用ポイント分を含める、2:税額を含めない + 利用ポイント分を含める、3:税額を含める + 利用ポイント分を含めない、4:税額を含めない + 利用ポイント分を含めない)(ver.2.1.1で追加)※未設定の場合、nullを設定 | |
PointGivingUnitPrice | Integer | False |
ポイント付与単位(金額) : ポイント付与の設定 n円をnポイントの「n円」の部分(ver.2.1.1で追加)(設定範囲:1円?99999円)(例:10円ごとに2ポイントの場合、10円) | |
PointGivingUnit | Decimal | False |
ポイント付与単位(ポイント) : ポイント付与の設定 n円をnポイントの「nポイント」の部分(ver.2.1.1で追加)(設定範囲:0.01ポイント?99999.99ポイント) | |
PointSpendDivision | Integer | False |
ポイント利用区分 : ポイント利用時の税を含む/含まないを判定(ver.2.1.5で追加)1:ポイント利用を現金として扱う (税を含む値引き)2:ポイント利用を値引として扱う (税を含まない値引き)※未設定の場合、1:ポイント利用を現金として扱う。 | |
MileageDivision | Integer | False |
マイレージ利用区分 : マイレージ機能を利用するか否か(ver.2.3.0で追加)(0: 利用しない, 1: 利用する, 2: ポイントの代わりに貯める)※未設定の場合、「0: 利用しない」を設定 | |
MileageLabel | String | False |
マイレージ名称 : マイレージの名称(ver.2.3.0で追加)例:rejiマイル | |
CustomerPinCode | String | False |
PINコード : 自由な文字列(ver.2.1.1で追加)PINコードなど会員を識別する任意の文字列を設定してください。 | |
DisposeDivision | Integer | False |
打消区分 : 0:通常、1:打消元レコード、2:打消レコード※0:通常と2:打消しレコードのみ設定可能(省略時は0:通常を設定)※打消しレコードの場合、取引明細区分は、(通常、部門売り)→返品に変換させて設定してください。 | |
DisposeServerTransactionHeadId | Long | False | ||
CancelDateTime | Datetime | True |
取消日時 : 取消したサーバー日時を設定。【自動更新】取消/打消しの場合自動設定 | |
SellDivision | Integer | False |
販売区分 : 取引が外税販売、内税販売かを識別する区分。(0:内税販売、1:外税販売)※省略時は0:内税販売を設定 | |
TaxRate | Decimal | False |
税率 : 税率 (単位:%)※未入力の場合、スマレジに設定されている消費税を設定(端末取引日時より算出) | |
TaxRounding | Integer | False |
税の丸め方式 : 税の丸めを判定(ver.2.1.5で追加)0:四捨五入、1:切り捨て、2:切り上げ※省略時は1:切り捨てを設定 | |
DiscountRoundingDivision | Integer | True | ||
TransactionUuid | String | False |
レシート番号 : レシートに印字する番号(ver.2.1.2で追加)※未設定の場合(1970年から計算した現在秒の末尾9桁+端末IDゼロ詰め4桁) | |
GiftReceiptValidDays | Integer | False |
ギフトレシート有効日数 : ギフトレシートの有効日数(ver.3.0.0で追加)有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。 | |
ReceiptIssueNumberOfTimes | Integer | True |
領収書発行回数 : 領収書発行回数(ver.2.7.0で追加) | |
PickUpDate | Date | False |
受取予定日 : 受取予定日。(YYYY-MM-DD形式)(ver.2.4.0で追加)取置き、および、取置きを引取りした取引の場合設定されます。※取置区分が10:取置きの場合、設定可能。(任意) | |
PartPayment | Decimal | False |
前受金 : 前受金。(ver.2.4.0で追加)取置き、および、取置きを引取りした取引の場合設定されます。※取置区分が10:取置きの場合、設定可能。(任意)※前受金 = 受領金額 - お釣り にならないとエラーになります。 | |
PartPaymentClass | Integer | True |
前受金区分 : 前受金区分。(ver.3.0.0で追加)1:現金、 2:クレジットカード取置き、および、取置きを引取りした取引の場合設定されます。支払方法におうじて、前受金区分は設定されます。(支払方法がない場合、1:現金が設定されます。) | |
LayawayServerTransactionHeadId | Long | False |
取置取引ID : 取置きを引取りした取引の取置取引IDを設定します。(ver.2.4.0で追加)※設定されていれば、取置きを引取りした取引となります。※取置き中の取引を取置き済にしたい場合、取置き中の取引IDを指定してください。取置き中以外(引取済み、取消済み)はエラーになります。 | |
DisabledEdit | Integer | False |
取置き販売変更不可区分 : 取置き販売変更不可区分(ver.2.9.0で追加)0:変更可、 1:変更不可※取置きの取引(取引区分:10)のみ設定されます。※省略時は0:変更可を設定※ 1:変更不可を設定した場合、取置き販売時に商品の追加削除や会員の変更ができなくなります。 | |
UpdDateTime | Datetime | True |
更新日時 : 取引履歴の更新日時。作成時/修正時に日付が設定されます。 | |
PickupTransactionHeadId | Long | True | ||
DetailAggregate | String | False |
A JSON aggregate of details associated with the transaction head. | |
CouponDiscount | Decimal | False |
取引で使用された各クーポンの割引総額 |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
Name | Description |
DailySums | 日時締め情報:日時締め |
DailySumsSalesList | Usage information for the operation DailySumsSalesList.rsd. |
LossDetails | ロス情報:ロス明細 |
ReceivingDetails | 入庫検品:入庫明細 |
ShipmentDetails | 出荷情報:出荷明細 |
ShippingDetails | 出庫情報:出庫明細 |
StaffStores | Category: スタッフ店舗情報 Staff Store Information ; TableName: スタッフ店舗 StaffStores |
StockHistories | 在庫情報:在庫履歴 |
StocktakingDetails | 棚卸情報:棚卸明細 |
StocktakingHeads | 棚卸情報:棚卸ヘッダ |
StocktakingInfo | 棚卸情報:棚卸情報 |
StocktakingStockDetails | 棚卸在庫情報:棚卸明細 |
StorageDetails | 入荷情報:入荷明細 |
StorageInfoDeliveries | 発注情報:発注配送先 |
StorageInfoDeliveryProducts | 発注情報:発注配送商品 |
StorageInfoProducts | 発注情報:発注商品 |
TransactionCoupons | 取引情報:取引クーポン |
TransactionDepositOthers | 取引情報:取引支払方法 |
TransactionDetails | 取引情報:取引明細 |
日時締め情報:日時締め
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM [DailySums] WHERE SumDate = '2019-08-02' SELECT * FROM [DailySums] WHERE TenThousandYen >= 0
Name | Type | References | Description |
SumDate [KEY] | Date | 締め日 (PK) : 締め日。YYYY-MM-DD形式 | |
StoreId [KEY] | Integer |
Stores.StoreId | 店舗ID (PK) : 数字9桁以内。 |
CashDrawerId [KEY] | Integer | キャッシュドロアID(PK) : キャッシュドロアID。※未登録の場合、0が設定されます | |
Status | Integer | ステータス : 締め処理の状況を表す区分。(2:処理済みのみ)※締め処理が行われていないデータは取得できません。(0:未処理、1:未処理(保存データあり) | |
SalesTotal | Decimal | 総売上 : 総売上の合計基本設定の【総売上に「売上対象外商品」分を含める】が、0:考慮する(除く)に設定されている場合、総売上には売上対象外商品の金額は含まれません。設定内容については、総売上対象外区分を参照。(ver.2.7.0で追記) | |
Discount | Decimal | 値引き : 値引き金額の合計 | |
PointDiscount | Decimal | ポイント利用 : ポイント利用金額の合計 | |
TaxExcludeReceive | Decimal | 外税受領額 : 外税受領額の合計 | |
NonSalesTargetTotal | Decimal | 売上対象外金額 : 売上対象外金額の合計 | |
Total | Decimal | 純売上 : 純売上の合計基本設定の【純売上に免税額を含める】が、0:考慮する(除く)に設定されている場合、純売上には免税額の金額は含まれません。設定内容については、純売上免税区分を参照。(ver.2.7.0で追記) | |
TotalExcludTax | Decimal | 純売上(税抜) : 純売上(税抜)の合計 | |
InTaxSalesTotal | Decimal | 内税対象額 : 内税対象外の合計 | |
TaxInclude | Decimal | 内税額 : 内税額の合計 | |
OutTaxSalesTotal | Decimal | 外税対象額 : 外税対象外の合計 | |
TaxExclude | Decimal | 外税額 : 外税額の合計 | |
TaxTotal | Decimal | 消費税合計 : 消費税合計 | |
TaxDetailList | String | ||
NonTaxSalesTotal | Decimal | 非課税対象額 : 非課税対象額の合計 | |
TaxFreeTotal | Decimal | 免税額 : 免税額の合計 | |
NonSalesTargetTaxFreeTotal | Decimal | ||
CostTotal | Decimal | 売上原価 : 売上原価の合計 | |
GrossMargin | Decimal | 粗利益 : 粗利益の合計 | |
Amount | Integer | 販売商品点数 : 販売商品点数の合計 | |
TransactionCount | Integer | 通常取引数 : 通常取引の合計 | |
ReturnAmount | Integer | 返品数 : 返品数の合計 | |
Carriage | Decimal | 送料 : 送料の合計 | |
Commission | Decimal | 手数料 : 手数料の合計 | |
PreparationCash | Decimal | 釣銭準備金 : 釣銭準備金 | |
CashSales | Decimal | 現金売上 : 現金売上額 | |
CreditSales | Decimal | クレジット売上 : クレジット売上 | |
OtherSalseList | String | その他売上 : 配列で返します。(その他支払方法が存在しない場合、空の配列を返します。) | |
PartPayment | Decimal | 前受金 : 取置き時の前受金受領額 | |
PartPaymentCash | Decimal | 前受金(現金) : 取置き時の前受金受領額(現金) | |
PartPaymentCredit | Decimal | 前受金(クレジット) : 取置き時の前受金受領額(クレジット) | |
ReceivedDepositCash | Decimal | 前受金(受領済金額) : 取置き時の前受金を売上として計上した金額 | |
ReceivedDepositCashTotal | Decimal | ||
ReceivedDepositCreditTotal | Decimal | ||
PartPaymentCancel | Decimal | 前受金(取消) : 取置き時の前受金をキャンセルした金額 | |
PartPaymentCashCancel | Decimal | ||
PartPaymentCreditCancel | Decimal | ||
Deposit | Decimal | 預かり金 : 取引区分が(4:預かり金) の合計額 | |
ReturnDeposit | Decimal | 預かり金返金 : 取引区分が(5:預かり金返金) の取引合計額 | |
Receipt | Decimal | 入金 : 取引区分が(2:入金) の取引合計額 | |
Payment | Decimal | 出金 : 取引区分が(3:出金) の取引合計額 | |
NonSalesCashTotal | Decimal | 売上対象外現金 : 売上対象外の現金受領額 | |
NonSalesCreditTotal | Decimal | 売上対象外クレジット : 売上対象外のクレジット受領額 | |
NonSalesOtherTotal | Decimal | 売上対象外その他 : 売上対象外のその他支払方法受領額 | |
NonSalesTaxFreeTotal | Decimal | 売上対象外免税 : 売上対象外の免税額(ver.2.7.0で追加) | |
ChangeDifference | Decimal | 釣銭差額 : 釣銭差額(ver.2.7.0で追加) | |
CalculateBalance | Decimal | 計算現金残高 : 釣銭準備金 + 現金売上 + 前受金 - 前受金(取消) + 預かり金 - 預かり金返金+ 入金 - 出金 | |
RealBalance | Decimal | 実現金残高 : 1万円札から1円玉の枚数の合計金額 | |
Difference | Decimal | 現金過不足 : 現金過不足 | |
Saving | Decimal | 移行預入金 : 移行預入金 | |
CarryOver | Decimal | 繰越準備金 : 繰越準備金 | |
TenThousandYen | Integer | 1万円札 : 締め時点の1万円札の枚数 | |
FiveThousandYen | Integer | 5千円札 : 5千円札 | |
TwoThousandYen | Integer | 2千円札 : 2千円札 | |
OneThousandYen | Integer | 千円札 : 千円札 | |
FiveHundredYen | Integer | 500円玉 : 500円玉 | |
OneHundredYen | Integer | 100円玉 : 100円玉 | |
FiftyYen | Integer | 50円玉 : 50円玉 | |
TenYen | Integer | 10円玉 : 10円玉 | |
FiveYen | Integer | 5円玉 : 5円玉 | |
OneYen | Integer | 1円玉 : 1円玉 | |
Comment | String | コメント : 1000文字以内 | |
InsDateTime | Datetime | 作成日時 : 登録時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
UpdDateTime | Datetime | 更新日時 : 登録時・更新時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
SalesTotalNonSalesTargetDivision | String | ||
TotalTaxFreeDivision | String | 純売上免税区分 : 基本設定の【純売上に免税額を含める】の設定内容(ver.2.7.0で追加)(0:免税額を考慮する(除く)、1:免税額を考慮しない)※0:考慮する(除く)なら、純売上には免税額の金額が含まれていません。 |
Usage information for the operation DailySumsSalesList.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions built with the following column and operator.
SELECT * FROM [DailySumsSalesList] WHERE StoreId = '1234'
Name | Type | References | Description |
SumDate [KEY] | Date | ||
StoreId [KEY] | Integer |
Stores.StoreId | |
CashDrawerId [KEY] | Integer | ||
Id [KEY] | Integer | ||
Name | String | ||
PaymentMethodDivision | String | ||
PaymentMethodDivisionName | String | ||
Sales | Decimal | ||
InsDateTime | Datetime | ||
UpdDateTime | Datetime |
ロス情報:ロス明細
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT LossId, ProductCode FROM LossDetails WHERE LossId >= 5 SELECT * FROM LossDetails WHERE LossId <= 5
Name | Type | References | Description |
LossId [KEY] | Integer |
Losses.LossId | ロスID : ロス毎に付与するID。【自動更新】自動採番登録時不要。更新、削除必須。 |
ProductId [KEY] | Long |
Products.ProductId | 商品ID : 数字15桁以内。存在しない商品IDを指定するとエラー。同ロス内で、同じ商品IDを指定するとエラー。 |
ProductCode | String | 商品コード : ロス商品の商品コード。(参照時点の商品マスタの値) | |
ProductName | String | 商品名 : ロス商品の商品名。(参照時点の商品マスタの値) | |
Size | String | サイズ : ロス商品のサイズ。(参照時点の商品マスタの値) | |
Color | String | カラー : ロス商品のカラー。(参照時点の商品マスタの値) | |
GroupCode | String | グループコード : ロス商品のグループコード。(参照時点の商品マスタの値) | |
SupplierProductNo | String | 品番 : ロス商品の品番。(参照時点の商品マスタの値) | |
Quantity | Integer | 数量 : 数字5桁以内。 | |
Modified | Datetime | 更新日時 : ロスの更新日時。 (YYYY-MM-DD HH:MM:SS形式)(ロステーブルと同じ値) |
入庫検品:入庫明細
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ReceivingDetails WHERE ReceivingId = 9 SELECT ProductId, ProductCode FROM ReceivingDetails WHERE ReceivingId != 5
Name | Type | References | Description |
ReceivingId [KEY] | Integer |
Receivings.ReceivingId | 入庫ID : 入庫毎に付与するID。 |
ProductId [KEY] | Long |
Products.ProductId | 商品ID : 数字15桁以内。存在しない商品IDを指定するとエラー。同ロス内で、同じ商品IDを指定するとエラー。 |
ProductCode | String | 商品コード : 入庫商品の商品コード。(参照時点の商品マスタの値) | |
ProductName | String | 商品名 : 入庫商品の商品名。(参照時点の商品マスタの値) | |
Size | String | サイズ : 入庫商品のサイズ。(参照時点の商品マスタの値) | |
Color | String | カラー : 入庫商品のカラー。(参照時点の商品マスタの値) | |
GroupCode | String | グループコード : 入庫商品のグループコード。(参照時点の商品マスタの値) | |
SupplierProductNo | String | 品番 : 入庫商品の品番。(参照時点の商品マスタの値) | |
ScheduledQuantity | Integer | 予定数 : 数字5桁以内。 | |
InspectionQuantity | Integer | 検品数 : 数字5桁以内。 | |
StockoutQuantity | Integer | 欠品数 : 数字5桁以内。 | |
StockoutReason | String | 欠品理由 : 1000文字以内。 | |
InspectionDate | Date | 検品日 : 検品日を設定。(YYYY-MM-DD形式)指定しない場合、更新日を設定。 | |
Status | Integer | 状態 : 検品状況によって自動更新する。0:未検品、1:検品完了 | |
Modified | Datetime | 更新日時 : 入庫の更新日時。 (YYYY-MM-DD HH:MM:SS形式) |
出荷情報:出荷明細
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ShipmentDetails WHERE ShipmentId = 5 SELECT ProductId, ProductCode FROM ShipmentDetails WHERE ShipmentId = 5
Name | Type | References | Description |
ShipmentId [KEY] | Integer |
Shipments.ShipmentId | 出荷ID : 出荷毎に付与するID。【自動更新】自動採番更新、削除必須。 |
ProductId [KEY] | Long |
Products.ProductId | 商品ID : 数字15桁以内。存在しない商品IDを指定するとエラー。同出荷内で、同じ商品IDを指定するとエラー。 |
ProductCode | String | 商品コード : 出荷商品の商品コード。(参照時点の商品マスタの値) | |
ProductName | String | 商品名 : 出荷商品の商品名。(参照時点の商品マスタの値) | |
Size | String | サイズ : 出荷商品のサイズ。(参照時点の商品マスタの値) | |
Color | String | カラー : 出荷商品のカラー。(参照時点の商品マスタの値) | |
GroupCode | String | グループコード : 出荷商品のグループコード。(参照時点の商品マスタの値) | |
SupplierProductNo | String | 品番 : 出荷商品の品番。(参照時点の商品マスタの値) | |
Cost | Decimal | 原単価(税抜) : 商品の原価。(半角数字 整数部分8桁、少数部5桁 (小数点含む最大14桁))※設定時そのまま設定※省略時、商品マスタの原価を設定。 | |
Quantity | Integer | 数量 : 数字5桁以内。 | |
Memo | String | メモ : 1000文字以内。 | |
Modified | Datetime | 更新日時 : 出荷の更新日時。 (YYYY-MM-DD HH:MM:SS形式) | |
TaxRate | Decimal |
出庫情報:出庫明細
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM ShippingDetails WHERE Quantity > 2 SELECT ShippingId, ProductId, ProductCode FROM ShippingDetails
Name | Type | References | Description |
ShippingId [KEY] | Integer |
Shippings.ShippingId | 出庫ID (PK) : 出庫毎に付与するID。【自動更新】自動採番 |
ProductId [KEY] | Long |
Products.ProductId | 商品ID (PK) : 数字15桁以内。同出庫内で、同じ配送店舗IDを指定するとエラー。 |
ProductCode | String | 商品コード : 出庫商品の商品コード。(参照時点の商品マスタの値) | |
ProductName | String | 商品名 : 出庫商品の商品名。(参照時点の商品マスタの値) | |
Size | String | サイズ : 出庫商品のサイズ。(参照時点の商品マスタの値) | |
Color | String | カラー : 出庫商品のカラー。(参照時点の商品マスタの値) | |
GroupCode | String | グループコード : 出庫商品のグループコード。(参照時点の商品マスタの値) | |
SupplierProductNo | String | 品番 : 出庫商品の品番。(参照時点の商品マスタの値) | |
RequestQuantity | Integer | 出庫依頼数 : 数字5桁以内。状況が未出庫の場合必須。 | |
Quantity | Integer | 出庫数 : 数字5桁以内。状況が未入庫、入庫検品中の場合必須。 | |
Modified | Datetime | 更新日時 : 出庫の更新日時。 (YYYY-MM-DD HH:MM:SS形式) |
Category: スタッフ店舗情報 Staff Store Information ; TableName: スタッフ店舗 StaffStores
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM StaffStores WHERE StaffId = 2 SELECT * FROM StaffStores WHERE StaffId = 1 AND StoreId > 3 ORDER BY StaffId DESC
Name | Type | References | Description |
StaffId [KEY] | Integer | スタッフID (PK) : 数字9桁以内。 | |
StoreId [KEY] | Integer | 店舗ID (PK) : 数字9桁以内。 | |
ControlDivision | Integer | 制御区分 : 制御区分 (0:使用不可、1:使用可) |
在庫情報:在庫履歴
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。 =、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。 例えば、次のクエリはサーバー側で処理されます。
NOTE:リクエストには、以下のフィルタリング条件のうち1つ以上が必要です。デフォルトのフィルタリング条件は、過去30日分のUpdDateTime に設定されています。
SELECT * FROM StockHistories WHERE Id >= 1 AND Id <= 100000 SELECT * FROM StockHistories WHERE ProductId = 1 SELECT * FROM StockHistories WHERE UpdDateTime >= '2021/03/01 00:00:00' AND UpdDateTime <= '2021/03/31 00:00:00' SELECT * FROM StockHistories WHERE TargetDateTime >= '2021/03/01 00:00:00' AND TargetDateTime <= '2021/03/31 00:00:00'
Name | Type | References | Description |
Id [KEY] | Long | ID (PK) : ID。自動で設定されます。 | |
UpdDateTime | Datetime | 更新日時 : データ更新時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
TargetDateTime | Datetime | 対象日時 : 在庫数を変更した時の日時。 (YYYY-MM-DD HH:MM:SS形式)棚卸、ロス登録時に日時を指定する場合があります。通常は更新日時と同じ日時が設定されます。 | |
ProductId | Long | 商品ID : 数字15桁以内。 | |
StoreId | Integer | 店舗ID : 数字5桁以内。 | |
Amount | Integer | 数量 : 更新在庫数(相対値で設定) | |
StockAmount | Integer | 在庫数 : 処理後の在庫数。 | |
StockDivision | String | 在庫区分 : 在庫を更新理由となる区分を設定。01:マスタ、02:売上、03:仕入、04:出庫、05:入庫、06:レンタル、07:取置、08:棚卸、09:調整、10:出荷、11:EC連携、12:返品、13:販促品、14:ロス、15:スマレジAPI連携、16:売上引当、17:入庫欠品 | |
FromStoreId | Integer | 配送元店舗ID : 配送元店舗ID。 | |
ToStoreId | Integer | 配送先店舗ID : 配送先店舗ID。 |
棚卸情報:棚卸明細
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。 =、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。 例えば、次のクエリはサーバー側で処理されます。
NOTE:リクエストには、以下のフィルタリング条件のうち1つ以上が必要です。デフォルトのフィルタリング条件は、Modified for the last 30 days に設定されています。
SELECT * FROM StocktakingDetails WHERE StocktakingInfoId >= 1 AND StocktakingInfoId <= 100000 SELECT * FROM StocktakingDetails WHERE Modified >= '2021/03/01 00:00:00' AND Modified <= '2021/03/31 00:00:00'
Name | Type | References | Description |
StocktakingInfoId [KEY] | Integer |
StocktakingInfo.StocktakingInfoId | 棚卸ID (PK) : 棚卸毎に付与するID。 |
StocktakingHeadId [KEY] | Integer |
StocktakingHeads.StocktakingHeadId | 棚卸ヘッダID (PK) : 棚卸分割毎に付与するID。 |
ProductId [KEY] | Long |
Products.ProductId | 商品ID (PK) : 棚卸対象の商品IDを設定。 |
ProductCode | String | 商品コード : 棚卸商品の商品コード。(参照時点の商品マスタの値) | |
ProductName | String | 商品名 : 棚卸商品の商品名。(参照時点の商品マスタの値) | |
Size | String | サイズ : 棚卸商品のサイズ。(参照時点の商品マスタの値) | |
Color | String | カラー : 棚卸商品のカラー。(参照時点の商品マスタの値) | |
GroupCode | String | グループコード : 棚卸商品のグループコード。(参照時点の商品マスタの値) | |
SupplierProductNo | String | 品番 : 棚卸商品の品番。(参照時点の商品マスタの値) | |
StocktakingQuantity | Integer | 実地棚卸数 : 棚卸で計測された在庫数。 | |
TransportationStockQuantity | Integer | ||
LayawayStockQuantity | Integer | 取置在庫数 : 棚卸調整時点の取置在庫数。 | |
StockQuantityBeforeAdjustment | Integer | ||
Cost | Decimal | 原価 : 状況が「調整中」「完了」の場合、棚卸調整時点の商品マスタの原価。状況が「棚卸中」の場合、商品マスタの原価。 | |
Memo | String | メモ : メモを設定。 | |
Modified | Datetime | 更新日時 : 棚卸情報の更新日時。 (YYYY-MM-DD HH:MM:SS形式)(棚卸情報テーブルと同じ値) | |
InputStocktakingQuantity | Integer | ||
QuantityModifiedDatetime | Datetime |
棚卸情報:棚卸ヘッダ
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM StocktakingHeads WHERE DivisionCode != '373838333'
Name | Type | References | Description |
StocktakingInfoId [KEY] | Integer |
StocktakingInfo.StocktakingInfoId | 棚卸ID (PK) : 棚卸毎に付与するID。 |
StocktakingHeadId [KEY] | Integer | 棚卸ヘッダID (PK) : 棚卸分割毎に付与するID。 | |
DivisionCode | String | 分割コード : 分割対象のコード、IDを設定。分割単位「分割なし」の場合: | |
Modified | Datetime | 更新日時 : 棚卸情報の更新日時。 (YYYY-MM-DD HH:MM:SS形式)(棚卸情報テーブルと同じ値) |
棚卸情報:棚卸情報
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM StocktakingInfo WHERE StocktakingInfoId != '344'
Name | Type | References | Description |
StocktakingInfoId [KEY] | Integer | 棚卸ID (PK) : 棚卸毎に付与するID。 | |
StoreId | Integer | 店舗ID : 棚卸を行う店舗IDを設定。 | |
DivisionUnit | Boolean | 分割単位 : 分割単位を設定。0:分割なし、1:部門 | |
TargetDate | Date | 対象年月 : 対象年月を指定。(日は1日固定) | |
AdjustmentDate | Datetime | 調整日時 : 状態を「棚卸中」から「調整中」又は、「完了」に変更した日時を設定。 | |
StocktakingCompleteDate | Datetime | ||
Status | Integer | 状態 : 棚卸状態を設定。0:棚卸中、1:調整中、2:完了 | |
Created | Datetime | 作成日時 : 登録時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
Modified | Datetime | 更新日時 : 登録時・更新時の日時。 (YYYY-MM-DD HH:MM:SS形式) | |
StockCountDivision | String | ||
StocktakingInputCompleteDate | Datetime | ||
AutoFollowingFlag | Integer | ||
LayawayStockIncludeFlag | Integer |
棚卸在庫情報:棚卸明細
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM StocktakingStockDetails WHERE stocktakingInfoId = 2 AND baseDate = '2019-08-07' SELECT * FROM StocktakingStockDetails WHERE stocktakingInfoId = 1 AND baseDate = '1/1/2019' ORDER BY stocktakingInfoId
Name | Type | References | Description |
StocktakingInfoId [KEY] | Integer |
StocktakingInfo.StocktakingInfoId | 棚卸ID (PK) : 棚卸毎に付与するID。 |
StocktakingHeadId [KEY] | Integer |
StocktakingHeads.StocktakingHeadId | 棚卸ヘッダID (PK) : 棚卸分割毎に付与するID。 |
ProductId [KEY] | Long |
Products.ProductId | 商品ID (PK) : 棚卸対象の商品IDを設定。 |
ProductCode | String | 商品コード : 商品コード。(半角英数記号 20桁以内) | |
ProductName | String | 商品名 : 商品名。(85文字以内) | |
Size | String | サイズ : 棚卸商品のサイズ。(参照時点の商品マスタの値) | |
Color | String | カラー : 棚卸商品のカラー。(参照時点の商品マスタの値) | |
GroupCode | String | グループコード : 棚卸商品のグループコード。(参照時点の商品マスタの値) | |
SupplierProductNo | String | 品番 : 棚卸商品の品番。(参照時点の商品マスタの値) | |
StockQuantity | Integer | 在庫数 : 基準日時点の在庫数。※検索条件の指定不可 | |
StockMoney | Decimal | 在庫金額 : 基準日時点の在庫金額。※検索条件の指定不可 | |
TransportationQuantity | Integer | 積送在庫数 : 基準日時点の積送在庫数。※検索条件の指定不可 | |
TransportationMoney | Decimal | 積送在庫金額 : 基準日時点の積送在庫金額。※検索条件の指定不可 | |
LayawayQuantity | Integer | 取置在庫数 : 基準日時点の取置在庫数。※検索条件の指定不可 | |
LayawayMoney | Decimal | 取置在庫金額 : 基準日時点の取置在庫金額。※検索条件の指定不可 | |
StoreId | Integer | 店舗ID : 棚卸を行った店舗ID。 | |
BaseDate | Date |
入荷情報:入荷明細
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM StorageDetails WHERE StorageId = 2 SELECT ProductCode, ProductName, GroupCode FROM StorageDetails ORDER BY Size
Name | Type | References | Description |
StorageId [KEY] | Integer |
Storages.StorageId | 入荷ID : 入荷毎に付与するID。【自動更新】自動採番 |
ProductId [KEY] | Long |
Products.ProductId | 商品ID : 数字15桁以内。存在しない商品IDを指定するとエラー。同入荷内で、同じ商品IDを指定するとエラー。 |
ProductCode | String | 商品コード : 入荷商品の商品コード。(参照時点の商品マスタの値) | |
ProductName | String | 商品名 : 入荷商品の商品名。(参照時点の商品マスタの値) | |
Size | String | サイズ : 入荷商品のサイズ。(参照時点の商品マスタの値) | |
Color | String | カラー : 入荷商品のカラー。(参照時点の商品マスタの値) | |
GroupCode | String | グループコード : 入荷商品のグループコード。(参照時点の商品マスタの値) | |
SupplierProductNo | String | 品番 : 入荷商品の品番。(参照時点の商品マスタの値) | |
Cost | Decimal | 原単価(税抜) : 商品の原価。(半角数字 整数部分8桁、少数部5桁 (小数点含む最大14桁))※設定時そのまま設定※省略時、商品マスタの原価を設定。 | |
ScheduledQuantity | Integer | 予定数 : 数字5桁以内。 | |
InspectionQuantity | Integer | 検品数 : 数字5桁以内。 | |
StockoutQuantity | Integer | 欠品数 : 数字5桁以内。 | |
StockoutReason | String | 欠品理由 : 1000文字以内。 | |
InspectionDate | Date | 検品日 : 検品日を設定。(YYYY-MM-DD形式)入荷日を設定。 | |
CompulsoryCompleteFlag | String | ||
Status | Integer | 状態 : 検品状況によって自動更新する。0:未検品、1:検品完了 | |
Modified | Datetime | 更新日時 : 入荷の更新日時。 (YYYY-MM-DD HH:MM:SS形式) |
発注情報:発注配送先
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。 =、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。 例えば、次のクエリはサーバー側で処理されます。
NOTE:リクエストには、以下のフィルタリング条件のうち1つ以上が必要です。デフォルトのフィルタリング条件は、Modified for the last 30 days に設定されています。
SELECT * FROM StorageInfoDeliveries WHERE StorageInfoId >= 1 AND StorageInfoId <= 100000 SELECT * FROM StorageInfoDeliveries WHERE Modified >= '2021/03/01 00:00:00' AND Modified <= '2021/03/31 00:00:00'
Name | Type | References | Description |
StorageInfoId [KEY] | Integer |
StorageInfo.StorageInfoId | 発注ID (PK) : 発注毎に付与するID。【自動更新】自動採番 |
StorageStoreId [KEY] | Integer | 入荷店舗ID (PK) : 数字9桁以内。同発注内で、同じ配送店舗IDを指定するとエラー。 | |
StorageExpectedDateFrom | Date | ||
StorageExpectedDateTo | Date | 入荷予定日From : 入荷予定日toを設定。(YYYY-MM-DD形式)指定しない場合、更新日を設定。 | |
Modified | Datetime | 更新日時 : 発注の更新日時。 (YYYY-MM-DD HH:MM:SS形式) | |
StorageId | Integer |
発注情報:発注配送商品
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。 =、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。 例えば、次のクエリはサーバー側で処理されます。
NOTE:リクエストには、以下のフィルタリング条件のうち1つ以上が必要です。デフォルトのフィルタリング条件は、Modified for the last 30 days に設定されています。
SELECT * FROM StorageInfoDeliveryProducts WHERE StorageInfoId >= 1 AND StorageInfoId <= 100000 SELECT * FROM StorageInfoDeliveryProducts WHERE Modified >= '2021/03/01 00:00:00' AND Modified <= '2021/03/31 00:00:00'
Name | Type | References | Description |
StorageInfoId [KEY] | Integer |
StorageInfo.StorageInfoId | 発注ID (PK) : 発注毎に付与するID。【自動更新】自動採番 |
StoreId [KEY] | Integer |
Stores.StoreId | 入荷店舗ID (PK) : 数字9桁以内。発注配送先で設定されていない配送店舗IDが設定された場合エラー。同発注、同商品内で、同じ配送店舗IDを指定するとエラー。 |
ProductId [KEY] | Long |
Products.ProductId | 商品ID (PK) : 数字15桁以内。存在しない商品IDを指定するとエラー。同発注、同入荷店舗ID内で、同じ商品IDを指定するとエラー。 |
ProductCode | String | 商品コード : 発注商品の商品コード。(参照時点の商品マスタの値) | |
ProductName | String | 商品名 : 発注商品の商品名。(参照時点の商品マスタの値) | |
Size | String | サイズ : 発注商品のサイズ。(参照時点の商品マスタの値) | |
Color | String | カラー : 発注商品のカラー。(参照時点の商品マスタの値) | |
GroupCode | String | グループコード : 発注商品のグループコード。(参照時点の商品マスタの値) | |
SupplierProductNo | String | 品番 : 発注商品の品番。(参照時点の商品マスタの値) | |
Quantity | Integer | 入荷数 : 数字5桁以内。 | |
Modified | Datetime | 更新日時 : 発注の更新日時。 (YYYY-MM-DD HH:MM:SS形式) |
発注情報:発注商品
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。 =、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。 例えば、次のクエリはサーバー側で処理されます。
NOTE:リクエストには、以下のフィルタリング条件のうち1つ以上が必要です。デフォルトのフィルタリング条件は、Modified for the last 30 days に設定されています。
SELECT * FROM StorageInfoProducts WHERE StorageInfoId >= 1 AND StorageInfoId <= 100000 SELECT * FROM StorageInfoProducts WHERE Modified >= '2021/03/01 00:00:00' AND Modified <= '2021/03/31 00:00:00'
Name | Type | References | Description |
StorageInfoId [KEY] | Integer |
StorageInfo.StorageInfoId | 発注ID (PK) : 発注毎に付与するID。【自動更新】自動採番 |
ProductId [KEY] | Long |
Products.ProductId | 商品ID (PK) : 数字15桁以内。存在しない商品IDを指定するとエラー。同発注内で、同じ商品IDを指定するとエラー。 |
ProductCode | String | 商品コード : 発注商品の商品コード。(参照時点の商品マスタの値) | |
ProductName | String | 商品名 : 発注商品の商品名。(参照時点の商品マスタの値) | |
Size | String | サイズ : 発注商品のサイズ。(参照時点の商品マスタの値) | |
Color | String | カラー : 発注商品のカラー。(参照時点の商品マスタの値) | |
GroupCode | String | グループコード : 発注商品のグループコード。(参照時点の商品マスタの値) | |
SupplierProductNo | String | 品番 : 発注商品の品番。(参照時点の商品マスタの値) | |
Cost | Decimal | 原単価(税抜) : 商品の原価。(半角数字 整数部分8桁、少数部5桁 (小数点含む最大14桁))※設定時そのまま設定※省略時、商品マスタの原価を設定。 | |
Quantity | Integer | 発注数 : 数字5桁以内。発注配送商品の入荷数の合計が設定されます。【自動更新】発注配送商品の合計を設定。 | |
Modified | Datetime | 更新日時 : 発注の更新日時。 (YYYY-MM-DD HH:MM:SS形式) |
取引情報:取引クーポン
Name | Type | References | Description |
TransactionCouponId [KEY] | Long | 取引クーポンID(PK):取引クーポン毎に付与されたID。 | |
TerminalTranCouponId [KEY] | Long | 端末取引クーポンID:端末取引クーポンID。 | |
TransactionHeadId [KEY] | Long |
TransactionHeads.TransactionHeadId | 取引ID:取引毎に付与するID。 |
TerminalTranId [KEY] | Long | 端末取引ID:端末取引ID。 | |
CouponId [KEY] | Long | クーポンID:クーポンID。スマレジで管理するクーポンID。 | |
CouponName | String | クーポン名:クーポン名。 | |
SerialNumber | String | シリアル番号:クーポンのシリアル番号。クーポン番号。 | |
AwardType | String | 特典タイプ:クーポンのタイプ(1:値引、2:割引、3:商品付与)。 | |
AwardValue | Decimal | 特典値:値引額、割引率など。特典タイプにより値が表わすものが異なる。 | |
DiscountPrice | Decimal | 値引額:クーポン値引額。 | |
AdjustmentValue | Decimal | The Adjustment points/mile. | |
CouponOfflineDivision | String | The Coupon Offline Classification. | |
CombineDivision | String | The Combination Classification. |
取引情報:取引支払方法
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。
=、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。
例えば、次のクエリはサーバー側で処理されます。
SELECT * FROM TransactionDepositOthers WHERE TransactionHeadId = 61855 SELECT PaymentMethodId, PaymentMethodName, DepositOthers, Denomination FROM TransactionDepositOthers ORDER BY TransactionHeadId
Name | Type | References | Description |
TransactionHeadId [KEY] | Long |
TransactionHeads.TransactionHeadId | 取引ID(PK):取引毎に付与するID。 |
PaymentMethodNumber [KEY] | Integer | 項番(PK):取引内の支払方法ごとに連番。 | |
PaymentMethodId | Integer | 支払方法ID:支払方法のID。(取引.支払方法ID 1-3と同じ値が設定されます。) | |
PaymentMethodName | String | 支払方法名:支払方法名。(取引.支払方法名1-3と同じ値が設定されます。) | |
DepositOthers | Decimal | 預かり金その他:会計時に預かった金額。(取引.預かり金その他1-3と同じ値が設定されます。) | |
Denomination | String | 支払金種:支払方法の金種。(支払方法がStay Pay の場合設定されます。) |
取引情報:取引明細
Sync App は Smaregi API を使用して、WHERE 句条件と選択されたカラムを処理します。LIKE(date およびdateTime データ型のカラムの場合)およびIN 演算子は、クライアント側で処理されます。 =、!=、<>、>、<、>=、<=、AND、LIKE、ORDER BY 演算子は、サーバー側で処理されます。 例えば、次のクエリはサーバー側で処理されます。
NOTE:リクエストには、以下のフィルタリング条件のうち1つ以上が必要です。デフォルトのフィルタリング条件は、過去30日分のUpdDateTime に設定されています。
SELECT * FROM TransactionDetails WHERE TransactionDateTime >= '2021/03/01 00:00:00' AND TransactionDateTime <= '2021/03/31 00:00:00' SELECT * FROM TransactionDetails WHERE TransactionHeadId >= 1 AND TransactionHeadId <= 100000 SELECT * FROM TransactionDetails WHERE UpdDateTime >= '2021/03/01 00:00:00' AND UpdDateTime <= '2021/03/31 00:00:00'
Name | Type | References | Description |
TransactionHeadId [KEY] | Long |
TransactionHeads.TransactionHeadId | 取引ID : 取引毎に付与するID。【自動更新】自動採番 |
TransactionDateTime | Datetime | 取引日時 : 取引テーブルの取引日時。(取引テーブルを参照)【自動更新】自動採番 | |
TransactionDetailId [KEY] | Integer | 取引明細ID : 取引毎の明細に付与するID。この項目を設定しない場合、取引毎に0から採番。設定する場合は0?999まで。(ver.2.10.0で追記)【自動更新】自動採番 | |
ParentTransactionDetailId | Integer | 親取引明細ID : 紐付く親の取引明細がある場合、その取引明細IDを設定。※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の 取引明細IDを設定しなければならない。(ver.2.10.0で追記) | |
TransactionDetailDivision | Integer | 取引明細区分 : 取引明細を識別する区分。(1:通常、2:返品、3:部門売り) | |
ProductId | Long | 商品ID : 商品毎に付与するID。数字15桁以内。※商品情報が存在しない場合nullを設定。省略時null | |
ProductCode | String | 商品コード : 商品コード。(半角英数記号 20桁以内)※設定時、そのまま設定。※省略時、商品IDが設定されている場合、マスタから設定。以外はnull | |
ProductName | String | 商品名 : 商品名。(85文字以内)※設定時、そのまま設定。※省略時、商品IDが設定されている場合、マスタから設定。以外はnull | |
TaxDivision | Integer | 税区分 : 商品単価の税区分。(0:税込、1:税抜、2:非課税) ※設定時そのまま設定 ※省略時、商品IDが設定されている場合、マスタから設定。以外は0:税込 | |
Price | Decimal | 商品単価 : 当時の商品単価。※設定時そのまま設定※省略時、商品IDが設定されている場合、マスタから設定。以外は0円 | |
SalesPrice | Decimal | 販売単価 : 当時の販売価格。ターミナルで任意入力。単価を修正した場合に設定。デフォルトは商品単価。 | |
UnitDiscountPrice | Decimal | 単品値引 : 販売単価の値引き金額を設定。単価割引率が設定された場合、その割合から値引き金額を設定。(切捨て) | |
UnitDiscountRate | Decimal | 単品割引 : 単品の割引率を設定。(単位:%)※設定された場合、単品値引は必須 | |
UnitDiscountDivision | Integer | 単品値引き/割引区分 : 単品値引き/割引時に指定された区分を設定。※汎用マスタIDが設定される | |
Cost | Decimal | 原価 : 商品の原価。(半角数字 整数部分8桁、少数部5桁 (小数点含む最大14桁))※設定時そのまま設定※省略時、商品IDが設定されている場合、マスタから設定。以外は0円 | |
Quantity | Integer | 数量 : 購入数。 | |
UnitNonDiscountSum | Decimal | 値引き前計 : 販売価格×数量。 | |
UnitDiscountSum | Decimal | 単価値引き計 : 単価値引き×数量。 | |
UnitDiscountedSum | Decimal | 値引き後計 : 値引き前計 - 単価値引き計。 | |
CostSum | Decimal | 原価計 : 原価×数量。 | |
CategoryId | Integer | 部門ID : 商品に紐付く部門毎に付与するID。数字9桁以内。※部門情報が存在しない場合nullを設定。省略時、商品IDが設定されている場合、商品マスタから設定。以外はnull※商品IDが設定されている場合、商品情報の部門IDと一致しないとエラー | |
CategoryName | String | 部門名 : 商品に紐付く部門名。(85文字以内)※設定時、そのまま設定。※省略時、部門IDが設定されている場合、マスタから設定。以外はnull | |
DiscriminationNo | String | 識別番号 : 明細行を識別できる番号を追加。(半角英数記号 20桁以内) | |
SalesDivision | Integer | 売上区分 : 売上計上するか否かの区分。(0:売上対象、1:売上対象外)※省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:売上対象を設定 | |
ProductDivision | Integer | 商品区分 : ############################################ | |
PointNotApplicable | Integer | ポイント対象 : ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外)※取置き登録時、マスタ情報を参照し設定します。(ver.3.1.0 追記) | |
TaxFreeDivision | Integer | 免税区分 : 免税区分の設定。商品マスタより自動で設定。(ver.2.1.0で追加)(0:対象外、1:一般品、2:消耗品) | |
TaxFreeCommodityPrice | Decimal | 免税対象額 : 免税対象額(ver.2.1.5で追加) | |
TaxFree | Decimal | 免税額 : 免税額(ver.2.1.5で追加) | |
ProductBundleGroupId | Integer | 商品バンドルグループID : 商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。商品バンドルグループに存在するIDを指定しなければならない。この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない(ver.2.10.0で追加) | |
DiscountPriceProportional | Decimal | ||
DiscountPointProportional | Decimal | ||
DiscountCouponProportional | Decimal | クーポン割引を設定 | |
TaxIncludeProportional | Decimal | 内税按分 : 内税を按分した金額を設定(ver.2.0.0で追加)端数処理は銀行丸め。誤差は最終行で調整 | |
TaxExcludeProportional | Decimal | 外税按分 : 外税を按分した金額を設定端数処理は銀行丸め。誤差は最終行で調整 | |
ProductBundleProportional | Decimal | ||
StaffDiscountProportional | Decimal | ||
BargainDiscountProportional | Decimal | ||
RoundingPriceProportional | Decimal | ||
InventoryReservationDivision | Integer | ||
GroupCode | String | グループコード : グループコード(ver.2.1.1で追加)※商品マスタのグループコードを参照 販売時のグループコードを返却 | |
UpdDateTime | Datetime | 更新日時 : 取引履歴の更新日時。作成時/修正時に日付が設定されます。(ver.2.0.0で追加) | |
ProductStaffDiscountRate | Integer | ||
StaffRank | String | 社員ランクコード : 社員販売時のみ設定社員ランクのコードを設定 | |
StaffRankName | String | 社員ランク名 : 社員販売時のみ設定社員ランクの名称を設定 | |
StaffDiscountRate | Decimal | 社員販売割引率 : 社員販売時のみ設定社員販売の割引率 | |
StaffDiscountDivision | Integer | 社員販売割引区分 : 社員販売時のみ設定1ビット目: 商品マスタの社員販売最大値引率を考慮(する or しない)2ビット目: セール価格と社員販売割引を掛け合わせて適用(する or しない)3ビット目: セール価格と社員販売価格を比較して安い方を適用(する or しない)4ビット目: セール価格と社員販売価格を比較して高い方を適用(する or しな | |
ApplyStaffDiscountRate | Decimal | 適用社員販売割引率 : い)セール販売時のみ設定適用した社員販売の割引率 | |
ApplyStaffDiscountPrice | Decimal | 適用社員値引き額 : セール販売時のみ設定適用した社員販売の値引き額 | |
BargainId | Integer | セールID : セール販売時のみ設定。適用したセールのID※セール商品ID(bargainProductId)の値が設定されます。(ver.3.1.0追記) | |
BargainName | String | セール名称 : セール販売時のみ設定適用したセールの名称 | |
BargainDivision | Integer | セール区分 : セール販売時のみ設定1:割引 2:値引 3:価格指定 | |
BargainValue | Decimal | セール値 : セール販売時のみ設定割引、値引、価格指定の値 | |
ApplyBargainValue | Decimal | 適用セール値 : セール販売時のみ設定適用したセール販売の割引、値引き、価格指定の値 | |
ApplyBargainDiscountPrice | Decimal | ||
TaxRate | Decimal | 適用税率 : 適用した税率(明細毎に税率変更可能な為) | |
StandardTaxRate | Decimal | 標準税率 : 標準税率(明細毎に税率変更可能な為) | |
ModifiedTaxRate | Decimal | 修正税率 : 修正した税率(明細毎に税率変更可能な為) | |
ReduceTaxId | Integer | ||
ReduceTaxName | String | ||
ReduceTaxRate | String | ||
Color | String | カラー : 販売時のカラー | |
Size | String | サイズ : 販売時のサイズ |
プロパティ | 説明 |
AccessToken | 現在認証されているユーザーのアクセストークン。 |
ContractId | 現在認証されているユーザーの契約ID。 |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
MaxThreads | 最大スレッド数。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | ドライバーが各リクエストに対して取得するイシューの数を指定します。スマレジAPI の最大値は1000 です。 ただし、DailySum テーブルの最大値はexepect です。このテーブルの最大値は 100 です。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
AccessToken | 現在認証されているユーザーのアクセストークン。 |
ContractId | 現在認証されているユーザーの契約ID。 |
現在認証されているユーザーのアクセストークン。
現在認証されているユーザーのアクセストークン。
現在認証されているユーザーの契約ID。
現在認証されているユーザーの契約ID。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はSmaregi への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Smaregi Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
Platform | %APPDATA% |
Windows | APPDATA 環境変数の値 |
Linux | ~/.config |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
MaxThreads | 最大スレッド数。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
Pagesize | ドライバーが各リクエストに対して取得するイシューの数を指定します。スマレジAPI の最大値は1000 です。 ただし、DailySum テーブルの最大値はexepect です。このテーブルの最大値は 100 です。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
最大スレッド数。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
ドライバーが各リクエストに対して取得するイシューの数を指定します。スマレジAPI の最大値は1000 です。 ただし、DailySum テーブルの最大値はexepect です。このテーブルの最大値は 100 です。
各ページで取得されるIssue エントリの数。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Products WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json指定されたパスは引用符で囲まれていないことに注意してください。