CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるSmaregi へのアクセスを実現します。SQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してSmaregi に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server と同じように、Smaregi への接続を標準化し、構成することができます。
このページでは、CData Cloud でのSmaregi への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのSmaregi への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してSmaregi からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、Smaregi に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
スマレジドライバーを使用するには、ContractId およびAccessToken パラメータが必要です。 スマレジにログイン後、[設定]->[システム連携]->[スマレジAPI 設定]に移動します。 API 受信設定セクションで、受信機能を利用するを[利用する]に変更し、アクセストークン発行をクリックしてアクセストークンを取得します。 次に、機能設定セクションで、必要なAPI 機能を利用するに設定して有効化します。
OAuth で認証するには、AuthScheme をOAuth またはOAuthClient に設定する必要があります。OAuth 認証はUserAccssToken を使用し、OAuthClient 認証はAppAccessToken を使用します。 すべての機能を使用するには、AppAccessToken を使用してOAuthClient 認証を行います。OAuthClient 認証を使用するには、カスタムOAuth アプリケーションの作成 で説明するように、カスタムOAuth アプリケーションを作成する必要があります。
OAuth アクセストークンの自動リフレッシュ
Cloud がOAuth アクセストークンを自動的にリフレッシュするようにするには:
OAuth アクセストークンの手動リフレッシュ:
OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。
OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
OAuth JWT で認証するには、AuthScheme をOAuthJWT に設定する必要があります。また、カスタムOAuth アプリケーションの作成 で説明するように、カスタムOAuth アプリケーションを作成する必要があります。
次の接続プロパティを設定して、接続してください。
To register a custom OAuth application and obtain the OAuth client credentials, client id, and client secret:
デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。
別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。
HTTP プロキシへの認証には、以下のように設定します。
次のプロパティを設定します。
Smaregi データモデルで利用可能なエンティティについては、Smaregi データモデル を参照してください。
Platform API データモデルで利用可能なエンティティについては、PlatformAPI データモデル を参照してください。
このセクションでは、利用可能なAPI オブジェクトを示し、Smaregi API へのSQL の実行について詳しく説明します。
テーブル では、利用可能なテーブルを説明します。テーブルは、Products、Customers、Shippings などを静的にモデル化するように定義されています。
ビュー では、利用可能なビューを説明します。ビューは、Stores、ShippingDetails などを静的にモデル化するように定義されています。ビューは変更できませんが、テーブルへのクエリを補足するために使用できます。
Cloud は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 | 取引情報:取引 |
セール情報:セール商品
| 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 |
値 : 割引、値引き、価格指定の値 |
セール情報:セール
Cloud は 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形式) |
セール情報:セール店舗
Cloud は 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で追加) |
部門情報:部門
Cloud は 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形式) |
会員情報:会員
Cloud は 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形式) |
ロス情報:ロス
Cloud は 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 |
ロスに関連する明細のJSON集約。 |
商品情報:在庫引当商品
Cloud は 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以上で設定してください。 |
商品情報:商品価格
Cloud は 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形式) |
商品情報:商品予備項目ラベル
Cloud は 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文字以内。予備項目の値。 |
商品情報:商品予備項目
Cloud は 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文字以内。予備項目の値。 |
商品情報:商品
Cloud は 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形式) |
商品情報:商品取扱店舗
Cloud は 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:販売しない |
入庫検品:入庫
Cloud は 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 |
入庫に関連する明細のJSON集計。 |
出荷情報:出荷
Cloud は 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 |
出荷に関連する明細のJSON集計。 |
出庫情報:出庫
Cloud は 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 |
出庫に関連する明細のJSON集計。 |
Category: スタッフ情報 Staff Information ; TableName: スタッフ Staff
Cloud は 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. |
在庫情報:在庫
Cloud は 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 |
stockAmountを絶対値で更新する場合は'Absolute'を使用し、stockAmountから値を加算または減算する場合は'Relative'を使用してください。 使用できる値は次のとおりです。Absolute, Relative デフォルト値はAbsoluteです。 |
発注情報:発注
Cloud は 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 |
発注情報に関連する配送のJSON集計。 | |
| ProductAggregate | String | False |
発注情報商品に関連する商品のJSON集計。 | |
| DeliveryProductAggregate | String | False |
発注情報配送に関連する商品のJSON集計。 |
入荷情報:入荷
Cloud は 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 |
入荷に関連する明細のJSON集計。 |
店舗情報:店舗
Cloud は 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形式) |
取引情報:取引
Cloud は 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 |
取引ヘッドに関連する明細のJSON集約。 | |
| 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 | 取引情報:取引明細 |
日時締め情報:日時締め
Cloud は 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 Cloud 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 |
ロス情報:ロス明細
Cloud は 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形式)(ロステーブルと同じ値) |
入庫検品:入庫明細
Cloud は 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形式) |
出荷情報:出荷明細
Cloud は 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 |
出庫情報:出庫明細
Cloud は 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
Cloud は 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:使用可) |
在庫情報:在庫履歴
Cloud は 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。 |
棚卸情報:棚卸明細
Cloud は 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 |
棚卸情報:棚卸ヘッダ
Cloud は 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形式)(棚卸情報テーブルと同じ値) |
棚卸情報:棚卸情報
Cloud は 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 |
棚卸在庫情報:棚卸明細
Cloud は 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 |
入荷情報:入荷明細
Cloud は 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形式) |
発注情報:発注配送先
Cloud は 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 |
発注情報:発注配送商品
Cloud は 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形式) |
発注情報:発注商品
Cloud は 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. |
取引情報:取引支払方法
Cloud は 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 の場合設定されます。) |
取引情報:取引明細
Cloud は 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 | サイズ : 販売時のサイズ |
ストアドプロシージャはファンクションライクなインターフェースで、Smaregi の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSmaregi から関連するレスポンスデータを返します。
| Name | Description |
このセクションでは、利用可能なAPI オブジェクトを示し、Smaregi API へのSQL の実行について詳しく説明します。
テーブル では、利用可能なテーブルを説明します。テーブルは、Products、Customers、Shippings などを静的にモデル化するように定義されています。
ビュー では、利用可能なビューを説明します。ビューは、Stores、ShippingDetails などを静的にモデル化するように定義されています。ビューは変更できませんが、テーブルへのクエリを補足するために使用できます。
Cloud はSmaregi のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。
| Name | Description |
| AppPaymentMethods | 個別アプリ専用支払方法を取得、登録、削除します。 |
| BargainProducts | セール商品情報を取得、更新、登録、削除します。 |
| Bargains | セール情報を取得、更新、登録、削除します。 |
| BargainStores | セール店舗情報を取得、更新、登録、削除します。 |
| BudgetStaffs | スタッフ別予算を取得、更新、登録、削除します。 |
| BundleProducts | バンドル販売対象商品情報を取得、削除します。 |
| Bundles | バンドル販売情報を取得、更新、登録、削除します。 |
| Categories | 部門情報を取得、更新、登録、削除します。 |
| CategoryGroups | 部門グループ情報を取得、更新、登録、削除します。 |
| CouponItems | クーポン商品情報を取得、更新、登録、削除します。 |
| Coupons | クーポン情報を取得、更新、登録、削除します |
| CustomerGroups | 客層情報を取得、更新、登録、削除します |
| CustomerGroupSections | 客層セクション情報を取得、更新します |
| CustomerPoints | 会員ポイント情報を取得、更新します。 |
| CustomerRanks | 会員ランク情報を取得、更新、登録、削除します。 |
| Customers | 会員情報を取得、更新、登録、削除します。 |
| DailyBudget | 日別予算情報を取得、更新、登録、削除します |
| LossDivisions | ロス区分情報を取得、更新、登録、削除します |
| Losses | ロス情報を取得、更新、登録、削除します |
| PaymentMethodGroups | 支払方法分類情報を取得、更新、登録、削除します |
| PaymentMethods | Returns a list of payment methods. |
| ProductAttributeItems | 商品属性項目を取得、更新、登録、削除します。 |
| ProductAttributes | 商品属性情報を取得、更新、削除します。 |
| ProductInventoryReservations | 在庫引当商品情報を取得、削除します。 |
| ProductOptionGroupProducts | オプショングループ商品情報を取得、削除します。 |
| ProductOptionGroups | オプショングループ情報を取得、更新、登録、削除します。 |
| ProductPrices | 商品価格情報を取得、削除します。 |
| ProductReserveItemLabels | 商品自由項目ラベル情報を取得、更新、削除します。 |
| ProductReserveItems | 商品属性項目を取得、削除します。 |
| Products | 商品情報を取得、更新、登録、削除します。 |
| PurchaseOrders | 発注情報を取得、更新、登録、削除します。 |
| Receiving | 入庫情報を取得、更新します。 |
| Roles | 役割・役職情報を取得、更新、登録、削除します。 |
| Shipments | 出荷情報を取得、更新、登録、削除します。 |
| Shipping | 出庫情報を取得、更新、登録、削除します。 |
| ShippingModificationRequests | 出庫修正依頼情報を取得、削除します。 |
| StaffRanks | 社員ランク情報を取得、更新、登録、削除します。 |
| Stock | 在庫情報を取得、更新します。 |
| Storage | 入荷情報を取得、更新、登録します。 |
| StoreClasses | 店舗分類情報を取得、更新、登録、削除します。 |
| StoreClassItemRelations | 店舗分類項目関連情報を取得、削除します。 |
| StoreClassItems | 店舗分類項目を取得、更新、登録、削除します。 |
| Stores | 店舗情報を取得、更新、登録、削除します。 |
| SupplierDivisions | 仕入先区分情報を取得、更新、登録、削除します。 |
| SupplierProducts | 仕入先商品情報を取得、登録、削除します。 |
| Suppliers | 仕入先情報を取得、更新、登録、削除します。 |
| TemporaryTransactionDetails | 仮販売取引明細情報を取得、更新、登録、削除します。 |
| TemporaryTransactions | 仮販売取引情報を取得、更新、登録、削除します。 |
| Terminals | レジ端末情報を取得、更新、登録、削除します。 |
| TransactionLayaways | 取置き取引情報を取得、登録します。 |
| Transactions | 取引情報を取得、更新、登録、削除します。 |
個別アプリ専用支払方法を取得、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| PaymentMethodId [KEY] | Integer | True |
個別アプリ専用支払方法ID:クライアントIDに紐づく、契約毎に一意な支払方法ID | |
| PaymentMethodName | String | False |
個別アプリ専用支払方法名 |
セール商品情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| BargainId [KEY] | Integer | True |
Bargains.BargainId |
セールID |
| BargainProductId [KEY] | Long | True |
セール商品ID:セールID、対象区分、対象ID の3つの値によって定まる一意なID | |
| Division | String | False |
割引区分:(1:割引 2:値引 3:価格指定) | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時 | |
| TargetDivision | String | False |
対象区分:(1:部門、2:商品、3:グループコード) | |
| TargetId | String | False |
対象ID:部門ID, 商品ID, グループコードのいずれかを設定 | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時 | |
| Value | Decimal | False |
値:割引、値引き、価格指定の値 |
セール情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| BargainId [KEY] | Integer | True |
セールID | |
| BargainName | String | False |
セール名称 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時 | |
| TermEnd | Date | False |
適用終了日時 | |
| TermStart | Date | False |
適用開始日時 | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時 | |
| BargainProductId | Long | False |
セール商品ID |
スタッフ別予算を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| StoreId [KEY] | Integer | False |
Stores.StoreId |
店舗ID |
| StaffId [KEY] | Integer | False |
Staffs.StaffId |
スタッフID |
| InsDateTime | Datetime | False |
作成日時 | |
| salesTargetStaff | Decimal | False |
売上金額予算額 | |
| UpdDateTime | Datetime | False |
更新日時 | |
| Ym | String | False |
年月 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| Year | Integer |
予算年 |
| Month | Integer |
予算月 |
バンドル販売対象商品情報を取得、削除します。
| Name | Type | ReadOnly | References | Description |
| ProductBundleGroupId [KEY] | Integer | False |
Bundles.ProductBundleGroupId |
商品バンドルグループID:商品バンドルグループ毎に付与するID。サーバー側で付与する。 |
| ProductBundleId [KEY] | Integer | False |
商品バンドル明細ID:商品バンドル明細毎に付与するID。サーバー側で付与する。 | |
| ProductCategoryId | Integer | False |
部門ID:バンドル販売の対象となる部門ID。セット販売の場合、商品IDに紐つく部門ID。 | |
| ProductId | Long | False |
商品ID:バンドル販売/セット販売の対象となる商品ID。 | |
| ProductGroupCode | String | False |
商品グループコード:バンドル販売の対象となる商品グループコード。セット販売の場合、商品IDに紐つく商品グループコード。 |
バンドル販売情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| ProductBundleGroupId [KEY] | Integer | False |
商品バンドルグループID:商品バンドルグループ毎に付与するID。 | |
| CalcDiscount | String | False |
値引割引計算対象区分:値引割引計算対象区分 (0:対象外、1:対象) | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| PointNotApplicable | String | False |
ポイント対象区分:ポイント対象区分 (0:ポイント対象、1:ポイント対象外) | |
| Priority | Integer | False |
優先順位:バンドル販売適用の優先順位。 | |
| ProductBundleGroupName | String | False |
商品バンドルグループ名:商品バンドルグループの名称。 | |
| Quantity | Integer | False |
数量:バンドル販売の条件となる数量。 | |
| ReduceTaxId | Integer | False |
軽減税率ID(税設定):軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。軽減:10000001 (特定商品の軽減税率適用)、選択[標準]:10000002(状態による適用[適用しない])、選択[軽減]:10000003(状態による適用[適用する])、選択[選択]:10000004(状態による適用[都度選択する]) | |
| ReduceTaxValue | Integer | False |
軽減税率適用時の値:タイプ=1,4の時は販売金額、タイプ=2の時は値引金額、タイプ=3の時は割引率 | |
| TaxDivision | String | False |
税区分:税区分 (0:税込、1:税抜、2:非課税) | |
| TaxFreeDivision | String | False |
免税区分:免税区分 (0:対象外、1:一般品、2:消耗品) | |
| TermFrom | Date | False |
適用開始日:適用開始日。 | |
| TermTo | Date | False |
適用終了日:適用終了日。 | |
| Type | String | False |
種類:バンドル販売の種類。1:バンドル売り+販売金額指定、2:バンドル売り+値引金額指定、3:バンドル売り+割引率指定、4:セット売り+販売金額指定 | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 | |
| Value | Integer | False |
値:タイプ=1,4の時は販売金額、タイプ=2の時は値引金額、タイプ=3の時は割引率。 | |
| Products | String | False |
対象商品:バンドル販売の対象商品 |
部門情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| CategoryId [KEY] | Integer | True |
部門ID:数字9桁以内。 | |
| CategoryAbbr | String | False |
部門名略称:85文字以内。 | |
| CategoryCode | String | False |
部門コード:半角英数記号20文字以内。 | |
| CategoryGroupId | Integer | False |
CategoryGroups.CategoryGroupId |
部門グループ:部門グループID。部門グループがない場合は空白。 |
| CategoryName | String | False |
部門名:85文字以内。 | |
| Color | String | False |
端末表示カラー:端末に表示するカラー。(HTMLカラーコード形式)例) #000000 | |
| DisplayFlag | String | False |
端末表示:スマレジ端末に表示するか否かの判定。 (0:表示しない、1:表示する) | |
| DisplaySequence | Integer | False |
表示順:数字9桁以内。 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| Level | String | True |
階層レベル:階層レベルは1〜3。親部門が未設定の場合は1。 | |
| ParentCategoryId | Integer | False |
親部門:親部門ID。親部門がない場合は空白。 | |
| PointNotApplicable | String | False |
ポイント対象:ポイント対象にするか否かの設定。(0:ポイント対象、1:ポイント対象外) | |
| ReduceTaxId | Integer | False |
軽減税率ID(税設定):軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。軽減:10000001 (特定商品の軽減税率適用)、選択[標準]:10000002(状態による適用[適用しない])、選択[軽減]:10000003(状態による適用[適用する])、選択[選択]:10000004(状態による適用[都度選択する]) | |
| Tag | String | False |
タグ:85文字以内。複数ある場合は、カンマで区切り。 | |
| TaxDivision | String | False |
税区分:商品価格の消費税の扱いに関する設定。 (0:内税、1:外税、2:非課税) | |
| TaxFreeDivision | String | False |
免税区分:免税区分の設定。 (0:対象外、1:一般品、2:消耗品) | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 |
部門グループ情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| CategoryGroupId [KEY] | Integer | True |
部門グループID | |
| CategoryGroupCode | String | False |
部門グループコード | |
| CategoryGroupName | String | False |
部門グループ名 | |
| DisplaySequence | Integer | False |
表示順 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 |
クーポン商品情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| CouponId [KEY] | Integer | True |
Coupons.CouponId |
クーポンID |
| CouponItemId | Integer | True |
クーポンに紐づくアイテムID | |
| Division [KEY] | String | False |
クーポンアイテム区分:itemId の値が何を示すものか表します。(1:部門ID、2:商品ID、3:商品グループコード) | |
| ItemId [KEY] | Integer | False |
アイテムID:クーポンに紐づくアイテムを特定するための、その区分におけるID。 | |
| Type [KEY] | String | False |
クーポンアイテムタイプ (1: 適用条件、2:商品付与) | |
| SalesPrice | Integer | False |
販売価格 |
クーポン情報を取得、更新、登録、削除します
| Name | Type | ReadOnly | References | Description |
| CouponId [KEY] | Integer | True |
クーポンID | |
| ApplyConditionDivision | String | False |
適用条件区分:クーポンの使用条件のうち、対象商品が含まれている必要があるか指定します。(0:全適用、1:対象商品が含まれる場合のみ適用) | |
| AwardType | String | False |
特典タイプ:そのクーポンのタイプ。(1:値引、2:割引、3:商品付与、P1:0ポイント、P2:ポイント指定(上書き)、P3:ポイント追加(加算)、P4:ポイントN倍、M1:0マイル、M2:マイル指定(上書き)、M3:マイル追加(加算)、M4:マイルN倍) | |
| AwardValue | Integer | False |
特典値: 特典タイプに応じた値を設定。 | |
| CombineDivision | String | False |
併用区分:クーポン利用時に他クーポンとの併用が可能か否かを指定します。(1:併用不可、2:一部のクーポン(3:併用可能)と併用可能、3:併用可能) | |
| CouponDivision | String | False |
クーポン区分:クーポン区分(0:通常、1:giftee) | |
| CouponName | String | False |
クーポン名 | |
| EndDate | Date | False |
利用可能終了日:クーポンの有効期限(終了日)。 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| MaxTargetPrice | Integer | False |
最高対象金額 | |
| MinTargetPrice | Integer | False |
最低対象金額 | |
| SerialNumber | String | False |
シリアル番号:端末側でのクーポンの入力に用いられます。 | |
| StartDate | Date | False |
利用可能開始日:クーポンの有効期限(開始日)。 | |
| Summary | String | False |
概要 | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 | |
| Items | String | False |
クーポンアイテム | |
| Applicable | Date | False |
利用可能期間 |
客層情報を取得、更新、登録、削除します
| Name | Type | ReadOnly | References | Description |
| CustomerGroupId [KEY] | Integer | True |
客層ID | |
| CustomerGroupSectionId | Integer | False |
CustomerGroupSections.CustomerGroupSectionId |
客層セクションID |
| DisplayFlag | String | False |
表示フラグ:端末で表示するか判定 (0:表示しない、1:表示する) | |
| DisplaySequence | Integer | False |
表示順 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| Label | String | False |
ラベル | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 |
客層セクション情報を取得、更新します
| Name | Type | ReadOnly | References | Description |
| CustomerGroupSectionId [KEY] | String | True |
客層セクションID | |
| CustomerGroupSectionLabel | String | False |
客層セクションラベル | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 |
会員ポイント情報を取得、更新します。
| Name | Type | ReadOnly | References | Description |
| CustomerId [KEY] | Long | True |
会員ID | |
| InsDateTime | Datetime | True |
登録日時:登録時の日時。 | |
| Mile | Integer | False |
マイル ※マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。 | |
| Point | Integer | False |
ポイント ※ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 | |
| PointExpireDate | Date | False |
ポイント失効予定日 | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 |
会員ランク情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| Rank [KEY] | String | True |
会員ランク | |
| DisplayFlag | String | False |
有効/無効:端末で表示するかを設定。(0:無効、1:有効) | |
| DisplaySequence | Integer | False |
表示順 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| Name | String | False |
名称 | |
| PointGivingUnit | Decimal | False |
付与ポイント数:付与するポイント数 | |
| PointGivingUnitPrice | Integer | False |
ポイント付与単位:ポイントを付与する単位(金額) | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 |
会員情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| CustomerId [KEY] | Long | True |
会員 ID | |
| Address | String | False |
住所 | |
| AlphabetName | String | False |
アルファベット氏名 | |
| BirthDate | Date | False |
生年月日: | |
| BrowsingList | String | False |
閲覧履歴リスト:1000文字以内。 | |
| CompanyName | String | False |
会社名 | |
| CustomerCode | String | False |
会員コード | |
| CustomerNo | String | False |
会員番号 | |
| DepartmentName | String | False |
部署名 | |
| EntryDate | Date | False |
入会日: | |
| FavoriteList | String | False |
お気に入りリスト:1000文字以内。 | |
| FaxNumber | String | False |
FAX 番号 | |
| FirstKana | String | False |
名カナ | |
| FirstName | String | False |
名 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| LastComeDateTime | Datetime | False |
最終来店日時: | |
| LastKana | String | False |
姓カナ | |
| LastName | String | False |
姓 | |
| LeaveDate | Date | False |
退会日: | |
| MailAddress | String | False |
メールアドレス | |
| MailAddress2 | String | False |
メールアドレス2 | |
| MailAddress3 | String | False |
メールアドレス3 | |
| MailReceiveFlag | String | False |
案内メール受取許可フラグ(0:拒否、1:許可) | |
| ManagerialPosition | String | False |
役職 | |
| MobileNumber | String | False |
携帯電話番号 | |
| Nationality | String | False |
国籍 | |
| Note | String | False |
備考:1000文字以内。 | |
| Note2 | String | False |
備考2:1000文字以内。 | |
| PassportNo | String | False |
旅券番号:パスポート番号 | |
| PhoneNumber | String | False | ||
| PinCode | String | False |
PIN コード | |
| PointExpireDate | Date | False |
ポイント失効予定日: | |
| PointGivingUnitPrice | Integer | False |
ポイント付与単位(金額) | |
| PointGivingUnit | Decimal | False |
ポイント付与単位(ポイント) | |
| PostCode | String | False | ||
| Rank | String | False | ||
| Sex | Integer | False | ||
| StaffRank | String | False |
社員ランク | |
| Status | String | False |
会員状態区分(0:利用可、1:利用停止、2:紛失、3:退会、4:名寄せ) | |
| StoreId | Integer | False |
対象店舗 ID | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 |
日別予算情報を取得、更新、登録、削除します
| Name | Type | ReadOnly | References | Description |
| StoreId [KEY] | Integer | False |
店舗ID | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| SalesTargetDaily | Decimal | False |
売上金額予算額:売上金額の目標額。(最大15桁) | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Ym | String | False |
年月:予算年月。(YYYYMM形式) | |
| Day | Integer | False |
日:予算年月の日。 | |
| Year [KEY] | Integer | False |
年:予算年月の年 | |
| Month [KEY] | Integer | False |
月:予算年月の月 |
ロス区分情報を取得、更新、登録、削除します
| Name | Type | ReadOnly | References | Description |
| Code [KEY] | String | True |
コード | |
| ActiveFlag | String | False |
有効フラグ: (0:無効 1:有効) | |
| Color | String | False |
色:ロス一覧に表示される色。カラーコード。例:「#FFFFFF」 | |
| DisplaySequence | Integer | False |
表示順 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| Name | String | False |
ロス区分名 | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 |
ロス情報を取得、更新、登録、削除します
| Name | Type | ReadOnly | References | Description |
| LossId [KEY] | Integer | True |
ロスID | |
| Division | String | False |
ロス区分:ロス区分一覧より設定可能。 | |
| IdentificationNo | String | False |
識別番号:ロス情報を管理するための任意の文字列を設定出来る項目。 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| LossDateTime | Datetime | False |
ロス発生日時:ロス発生時の日時。 | |
| Memo | String | False |
メモ | |
| StaffId | Integer | False |
スタッフID:ロス処理時のスタッフID | |
| StaffName | String | False |
スタッフ名:ロス処理時のスタッフ名 | |
| StoreId | Integer | False |
店舗ID | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 | |
| Details | String | False |
ロス明細 |
支払方法分類情報を取得、更新、登録、削除します
| Name | Type | ReadOnly | References | Description |
| PaymentMethodGroupId [KEY] | Integer | False |
支払方法分類ID | |
| Code | String | False |
コード:一意にするための値 | |
| DisplayFlag | String | False |
有効/無効:端末で表示するかを設定。(0:無効、1:有効) | |
| DisplaySequence | Integer | False |
表示順 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時 | |
| Name | String | False |
名称 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時 |
Returns a list of payment methods.
| Name | Type | ReadOnly | References | Description |
| PaymentMethodId [KEY] | Integer | False |
支払方法ID:各支払方法に紐づくID。 | |
| ChangeFlag | String | False |
釣銭フラグ:釣銭の有無を設定。(0:釣銭なし、1:釣銭あり) | |
| DisplayFlag | String | False |
表示フラグ:端末で表示するかを設定。(0:表示しない、1:表示する) | |
| DisplaySequence | Integer | False |
表示番号 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| PaymentMethodCode | String | False |
支払方法コード:半角英数記号20文字以内。 | |
| PaymentMethodGroupId | Integer | False |
支払方法分類ID:[管理画面->設定->販売設定->支払方法分類] から確認できる支払方法分類のIDを指定。 | |
| PaymentMethodName | String | False |
支払方法名:支払方法名。85文字以内。 | |
| PointGivingUnit | Decimal | False |
ポイント付与単位(ポイント):ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)(例10円ごとに0.2ポイントの場合、0.2ポイント) | |
| PointGivingUnitPrice | Integer | False |
ポイント付与単位(金額):ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)(例10円ごとに2ポイントの場合、10円)※ポイント付与が重複で設定されている場合、適用される優先度は【カード会社 > 支払方法 > 会員 > 会員ランク > 店舗】の順。 | |
| SecuritiesFlag | String | False |
有価証券フラグ:有価証券であるかを設定。(0:有価証券ではない、1:有価証券である) | |
| UnitPrice | Integer | False |
単価:商品券のように1枚あたりの価格が決まっている場合に設定。(例:商品券1枚が500円の場合、500) | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Stores | String | False |
支払方法取扱店舗 |
商品属性項目を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| Code [KEY] | String | False |
コード:商品属性項目を一意にする項目 | |
| DisplaySequence | Integer | False |
表示順:表示順序 | |
| No | String | False |
項目番号:商品属性に付与されている連番 | |
| Name | String | False |
選択肢名:商品属性項目の名称 |
商品属性情報を取得、更新、削除します。
| Name | Type | ReadOnly | References | Description |
| No [KEY] | String | True |
項目番号:商品属性に付与されている連番 | |
| Name | String | False |
属性名:商品属性の名称 |
在庫引当商品情報を取得、削除します。
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | Long | False |
Products.ProductId |
商品ID |
| ReservationProductId [KEY] | Long | False |
引当商品商品ID | |
| ReservationAmount | Integer | False |
引当数 |
オプショングループ商品情報を取得、削除します。
| Name | Type | ReadOnly | References | Description |
| ProductOptionGroupId [KEY] | String | False |
ProductOptionGroups.ProductOptionGroupId |
オプショングループID |
| ProductId [KEY] | Long | False |
Products.ProductId |
商品ID |
| SyncDivision | String | False |
作成区分:作成区分。(0:通常、1:Waiter、2:本部、9:その他) (本部から同期処理で作成された場合2:本部で作成されます。) | |
| insDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| updDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 |
オプショングループ情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| ProductOptionGroupId [KEY] | String | False |
オプショングループID | |
| ConditionId | String | False |
条件ID (0:条件なし、1:全体、2:部門毎) | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| Max | String | False |
適用条件の上限:条件IDが 1:全体、2:部門毎 のときは必須。 | |
| Min | String | False |
適用条件の下限:条件IDが 1:全体、2:部門毎 のときは必須。 | |
| ProductOptionGroupName | String | False |
オプショングループ名 | |
| SyncDivision | String | False |
作成区分:(0:通常、1:Waiter、2:本部、9:その他) 本部から同期処理で作成された場合2:本部で作成されます。 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Products | String | False |
オプショングループ商品 |
商品価格情報を取得、削除します。
Cloud は、WHERE 句の条件と選択されたカラムを処理するために Smaregi API を使用します。
演算子: =、ORDER BY はサーバー側で処理されます。
例えば、以下のクエリはサーバー側で処理されます:
SELECT * from ProductPrices where ProductId=202504301729112
NOTE: 疑似カラムはINSERT およびUPDATE 操作でのみサポートされています。
ProductPrices に追加するには、以下のカラムを指定してください: Price、ProductName、CategoryId、StoreId、PriceDivision、StartDate、EndDate、ProductPrice。
INSERT INTO ProductPrices (Price, ProductName, CategoryId, StoreId, PriceDivision, StartDate, EndDate, ProductPrice) VALUES (90,testingproductname,1,35,2,2000-01-23,2000-01-24,12345678)
Smaregi ではProductPrice カラムの更新が可能です。
UPDATE ProductPrices SET ProductPrice=89 WHERE ProductId=202504301729109
NOTE: ProductPrice を更新すると、Price カラムの値も更新されます。
ProductPrices は、ProductId、PriceDivision、StoreId、StartDate を指定することで削除できます。
DELETE FROM ProductPrices WHERE ProductId = 1 AND PriceDivision = 2 AND StoreId = 3 AND StartDate = '2025/3/3'
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | Long | False |
Products.ProductId |
商品ID:数字15桁以内。 |
| PriceDivision [KEY] | String | False |
価格区分:1:商品単価、2:会員価格 | |
| StartDate [KEY] | Date | False |
適用開始日:適用開始日。 | |
| StoreId [KEY] | Integer | False |
店舗ID:数字9桁以内。全店の場合「-1」を設定 | |
| Price | Integer | False |
商品単価:商品単価。数字8桁以内。 | |
| EndDate | Date | False |
適用終了日:適用終了日。※未設定の場合、有効期限なしとして適用されます。 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| CategoryId | Integer | |
| ProductName | String | |
| ProductPrice | String |
商品自由項目ラベル情報を取得、更新、削除します。
| Name | Type | ReadOnly | References | Description |
| No [KEY] | String | False |
商品自由項目番号 | |
| Label | String | False |
ラベル:85文字以内。自由項目の値。 |
商品属性項目を取得、削除します。
| Name | Type | ReadOnly | References | Description |
| No [KEY] | String | False |
商品自由項目番号 | |
| ProductId [KEY] | Long | False |
Products.ProductId |
商品ID |
| Value | String | False |
自由項目の値 |
商品情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | Long | False |
商品 ID:数字15桁以内。 | |
| AppStartDateTime | Datetime | False |
適用開始日時:商品が端末に適用される日時を設定。未設定の場合は未使用。 | |
| Attribute | String | False |
規格:1000文字以内。商品のカラー・サイズなどを設定。 | |
| CalcDiscount | String | False |
値引割引計算対象:小計値引/割引(クーポン値引、ポイント値引含む)の対象かどうかを設定(0:対象外、1:対象)未設定の場合、1:対象を設定。 | |
| CatchCopy | String | False |
キャッチコピー:1000文字以内。商品のキャッチコピーなどを設定。 | |
| CategoryId | Integer | False |
部門 ID:数字9桁以内。 | |
| Color | String | False |
カラー:85文字以内。 | |
| Cost | Decimal | False |
原価:数字8桁以内(少数5桁まで)。未設定の場合0を設定。 | |
| CustomerPrice | Integer | False |
会員価格:数字8桁以内。会員価格を設定。 | |
| Description | String | False |
説明:1000文字以内。商品説明などを設定。 | |
| DisplayFlag | String | False |
端末表示:スマレジ端末に表示するか否かの判定。未設定の場合1を設定。(0:表示しない、1:表示する) | |
| DisplaySequence | Integer | False |
表示順:数字9桁以内。 | |
| Division | String | False |
商品区分:商品の種類を設定。未設定の場合0を設定。(0:通常商品、1:回数券(*1)、2:オプション商品) | |
| GroupCode | String | False |
グループコード:関連商品として紐付ける為のグループコードを設定。例えば、A と B の商品に同じグループコード001を設定すると、A と B は関連商品となります。サイズ、カラーが異なる場合などに使用してください。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| OrderPoint | Integer | False |
発注点:発注をかけるべき在庫数。 | |
| PointNotApplicable | String | False |
ポイント対象:ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外) | |
| Price | Integer | False |
商品単価:数字8桁以内。販売価格を設定。 | |
| PrintReceiptProductName | String | False |
レシート印字商品名:レシートに印字する商品名。64文字以内。 | |
| ProductCode | String | False |
商品コード:半角英数記号20文字以内。 | |
| ProductKana | String | False |
商品カナ:全角カナ85文字以内。 | |
| ProductName | String | False |
商品名:85文字以内。 | |
| ProductOptionGroupId | Integer | False |
オプショングループ ID:オプショングループの設定方法が「全店舗共通」の場合、適用可能なオプショングループがあればその ID がこちらに設定されます。無ければ null が設定されます。 | |
| ProductPriceDivision | String | False |
商品価格区分:商品をオープン価格販売するかどうか設定。未設定の場合1を設定。(1:通常価格、2:オープン価格) | |
| PurchaseCost | Decimal | False |
仕入原価:商品の仕入原価。 | |
| ReduceTaxCustomerPrice | Integer | False |
軽減税率用商品会員単価:軽減税率用会員単価を設定。設定内容については、「軽減税率用商品単価」と同様となります。 | |
| ReduceTaxId | Integer | False |
軽減税率 ID(税設定):軽減税率 ID。軽減税率設定画面で設定した軽減税率 ID、または、下記の軽減税率 ID。標準税率の場合は null。軽減:10000001(特定商品の軽減税率適用)選択[標準]:10000002(状態による適用[適用しない])選択[軽減]:10000003(状態による適用[適用する])選択[選択]:10000004(状態による適用[都度選択する])※部門の税設定を使用する場合、所属部門の軽減税率 ID。 | |
| ReduceTaxPrice | String | False |
軽減税率用商品単価:軽減税率用商品単価を設定。当項目は、レジ端末で販売時に、軽減税率を選択した時の価格になります。未設定の場合は、「商品単価」が軽減税率を選択した時の価格になります。税込の場合設定可能。税抜価格の場合計算して算出できるため税込の場合のみ設定できます。 | |
| SalesDivision | String | False |
売上区分:取引時に売上計上するか否かの設定。(0:売上対象、1:売上対象外) | |
| Size | String | False |
サイズ:85文字以内。 | |
| StaffDiscountRate | Integer | False |
社員販売割引率:数字3桁以内。社員販売時の割引率を設定。 | |
| StockControlDivision | String | False |
在庫管理区分:棚卸対象商品とするか否かの設定。(0:在庫管理対象、1:在庫管理対象外) | |
| SupplierProductNo | String | False |
品番:85文字以内。 | |
| Tag | String | False |
タグ:85文字以内。複数ある場合は、カンマで区切り。 | |
| TaxDivision | String | False |
税区分:商品価格の消費税の扱いに関する設定。(0:内税、1:外税、2:非課税) | |
| TaxFreeDivision | String | False |
免税区分:免税区分の設定。未設定の場合0を設定。(0:対象外、1:一般品、2:消耗品)免税機能を利用しない場合は「対象外」としてください。「対象外」免税対象ではない商品、「一般品」電化製品、服、着物、カバンなど、「消耗品」酒、食品類、薬品類、化粧品類など※部門の免税区分よりも、商品の免税区分を優先します。(部門売りで適用されます。) | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Url | String | False |
URL:255文字以内。スマレジ端末で WEB ページを表示したい場合設定。 | |
| UseCategoryReduceTax | String | False |
部門の税設定を使用:商品に設定した税設定を使用するか、その商品に設定した部門の税設定を使用するかを選択。(0:商品の税設定を使用、1:部門の税設定を使用)「軽減税率 ID(税設定)」に値が設定されている場合「0:商品の税設定を使用」。「軽減税率 ID(税設定)」の値が未設定(null)の場合「1:部門の税設定を使用」を設定 | |
| ReserveItems | String | False |
商品自由項目 | |
| Prices | String | False |
商品価格 | |
| Stores | String | False |
商品取扱店舗 | |
| AttributeItems | String | False |
商品属性項目 | |
| InventoryReservations | String | False |
在庫引当商品 | |
| OrderSettings | String | False |
発注設定 |
発注情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| PurchaseOrderId [KEY] | Integer | False |
発注ID | |
| StorageInfoId | Integer | False |
発注ID | |
| CategoryGroupId | Integer | False |
部門グループID:nullの時は全部門グループ | |
| DivisionUnit | String | False |
分割単位:0:なし、1:部門グループ、2:仕入先 | |
| IdentificationNo | String | False |
識別番号:発注情報を管理するための任意の文字列を設定出来る項目。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| Memo | String | False |
メモ | |
| OrderedDate | Date | False |
発注日 | |
| RecipientOrderId | Integer | False |
発注先ID:発注先となる仕入先ID | |
| RoundingDivision | String | False |
税丸め(0:四捨五入、1:切り捨て、2:切り上げ) | |
| StaffId | Integer | False |
スタッフID:発注処理時のスタッフID | |
| Status | String | False |
ステータス(2:発注済、3:入荷検品中、4:入荷完了、5:仮発注) | |
| StorageInfoId | Integer | False |
発注ID | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Products | String | False |
発注対象商品 | |
| Stores | String | False |
発注対象店舗 |
入庫情報を取得、更新します。
| Name | Type | ReadOnly | References | Description |
| ReceivingId [KEY] | Integer | True |
入庫ID | |
| ReceivingDate [KEY] | Date | True |
入庫日 | |
| IdentificationNo | String | False |
識別番号:入庫情報を管理するための任意の文字列を設定出来る項目。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| Memo | String | False |
メモ | |
| ReceivingExpectedDateFrom | Date | False |
入庫予定日From: | |
| ReceivingExpectedDateTo | Date | False |
入庫予定日To: | |
| ReceivingStoreId | Integer | False |
入庫店舗ID | |
| ShippingId | Integer | False |
出庫ID | |
| ShippingStoreId | Integer | False |
出庫店舗ID | |
| StaffId | Integer | False |
スタッフID:入庫登録時のスタッフID | |
| Status | String | False |
入庫ステータス:(0:未入庫、1:検品中、2:入庫完了) | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Details | String | False |
入庫明細(with_details=all時のみ返される) |
役割・役職情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| RoleId [KEY] | Integer | True |
役割・役職ID | |
| RoleName | String | False |
役割名・役職名 | |
| Note | String | False |
説明 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| FunctionControls | String | False |
機能制限:POS機能における役割・役職に対する機能制限の一覧です。 | |
| InventoryFunctionControls | String | False |
在庫機能制限:在庫機能における役割・役職に対する機能制限の一覧です。 | |
| AlertFunctionControls | String | False |
アラート機能制限:在庫アラートにおける役割・役職に対する機能制限の一覧です。 |
出荷情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| ShipmentId [KEY] | Integer | True |
出荷ID | |
| ApprovalDateTime | Datetime | False |
承認日時:出荷承認日時/承認拒否日時 | |
| ApprovalStatus | String | False |
承認ステータス:0:未承認, 1:承認済, 2:承認拒否 | |
| IdentificationNo | String | False |
識別番号:出荷情報を管理するための任意の文字列を設定出来る項目。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| Memo | String | False |
メモ | |
| RecipientId | Integer | False |
受取先ID:受取先タイプのID | |
| RecipientName | String | False |
受取先名:登録時の受取先名 | |
| RecipientType | String | False |
受取先タイプ:1:仕入先、3:その他 | |
| RoundingDivision | String | False |
税丸め(0:四捨五入、1:切り捨て、2:切り上げ) | |
| ShipmentDate | Date | False |
出荷日: | |
| ShipmentDivision | String | False |
出荷区分:0:出荷、1:返品、2:販促品 | |
| ShipmentStoreId | Integer | False |
出荷店舗ID | |
| StaffId | Integer | False |
スタッフID | |
| Status | String | False |
出荷ステータス:(0:未出荷、2:出荷済、3:出荷検品中) ※3:出荷検品中はAPIでの指定のみ | |
| TaxRate | Decimal | False |
税率:出荷時の税率 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Details | String | False |
出荷明細一覧 |
出庫情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| ShippingId [KEY] | Integer | True |
出庫ID | |
| ApprovalDateTime | Datetime | False |
承認日時:出庫承認日時/承認拒否日時。 | |
| ApprovalStatus | String | False |
承認ステータス:未設定の場合 0:未承認を設定。0:未承認、1:承認済、2:承認拒否、3:依頼未承認 | |
| IdentificationNo | String | False |
識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| Memo | String | False |
入庫/出庫メモ | |
| ModificationRequestCheckedDateTime | Datetime | False |
修正依頼確認完了日時:修正依頼ステータスが修正完了になった日時を設定。 | |
| ModificationRequestDateTime | Datetime | False |
修正依頼日時:修正依頼を行った日時を設定。 | |
| ModificationRequestStatus | String | False |
修正依頼ステータス:出庫情報の修正依頼ステータスを設定。0:修正依頼なし、1:修正依頼あり、2:修正完了 | |
| ReceivingDesiredDate | Date | False |
入庫希望日: | |
| ReceivingExpectedDateFrom | Date | False |
入庫予定日From: | |
| ReceivingExpectedDateTo | Date | False |
入庫予定日To: | |
| ReceivingStoreId | Integer | False |
入庫店舗ID | |
| RequestStaffId | Integer | False |
出庫依頼スタッフID:出庫依頼登録時のスタッフID | |
| ShippingDate | Date | False |
出庫日: | |
| ShippingStoreId | Integer | False |
出庫店舗ID | |
| StaffId | Integer | False |
スタッフID:出庫登録時のスタッフID | |
| Status | String | False |
状態:出庫/入庫の状況を設定。0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Details | String | False |
出庫明細 |
出庫修正依頼情報を取得、削除します。
| Name | Type | ReadOnly | References | Description |
| ShippingId [KEY] | String | True |
出庫ID | |
| ApprovalDateTime | Datetime | False |
承認日時:出荷承認日時/承認拒否日時。未設定の場合null | |
| ApprovalStatus | String | False |
承認ステータス。0: 未承認、1: 承認済、2: 承認拒否、3: 依頼未承認 | |
| Details | String | False |
出庫明細 | |
| IdentificationNo | String | False |
識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| Memo | String | False |
メモ | |
| ModificationRequestCheckedDateTime | String | False |
修正依頼確認完了日時:修正依頼ステータスが修正完了になった日時を設定。未設定の場合null | |
| ModificationRequestDateTime | String | False |
修正依頼日時:修正依頼を行った日時を設定。未設定の場合null | |
| ModificationRequestStatus | String | False |
修正依頼ステータス:出庫情報の修正依頼ステータスを設定。0: 修正依頼なし、1: 修正依頼あり、2: 修正完了 | |
| Receiving | String | False | ||
| ReceivingDesiredDate | Date | False |
入庫希望日: | |
| ReceivingExpectedDateFrom | Date | False |
入庫予定日From: | |
| ReceivingExpectedDateTo | Date | False |
入庫予定日To: | |
| ReceivingStoreId | String | False |
入庫店舗ID | |
| RequestStaffId | String | False |
出庫依頼スタッフID | |
| ShippingDate | Date | False |
出庫日: | |
| ShippingStoreId | String | False |
出庫店舗ID | |
| StaffId | Integer | False |
スタッフID | |
| Status | String | False |
状態:出庫/入庫の状況を設定。0: 未出庫、1: 未入庫、2: 入庫検品中、3: 入庫完了 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| ModificationRequestDate | Date | False |
修正依頼日 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| WithDetails | String |
明細取得フラグ:出庫明細を付加するか(付加する場合はall, しない場合はnone) |
| WithReceiving | String |
入庫取得フラグ:入庫情報を付加するか(付加する場合はall, しない場合はnone) |
社員ランク情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| StaffRank [KEY] | String | True |
社員ランク:社員ランクを一意に識別する番号であり、管理画面における「コード」に該当します。 | |
| DisplayFlag | String | False |
有効/無効:表示区分。(0:無効、1:有効) | |
| DisplaySequence | Integer | False |
表示順:一覧表示時の並び順の優先順位です。 | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| StaffApplicationSellingPriceDivision | String | False |
社員販売適用価格区分:セール期間中の社員販売をする際、適用される価格を設定します。(0:セール価格と社員販売割引率を掛け合わせて適用、1:セール価格と社員販売価格を比較して安い方を適用、2:セール価格と社員販売価格を比較して高い方を適用) | |
| StaffDiscountRate | Integer | False |
社員販売割引率:社員販売を行う際に適用される割引率を入力します。 | |
| StaffRankDisplayName | String | False |
表示名称:社員販売時に表示される名称です。未設定の場合は「名称」がそのまま表示されます。 | |
| StaffRankFullName | String | False |
名称:社員ランクの正式名称です。 | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 | |
| UseProductStaffDiscountRateDivision | String | False |
商品マスタ社員販売割引率利用区分:社員販売の割引率に商品マスタの社員販売割引率を適用するかを設定します。(0:利用しない、1:利用する) |
在庫情報を取得、更新します。
| Name | Type | ReadOnly | References | Description |
| ProductId [KEY] | Long | False |
商品ID:数字15桁以内。 | |
| StoreId [KEY] | Integer | False |
店舗ID:数字9桁以内。 | |
| LayawayStockAmount | Integer | False |
取置き在庫数:現在の取置き在庫数。 | |
| StockAmount | Integer | False |
在庫数:現在の在庫数。 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| StockHistory | String | False |
在庫変動履歴 |
入荷情報を取得、更新、登録します。
| Name | Type | ReadOnly | References | Description |
| StorageId [KEY] | Integer | False |
入荷ID:自動採番 | |
| IdentificationNo | String | False |
識別番号:入荷情報を管理するための任意の文字列を設定出来る項目。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| Memo | String | False |
メモ | |
| RoundingDivision | String | False |
税丸め(0:四捨五入、1:切り捨て、2:切り上げ) | |
| StaffId | Integer | False |
スタッフID:入荷登録時のスタッフID | |
| Status | String | False |
入荷ステータス:(0:未入荷、1:検品中、2:入荷完了) | |
| StorageDate | Date | False |
入荷日 | |
| StorageExpectedDateFrom | Date | False |
入荷予定日From: | |
| StorageExpectedDateTo | Date | False |
入荷予定日To: | |
| StorageInfoId | Integer | False |
発注ID:発注登録から作成された入荷の場合のみ、発注IDを設定。 | |
| StorageStoreId | Integer | False |
入荷店舗ID | |
| SupplierId | Integer | False |
仕入先ID | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Details | String | False |
入荷明細 |
店舗分類情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| StoreClassId [KEY] | Integer | False |
店舗分類ID:数字10桁以内。 | |
| DisplaySequence | Integer | False |
表示順: | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| StoreClassName | String | False |
店舗分類項目名 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 |
店舗分類項目関連情報を取得、削除します。
| Name | Type | ReadOnly | References | Description |
| StoreClassId [KEY] | Integer | False |
StoreClasses.StoreClassId |
店舗ID |
| StoreId [KEY] | Integer | False |
Stores.StoreId |
店舗分類ID |
| StoreClassItemId | Integer | False |
StoreClassItems.StoreClassItemId |
店舗分類項目ID |
店舗分類項目を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| StoreClassId [KEY] | Integer | True |
StoreClasses.StoreClassId |
店舗分類ID: |
| StoreClassItemId [KEY] | Integer | True |
店舗分類項目ID: | |
| DisplaySequence | Integer | False |
表示順: | |
| InsDateTime | Datetime | True |
作成日時:登録時の日時。 | |
| StoreClassItemName | String | False |
店舗分類項目名: | |
| UpdDateTime | Datetime | True |
更新日時:登録時・更新時の日時。 |
店舗情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| StoreId [KEY] | Integer | False |
店舗ID:店舗毎に付与するID。 | |
| Address | String | False |
住所:店舗住所。85文字以内。 | |
| CancelSettingDivision | String | False |
取消設定区分:(1:自動、2:消込のみ、3:両方) | |
| CardCompanySelectDivision | String | False |
カード会社選択区分(0:選択なし、1:選択あり) | |
| CarriageDisplayFlag | String | False |
送料表示フラグ:(0:表示しない、1:表示する) | |
| DiscountRoundingDivision | String | False |
割引丸め区分:割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ | |
| DisplaySequence | Integer | False |
表示順: | |
| Division | String | False |
店舗区分:店舗区分。(1:通常店舗、2:倉庫) | |
| FaxNumber | String | False |
FAX番号:店舗FAX番号。半角英数20文字以内。 | |
| GiftReceiptValidDays | Integer | False |
ギフトレシート引換有効日数 | |
| Homepage | String | False |
ホームページ:店舗ホームページ。255文字以内。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| InvoiceRegistrationNo | String | False |
登録事業者番号:適格請求書発行事業者としての登録番号。 | |
| MailAddress | String | False |
メールアドレス:店舗メールアドレス。半角英数記号255文字以内。メールアドレス形式。 | |
| MaxBundleProductCount | Integer | False |
バンドル登録最大件数:簡易バンドル商品登録最大件数。(設定範囲: 0-999) | |
| MaxDiscountRate | Integer | False |
最大値引率 | |
| PauseFlag | String | False |
休止フラグ:数字1桁。休止フラグ。(0:通常、1:休止) | |
| PhoneNumber | String | False |
電話番号:店舗電話番号。半角英数20文字以内。 | |
| PointNotApplicable | String | False |
ポイント対象区分:ポイント対象区分。(0:ポイント対象、1:ポイント対象外) | |
| PostCode | String | False |
郵便番号:店舗郵便番号。半角英数記号10文字以内。 | |
| PriceChangeFlag | String | False |
端末価格変更許可フラグ:iPod、iPadで販売価格を変更可能か否かの区分。 (0:変更不可、1:変更可能) | |
| PrintReceiptStoreName | String | False |
レシート印刷用店舗名:レシートに印字する店舗名。(64文字以内) | |
| PrintStockReceiptStoreName | String | False |
在庫レシート印字店舗名:在庫レシートに印字する店舗名。(64文字以内) | |
| RoundingDivision | String | False |
端数値引区分:販売時の合計金額の端数を丸めるか否かを設定する(00:なし、11:一の位を四捨五入,12:一の位を切捨,13:一の位を切上、21:十の位を四捨五入,22:十の位を切捨,23:十の位を切上、31:百の位を四捨五入,32:百の位を切捨,33:百の位を切上、41:千の位を四捨五入,42:千の位を切捨,43:千の位を切上、99:手入力) | |
| SavingAutoDivision | String | False |
銀行預入金自動入力区分:(0:自動入力しない、1:自動入力する) | |
| SavingAutoPrice | Integer | False |
銀行預入金自動入力金額 | |
| SellDivision | String | False |
販売区分:店舗での販売時の消費税の扱いを指定する区分。 (0:内税販売、1:外税販売) | |
| StoreAbbr | String | False |
店舗名略称:店舗名略称。85文字以内。 | |
| StoreCode | String | False |
店舗コード:店舗コード。 | |
| StoreName | String | False |
店舗名:店舗名。(85文字以内) | |
| SumDateChangeTime | String | False |
締め日付変更時間:日付変更時間。締め処理時に使用 (HHMM形式) 締め方式区分が1:自動締め処理の場合必須。 | |
| SumProcDivision | String | False |
締め方式区分:締め方法を指定する区分。 (0:手動締め処理、1:自動締め処理) | |
| SumRefColumn | String | False |
締め参照時間項目:締め処理を行う時に参照する時間。締め処理時に使用。 (0:端末時間、1:サーバー時間) | |
| TaxFreeDivision | String | False |
免税区分:免税区分。(0:対象外、1:一般品、2:消耗品) | |
| TaxLabelNormal | String | False |
標準税率のボタンラベル | |
| TaxLabelReduce | String | False |
軽減税率のボタンラベル | |
| TempTranMailAddress | String | False |
仮販売登録時送信先アドレス:仮販売登録時に送信するメールアドレス。1000文字以内。 | |
| TerminalAdjustmentCashFlag | String | False |
端末精算時の現金管理フラグ:(0:入力しない、1:入力する) | |
| TerminalCheckCashFlag | String | False |
端末点検時の現金管理フラグ:(0:入力しない、1:入力する) | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| WaiterAdjustmentDivision | String | False |
ウェイター精算可能チェック区分:(0:チェックしない、1:チェックする) | |
| PointCondition | String | False |
ポイント条件 | |
| ReceiptPrintInfo | String | False |
レシート印刷情報 | |
| WithPointCondition | String | False |
ポイント情報を付加するか(付加する場合はall, しない場合はnone) | |
| WithReceiptPrintInfo | String | False |
レシート印刷情報を付加するか(付加する場合はall, しない場合はnone) |
仕入先区分情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| SupplierDivisionId [KEY] | Integer | False |
仕入先区分ID | |
| DisplayFlag | String | False |
有効/無効:端末で表示するかを設定。(0:無効、1:有効) | |
| DisplaySequence | Integer | False |
表示順 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| Name | String | False |
名称 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 |
仕入先商品情報を取得、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| SupplierId [KEY] | Integer | False |
Suppliers.SupplierId |
仕入先ID |
| CategoryId | Integer | False |
部門ID:仕入先で取り扱っている部門のID。商品IDで登録された仕入先商品の場合、nullを設定。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| ProductId | Long | False |
Products.ProductId |
商品ID:仕入先で取り扱っている商品のID。部門IDで登録された仕入先商品の場合、nullを設定。 |
| TargetId [KEY] | String | False |
仕入先に紐づく部門IDか商品IDを指定します。 | |
| Division [KEY] | String | False |
TargetIdが部門ID、商品IDのいずれを指すか指定します。(1:部門ID、2:商品ID) |
仕入先情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| SupplierId [KEY] | Integer | False |
仕入先ID:半角数字5桁以内。 | |
| Address | String | False |
住所:255文字以内。 | |
| FaxNumber | String | False |
FAX:半角英数記号20文字以内。 | |
| InsDateTime | Datetime | False |
作成日時:登録時の日時。 | |
| MailAddress | String | False |
メールアドレス:半角英数記号255文字以内。 | |
| OrderPriority | Integer | False |
発注先優先度:半角数字5桁以内。 | |
| PhoneNumber | String | False |
電話番号:半角英数記号20文字以内。 | |
| StaffName | String | False |
担当者名:85文字以内。 | |
| SupplierAbbr | String | False |
仕入先名略称:85文字以内。 | |
| SupplierCode | String | False |
仕入先コード:半角英数10文字以内。 | |
| SupplierDivisionId | Integer | False |
SupplierDivisions.SupplierDivisionId |
仕入先区分ID:半角英数20文字以内。 |
| SupplierName | String | False |
仕入先名:85文字以内。 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 |
仮販売取引明細情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| TransactionHeadId | Integer | False |
仮販売取引ID | |
| ApplyBargainDiscountPrice | Integer | False | ||
| ApplyBargainValue | String | False | ||
| ApplyStaffDiscountPrice | Integer | False |
セール販売時のみ設定 適用した社員販売の値引き額 | |
| ApplyStaffDiscountRate | Integer | False |
セール販売時のみ設定 適用した社員販売の割引率 | |
| BargainDiscountProportional | Integer | False | ||
| BargainDivision | String | False | ||
| BargainId | Integer | False |
セール販売時のみ設定。適用したセールのID | |
| BargainName | String | False | ||
| BargainValue | Integer | False | ||
| CalcDiscount | String | False | ||
| CategoryId | Integer | False | ||
| CategoryName | String | False | ||
| Color | String | False |
カラー | |
| Cost | Decimal | False |
商品原価。整数部分8桁、少数部5桁。 | |
| CostSum | Decimal | False | ||
| DiscountCouponProportional | Integer | False | ||
| DiscountPointProportional | Integer | False | ||
| DiscountPriceProportional | Integer | False | ||
| DiscriminationNo | String | False | ||
| GroupCode | String | False |
グループコード | |
| InventoryReservationDivision | String | False | ||
| Memo | String | False | ||
| ModifiedTaxRate | Decimal | False | ||
| ParentTransactionDetailId | Integer | False |
紐付く親の取引明細がある場合、その取引明細IDを設定。※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の取引明細IDを設定しなければならない。 | |
| PointNotApplicable | String | False | ||
| Price | Integer | False |
※設定時そのまま設定 ※省略時、商品IDが設定されている場合、マスタから設定。以外は0円 | |
| PrintReceiptProductName | String | False |
レシート印字商品名 | |
| ProductBundleGroupId | Integer | False |
商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。商品バンドルグループに存在するIDを指定しなければならない。この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない | |
| ProductBundleProportional | Integer | False | ||
| ProductCode | String | False |
商品コード | |
| ProductDivision | String | False | ||
| ProductId | Long | False |
商品ID | |
| ProductName | String | False |
商品名 | |
| ProductStaffDiscountRate | Integer | False |
社員販売時のみ設定 商品の社販販売割引率 | |
| Quantity | Integer | False |
購入数 | |
| ReduceTaxId | Integer | False | ||
| ReduceTaxMemberPrice | Integer | False | ||
| ReduceTaxName | String | False | ||
| ReduceTaxPrice | Integer | False | ||
| ReduceTaxRate | Decimal | False | ||
| RfidTags | String | False | ||
| RoundingPriceProportional | Integer | False | ||
| SalesDivision | String | False | ||
| SalesPrice | Integer | False |
販売時の単価を設定。 | |
| Size | String | False |
サイズ | |
| StaffDiscountDivision | String | False |
社員販売時のみ設定 1ビット目: 商品マスタの社員販売最大値引率を考慮(する or しない) 2ビット目: セール価格と社員販売割引を掛け合わせて適用(する or しない) 3ビット目: セール価格と社員販売価格を比較して安い方を適用(する or しない) 4ビット目: セール価格と社員販売価格を比較して高い方を適用(する or しない) 8ビット目: セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用(する or しない) | |
| StaffDiscountProportional | Integer | False | ||
| StaffDiscountRate | Integer | False |
社員販売時のみ設定 社員販売の割引率 | |
| StaffRank | String | False |
社員販売時のみ設定 社員ランクのコードを設定 | |
| StaffRankName | String | False |
社員販売時のみ設定 社員ランクの名称を設定 | |
| StandardTaxRate | String | False | ||
| TaxDivision | String | False |
税区分。(0:税込、1:税抜、2:非課税)※設定時そのまま設定 ※省略時、商品IDが設定されている場合、マスタから設定。以外は0:税込 | |
| TaxExcludeProportional | Integer | False | ||
| TaxFree | String | False | ||
| TaxFreeCommodityPrice | Integer | False | ||
| TaxFreeDivision | String | False | ||
| TaxIncludeProportional | Integer | False | ||
| TaxRate | Decimal | False | ||
| TransactionDetailDivision | String | False |
取引明細を識別する区分。(1:通常、2:返品、3:部門売り) | |
| TransactionDetailId | Integer | False |
ユニーク値取引毎の明細に付与するID。設定する場合は1〜999まで。取引明細を指定する場合必須。 | |
| UnitDiscountDivision | String | False |
単品値引き/割引時に指定された割引区分を設定。 | |
| UnitDiscountedSum | Integer | False | ||
| UnitDiscountPrice | Integer | False |
販売単価の値引き金額を設定。単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て)。 | |
| UnitDiscountRate | Integer | False |
単品の割引率を設定。(単位:%)※設定された場合、単品値引は必須 | |
| UnitDiscountSum | Integer | False | ||
| UnitNonDiscountSum | Integer | False |
仮販売取引情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| TransactionHeadId [KEY] | Integer | True |
仮販売取引ID | |
| AdjustmentDateTime | Datetime | False | ||
| AdjustmentMile | Integer | False | ||
| AdjustmentMileDivision | String | False | ||
| AdjustmentMileValue | Integer | False | ||
| Amount | Integer | False |
取引明細の返品以外の数量の合計 (取引明細区分が2返品以外の数量) | |
| AuthDate | Date | False | ||
| AuthNumber | String | False | ||
| Barcode | String | False |
バーコード | |
| CancelDateTime | Datetime | False | ||
| CancelDivision | String | False |
取引の取消を識別する区分。 (0:通常、1取消) | |
| CancelSlipNumber | String | False | ||
| CardCompany | String | False | ||
| Carriage | Integer | False | ||
| CashTotal | Integer | False | ||
| Change | Integer | False | ||
| Commission | Integer | False | ||
| CostTotal | Decimal | False |
明細の原価計の合計 | |
| CouponDiscount | Integer | False | ||
| CreditDivision | String | False | ||
| CreditTotal | Integer | False | ||
| CurrentMile | Integer | False | ||
| Customer | String | False | ||
| CustomerCode | String | False | ||
| CustomerGroupId | Integer | False |
客層ID。客層セクションIDが1の客層IDを設定。 | |
| CustomerGroupId2 | Integer | False |
客層ID2。客層セクションIDが2の客層IDを設定。 | |
| CustomerGroupId3 | Integer | False |
客層ID3。客層セクションIDが3の客層IDを設定。 | |
| CustomerGroupId4 | Integer | False |
客層ID4。客層セクションIDが4の客層IDを設定。 | |
| CustomerGroupId5 | Integer | False |
客層ID5。客層セクションIDが5の客層IDを設定。 | |
| CustomerGroups | String | False | ||
| CustomerId | Long | False |
会員毎に付与するID。 | |
| CustomerPinCode | String | False | ||
| CustomerRank | String | False | ||
| Denomination | String | False | ||
| Deposit | Integer | False | ||
| DepositCash | Integer | False | ||
| DepositCredit | Integer | False | ||
| DiscountRoundingDivision | String | False | ||
| DisposeDivision | String | False | ||
| DisposeServerTransactionHeadId | Integer | False | ||
| EarnMile | Integer | False | ||
| EnterDateTime | Datetime | False | ||
| ExchangeTicketNo | String | False | ||
| GiftReceiptValidDays | Integer | False | ||
| GuestNumbers | Integer | False | ||
| GuestNumbersFemale | Integer | False | ||
| GuestNumbersMale | Integer | False | ||
| GuestNumbersUnknown | Integer | False | ||
| InTaxSalesTotal | Integer | False | ||
| Memo | String | False | ||
| MileageDivision | String | False | ||
| MileageLabel | String | False | ||
| NetTaxFreeConsumableTaxExclude | Integer | False | ||
| NetTaxFreeConsumableTaxInclude | Integer | False | ||
| NetTaxFreeGeneralTaxExclude | Integer | False | ||
| NetTaxFreeGeneralTaxInclude | Integer | False | ||
| NewPoint | Integer | False |
取引で付与されるポイント。 合計 * ポイント付与率 | |
| NonSalesTargetAmount | Integer | False | ||
| NonSalesTargetCostTotal | Decimal | False | ||
| NonSalesTargetInTaxTotal | Integer | False | ||
| NonSalesTargetOutTaxTotal | Integer | False | ||
| NonSalesTargetReturnAmount | Integer | False | ||
| NonSalesTargetTaxFreeTotal | Integer | False | ||
| NonSalesTargetTotal | Integer | False | ||
| NonTaxSalesTotal | Integer | False | ||
| OutTaxSalesTotal | Integer | False | ||
| PaymentCount | Integer | False | ||
| Point | Integer | False |
取引前のポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 | |
| PointDiscount | Integer | False |
使用ポイント * ポイント還元率。 | |
| PointGivingDivision | String | False | ||
| PointGivingUnit | Decimal | False | ||
| PointGivingUnitPrice | Integer | False | ||
| PointSpendDivision | String | False | ||
| ReceiptMemo | String | False | ||
| ReturnAmount | String | False |
取引明細の返品の数量の合計 (取引明細区分が2返品の数量) | |
| ReturnSales | String | False | ||
| RoundingDivision | String | False |
販売時の合計金額の端数を丸めるか否かを設定する。00:なし、11:一の位を四捨五入、12:一の位を切捨、13:一の位を切上、21:十の位を四捨五入、22:十の位を切捨、23:十の位を切上、31:百の位を四捨五入、32:百の位を切捨、33:百の位を切上、41:千の位を四捨五入、42:千の位を切捨、43:千の位を切上、99:手入力 | |
| RoundingPrice | Integer | False |
端数値引額 | |
| SalesHeadDivision | String | False | ||
| SequentialNumber | Integer | False |
連番 | |
| SellDivision | String | False | ||
| SlipNumber | String | False | ||
| SpendPoint | Integer | False |
取引で使用したポイント。 | |
| Staff | String | False | ||
| StaffCode | String | False | ||
| StaffId | Integer | False |
販売員ID(スタッフID) | |
| StaffName | String | False |
AppAccessToken(pos.staffs:read) | |
| Status | String | False |
仮販売のステータス。(0:通常、1:完了、2:取消) | |
| Store | String | False | ||
| StoreCode | String | False | ||
| StoreId | Integer | False |
店舗毎に付与するID。 | |
| Subtotal | Integer | False |
取引明細の値引き後小計の合計。 | |
| SubtotalDiscountDivision | String | False |
小計値引き/割引時に指定された区分を設定。管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。 | |
| SubtotalDiscountPrice | Integer | False |
小計の値引き金額を設定。 | |
| SubtotalDiscountRate | Integer | False |
小計の割引を設定 (単位%) デフォルトは未設定。設定された場合、小計値引きは必須。※小計値引率から小計値引きは計算しないため小計値引きに値引額を設定してください。 | |
| SubtotalForDiscount | String | False |
取引明細の割引値引対象区分が対象の小計金額 | |
| SumDate | Date | False | ||
| SumDivision | String | False | ||
| Tags | String | False | ||
| TaxExclude | Integer | False |
外税商品計 * 10 / 100。※税率が10%の場合 ※小数点以下は税の丸め方式で指定の通り | |
| TaxFreeSalesDivision | String | False | ||
| TaxInclude | Integer | False |
内税商品計 / 110 * 10。※税率が10%の場合 ※小数点以下は税の丸め方式で指定の通り | |
| TaxRate | Decimal | False | ||
| TaxRounding | String | False | ||
| TerminalId | Integer | False |
店舗の端末毎に付与するID。 | |
| TerminalTranDateTime | Datetime | False |
端末で設定された取引日時。 | |
| TerminalTranId | Integer | False |
端末で設定された取引ID。 | |
| TipCash | String | False | ||
| TipCredit | String | False | ||
| Total | Integer | False |
小計 - 小計値引き - ポイント値引き + 端数値引額 + 外税額 - 免税額 を設定 | |
| TotalMile | Integer | False | ||
| TotalPoint | Integer | False |
取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 | |
| TransactionDateTime | Datetime | False |
取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。 | |
| TransactionHeadDivision | String | False |
取引を識別する区分。(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証) | |
| TransactionUuid | String | False | ||
| UnitBargainDiscountsubtotal | Integer | False | ||
| UnitDiscountsubtotal | Integer | False |
単品値引き小計:取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。※ 取引明細区分が2:返品の取引明細のとき、単品値引き計および商品バンドル値引按分は符号反転して計算されます。(例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。)※ 以下の商品区分を持つ取引明細については、単品値引き計および商品バンドル値引按分が0として計算されます。4:バンドル (親)、5:セット売り(親)、6:簡易セット(親)、8:バンドル値引(子) ※ ウェイターから生成された仮販売取引では、本項目が0になります。 | |
| UnitNonDiscountsubtotal | Integer | False |
取引明細の、値引き前計の合計。明細より自動算出。※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計 | |
| UnitStaffDiscountsubtotal | Integer | False | ||
| UpdDateTime | Datetime | False | ||
| Details | String | False |
仮販売取引明細 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| WithCustomer | String |
会員情報を付加するか(付加する場合はall, しない場合はnone) |
| WithCustomerGroups | String |
客層情報を付加するか(付加する場合はall, しない場合はnone) |
| WithStore | String |
店舗情報を付加するか(付加する場合はall, しない場合はnone) |
| WithStaff | String |
スタッフ情報を付加するか(付加する場合はall, しない場合はnone) |
レジ端末情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| TerminalId [KEY] | Integer | False |
端末ID | |
| AppVersion | String | False |
アプリバージョン | |
| CashDrawerId | Integer | False |
キャッシュドロアID | |
| CreditTerminalId | Integer | False |
CAT/CCT端末ID | |
| InsDateTime | Datetime | False |
登録時の日時。 | |
| ParentTerminalId | Integer | False |
親端末ID | |
| SelfCheckoutAvailableFlag | String | False |
セルフレジ使用可能フラグ。(0:使用できない、1:使用できる) | |
| SmartIdEngineAvailableFlag | String | False |
Smart ID Engine利用フラグ(0:利用しない、1:利用する) | |
| StoreId | Integer | False |
店舗ID | |
| TerminalName | String | False |
端末名 | |
| TransactionEditableFlag | String | False |
取引編集可能フラグ(0:利用しない、1:利用する) | |
| UpdDateTime | Datetime | False |
登録時・更新時の日時。 | |
| UseStopDivision | String | False |
利用停止区分。(0:利用する、1:利用しない) | |
| Uuid | String | False |
端末識別番号 |
取置き取引情報を取得、登録します。
| Name | Type | ReadOnly | References | Description |
| TransactionHeadId [KEY] | Integer | True |
取引ID | |
| AdjustmentDateTime | Datetime | False |
精算日時:精算をしたら日時が入る。 | |
| AdjustmentMile | Integer | False |
調整マイル:取引で手動で付与されるマイル※ 会員販売でない場合、nullが返されます。 | |
| AdjustmentMileDivision | String | False |
調整マイル区分:調整マイルの区分 1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」)3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」※ 会員販売でない場合、nullが返されます。 | |
| AdjustmentMileValue | Integer | False |
調整マイル区分値:調整マイルの入力値 ※ 会員販売でない場合、nullが返されます。 | |
| Amount | Integer | False |
数量合計:取引明細の返品以外の数量の合計 (取引明細区分が2返品以外の数量) | |
| AuthDate | Date | False |
センター処理日:クレジットのセンター処理日。 | |
| AuthNumber | String | False |
承認番号:クレジットの承認番号。 | |
| CancelDateTime | Datetime | False |
取消日時:取消/打消しの場合自動設定。 | |
| CancelDivision | String | False |
取消区分:取引の取消を識別する区分。 (0:通常、1取消) | |
| CancelSlipNumber | String | False |
取消伝票番号:クレジットの取消伝票番号。 | |
| CardCompany | String | False |
取扱カード会社:クレジットカード会社 例) VISA、JCB、MASTER、AMEX、DINERSなど | |
| Carriage | Integer | False |
送料:EC連携用送料。 | |
| CashTotal | Integer | False |
内現金支払金額:合計金額の内訳 (現金払い) | |
| Change | Integer | False |
釣銭 | |
| Commission | Integer | False |
手数料:EC連携用手数料。 | |
| CostTotal | Decimal | False |
原価合計:明細の原価計の合計 | |
| CreditDivision | String | False |
クレジット区分:クレジット会社を識別する区分 | |
| CreditTotal | Integer | False |
内クレジット支払金額:合計金額の内訳 (クレジット払い) | |
| CurrentMile | Integer | False |
現在マイル:取引前のマイル。※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 | |
| Customer | String | False |
会員 ※ 現在の会員マスタに登録されている会員情報が設定されます。 | |
| CustomerCode | 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を設定。 | |
| CustomerGroups | String | False |
客層 ※ 現在の客層マスタに登録されている客層情報が設定されます。 | |
| CustomerId | Long | False |
会員ID:会員毎に付与するID。数字10桁以内。 | |
| CustomerPinCode | String | False |
PINコード:自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。 | |
| CustomerRank | String | False |
会員ランク:管理画面の[設定]→[会員設定]→[会員ランク]で設定した値 | |
| Denomination | String | False |
金種:11:磁気クレジットカード、12:ICクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー ※ペイメント・マイスターで使用 | |
| Deposit | Integer | False |
預かり金:会計時に預かった金額。 | |
| DepositCash | Integer | False |
預かり金現金:会計時に預かった現金金額。 | |
| DepositCredit | Integer | False |
預かり金クレジット:会計時に預かったクレジット金額。 | |
| DiscountRoundingDivision | String | False |
割引丸め区分:割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ ※2:切り上げを一律で設定 | |
| Discounts | String | False |
小計値引/割引、単品値引/割引の詳細情報 | |
| DisposeDivision | String | False |
打消区分:0通常、1打消元レコード、2打消レコード ※0:通常と2:打消レコードのみ設定可能(省略時は0:通常を設定)※打消レコードの場合、取引明細区分は、(通常、部門売り)→返品に変換させて設定してください。 | |
| DisposeServerTransactionHeadId | String | False |
打消元取引ID:打消元取引ID ※打消し区分が2の場合必須 ※打消元取引IDが存在しない場合エラー。省略時はnullを設定 | |
| EarnMile | Integer | False |
獲得マイル:取引で付与されるマイル 合計 * ポイント付与率 ※ 会員販売でない場合、nullが返されます。 | |
| EnterDateTime | Datetime | False |
入店日時: | |
| ExchangeTicketNo | String | False |
引換券番号 | |
| GiftReceiptValidDays | Integer | False |
ギフトレシート引換有効日数:有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。 | |
| GuestNumbers | Integer | False |
客数:客数。 | |
| GuestNumbersFemale | Integer | False |
客数(女):客数(女)。 | |
| GuestNumbersMale | Integer | False |
客数(男):客数(男)。 | |
| GuestNumbersUnknown | Integer | False |
客数(不明):客数(不明)。 | |
| InTaxSalesTotal | Integer | False |
内税対象額:売上対象商品の内税販売合計金額。 内税販売の場合は、税込・税抜き商品を対象。 | |
| Layaway | String | False |
取置き情報:取置き時の詳細情報 | |
| LayawayPickUp | String | False |
取置き引取情報:取置き引取時の詳細情報 | |
| Memo | String | False |
メモ:入出金時のメモなどを設定。 1000文字以内。 | |
| MileageDivision | String | False |
マイレージ利用区分:マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める) | |
| MileageLabel | String | False |
マイレージラベル:マイレージの名称。未設定の場合は「マイル」 | |
| NetTaxFreeConsumableTaxExclude | Integer | False |
外税商品の消耗品免税額:外税商品の消耗品免税額。 | |
| NetTaxFreeConsumableTaxInclude | Integer | False |
内税商品の消耗品免税額:内税商品の消耗品免税額。 | |
| NetTaxFreeGeneralTaxExclude | Integer | False |
外税商品の一般品免税額:外税商品の一般品免税額。 | |
| NetTaxFreeGeneralTaxInclude | Integer | False |
内税商品の一般品免税額:内税商品の一般品免税額。 | |
| NewPoint | Integer | False |
付与ポイント:取引で付与されるポイント。 合計 * ポイント付与率 | |
| NonSalesTargetAmount | Integer | False |
売上対象外数量合計:取引明細の返品以外かつ売上対象外の数量の合計。 (取引明細区分が2返品以外の数量) | |
| NonSalesTargetCostTotal | Decimal | False |
売上対象外原価合計:売上対象外商品の原価合計。 | |
| NonSalesTargetInTaxTotal | Integer | False |
売上対象外内税合計:売上対象外商品の外税合計。 | |
| NonSalesTargetOutTaxTotal | Integer | False |
売上対象外外税合計:売上対象外商品の内税合計。 | |
| NonSalesTargetReturnAmount | Integer | False |
売上対象外返品数量合計:取引明細の返品かつ売上対象外の数量の合計。 (取引明細区分が2返品の数量) | |
| NonSalesTargetTaxFreeTotal | Integer | False |
売上対象外免税額合計:売上対象外商品の免税額合計。 | |
| NonSalesTargetTotal | Integer | False |
売上対象外合計:売上対象外商品の合計。 外税販売の場合、税を含まない。 | |
| NonTaxSalesTotal | Integer | False |
非課税対象額:売上対象商品の非課税商品の合計金額。 | |
| OutTaxSalesTotal | Integer | False |
外税対象額:売上対象商品の外税販売の税抜き商品合計金額 | |
| PaymentCount | Integer | False |
支払回数:クレジットの支払回数。※ゼウス、ペイメントマイスターご利用時 (1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い) | |
| Point | Integer | False |
現在ポイント:取引前のポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 | |
| PointDiscount | Integer | False |
ポイント値引き:使用ポイント * ポイント還元率。※消費税含む | |
| PointGivingDivision | String | False |
ポイント付与税区分:1:税額を含める + 利用ポイント分を含める、2:税額を含めない + 利用ポイント分を含める、3:税額を含める + 利用ポイント分を含めない、4:税額を含めない + 利用ポイント分を含めない ※未設定の場合は店舗マスタから設定 | |
| PointGivingUnit | Decimal | False |
ポイント付与単位(ポイント):ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)(例10円ごとに0.2ポイントの場合、0.2ポイント) | |
| PointGivingUnitPrice | Integer | False |
ポイント付与単位(金額):ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円)(例10円ごとに2ポイントの場合、10円) | |
| PointSpendDivision | String | False |
ポイント利用区分:ポイント利用時の税を含む/含まないを判定。1:ポイント利用を現金として扱う (税を含む値引き)、2:ポイント利用を値引として扱う (税を含まない値引き) ※未設定の場合、店舗のポイント利用区分に従う | |
| ReceiptMemo | String | False |
レシートメモ:レシートに印字するメモを設定。 | |
| ReturnAmount | Integer | False |
返品数量合計:取引明細の返品の数量の合計 (取引明細区分が2返品の数量) | |
| ReturnSales | String | False |
返品取引区分:(0:通常、1:返品販売) | |
| RoundingDivision | String | False |
端数値引区分:販売時の合計金額の端数を丸めるか否かを設定する。00:なし、11:一の位を四捨五入、12:一の位を切捨、13:一の位を切上、21:十の位を四捨五入、22:十の位を切捨、23:十の位を切上、31:百の位を四捨五入、32:百の位を切捨、33:百の位を切上、41:千の位を四捨五入、42:千の位を切捨、43:千の位を切上、99:手入力 | |
| RoundingPrice | Integer | False |
端数値引額 | |
| SalesHeadDivision | String | False |
売上ヘッダ区分:売上明細に売上対象外商品を含むか否かの区分。 (0:売上対象のみ、1:売上対象外含む) | |
| SellDivision | String | False |
販売区分:取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)※省略時は0:内税販売を設定 | |
| SlipNumber | String | False |
伝票番号:クレジットの伝票番号。 | |
| SpendPoint | Integer | False |
使用ポイント:取引で使用したポイント。 | |
| Staff | String | False |
スタッフ ※ 現在のスタッフマスタに登録されているスタッフ情報が設定されます。 | |
| StaffCode | String | False | ||
| StaffId | Integer | False |
スタッフID:販売員ID。(スタッフID) | |
| StaffName | String | False |
スタッフ名:販売員名。(スタッフ名) | |
| Store | String | False |
店舗 ※ 現在の店舗マスタに登録されている店舗情報が設定されます。 | |
| StoreCode | String | False | ||
| StoreId | Integer | False |
店舗ID:店舗毎に付与するID。 | |
| Subtotal | Integer | False |
小計:取引明細の値引き後小計の合計。 | |
| SubtotalDiscountDivision | Integer | False |
小計値引き/割引区分:小計値引き/割引時に指定された区分を設定。 | |
| SubtotalDiscountPrice | Integer | False |
小計値引き:小計の値引き金額を設定。 単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て) | |
| SubtotalDiscountRate | Integer | False |
小計割引率:小計の割引を設定 (単位%) デフォルトは未設定。設定された場合、小計計値引きに自動的に設定(切り捨て) 集計は、小計値引きしか見ない。 | |
| SubtotalForDiscount | String | False |
値引対象金額:取引明細の割引値引対象区分が対象の小計金額 | |
| SumDate | Date | False |
締め日時:締めをしたら年月日が入る。 | |
| SumDivision | String | False |
締め区分:締め処理を実施したかの区分。 (0未処理、1精算処理済み、2締め処理済み) | |
| Tags | String | False |
取引タグ:レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。※複数ある場合は、カンマ区切りで設定 | |
| TaxExclude | Integer | False |
外税額:外税商品計 * 10 / 100。※税率が10%の場合 ※小数点以下は税の丸め方式で指定の通り | |
| TaxFreeSalesDivision | String | False |
免税販売区分:免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算)) | |
| TaxInclude | Integer | False |
内税額:内税商品計 / 110 * 10。※税率が10%の場合 ※小数点以下は税の丸め方式で指定 | |
| TaxRate | Decimal | False |
税率:税率 (単位%)※未入力の場合、スマレジに設定されている消費税を設定(端末取引日時より算出) | |
| TaxRounding | String | False |
税の丸め方式:税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ ※省略時は1:切り捨てを設定 | |
| TerminalId | Integer | False |
端末ID:店舗の端末毎に付与するID。 | |
| TerminalTranDateTime | Datetime | False |
端末取引日時:端末で設定された取引日時。 | |
| TerminalTranId | Integer | False |
端末取引ID:端末で設定された取引ID。 | |
| TipCash | Integer | False |
現金チップ | |
| TipCredit | Integer | False |
クレジットチップ | |
| Total | Integer | False |
合計:小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定 | |
| TotalMile | Integer | False |
合計マイル:取引後のマイル 現在マイル + 獲得マイル + 調整マイル ※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 | |
| TotalPoint | Integer | False |
合計ポイント:取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 | |
| TransactionDateTime | Datetime | False |
取引日時:取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。 | |
| TransactionHeadDivision | String | False |
取引区分:取引を識別する区分。(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証) | |
| TransactionUuid | String | False |
レシート番号:レシートに印字する番号。※スマレジアプリの採番方法(1970年から計算した現在秒9桁+端末IDゼロ詰め4桁) | |
| UnitBargainDiscountsubtotal | Integer | False |
単品セール販売値引き計 | |
| UnitDiscountsubtotal | Integer | False |
単品値引き小計:取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。※ 取引明細区分が2:返品の取引明細のとき、単品値引き計および商品バンドル値引按分は符号反転して計算されます。(例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。)※ 以下の商品区分を持つ取引明細については、単品値引き計および商品バンドル値引按分が0として計算されます。4:バンドル (親)、5:セット売り(親)、6:簡易セット(親)、8:バンドル値引(子) | |
| UnitNonDiscountsubtotal | Integer | False |
単品値引き前小計:取引明細の、値引き前計の合計。明細より自動算出 ※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計 | |
| UnitStaffDiscountsubtotal | Integer | False |
単品社員販売値引き計 | |
| UpdDateTime | Datetime | False |
更新日時:登録時・更新時の日時。 | |
| Details | String | False |
取引明細 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| WithCustomer | String |
会員情報を付加するか(付加する場合はall, しない場合はnone) |
| WithCustomerGroups | String |
客層情報を付加するか(付加する場合はall, しない場合はnone) |
| WithDiscounts | String |
小計値引/割引、単品値引/割引の値引区分や割引区分情報を付加するか(付加する場合はall, しない場合はnone) |
| WithStore | String |
店舗情報を付加するか(付加する場合はall, しない場合はnone) |
| WithStaff | String |
スタッフ情報を付加するか(付加する場合はall, しない場合はnone) |
| WithLayway | String |
取置き情報を付加するか(付加する場合はall, しない場合はnone) |
| WithLaywayPickUp | String |
取置き引取情報を付加するか(付加する場合はall, しない場合はnone) |
取引情報を取得、更新、登録、削除します。
| Name | Type | ReadOnly | References | Description |
| TransactionHeadId [KEY] | Integer | True |
取引ID:取引毎に付与するID。 | |
| AdjustmentDateTime | Datetime | False |
精算日時:精算をしたら日時が入る。 | |
| AdjustmentMile | Integer | False |
調整マイル:取引で手動で付与されるマイル。※ 会員販売でない場合、nullが返されます。 | |
| AdjustmentMileDivision | String | False |
調整マイル区分:調整マイルの区分。1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)、2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」)、3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)、4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」※ 会員販売でない場合、nullが返されます。 | |
| AdjustmentMileValue | Integer | False |
調整マイル区分値:調整マイルの入力値。※ 会員販売でない場合、nullが返されます。 | |
| Amount | Integer | False |
数量合計:取引明細の返品以外の数量の合計 (取引明細区分が2:返品以外の数量) | |
| AuthDate | Date | False |
センター処理日:クレジットのセンター処理日。 | |
| AuthNumber | String | False |
承認番号:クレジットの承認番号。 | |
| Barcode | String | False |
仮販売のバーコード。※ 複数ある場合はカンマ区切り。 | |
| CancelDateTime | Datetime | False |
取消日時:取消したサーバー日時を設定。 | |
| CancelDivision | String | False |
取消区分:取引の取消を識別する区分。 (0:通常、1:取消) | |
| CancelSlipNumber | String | False |
取消伝票番号:クレジットの取消伝票番号。 | |
| CardCompany | String | False |
取扱カード会社:クレジットカード会社 例) VISA、JCB、MASTER、AMEX、DINERSなど | |
| Carriage | Integer | False |
送料:EC連携用送料。 | |
| CashTotal | Integer | False |
内現金支払金額:合計金額の内訳 (現金払い) | |
| Change | Integer | False |
釣銭:預かり金 - 合計。 | |
| Commission | Integer | False |
手数料:EC連携用手数料。 | |
| CostTotal | Decimal | False |
原価合計:明細の原価計の合計 | |
| CouponDiscount | String | False |
クーポン値引き:その取引で使用された各クーポンの値引き・割引額の合計値。 | |
| CreditDivision | String | False |
クレジット区分:クレジット会社を識別する区分 | |
| CreditTotal | String | False |
内クレジット支払金額:合計金額の内訳 (クレジット払い) | |
| CurrentMile | Integer | False |
現在マイル:取引前のマイル。※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 | |
| Customer | String | False |
会員※現在の会員マスタに登録されている会員情報が設定されます。 | |
| CustomerCode | 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を設定。 | |
| CustomerGroups | String | False |
客層※ 現在の客層マスタに登録されている客層情報が設定されます。 | |
| CustomerId | Long | False |
会員ID:会員毎に付与するID。数字10桁以内。 | |
| CustomerPinCode | String | False |
PINコード:自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。 | |
| CustomerRank | String | False |
会員ランク:汎用マスタの「会員ランク」で登録しているコードを設定してください。 汎用マスタに登録されていないコードを設定するとエラーになります。 | |
| Denomination | String | False |
金種:(11:磁気クレジットカード、12:ICクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー)など | |
| Deposit | Integer | False |
預かり金:会計時に預かった金額。 | |
| DepositCash | Integer | False |
預かり金現金:会計時に預かった現金金額。 | |
| DepositCredit | Integer | False |
預かり金クレジット:会計時に預かったクレジット金額。 | |
| DiscountRoundingDivision | String | False |
割引丸め区分:割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ | |
| Discounts | String | False |
小計値引/割引、単品値引/割引の詳細情報 | |
| DisposeDivision | String | False |
打消区分:0:通常、1:打消元レコード、2:打消レコード | |
| DisposeServerTransactionHeadId | Integer | False |
打消元取引ID:打消元取引ID、打消先取引ID。 | |
| EarnMile | Integer | False |
獲得マイル:取引で付与されるマイル。 合計 * ポイント付与率※ 会員販売でない場合、nullが返されます。 | |
| EnterDateTime | Datetime | False |
入店日時: | |
| ExchangeTicketNo | String | False |
引換券番号 | |
| GiftReceiptValidDays | Integer | False |
ギフトレシート有効日数:ギフトレシートの有効日数。 有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。 | |
| GuestNumbers | Integer | False |
客数:客数。 | |
| GuestNumbersFemale | Integer | False |
客数(女):客数(女)。 | |
| GuestNumbersMale | Integer | False |
客数(男):客数(男)。 | |
| GuestNumbersUnknown | Integer | False |
客数(不明):客数(不明)。 | |
| InTaxSalesTotal | Integer | False |
内税対象額:売上対象商品の内税販売合計金額。 内税販売の場合は、税込・税抜き商品を対象。 | |
| Layaway | String | False |
(非推奨)取置き情報:取置き時の詳細情報※ with_layawaysを活用するようにしてください。※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。※ 既存のwith_layaway: \ | |
| Layaways | String | False |
取置き時の詳細情報 | |
| LayawayPickUp | String | False |
(非推奨)取置き引取情報:取置き引取時の詳細情報※ with_layaway_pick_upsを活用するようにしてください。※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。※ 既存のwith_layaway_pick_up: \ | |
| Memo | String | False |
メモ:入出金時のメモなどを設定。 1000文字以内。 | |
| MileageDivision | String | False |
マイレージ利用区分:マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める) | |
| MileageLabel | String | False |
マイレージ名称:マイレージの名称。例:rejiマイル | |
| MoneyControls | String | False |
取引金操作情報:入出金区分の詳細情報 | |
| NetTaxFreeConsumableTaxExclude | Integer | False |
外税商品の消耗品免税額:外税商品の消耗品免税額。 | |
| NetTaxFreeConsumableTaxInclude | Integer | False |
内税商品の消耗品免税額:内税商品の消耗品免税額。 | |
| NetTaxFreeGeneralTaxExclude | Integer | False |
外税商品の一般品免税額:外税商品の一般品免税額。 | |
| NetTaxFreeGeneralTaxInclude | Integer | False |
内税商品の一般品免税額:内税商品の一般品免税額。 | |
| NewPoint | Integer | False |
付与ポイント:取引で付与されるポイント。 合計 * ポイント付与率 | |
| NonSalesTargetAmount | Integer | False |
売上対象外数量合計:取引明細の返品以外かつ売上対象外の数量の合計。 (取引明細区分が2:返品以外の数量) | |
| NonSalesTargetCostTotal | Decimal | False |
売上対象外原価合計:売上対象外商品の原価合計。 | |
| NonSalesTargetInTaxTotal | Integer | False |
売上対象外内税合計:売上対象外商品の内税合計。 | |
| NonSalesTargetOutTaxTotal | Integer | False |
売上対象外外税合計:売上対象外商品の外税合計。 | |
| NonSalesTargetReturnAmount | Integer | False |
売上対象外返品数量合計:取引明細の返品かつ売上対象外の数量の合計。 (取引明細区分が2:返品の数量) | |
| NonSalesTargetTaxFreeTotal | Integer | False |
売上対象外免税額合計:売上対象外商品の免税額合計。 | |
| NonSalesTargetTotal | Integer | False |
売上対象外合計:売上対象外商品の合計。 外税販売の場合、税を含まない。 | |
| NonTaxSalesTotal | Integer | False |
非課税対象額:売上対象商品の非課税商品の合計金額。 | |
| OutTaxSalesTotal | Integer | False |
外税対象額:売上対象商品の外税販売の税抜き商品合計金額 | |
| PaymentCount | Integer | False |
支払回数:クレジットの支払回数。※ゼウス、ペイメントマイスターご利用時(1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い) | |
| Point | Integer | False |
現在ポイント:取引前のポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 | |
| PointDiscount | Integer | False |
ポイント値引き:使用ポイント * ポイント還元率。※消費税含む | |
| PointGivingDivision | String | False |
ポイント付与区分:1:税額を含める + 利用ポイント分を含める、2:税額を含めない + 利用ポイント分を含める、3:税額を含める + 利用ポイント分を含めない、4:税額を含めない + 利用ポイント分を含めない | |
| PointGivingUnit | Decimal | False |
ポイント付与単位(ポイント):ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲:0.00ポイント~99999.99ポイント)(例:10円ごとに0.2ポイントの場合、0.2ポイント) | |
| PointGivingUnitPrice | Integer | False |
ポイント付与単位(金額):ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲:1円~99999円)(例:10円ごとに2ポイントの場合、10円) | |
| PointSpendDivision | String | False |
ポイント利用区分:ポイント利用時の税を含む/含まないを判定。1:ポイント利用を現金として扱う (税を含む値引き)、2:ポイント利用を値引として扱う (税を含まない値引き)※未設定の場合、店舗のポイント利用区分に従う | |
| ReceiptMemo | String | False |
レシートメモ:レシートに印字するメモを設定。 | |
| RecordedStaffs | String | False |
取引スタッフ※取引当時のスタッフマスタに登録されていたスタッフ情報が設定されます。 | |
| ReturnAmount | String | False |
返品数量合計:取引明細の返品の数量の合計 (取引明細区分が2:返品の数量) | |
| ReturnSales | String | False |
返品取引区分:(0:通常、1:返品販売) | |
| RoundingDivision | String | False |
端数値引区分:販売時の合計金額の端数を丸めるか否かを設定する。00:なし、11:一の位を四捨五入、12:一の位を切捨、13:一の位を切上、21:十の位を四捨五入、22:十の位を切捨、23:十の位を切上、31:百の位を四捨五入、32:百の位を切捨、33:百の位を切上、41:千の位を四捨五入、42:千の位を切捨、43:千の位を切上、99:手入力 | |
| RoundingPrice | Integer | False |
端数値引額:端数値引金額 | |
| SalesHeadDivision | String | False |
売上ヘッダ区分:売上明細に売上対象外商品を含むか否かの区分。 (0:売上対象のみ、1:売上対象外含む) | |
| SellDivision | String | False |
販売区分:取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売) | |
| SlipNumber | String | False |
伝票番号:クレジットの伝票番号。 | |
| SpendPoint | Integer | False |
使用ポイント:取引で使用したポイント。 | |
| Staff | String | False |
スタッフ※現在のスタッフマスタに登録されているスタッフ情報が設定されます。 | |
| StaffCode | String | False | ||
| StaffId | Integer | False |
販売員ID:販売員ID。(スタッフID) | |
| StaffName | String | False |
販売員名:販売員名。(スタッフ名) | |
| Store | String | False |
店舗※現在の店舗マスタに登録されている店舗情報が設定されます。 | |
| StoreCode | String | False | ||
| StoreId | Integer | False |
店舗ID:店舗毎に付与するID。 | |
| Subtotal | Integer | False |
小計:取引明細の値引き後小計の合計。 | |
| SubtotalDiscountDivision | Integer | False |
小計値引き/割引区分:小計値引き/割引時に指定された区分を設定。 | |
| SubtotalDiscountPrice | Integer | False |
小計値引き:小計の値引き金額を設定。 単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て) | |
| SubtotalDiscountRate | Integer | False |
小計割引率:小計の割引を設定 (単位:%) デフォルトは未設定。設定された場合、小計計値引きに自動的に設定(切り捨て)。集計は、小計値引きしか見ない。 | |
| SubtotalForDiscount | String | False |
値引対象小計:取引明細の割引値引対象区分が対象の小計金額 | |
| SumDate | Date | False |
締め日時:締めをしたら年月日が入る。 | |
| SumDivision | String | False |
締め区分:締め処理を実施したかの区分。 (0:未処理、1:精算処理済み、2:締め処理済み) | |
| Tags | String | False |
取引タグ:レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。※複数ある場合は、カンマ区切りで設定 | |
| TaxExclude | Integer | False |
外税額:外税商品計 * 10 / 100。※税率が10%の場合 ※小数点以下は税の丸め方式で指定の通り | |
| TaxFreeSalesDivision | String | False |
免税販売区分:免税販売区分(0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算)) | |
| TaxInclude | Integer | False |
内税額:内税商品計 / 110 * 10。※税率が10%の場合 ※小数点以下は税の丸め方式で指定の通り ※内税商品の税額 | |
| TaxRate | Decimal | False |
税率:税率 (単位:%) | |
| TaxRounding | String | False |
税の丸め方式:税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ | |
| TerminalId | Integer | False |
端末ID:店舗の端末毎に付与するID。 | |
| TerminalTranDateTime | Datetime | False |
端末取引日時:端末で設定された取引日時。 | |
| TerminalTranId | Integer | False |
端末取引ID:端末で設定された取引ID。 | |
| TipCash | Integer | False |
現金チップ | |
| TipCredit | Integer | False |
クレジットチップ | |
| Total | Integer | False |
合計:小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定 | |
| TotalMile | Integer | False |
合計マイル:取引後のマイル。 現在マイル + 獲得マイル - 調整マイル※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 | |
| TotalPoint | Integer | False |
合計ポイント:取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 | |
| TransactionDateTime | Datetime | False |
取引日時:取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。 | |
| TransactionHeadDivision | String | False |
取引区分:取引を識別する区分。 (1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、9:回数券、10:取置き、11:チップ、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証) | |
| TransactionUuid | String | False |
レシート番号:レシートに印字する番号。※スマレジアプリの採番方法(1970年から計算した現在秒9桁+端末IDゼロ詰め4桁) | |
| UnitBargainDiscountsubtotal | Integer | False |
単品セール販売値引き計 | |
| UnitDiscountsubtotal | Integer | False |
単品値引き小計:取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。(例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。)※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。4:バンドル (親)、5:セット売り(親)、6:簡易セット(親)、8:バンドル値引(子) | |
| UnitNonDiscountsubtotal | Integer | False |
単品値引き前小計:取引明細の、値引き前計の合計。※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計 | |
| UnitStaffDiscountsubtotal | Integer | False |
単品社員販売値引き計 | |
| UpdDateTime | Datetime | False |
更新日時:取引履歴の更新日時。作成時/修正時に日付が設定されます。 | |
| Details | String | False |
取引詳細 | |
| DepositOthers | String | False |
その他支払方法 | |
| Coupons | String | False |
取引クーポン明細 | |
| CouponItems | String | False |
取引クーポン商品付与明細 | |
| LayawayPickUps | String | False |
取置き引取時の詳細情報 |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
| Name | Type | Description |
| WithCustomer | String |
会員情報を付加するか(付加する場合はall, しない場合はnone) |
| WithCustomerGroups | String |
客層情報を付加するか(付加する場合はall, しない場合はnone) |
| WithDiscounts | String |
店舗情報を付加するか(付加する場合はall, しない場合はnone) |
| WithStore | String |
小計値引/割引、単品値引/割引の値引区分や割引区分情報を付加するか(付加する場合はall, しない場合はnone) |
| WithStaff | String |
スタッフ情報を付加するか(付加する場合はall, しない場合はnone) |
| WithRecordedStaff | String |
取引時のスタッフ情報を付加するか(付加する場合はall, しない場合はnone) |
| WithLayway | String |
(非推奨)取置き情報を付加するか(付加する場合はall, しない場合はnone)※ with_layawaysを活用するようにしてください。※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。※ 既存のwith_layaway: all を指定して取得できる取置きデータには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置きデータしか返りません。 |
| WithLayways | String |
取置き情報を付加するか(付加する場合はall, しない場合はnone) |
| WithLaywayPickUp | String |
(非推奨)取置き引取情報を付加するか(付加する場合はall, しない場合はnone)※ with_layaway_pick_upsを活用するようにしてください。※ 2024年2月下旬に、2つ以上の取置きを一括で引取ることができる機能を追加予定です。追加した機能により、引取をした取引データに複数の取置きデータが紐づくようになります。※ 既存のwith_layaway_pick_up: all を指定して取得できる取置き引取データには、取引データに2つ以上の取置きデータが紐づいていても、最初の1つの取置き引取データしか返りません。 |
| WithMoneyControl | String |
取引金操作情報を付加するか(付加する場合はall, しない場合はnone) |
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
精算情報を取得します。
| Name | Type | References | Description |
| StoreId | Integer | 店舗ID | |
| AdjustmentDateTime | Datetime | 精算日時 | |
| CalculateBalance | Decimal | 計算現金残高: 釣銭準備金 + 現金売上 + 前受金 - 前受金(取消) + 預かり金 - 預かり金返金 + 入金 - 出金 | |
| CashAdjustmentCarryOver | Decimal | 繰越準備金:繰越準備金 | |
| CashAdjustmentDifference | Decimal | 現金過不足:現金過不足 | |
| CashAdjustmentFiftyYen | Integer | 50円玉:50円玉の枚数 | |
| CashAdjustmentFiveHundredYen | Integer | 500円玉:500円玉の枚数 | |
| CashAdjustmentFiveThousandYen | Integer | 5千円札:5千円札の枚数 | |
| CashAdjustmentFiveYen | Integer | 5円玉:5円玉の枚数 | |
| CashAdjustmentOneHundredYen | Integer | 100円玉:100円玉の枚数 | |
| CashAdjustmentOneThousandYen | Integer | 千円札:千円札の枚数 | |
| CashAdjustmentOneYen | Integer | 1円玉:1円玉の枚数 | |
| CashAdjustmentRealBalance | Integer | 実現金残高:1万円札から1円玉の枚数の合計金額 | |
| CashAdjustmentSaving | Integer | 銀行預入金:銀行預入金 | |
| CashAdjustmentTenThousandYen | Integer | 1万円札:1万円札の枚数 | |
| CashAdjustmentTenYen | Integer | 10円玉:10円玉の枚数 | |
| CashAdjustmentTwoThousandYen | Integer | 2千円札:2千円札の枚数 | |
| CashSales | Decimal | 現金売上:現金売上額 | |
| ChildTerminals | String | 子端末リスト:精算実施時の子端末の一覧 | |
| CreditSales | Decimal | クレジット売上:クレジット売上 | |
| Deposit | Integer | 預かり金:取引区分が(4:預かり金) の合計額 | |
| NonSalesCashTotal | Decimal | 売上対象外現金:売上対象外の現金受領額 | |
| NonSalesCreditTotal | Decimal | 売上対象外クレジット:売上対象外のクレジット受領額 | |
| NonSalesOtherTotal | Decimal | 売上対象外その他:売上対象外のその他支払方法受領額 | |
| OtherSalesList | String | その他支払いリスト | |
| PartPayment | Decimal | 前受金:取置き時の前受金受領額 | |
| PartPaymentCancel | Decimal | 前受金(取消):取置き時の前受金をキャンセルした金額 | |
| PartPaymentCash | Decimal | 前受金(現金):取置き時の前受金受領額(現金) | |
| PartPaymentCashCancel | Decimal | 前受金(取消)(現金):取置き時の前受金をキャンセルした金額(現金) | |
| PartPaymentCredit | Decimal | 前受金(クレジット):取置き時の前受金受領額(クレジット) | |
| PartPaymentCreditCancel | Decimal | 前受金(取消)(クレジット):取置き時の前受金をキャンセルした金額(クレジット) | |
| Payment | Decimal | 出金:取引区分が(3:出金) の取引合計額 | |
| PreparationCash | Decimal | 釣銭準備金:釣銭準備金 | |
| Receipt | Decimal | 入金:取引区分が(2:入金) の取引合計額 | |
| ReceivedDeposit | Decimal | 前受金(受領済金額):取置き時の前受金を売上として計上した金額 | |
| ReceivedDepositCash | Decimal | 前受金(受領済金額)(現金):取置き時の前受金を売上として計上した金額(現金) | |
| ReceivedDepositCredit | Decimal | 前受金(受領済金額)(クレジット):取置き時の前受金を売上として計上した金額(クレジット) | |
| ReturnDeposit | Decimal | 預かり金返金:取引区分が(5:預かり金返金) の取引合計額 | |
| TerminalId | Integer | 端末ID:店舗の端末毎に付与するID | |
| Tip | Decimal | チップ:チップの合計額 | |
| TipCash | Decimal | チップ現金:チップの現金合計額 | |
| TipCredit | Decimal | チップクレジット:チップのクレジット合計額 | |
| TransactionCount | Integer | 通常取引数:通常取引の合計 | |
| AdjustmentDate | Date | 精算日:精算を実施した日 |
CAT/CCTカード会社情報を取得します。
| Name | Type | References | Description |
| CatCardCompanyCode | String | CAT/CCTカード会社コード | |
| CatCardCompanyName | String | CAT/CCTカード会社名 | |
| DisplayFlag | String | 表示フラグ:端末で表示するかを設定。(0:表示しない、1:表示する) | |
| DisplaySequence | Integer | 表示順:表示順 | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| Kid | String | KID:カード会社番号 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
消費税率情報を取得します。
| Name | Type | References | Description |
| ApplyStartDate | Date | 適用開始日 | |
| TaxRate | Decimal | 税率(単位%) | |
| TaxRounding | String | 税の丸め方式(0:四捨五入、1:切り捨て、2:切り上げ) | |
| TargetDate | Date | 対象日:指定した場合、対象日時点で有効な消費税率を1件取得 |
会員必須項目設定情報を取得します。
| Name | Type | References | Description |
| ColumnName | String | カラム名 | |
| DisplaySequence | Integer | 表示順序 | |
| InitialValue | String | 初期値:会員登録・更新時に必須項目とするかどうかの初期値。 (0:任意、1:必須) | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 | |
| Value | String | 設定値:会員登録・更新時に必須項目とするかどうかの設定値。 (0:任意、1:必須) |
日次締め情報を取得します。
| Name | Type | References | Description |
| Amount | Integer | 販売商品点数:販売商品点数の合計。 | |
| CalculateBalance | Integer | 計算現金残高: 釣銭準備金 + 現金売上 + 前受金 - 前受金(取消) + 預かり金 - 預かり金返金 + 入金 - 出金 | |
| Carriage | Integer | 送料:送料の合計。 | |
| CarryOver | Integer | 繰越準備金:繰越準備金。 | |
| CashDrawerId | Integer | キャッシュドロアID:キャッシュドロアID。※未登録の場合、0が設定されます | |
| CashSales | Integer | 現金売上:現金売上額。 | |
| ChangeDifference | Integer | 釣銭差額:釣銭差額。 | |
| Comment | String | コメント:1000文字以内。 | |
| Commission | Integer | 手数料:手数料の合計。 | |
| CostTotal | Decimal | 売上原価:売上原価の合計。 | |
| CreditSales | Integer | クレジット売上:クレジット売上。 | |
| Deposit | Integer | 預かり金:取引区分が(4:預かり金) の合計額。 | |
| Difference | Integer | 現金過不足:現金過不足。 | |
| Discount | Integer | 値引き:値引き金額の合計。 | |
| FiftyYen | Integer | 50円玉:50円玉の枚数。 | |
| FiveHundredYen | Integer | 500円玉:500円玉の枚数。 | |
| FiveThousandYen | Integer | 5千円札:5千円札の枚数。 | |
| FiveYen | Integer | 5円玉:5円玉の枚数。 | |
| GrossMargin | Integer | 粗利益:粗利益の合計。 | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| InTaxSalesTotal | Integer | 内税対象額:内税対象外の合計。 | |
| NonSalesCashTotal | Integer | 売上対象外現金:売上対象外の現金受領額。 | |
| NonSalesCreditTotal | Integer | 売上対象外クレジット:売上対象外のクレジット受領額。 | |
| NonSalesOtherTotal | Integer | 売上対象外その他:売上対象外のその他支払方法受領額。 | |
| NonSalesTargetTaxFreeTotal | Integer | 売上対象外免税額:売上対象外の免税額合計。 | |
| NonSalesTargetTotal | Integer | 売上対象外金額:売上対象外金額の合計。 | |
| NonSalesTaxFreeTotal | Integer | 売上対象外免税:売上対象外の免税額。 | |
| NonTaxSalesTotal | Integer | 非課税対象額:非課税対象額の合計。 | |
| OneHundredYen | Integer | 100円玉:100円玉の枚数。 | |
| OneThousandYen | Integer | 千円札:千円札の枚数。 | |
| OneYen | Integer | 1円玉:1円玉の枚数。 | |
| OtherSalesList | String | その他支払いリスト | |
| OutTaxSalesTotal | Integer | 外税対象額:外税対象外の合計。 | |
| PartPayment | Integer | 前受金:取置き時の前受金受領額。 | |
| PartPaymentCancel | Integer | 前受金(取消):取置き時の前受金をキャンセルした金額。 | |
| PartPaymentCash | Integer | 前受金(現金):取置き時の前受金受領額。(現金) | |
| PartPaymentCashCancel | Integer | 前受金(取消)(現金):取置き時の前受金をキャンセルした金額。(現金) | |
| PartPaymentCredit | Integer | 前受金(クレジット):取置き時の前受金受領額。(クレジット) | |
| PartPaymentCreditCancel | Integer | 前受金(取消)(クレジット):取置き時の前受金をキャンセルした金額。(クレジット) | |
| Payment | Integer | 出金:取引区分が(3:出金) の取引合計額。 | |
| PointDiscount | Integer | ポイント利用:ポイント利用金額の合計。 | |
| PreparationCash | Integer | 釣銭準備金:釣銭準備金。 | |
| RealBalance | Integer | 実現金残高:1万円札から1円玉の枚数の合計金額。 | |
| Receipt | Integer | 入金:取引区分が(2:入金) の取引合計額。 | |
| ReceivedDepositCash | Integer | 前受金(受領済金額):取置き時の前受金を売上として計上した金額。 | |
| ReceivedDepositCashTotal | Integer | 前受金(受領済金額)(現金):取置き時の前受金を売上として計上した金額。(現金) | |
| ReceivedDepositCreditTotal | Integer | 前受金(受領済金額)(クレジット):取置き時の前受金を売上として計上した金額。(クレジット) | |
| ReturnAmount | Integer | 返品数:返品数の合計。 | |
| ReturnDeposit | Integer | 預かり金返金:取引区分が(5:預かり金返金) の取引合計額。 | |
| SalesTotal | Integer | 総売上:総売上の合計。 基本設定の【総売上に「売上対象外商品」分を含める】が、0:考慮する(除く)に設定されている場合、総売上には売上対象外商品の金額は含まれません。設定内容については、総売上対象外区分を参照。 | |
| SalesTotalNonSalesTargetDivision | String | 総売上対象外区分:基本設定の【総売上に「売上対象外商品」分を含める】の設定内容 (0:売上対象外を考慮する(除く)、1:売上対象外を考慮しない) ※0:考慮する(除く)なら、総売上には売上対象外商品の金額が含まれていません。 | |
| Saving | Integer | 銀行預入金:銀行預入金。 | |
| Status | String | ステータス:締め処理の状況を表す区分。(2:処理済みのみ) ※締め処理が行われていないデータは取得できません。(0:未処理、1:未処理(保存データあり) | |
| StoreId | Integer | 店舗ID:数字9桁以内。 | |
| SumDate | Date | 締め日:締め日。 | |
| TaxDetailList | String | 税率内訳リスト | |
| TaxExclude | Integer | 外税額:外税額の合計。 | |
| TaxExcludeReceive | Integer | 外税受領額:外税受領額の合計。 | |
| TaxFreeTotal | Integer | 免税額:免税額の合計。 | |
| TaxInclude | Integer | 内税額:内税額の合計。 | |
| TaxTotal | Integer | 消費税合計:消費税の合計。 | |
| TenThousandYen | Integer | 1万円札:締め時点の1万円札の枚数。 | |
| TenYen | Integer | 10円玉:10円玉の枚数。 | |
| Total | Integer | 純売上:純売上の合計。 基本設定の【純売上に免税額を含める】が、0:考慮する(除く)に設定されている場合、純売上には免税額の金額は含まれません。設定内容については、純売上免税区分を参照。 | |
| TotalExcludeTax | Integer | 純売上(税抜):純売上(税抜)の合計。 | |
| TotalExcludTax | Integer | (非推奨)純売上(税抜):純売上(税抜)の合計。 | |
| TotalTaxFreeDivision | String | 純売上免税区分:基本設定の【純売上に免税額を含める】の設定内容。 (0:免税額を考慮する(除く)、1:免税額を考慮しない) ※0:考慮する(除く)なら、純売上には免税額の金額が含まれていません。 | |
| TransactionCount | Integer | 通常取引数:通常取引の合計。 | |
| TwoThousandYen | Integer | 2千円札:2千円札の枚数。 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
値引/割引区分情報を取得します。
| Name | Type | References | Description |
| AwardType | String | 1:値引、2:割引 | |
| DiscountDivision | String | 値引/割引区分:値引/割引区分を一意に識別する番号であり、管理画面の[設定]→[販売設定]→[値引区分] / [割引区分]のページで確認できる「ID」に該当する。 ※取引時、小計値引/割引区分または単品値引/割引区分に対して指定可能。 | |
| DiscountDivisionName | String | 値引/割引区分名称 | |
| DisplayFlag | String | 有効/無効:端末で表示するかを設定。(0:無効、1:有効) | |
| DisplaySequence | Integer | 表示順 | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
ロス明細情報を取得します。
| Name | Type | References | Description |
| LossId [KEY] | Integer |
Losses.LossId | ロスID |
| LossDetailId [KEY] | Integer | ロス明細ID | |
| ProductId | Long | 商品ID | |
| TaxRate | Decimal | 税率 | |
| Cost | Decimal | 原価 | |
| Quantity | Integer | 数量 | |
| RfidTags | String | RFIDタグリスト | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
月別予算情報を取得します。
| Name | Type | References | Description |
| StoreId [KEY] | Integer |
Stores.StoreId | 店舗 ID |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| SalesTargetMonthly | Decimal | 売上金額の目標額(最大15桁) | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 | |
| Ym | String | 予算年月(YYYYMM 形式) |
支払方法取扱店舗情報を取得します。
| Name | Type | References | Description |
| PaymentMethodId [KEY] | Integer |
PaymentMethods.PaymentMethodId | 支払方法ID |
| StoreId [KEY] | Integer |
Stores.StoreId | 店舗ID |
| AssignDivision | String | 取扱区分:この支払方法を取扱うかを設定。(0:取扱う、1:取扱わない) |
商品画像情報を取得します。
| Name | Type | References | Description |
| ProductId | Long | 商品ID | |
| Url | String | 商品画像URL:商品画像のURL。※ 本画像URLはキャッシュサーバ上に一時保存されたものです。キャッシュ画像は本APIでアクセス後、約1時間で削除されますので、それまでに画像の取得をお願いいたします。※ 本APIでキャッシュ画像のURL取得後、商品画像を変更した場合、キャッシュ画像側は変更されませんのでご注意ください。※ 弊社システム間の一時的な通信不良等により、本項目がfailedとなることがあります。その場合は再度取得していただき、改善しない場合は弊社窓口、もしくはディベロッパーズコミュニティへのご報告をお願いいたします。 |
商品店舗別発注点情報を取得します。
| Name | Type | References | Description |
| StoreId | Integer |
Stores.StoreId | 店舗ID:数字9桁以内。 |
| ProductId | Long |
Products.ProductId | 商品ID:数字15桁以内。指定店舗に対して発注点が設定されている商品の場合、そのIDが返ります。指定店舗に対して発注点が未設定の商品の場合、そのIDの要素はレスポンスの配列には含まれません。 |
| OrderPoint | Number | 発注点:指定店舗に対して発注点が設定されている商品の場合、その発注点の値が返ります。 | |
| UpdDateTime | Datetime | 設定日時:更新時の日時。 |
商品発注設定情報を取得します。
| Name | Type | References | Description |
| ProductId [KEY] | Long |
Products.ProductId | 商品ID |
| ContinuationDivision | String | 継続区分:[管理画面->設定->在庫設定->発注設定->継続区分]から確認できる継続区分のコード。 | |
| OrderStatusDivision | String | 発注状態:(0:発注不可、1:発注可) | |
| OrderNoReasonDivision | String | 発注不可理由:[管理画面->設定->在庫設定->発注設定->発注不可理由]から確認できる発注不可理由のコード。 | |
| OrderLimitAmount | Integer | 発注制限数:(null:発注制限なし、0~99999999:発注制限) | |
| OrderSupplierEditable | String | 発注時仕入先編集状態:(0:編集不可、1:編集可能) | |
| PbDivision | String | PB区分:(1:プロパー、2:バーゲン) | |
| DisplayFlag | String | 発注表示:(0:表示しない、1:表示する) | |
| OrderUnit | String | 発注単位 | |
| Stores | String | 店舗別発注設定 |
商品価格変更履歴情報を取得します。
| Name | Type | References | Description |
| ProductId [KEY] | Long |
Products.ProductId | 商品ID |
| Id | Integer | ID | |
| AfterPrice | Integer | 変更後価格 | |
| AfterTaxDivision | String | 変更後税区分:(0:税込、1:税抜、2:非課税) | |
| BeforePrice | Integer | 変更前価格 | |
| BeforeTaxDivision | String | 変更前税区分:(0:税込、1:税抜、2:非課税) | |
| PriceDivision | String | 価格区分:(1:商品単価、2:会員価格、3:原価、4:商品単価詳細、5:会員価格詳細) | |
| ProcDetailDivision | String | 処理詳細区分:(1:登録、2:更新、3:削除) | |
| ProcDivision | String | 価格登録・更新時の処理区分:01:管理画面での商品登録・更新・削除、02:仕入時の商品価格変更、03:EC連携での商品登録・更新・削除、04:スマレジAPI連携で商品登録・更新・削除、05:waiter連携時の商品登録・更新・削除 | |
| UpdDateTime | Datetime | 更新日時 |
商品店舗情報を取得します。
| Name | Type | References | Description |
| ProductId [KEY] | Long |
Products.ProductId | 商品ID:数字15桁以内。 |
| StoreId [KEY] | Integer | 店舗ID:数字9桁以内。 | |
| AssignDivision | String | 取扱区分:0:販売する/1:販売しない |
発注対象商品情報を取得します。
| Name | Type | References | Description |
| StorageInfoId [KEY] | Integer | 発注ID | |
| Cost | Decimal | 原価(外税) 未設定の場合、商品マスタの原価を自動で設定する。 | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| ProductId | Long | 商品ID | |
| Quantity | Integer | 発注数量 発注配送商品の発注数量の合計が自動で設定されます。 | |
| StorageInfoProductId | Integer | 発注商品ID 自動採番 | |
| TaxDivision | String | 税区分:(0:税込、1:税抜、2:非課税) | |
| TaxRate | Decimal | 税率 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 | |
| DeliveryStores | String | 発注配送商品 |
発注配送商品情報を取得します。
| Name | Type | References | Description |
| PurchaseOrderId [KEY] | Integer | 発注ID | |
| StoreId | Integer | 配送店舗ID | |
| StorageInfoDeliveryProductId | Integer | 発注配送商品ID | |
| Quantity | Integer | 発注数量 |
発注対象店舗情報を取得します。
| Name | Type | References | Description |
| StorageInfoId [KEY] | Integer | 発注ID | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| StorageExpectedDateFrom | Date | 入荷予定日From 未設定の場合、登録日を設定します。 | |
| StorageExpectedDateTo | Date | 入荷予定日To 未設定の場合、登録日を設定します。 | |
| StorageInfoDeliveryId | Integer | 発注配送店舗ID 自動採番 | |
| StorageStoreId | Integer | 配送店舗ID | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
但し書き(領収証)情報を取得します。
| Name | Type | References | Description |
| DisplayFlag | String | 有効/無効:端末で表示するかを設定。(0:無効、1:有効) | |
| DisplaySequence | Integer | 表示順 | |
| InitialValueFlag | String | 初期値フラグ:端末で使用する際に、初期値として選択されるかを設定。(0:初期値としない、1:初期値) | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| ReceiptProvisoCode | String | 但し書き(領収証)コード | |
| ReceiptProvisoName | String | 但し書き(領収証)名称 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
入庫明細情報を取得します。
| Name | Type | References | Description |
| ReceivingId | Integer |
Receiving.ReceivingId | 入庫ID |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| InspectionDate | Date | 検品日 | |
| InspectionQuantity | Integer | 検品数:検品数(入庫した数)を設定。 | |
| ProductId | Long | 商品ID | |
| ReceivingDetailId | Integer | 入庫明細ID | |
| RfidTags | String | RFIDタグリスト。入庫検品分。 | |
| ScheduledQuantity | Integer | 予定数:入庫予定数を設定。 | |
| Status | String | 状態:商品の検品状況を設定。 0:未検品、1:検品完了 | |
| StockoutQuantity | Integer | 欠品数 | |
| StockoutReason | String | 欠品理由 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
軽減税率情報を取得します。
| Name | Type | References | Description |
| AdvancedCondition | String | ボタン選択初期値:軽減税率区分が 2:状態による権限税率適用 の場合、スマレジ・アプリ上で適用する/適用しないを選択するボタンのうち、初期状態でどちらが選択されているかが設定されます。(null:都度選択する、0:適用しない、1:適用する)※ 軽減税率区分が 1:特定商品や特定部門の軽減税率適用 の場合も null が設定されます。 | |
| Condition | String | ボタン名称:軽減税率区分が 2:状態による軽減税率適用 の場合、スマレジ・アプリ上で適用する/適用しないを選択するボタンの名称が、カンマ(,)区切りで設定されます。※ 軽減税率区分が 1:特定商品や特定部門の軽減税率適用 の場合は null が設定されます。 | |
| Division | String | 軽減税率区分:軽減税率の適用時、部門や商品にこの軽減税率が設定されている場合にこれをそのまま適用して販売するか、それとも状態(提供方法など)によって標準税率と軽減税率で適用税率を切り替えて販売するかの区分値が設定されます。1:特定商品や特定部門の軽減税率適用、2:状態による軽減税率適用 | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| Name | String | 軽減税率名:軽減税率につけられた名称です。 | |
| Rate | Decimal | 軽減税率:軽減税率がパーセントで設定されます。(数字3桁、小数は第3位まで) | |
| ReduceTaxId | Integer | 軽減税率ID | |
| TermEnd | Date | 適用終了日:軽減税率が適用可能な期間の最終日です。 | |
| TermStart | Date | 適用開始日:軽減税率が適用可能な期間の開始日です。 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 | |
| TargetDate | Date | 対象日:指定した場合、対象日時点で有効な軽減税率を取得します。 |
役割・役職アラート機能制限情報を取得します。
| Name | Type | References | Description |
| RoleId [KEY] | Integer | 役割・役職ID | |
| AlertType | String | アラート種別:制限対象アラートの種別です。(1:在庫切れ、2:発注点) | |
| ControlDivision | String | 制限区分:対象機能に対する制限区分です。(0:使用不可、1:使用可) |
役割・役職機能制限情報を取得します。
| Name | Type | References | Description |
| RoleId [KEY] | Integer | 役割・役職ID | |
| FunctionId | Integer | 機能ID:制限対象機能のIDです。 | |
| ControlDivision | String | 制限区分:対象機能に対する制限区分です。(1:使用不可、2:閲覧、3:編集、4:すべて) |
役割・役職在庫機能制限情報を取得します。
| Name | Type | References | Description |
| RoleId [KEY] | Integer | 役割・役職ID | |
| FunctionId | Integer | 機能ID:制限対象機能のIDです。 | |
| ControlDivision | String | 制限区分:対象機能に対する制限区分です。(1:使用不可、2:閲覧、3:編集、4:すべて) |
出荷明細情報を取得します。
| Name | Type | References | Description |
| ShipmentId | Integer |
Shipments.ShipmentId | 出荷ID |
| Cost | Decimal | 原価(外税) | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| Memo | String | メモ | |
| Price | Integer | 商品単価(内税) | |
| ProductId | Long | 商品ID | |
| Quantity | Integer | 出荷数 | |
| RfidTags | String | RFIDタグリスト | |
| ShipmentDetailId | Integer | 出荷明細ID | |
| TaxRate | Decimal | 税率:出荷時の商品税率 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
出庫明細情報を取得します。
| Name | Type | References | Description |
| ShippingId | Integer |
Shipping.ShippingId | 出庫ID |
| Cost | Decimal | ||
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| Price | Integer | ||
| ProductId | Long | 商品ID | |
| Quantity | Integer | 出庫数:出庫した数量を設定。 | |
| RequestQuantity | Integer | 出庫依頼数:出庫依頼された数量を設定。 | |
| RfidTags | String | RFIDタグリスト | |
| ShippingDetailId | Integer | 出庫明細ID | |
| Status | String | ||
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
スタッフ情報を取得します。
| Name | Type | References | Description |
| StaffId [KEY] | Integer | スタッフID:半角数字5桁以内。 | |
| DisplayFlag | String | 表示フラグ:表示フラグ。 (0:表示しない、1:表示する) | |
| DisplaySequence | Integer | 表示順:半角数字9桁以内。 | |
| String | メールアドレス。 | ||
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| LoginIpAddress | String | ログイン許可IPアドレス。 | |
| LoginStaffFlag | String | ログインフラグ:ログインフラグ。(0:ログイン不可、1:ログイン可、2:認証待ち、3:停止) | |
| Rank | String | ランク:85文字以内。 | |
| RoleId | Integer | 役割・役職ID:半角数字11桁以内。 | |
| StaffCode | String | スタッフコード:半角英数20文字以内。 | |
| StaffName | String | スタッフ名:50文字以内。 | |
| StaffNameKana | String | スタッフ名カナ:50文字以内。 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 | |
| Stores | String | スタッフ取扱店舗 | |
| UserId | String | ユーザー識別子:契約ID内において一意なユーザー識別子 |
在庫変動履歴情報を取得します。
| Name | Type | References | Description |
| ProductId [KEY] | Long | 商品ID | |
| StoreId [KEY] | Integer | 店舗ID | |
| Amount | Integer | 数量:入出庫数(相対値で設定) | |
| Cost | Decimal | 原価:原価 | |
| FromStoreId | Integer | 配送元店舗ID:入出庫時の配送元店舗の店舗ID | |
| Id | Integer | 在庫変動履歴ID | |
| LayawayStockAmount | Integer | 取置き在庫数:処理後の取置き在庫数。 | |
| Memo | String | メモ | |
| Price | Integer | 商品単価:商品単価 | |
| StaffId | Integer | スタッフID:登録時・更新時のスタッフID | |
| StaffName | String | スタッフ名:出庫処理時のスタッフ名 | |
| StockAmount | Integer | 在庫数:処理後の在庫数 | |
| StockDivision | String | 在庫区分:在庫を更新理由となる区分 (01:修正、02:売上、03:仕入、04:出庫、05:入庫、06:レンタル、07:取置き、08:棚卸、09:調整、10:出荷、12:返品、13:販促品、14:ロス、15:スマレジAPI連携、16:売上引当、17:入庫欠品、18:受注在庫引当) | |
| TargetDateTime | Datetime | 対象日時:在庫数を変更した時の日時。 棚卸、ロス登録時に日時を指定する場合があります。 通常は更新日時と同じ日時が設定されます。 | |
| TaxDivision | String | 税区分:商品単価の税区分 (0:税込、1:税抜、2:非課税) | |
| ToStoreId | Integer | 配送先店舗ID:入出庫時の配送先店舗の店舗ID | |
| UpdDateTime | Datetime | 更新日時:データ更新時の日時。 |
棚卸情報を取得します。
| Name | Type | References | Description |
| StocktakingInfoId | Integer | 棚卸情報ID | |
| AdjustmentDateTime | Datetime | 調整日時 | |
| AutoFollowingFlag | String | 自動追従フラグ:自動追従フラグ(0:利用しない、1:利用する) | |
| DivisionUnit | String | 分割単位:分割単位を設定。 (0:分割なし、1:部門) | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| LayawayStockIncludeFlag | String | 取置在庫取扱フラグ:取置在庫取扱フラグ(0:棚卸数量に取置在庫を含まない、1:棚卸数量に取置在庫を含む) | |
| Status | String | ステータス:(0:棚卸途中、1:調整中、2:棚卸完了、3:入力完了) | |
| StockCountDivision | String | 在庫計上区分:在庫計上区分(1:更新日、 2:計上日) | |
| StocktakingCompleteDateTime | Datetime | 棚卸完了日時 | |
| StocktakingInputCompleteDate | String | 入力完了日時 | |
| StoreId | Integer | 店舗ID | |
| TargetDate | Date | 棚卸日 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
棚卸対象部門情報を取得します。
| Name | Type | References | Description |
| StocktakingInfoId [KEY] | Integer |
Stocktaking.StocktakingInfoId | 棚卸情報ID:棚卸情報毎に付与するID。 |
| CategoryId | Integer | 部門ID一覧:棚卸対象部門の部門ID。対象が全部門の場合は「0」固定。 |
棚卸明細情報を取得します。
| Name | Type | References | Description |
| StocktakingInfoId [KEY] | Integer |
Stocktaking.StocktakingInfoId | 棚卸情報ID |
| CategoryId | Integer | 部門ID:現在の商品マスタの部門ID | |
| LayawayMoney | Integer | 取置在庫金額:基準日時点の取置在庫金額。 | |
| LayawayQuantity | Integer | 取置在庫数:基準日時点の取置在庫数。 | |
| ProductId | Long |
Products.ProductId | 商品ID |
| StockMoney | Integer | 在庫金額:基準日時点の在庫金額。 | |
| StockQuantity | Integer | 在庫数:基準日時点の在庫数。 | |
| StoreId | Integer |
Stores.StoreId | 店舗ID:棚卸を行った店舗ID。 |
| TransportationMoney | Integer | 積送在庫金額:基準日時点の積送在庫金額。 | |
| TransportationQuantity | Integer | 積送在庫数:基準日時点の積送在庫数。 | |
| BaseDate | Date | 基準日 |
棚卸対象商品情報を取得します。
| Name | Type | References | Description |
| CategoryId | Integer | 部門ID:現在の商品マスタの部門ID。 | |
| Cost | Decimal | 原価:状況が「調整中」「完了」の場合、棚卸調整時点の商品マスタの原価。状況が「棚卸中」の場合、商品マスタの原価。※棚卸ステータスが完了になっていない場合、正しい数値を取得する事ができません。 | |
| InputStocktakingQuantity | Integer | 棚卸数量入力値:棚卸数量入力値(実際に入力された棚卸数量) | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| LayawayStockQuantity | Integer | 取置き在庫数:棚卸調整時点の取置き在庫数。※棚卸ステータスが完了になっていない場合、正しい数値を取得する事ができません。 | |
| Memo | String | メモ | |
| ProductId | Long | 商品ID | |
| QuantityModifiedDatetime | Datetime | 棚卸数量入力日時:棚卸数量入力日時(棚卸数量を最後に入力した日時) | |
| RfidTags | String | RFIDタグリスト。棚卸数量入力分。 | |
| StockQuantityBeforeAdjustment | Integer | 調整前在庫数量:棚卸調整時点の理論在庫数。※棚卸ステータスが完了になっていない場合、正しい数値を取得する事ができません。 | |
| StocktakingQuantity | Integer | 棚卸数量:実在庫数。NULLの場合は未入力。※棚卸ステータスが完了になっていない場合、正しい数値を取得する事ができません。 | |
| TransportationStockQuantity | Integer | 積送在庫数:棚卸調整時点の積送在庫数。※棚卸ステータスが完了になっていない場合、正しい数値を取得する事ができません。 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 | |
| StocktakingInfoId | Integer | 棚卸情報ID |
入荷明細情報を取得します。
| Name | Type | References | Description |
| StorageId | Integer |
Storage.StorageId | 入荷ID |
| CompulsoryCompleteFlag | String | 強制終了フラグ:0:通常、1:強制終了 | |
| Cost | Decimal | 原価(外税):入荷商品の原価 | |
| DateMemo | String | 日付メモ: | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| InspectionDate | Date | 検品日: | |
| InspectionQuantity | Integer | 検品数 | |
| NumberMemo | String | 数字メモ | |
| ProductId | Long |
Products.ProductId | 商品ID |
| RfidTags | String | RFIDタグリスト。入荷検品分。 | |
| ScheduledQuantity | Integer | 予定数 | |
| Status | String | ステータス:0:未検品、1:検品完了 | |
| StockoutQuantity | Integer | 欠品数 | |
| StockoutReason | String | 欠品理由 | |
| StorageDetailId | Integer | 入荷明細ID | |
| StorageInfoId | Integer | 発注ID:発注登録から作成された入荷の場合のみ、発注IDを設定。 | |
| TaxRate | Decimal | 税率 | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
店舗取扱支払方法を取得します。
| Name | Type | References | Description |
| ChangeFlag | String | 釣銭フラグ:釣銭の有無を設定。(0:なし、1:あり) | |
| DisplayFlag | String | 表示フラグ:端末で表示するかを設定。(0:表示しない、1:表示する) | |
| DisplaySequence | Integer | 表示順 | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| PaymentMethodCode | String | 支払方法コード: | |
| PaymentMethodGroupId | Integer | 支払方法分類ID:[管理画面->設定->販売設定->支払方法分類] から確認できる支払方法分類のIDを指定。 | |
| PaymentMethodId | String | 支払方法ID:各支払方法に紐づくID。 | |
| PaymentMethodName | String | 支払方法名:支払方法名。85文字以内。 | |
| PointGivingUnit | Decimal | ポイント付与単位(ポイント):ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)(例10円ごとに0.2ポイントの場合、0.2ポイント) | |
| PointGivingUnitPrice | Integer | ポイント付与単位(金額):ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)(例10円ごとに2ポイントの場合、10円)※ポイント付与が重複で設定されている場合、適用される優先度は【カード会社 > 支払方法 > 会員 > 会員ランク > 店舗】の順。 | |
| SecuritiesFlag | String | 有価証券フラグ:有価証券であるかを設定。(0:有価証券ではない、1:有価証券である) | |
| UnitPrice | Integer | 単価:商品券のように1枚あたりの価格が決まっている場合に設定。(例:商品券1枚が500円の場合、500) | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 | |
| StoreId | Integer |
Stores.StoreId | 店舗ID |
指定した店舗のポイント条件を取得します。
| Name | Type | References | Description |
| StoreId | Integer |
Stores.StoreId | 店舗ID。 |
| PointUseDivision | String | ポイント使用区分:ポイント機能を使用するか判断。(0:使用しない、1:使用する) | |
| SpendRate | String | ポイント還元率:1ポイントの還元率を、円で設定(例:1ポイント1円の場合、1円) | |
| PointGivingUnitPrice | Integer | ポイント付与単位(金額):ポイント付与の設定 n円をnポイントの「n円」の部分(例:10円ごとに2ポイントの場合、10円) | |
| PointGivingUnit | Decimal | ポイント付与単位(ポイント):ポイント付与の設定 n円をnポイントの「nポイント」の部分(例:10円ごとに0.2ポイントの場合、0.2ポイント) | |
| PointGivingDivision | String | ポイント付与区分:1:税額を含める + 利用ポイント分を含める、2:税額を含めない + 利用ポイント分を含める、3:税額を含める + 利用ポイント分を含めない、4:税額を含めない + 利用ポイント分を含めない | |
| PointUseUnit | String | ポイント利用単位:例:500ポイント単位で利用可能の場合、500 | |
| PointSpendDivision | String | ポイント利用区分:1:外税を含む合計からポイント利用分を差し引く、2:外税を含まない合計からポイント利用分を差し引く | |
| PointSpendLimitDivision | String | ポイント利用上限区分: ポイント利用時にどこまで利用可能かを識別する。区分0: 保有ポイントまで利用可能、1: 値引き対象額以下で最小のポイントまで利用可能、2: 値引き対象額以上で最小のポイントまで利用可能 | |
| ExpireDivision | String | ポイント失効期限区分:ポイント失効期限の単位を設定。(0:なし、1:日、2:月、3:年) | |
| ExpireLimit | String | ポイント失効期限:ポイント失効までの期限を設定 | |
| MileageDivision | String | マイレージ利用区分: マイレージ機能を利用するか否か(0: 利用しない, 1: 利用する, 2: ポイントの代わりに貯める) | |
| MileageLimit | String | マイレージ付与上限 |
店舗商品価格を取得します。
| Name | Type | References | Description |
| StoreId | Integer |
Stores.StoreId | 店舗ID:全店の場合「-1」を設定 |
| EndDate | Date | 適用終了日:適用終了日が設定されていない場合はnull | |
| Price | Integer | 商品単価:数字8桁以内。 | |
| PriceDivision | String | 価格区分(1:商品単価、2:会員価格) | |
| ProductId | Long |
Products.ProductId | 商品ID:数字15桁以内。 |
| StartDate | Date | 適用開始日: | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 | |
| TargetDate | Date | 対象日:指定した場合、対象日時点で有効な商品価格を取得します。 |
商品取扱店舗
| Name | Type | References | Description |
| AppStartDateTime | Datetime | 適用開始日時:商品が端末に適用される日時を設定。 未設定の場合は未使用。 | |
| Attribute | String | 規格:1000文字以内。商品のカラー・サイズなどを設定。 | |
| CalcDiscount | String | 値引割引計算対象:小計値引/割引(クーポン値引、ポイント値引き含む)の対象かどうかを設定 (0:対象外、1:対象)未設定の場合、1:対象 を設定。 | |
| CatchCopy | String | キャッチコピー:1000文字以内。商品のキャッチコピーなどを設定。 | |
| CategoryId | Integer | 部門ID: | |
| Color | String | カラー:85文字以内。 | |
| Cost | Decimal | 原価:数字8桁以内(少数5桁まで)。未設定の場合0を設定。 | |
| CustomerPrice | Integer | 会員価格:数字8桁以内。会員価格を設定。 | |
| Description | String | 説明:1000文字以内。商品説明などを設定。 | |
| DisplayFlag | String | 端末表示:スマレジ端末に表示するか否かの判定。未設定の場合1を設定。 (0:表示しない、1:表示する) | |
| DisplaySequence | Integer | 表示順: | |
| Division | String | 商品区分:商品の種類を設定。未設定の場合0を設定。 (0:通常商品、1:回数券(*1)、2:オプション商品) | |
| GroupCode | String | グループコード:関連商品として紐付ける為のグループコードを設定。 例えば、AとBの商品に同じグループコード001を設定すると、AとBは関連商品となります。サイズ、カラーが異なる場合などに使用してください。 | |
| InsDateTime | Datetime | 作成日時:登録時の日時。 | |
| OrderPoint | Integer | ||
| PointNotApplicable | String | ポイント対象:ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外) | |
| Price | Integer | 商品単価:数字8桁以内。販売価格を設定。 | |
| PrintReceiptProductName | String | レシート印字商品名:レシートに印字する商品名。64文字以内。 | |
| ProductCode | String | 商品コード: | |
| ProductId | Long | 商品ID:数字15桁以内。 | |
| ProductKana | String | 商品カナ:全角カナ85文字以内。 | |
| ProductName | String | 商品名:85文字以内。 | |
| ProductOptionGroupId | Integer | オプショングループID:オプショングループの設定方法が「全店舗共通」の場合、適用可能なオプショングループがあればそのIDがこちらに設定されます。無ければnullが設定されます。 | |
| ProductPriceDivision | String | 商品価格区分:商品をオープン価格販売するかどうか設定。未設定の場合1を設定。 (1:通常価格、2:オープン価格) | |
| PurchaseCost | Decimal | ||
| ReduceTaxCustomerPrice | Integer | 軽減税率用商品会員単価:軽減税率用会員単価を設定。 設定内容については、「軽減税率用商品単価」と同様となります。 | |
| ReduceTaxId | Integer | 軽減税率ID(税設定):軽減税率ID。 軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。軽減:10000001 (特定商品の軽減税率適用)選択[標準]:10000002(状態による適用[適用しない])選択[軽減]:10000003(状態による適用[適用する])選択[選択]:10000004(状態による適用[都度選択する]) | |
| ReduceTaxPrice | Integer | 軽減税率用商品単価:軽減税率用商品単価を設定。 当項目は、レジ端末で販売時に、軽減税率を選択した時の価格になります。未設定の場合は、「商品単価」が軽減税率を選択した時の価格になります。税込の場合設定可能。税抜価格の場合計算して算出できるため税込の場合のみ設定できます。 | |
| SalesDivision | String | 売上区分:取引時に売上計上するか否かの設定。 (0:売上対象、1:売上対象外) | |
| Size | String | サイズ:85文字以内。 | |
| StaffDiscountRate | Integer | 社員販売割引率:数字3桁以内。社員販売時の割引率を設定。 | |
| StockControlDivision | String | 在庫管理区分:棚卸対象商品とするか否かの設定。 (0:在庫管理対象、1:在庫管理対象外) | |
| SupplierProductNo | String | 品番:85文字以内。 | |
| Tag | String | タグ:85文字以内。複数ある場合は、カンマで区切り。 | |
| TaxDivision | String | 税区分:商品価格の消費税の扱いに関する設定。 (0:内税、1:外税、2:非課税) | |
| TaxFreeDivision | String | 免税区分:免税区分の設定。未設定の場合0を設定。 (0:対象外、1:一般品、2:消耗品)免税機能を利用しない場合は「対象外」としてください。「対象外」免税対象ではない商品:「一般品」電化製品、服、着物、カバンなど、「消耗品」酒、食品類、薬品類、化粧品類など。※部門の免税区分よりも、商品の免税区分を優先します。(部門売りで適用されます。) | |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 | |
| Url | String | URL:255文字以内。 スマレジ端末でWEBページを表示したい場合設定。 | |
| UseCategoryReduceTax | String | 部門の税設定を使用:商品に設定した税設定を使用するか、その商品に設定した部門の税設定を使用するかを選択。(0:商品の税設定を使用、1:部門の税設定を使用)「軽減税率ID(税設定)」に値が設定されている場合「0:商品の税設定を使用」。「軽減税率ID(税設定)」の値が未設定(null)の場合「1:部門の税設定を使用」を設定 | |
| StoreId | Integer |
Stores.StoreId | |
| WithStores | String |
店舗のレシート印刷情報を取得します。
| Name | Type | References | Description |
| StoreId | Integer |
Stores.StoreId | 店舗ID。 |
| header | String | レシートヘッダ:レシートのヘッダ部分に印字する内容を設定してください。横幅24文字(半角48文字)で改行して登録してください。縦幅は100列程度まで。1000文字以内。 | |
| footer | String | レシートフッタ:レシートのフッタ部分に印字する内容を設定してください。横幅24文字(半角48文字)で改行して登録してください。縦幅は100列程度まで。1000文字以内。 | |
| receiptTaxOfficeStampComment | String | レシート税務署印コメント:税務署名が登録されてい場合のみ、レシートのコメント部分に印字されます。横幅24文字(半角48文字)で改行して登録してください。縦幅は100列程度まで。1000文字以内。 | |
| taxOfficeName | String | 税務署名:10文字以内。規定の位置に収入印紙を貼り付ける代わりに「印紙税申告納付につき○○税務署承認済」印を押印する場合、税務署名を入力してください。例) 渋谷税務署の場合「渋谷」、新宿税務署の場合「新宿」と入力してください。 | |
| airPrintLogo | String | AirPrint用ロゴ | |
| advertisementImage | String | 広告画像 | |
| giftReceiptImage | String | ギフトレシート用画像 | |
| giftReceiptNote | String | ギフトレシート用注釈 | |
| discountReceiptHeader | String | 割引レシート控えヘッダ:割引レシート控えレシートのヘッダ部分に印字する内容を設定してください。1000文字以内。 | |
| discountReceiptFooter | String | 割引レシート控えフッダ:割引レシート控えレシートのヘッダ部分に印字する内容を設定してください。1000文字以内。 |
取引クーポン商品付与明細を取得します。
| Name | Type | References | Description |
| TransactionHeadId [KEY] | Integer | 取引ID | |
| TransactionCouponDetailId | Integer | 取引クーポン明細ID | |
| TransactionCouponId | Integer | 取引クーポンID | |
| TerminalTranCouponId | Integer | 端末取引クーポンID | |
| TransactionDetailId | Integer | 取引明細ID | |
| CouponItemId | Integer | クーポンアイテムID |
取引クーポン情報を取得します。
| Name | Type | References | Description |
| TransactionHeadId [KEY] | Integer | 取引ID | |
| TransactionCouponId | Integer | 取引クーポンID | |
| TerminalTranCouponId | Integer | 端末取引クーポンID | |
| CouponId | Integer | クーポンID | |
| CouponName | String | クーポン名 | |
| CouponDivision | String | クーポン区分:クーポン区分(0:通常、1:giftee) | |
| SerialNumber | String | シリアル番号:クーポンのシリアル番号。端末側でのクーポンの入力にはこちらが用いられます。 | |
| AwardType | String | 特典タイプ:そのクーポンのタイプ。(1:値引、2:割引、3:商品付与、P1:0ポイント、P2:ポイント指定(上書き)、P3:ポイント追加(加算)、P4:ポイントN倍、M1:0マイル、M2:マイル指定(上書き)、M3:マイル追加(加算)、M4:マイルN倍) | |
| AwardValue | Integer | 特典値: 特典タイプが値引きの場合は値引き額[円]、割引の場合は割引率[%]、商品付与の場合は0が入ります。 | |
| DiscountPrice | Integer | 値引額:その取引でのクーポン値引き・割引額の合計。 |
取引その他支払方法を取得します。
| Name | Type | References | Description |
| TransactionHeadId | Integer | 取引ID:取引毎に付与するID。 | |
| No | String | 項番 | |
| paymentMethodId | Integer | その他支払方法ID:各支払方法に紐づくID。 | |
| paymentMethodCode | String | 支払方法コード:半角英数記号20文字以内。 | |
| paymentMethodName | String | 支払方法名:支払方法名。85文字以内。 | |
| depositOthers | String | 預り金その他:会計時に預かった金額。(例:500円商品券2枚の場合、1000) | |
| paymentUnitPrice | Integer | 単価:商品券のように1枚あたりの価格が決まっている場合に設定。(例:500円商品券2枚の場合、500) | |
| paymentChangeFlag | String | 釣銭フラグ:釣銭フラグ(0:釣銭なし、1:釣銭あり) | |
| paymentDivision | String | 支払方法マスタの支払方法分類を自動設定。 | |
| paymentSecuritiesFlag | String | 有価証券フラグ:有価証券フラグ(0:有価証券以外,1:有価証券) | |
| denominationCode | String | 支払金種コード ※個別アプリ専用支払方法登録APIで登録した支払方法でのみ指定可能です | |
| denominationName | String | 支払金種名。詳細は、支払金種コードの「支払金種コード対応表」をご参照ください ※現状、個別アプリ専用支払方法ID利用時のみ対応 | |
| cardCompanyName | String | クレジットカード会社名 ※現状、個別アプリ専用支払方法ID利用時のみ対応 | |
| slipNumber | String | 伝票番号 | |
| cancelSlipNumber | String | 取消伝票番号 | |
| pointGivingUnitPrice | Integer | ポイント付与単位(金額):ポイント付与の設定 m円につきnポイントの「m円」の部分。 (設定範囲1円~99999円)(例10円ごとに2ポイントの場合、10円) | |
| pointGivingUnit | Decimal | ポイント付与単位(ポイント):ポイント付与の設定 m円につきnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)(例10円ごとに0.2ポイントの場合、0.2ポイント) |
取引明細情報を取得します。
| Name | Type | References | Description |
| TransactionHeadId | Integer |
Transactions.TransactionHeadId | 取引ID:数値型。 |
| TransactionDetailId | Integer | 取引明細ID:数値型。 | |
| ApplyBargainDiscountPrice | Integer | 適用セール値引き額:セール販売時のみ設定。 | |
| ApplyBargainValue | String | 適用セール値:セール販売時のみ設定。 | |
| ApplyStaffDiscountPrice | Integer | 適用社員値引き額:社員販売時のみ設定。 | |
| ApplyStaffDiscountRate | Integer | 適用社員販売割引率:社員販売時のみ設定。 | |
| BargainDiscountProportional | Integer | セール値引き按分:セール販売時のみ設定。 | |
| BargainDivision | String | セール区分:セール販売時のみ設定。 | |
| BargainId | Integer | セールID:セール販売時のみ設定。※セール商品ID(bargainProductId)の値が設定されます。 | |
| BargainName | String | セール名称:セール販売時のみ設定。 | |
| BargainValue | Integer | セール値:セール販売時のみ設定。 | |
| CalcDiscount | String | 値引割引計算対象:小計値引/割引(クーポン、ポイント値引き含む)の対象かどうかを設定(0:対象外、1:対象)。 | |
| CategoryId | Integer | 部門ID:数字9桁以内。 | |
| CategoryName | String | 部門名:85文字以内。 | |
| Color | String | カラー:85文字以内。 | |
| Cost | Decimal | 原価:数字8桁以内(少数5桁まで)。未設定の場合0を設定。 | |
| CostSum | Decimal | 原価計:数字8桁以内(少数5桁まで)。未設定の場合0を設定。 | |
| DiscountCouponProportional | Integer | クーポン値引き按分:クーポン値引きの按分を設定。端数処理は銀行丸め。誤差は最終行で調整します。 | |
| DiscountPointProportional | Integer | ポイント値引き按分:ポイント値引きの按分を設定。端数処理は銀行丸め。誤差は最終行で調整。 | |
| DiscountPriceProportional | Integer | 小計値引き按分:小計値引きの按分を設定。端数処理は銀行丸め。誤差は最終行で調整。 | |
| DiscriminationNo | String | 識別番号:20桁以内。 | |
| GroupCode | String | グループコード:関連商品として紐付ける為のグループコードを設定。 例えば、AとBの商品に同じグループコード001を設定すると、AとBは関連商品となります。サイズ、カラーが異なる場合などに使用してください。 | |
| InventoryReservationDivision | String | 在庫引当区分:在庫引当商品か否かの区分(0:通常商品 1:在庫引当商品)。 | |
| Memo | String | 返品販売時などのメモなどを設定。 1000文字以内。 | |
| ModifiedTaxRate | Decimal | 修正税率: 修正した税率(明細毎に税率変更可能なため)。 | |
| ParentTransactionDetailId | Integer | 親取引明細ID:紐付く親の取引明細がある場合、その取引明細IDを設定。ない場合、NULLを設定。※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の 取引明細IDを設定しなければならない。 | |
| PointNotApplicable | String | ポイント対象:ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外)。 | |
| Price | Integer | 商品単価:当時の商品マスタの商品単価。数値型。 | |
| PrintReceiptProductName | String | レシート印字商品名:レシートに印字する商品名。64文字以内。 | |
| ProductBundleGroupId | Integer | 商品バンドルグループID:商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。商品バンドルグループに存在するIDを指定しなければならない。この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない。 | |
| ProductBundleProportional | Integer | 商品バンドル値引按分:商品バンドル値引きを按分した金額を設定。端数処理は銀行丸め。誤差は最終行で調整。 | |
| ProductCode | String | 商品コード:半角英数記号64文字以内(2段バーコード利用時は最大64桁、それ以外は20桁)。 | |
| ProductDivision | String | 商品区分:(0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル(親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値引(子)、A:プラン(子)、B:コース(子))。 | |
| ProductId | Long |
Products.ProductId | 商品ID:数字15桁以内。 |
| ProductName | String | 商品名:85文字以内。 | |
| ProductStaffDiscountRate | Integer | 商品毎の社員割引率:社員販売時のみ設定。 | |
| Quantity | Integer | 数量:数値型。 | |
| ReduceTaxId | Integer | 軽減税率ID(税設定):軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。軽減:10000001 (特定商品の軽減税率適用)、選択[標準]:10000002(状態による適用[適用しない])、選択[軽減]:10000003(状態による適用[適用する])、選択[選択]:10000004(状態による適用[都度選択する]) | |
| ReduceTaxMemberPrice | Integer | 軽減税率用会員商品単価:軽減税率販売時のみ設定。 | |
| ReduceTaxName | String | 軽減税率名:軽減税率販売時のみ設定。 | |
| ReduceTaxPrice | Integer | 軽減税率用商品単価:軽減税率販売時のみ設定。 | |
| ReduceTaxRate | Decimal | 軽減税率:軽減税率販売時のみ設定。 | |
| RfidTags | String | RFIDタグリスト。スマレジ・アプリでRFIDタグを用いて取引登録した場合、取引明細に紐付くRFIDタグリストを取得することができます。「summary」指定時省略 | |
| RoundingPriceProportional | Integer | 端数値引額按分:端数値引額の按分した金額を設定。端数処理は銀行丸め。誤差は最終行で調整。 | |
| SalesDivision | String | 売上区分:(0:売上対象、1:売上対象外)。 | |
| SalesPrice | Integer | 販売単価:販売時の単価を設定。デフォルトは商品単価。 | |
| Size | String | サイズ:85文字以内。 | |
| StaffDiscountDivision | String | 社員販売割引区分:社員販売時のみ設定。1ビット目:商品マスタの社員販売最大値引率を考慮(する or しない)、2ビット目:セール価格と社員販売割引を掛け合わせて適用(する or しない)、3ビット目:セール価格と社員販売価格を比較して安い方を適用(する or しない)、4ビット目:セール価格と社員販売価格を比較して高い方を適用(する or しない)、8ビット目:セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用(する or しない)。 | |
| StaffDiscountProportional | Integer | 社員値引き按分:社員販売時のみ設定。 | |
| StaffDiscountRate | Integer | 社員販売割引率:社員販売時のみ設定。 | |
| StaffRank | String | 社員ランクコード:社員販売時のみ設定。 | |
| StaffRankName | String | 社員ランク名:社員販売時のみ設定。 | |
| StandardTaxRate | String | 標準税率:(明細毎に税率変更可能なため)。 | |
| TaxDivision | String | 税区分:(0:税込、1:税抜、2:非課税)。 | |
| TaxExcludeProportional | Integer | 外税按分:外税を按分した金額を設定。端数処理は銀行丸め。誤差は最終行で調整。 | |
| TaxFree | String | 免税額:数値型。 | |
| TaxFreeCommodityPrice | Integer | 免税対象額:数値型。 | |
| TaxFreeDivision | String | 免税区分:(0:対象外、1:一般品、2:消耗品)。 | |
| TaxIncludeProportional | Integer | 内税按分:内税を按分した金額を設定。端数処理は銀行丸め。誤差は最終行で調整。 | |
| TaxRate | Decimal | 適用税率:(明細毎に税率変更可能なため)。 | |
| TransactionDetailDivision | String | 取引明細区分:(1:通常、2:返品、3:部門売り)。 | |
| UnitDiscountDivision | String | 単品値引き/割引区分:単品値引き/割引時に指定された区分を設定。 | |
| UnitDiscountedSum | Integer | 値引き後計:値引き前計 - 単品値引き計。 | |
| UnitDiscountPrice | Integer | 単品値引:販売単価の値引き金額を設定。単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て)。 | |
| UnitDiscountRate | Integer | 単品割引:単品の割引率を設定。(単位:%)。 | |
| UnitDiscountSum | Integer | 単品値引き計:単品値引き×数量。※管理画面の取引履歴CSVで対応する項目: 単価値引き計 | |
| UnitNonDiscountSum | Integer | 値引き前計:販売価格×数量。 | |
| Discounts | String | 単品値引/割引の詳細情報 | |
| ProductAttributesunts | String | 取引時の商品属性情報 | |
| WithDiscounts | String | 単品値引/割引の値引区分や割引区分情報を付加するか(付加する場合はall, しない場合はnone) | |
| WithDetailProductAttributes | String | 販売時の商品属性情報を付加するか(付加する場合はall, しない場合はnone) |
取引明細単品値引/割引情報を取得します。
| Name | Type | References | Description |
| TransactionHeadId | Integer |
Transactions.TransactionHeadId | 取引ID |
| TransactionDetailId | Integer |
TransactionDetails.TransactionDetailId | 取引明細ID:取引毎の明細に付与するID。 |
| TransactionDiscountDivision | String | 取引値引区分 (2:単品) | |
| DiscountDivision | String | 値引/割引区分: 値引/割引時に指定された区分を設定。 | |
| DiscountDivisionName | String | 値引/割引区分名称 | |
| AwardType | String | 特典タイプ:(1:値引・値増、2:割引)。 | |
| AwardValue | Integer | 特典値:特典タイプに応じた値を設定。特典タイプ設定値1:値引値引額[円](※)2:割引割引率[%]※ 値引は正の数、値増は負の数が設定されます | |
| DiscountPrice | Integer | 値引額 ※ 値引は正の数、値増は負の数が設定されます |
取引明細販売時商品属性情報を取得します。
| Name | Type | References | Description |
| TransactionHeadId | Integer |
Transactions.TransactionHeadId | 取引ID |
| TransactionDetailId | Integer |
TransactionDetails.TransactionDetailId | 取引明細ID |
| Code | String | コード | |
| Name | String | 名称 |
取引 値引/割引区分情報を取得します。
| Name | Type | References | Description |
| TransactionHeadId | Integer |
Transactions.TransactionHeadId | 取引ID |
| TransactionDetailId | Integer | 取引明細ID:取引毎の明細に付与するID。※ 取引値引区分が小計の場合、nullが返されます。 | |
| TransactionDiscountDivision | String | 取引値引区分 (1:小計、2:単品) | |
| DiscountDivision | String | 値引/割引区分: 値引/割引時に指定された区分を設定。 | |
| DiscountDivisionName | String | 値引/割引区分名称 | |
| AwardType | String | 特典タイプ:(1:値引・値増、2:割引)。 | |
| AwardValue | Integer | 特典値:特典タイプに応じた値を設定。特典タイプ設定値1:値引値引額[円](※)2:割引割引率[%] ※ 値引は正の数、値増は負の数が設定されます | |
| DiscountPrice | Integer | 値引額 ※ 値引は正の数、値増は負の数が設定されます ※ 取引値引区分が(1:小計)の場合、打消レコードに関連すると、値が正負が逆転して設定されます |
取置き取引明細を取得します。
| Name | Type | References | Description |
| TransactionHeadId | Integer |
TransactionLayaways.TransactionHeadId | 取引ID |
| ApplyBargainDiscountPrice | Integer | 適用セール値引き額:セール販売時のみ設定 適用したセール販売の値引き額 | |
| ApplyBargainValue | Integer | 適用セール値:セール販売時のみ設定 適用したセール販売の割引、値引き、価格指定の値 | |
| ApplyStaffDiscountPrice | Integer | 適用社員値引き額:セール販売時のみ設定 適用した社員販売の値引き額 | |
| ApplyStaffDiscountRate | Integer | 適用社員販売割引率:セール販売時のみ設定 適用した社員販売の割引率 | |
| BargainDiscountProportional | Integer | セール値引き按分:端数処理は銀行丸め。誤差は最終行で調整。 | |
| BargainDivision | String | セール区分:セール販売時のみ設定 1:割引 2:値引 3:価格指定 | |
| BargainId | Integer | セールID:セール販売時のみ設定。適用したセールのID。※セール商品ID(bargainProductId)の値が設定されます。 | |
| BargainName | String | セール名称:セール販売時のみ設定 適用したセールの名称 | |
| BargainValue | Integer | セール値:セール販売時のみ設定 割引、値引、価格指定の値 | |
| CalcDiscount | String | 小計値引/割引(クーポン、ポイント値引き含む)の対象かどうかを設定(0:対象外、1:対象)。 | |
| CategoryId | Integer | 部門ID:商品に紐付く部門毎に付与するID。数字9桁以内。※部門情報が存在しない場合nullを設定。 省略時、商品IDが設定されている場合、商品マスタから設定。以外はnull。※商品IDが設定されている場合、商品情報の部門IDと一致しないとエラー | |
| CategoryName | String | 部門名:商品に紐付く部門名。(85文字以内) ※設定時、そのまま設定。※省略時、部門IDが設定されている場合、マスタから設定。以外はnull | |
| Color | String | カラー:商品IDが設定されている場合、商品マスタのカラーを設定します | |
| Cost | Decimal | 商品原価:整数部分8桁、少数部5桁.。省略時、商品IDが設定されている場合、マスタから設定。以外は0円 | |
| CostSum | Decimal | 原価計:原価×数量 | |
| DiscountCouponProportional | Integer | ||
| DiscountPointProportional | Integer | ポイント値引き按分:端数処理は銀行丸め。誤差は最終行で調整。 | |
| DiscountPriceProportional | Integer | 小計値引き按分:端数処理は銀行丸め。誤差は最終行で調整。 | |
| DiscriminationNo | String | 識別番号:明細行を識別できる番号を追加。 | |
| GroupCode | String | グループコード:商品IDが設定されている場合、商品マスタのグループコードを設定します | |
| InventoryReservationDivision | String | 在庫引当区分:在庫引当商品か否かの区分(0: 通常商品 1: 在庫引当商品) 自動で設定します。商品IDが設定されている場合、商品マスタから設定。以外は0:通常商品を設定 | |
| Memo | String | ||
| ModifiedTaxRate | Decimal | 修正税率:修正した税率(明細毎に税率変更可能な為) | |
| ParentTransactionDetailId | Integer | 親取引明細ID:紐付く親の取引明細がある場合、その取引明細IDを設定。※商品区分が、0(通常販売), 4(バンドル(親))の場合は設定できず、7(バンドル子), 8(バンドル値引)の時は、バンドル(親)の取引明細IDを設定しなければならない。 | |
| PointNotApplicable | String | ポイント対象区分:ポイント対象にするか否かの設定(0:ポイント対象、1:ポイント対象外) 自動で設定します。商品IDが設定されている場合、商品マスタから設定。以外は0:ポイント対象を設定 | |
| Price | Integer | 商品単価:※設定時そのまま設定。※省略時、商品IDが設定されている場合、マスタから設定。以外は0円 | |
| PrintReceiptProductName | String | レシート印字商品名:省略時、商品IDが設定されている場合、マスタから設定。以外はnull | |
| ProductBundleGroupId | Integer | 商品バンドルグループID:商品バンドル販売の明細の場合、商品バンドルグループのIDを設定。商品バンドルグループに存在するIDを指定しなければならない。この項目を設定する明細の商品区分は「4:バンドル(親)」でなければならない | |
| ProductBundleProportional | Integer | 商品バンドル値引按分:端数処理は銀行丸め。誤差は最終行で調整。 | |
| ProductCode | String | 商品コード:省略時、商品IDが設定されている場合、マスタから設定。以外はnull | |
| ProductDivision | String | 商品区分:商品区分 (0:通常、1:回数券、2:オプション商品、3:部門販売、4:バンドル (親)、5:セット売(親)、6:簡易セット(親)、7:バンドル商品(子)、8:バンドル値 引(子)、A:プラン(子)、B:コース(子)) ※A,Bはウェイターでのみ利用する区分。 | |
| ProductId | Long | 商品ID | |
| ProductName | String | 商品名:省略時、商品IDが設定されている場合、マスタから設定。以外はnull | |
| ProductStaffDiscountRate | Integer | 商品毎の社員割引率:社員販売時のみ設定 商品の社販販売割引率 | |
| Quantity | Integer | 数量:購入数 | |
| ReduceTaxId | Integer | 軽減税率ID(税設定):軽減税率設定画面で設定した軽減税率ID、または、下記の軽減税率ID。標準税率の場合はnull。軽減:10000001 (特定商品の軽減税率適用)、選択[標準]:10000002(状態による適用[適用しない])、選択[軽減]:10000003(状態による適用[適用する])、選択[選択]:10000004(状態による適用[都度選択する]) | |
| ReduceTaxMemberPrice | Integer | 軽減税率用会員商品単価:軽減税率用会員商品単価 | |
| ReduceTaxName | String | 軽減税率名 | |
| ReduceTaxPrice | Integer | 軽減税率用商品単価:軽減税率用商品単価 | |
| ReduceTaxRate | Decimal | 軽減税率 | |
| RfidTags | String | ||
| RoundingPriceProportional | Integer | 端数値引額按分:端数処理は銀行丸め。誤差は最終行で調整。 | |
| SalesDivision | String | 売上区分:売上計上するか否かの区分。(0:売上対象、1:売上対象外) 省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:売上対象を設定 | |
| SalesPrice | Integer | 販売単価:販売時の単価を設定。 | |
| Size | String | サイズ:商品IDが設定されている場合、商品マスタのサイズを設定します | |
| StaffDiscountDivision | String | 社員販売割引区分:社員販売時のみ設定 1ビット目: 商品マスタの社員販売最大値引率を考慮(する or しない) 2ビット目: セール価格と社員販売割引を掛け合わせて適用(する or しない) 3ビット目: セール価格と社員販売価格を比較して安い方を適用(する or しない) 4ビット目: セール価格と社員販売価格を比較して高い方を適用(する or しない) 8ビット目: セール価格と社員販売価格の比較に商品マスタの社販OFF率を利用(する or しない) | |
| StaffDiscountProportional | Integer | 社員値引き按分:端数処理は銀行丸め。誤差は最終行で調整。 | |
| StaffDiscountRate | Integer | 社員販売割引率:社員販売時のみ設定 社員販売の割引率 | |
| StaffRank | String | 社員ランクコード:社員販売時のみ設定 社員ランクのコードを設定 | |
| StaffRankName | String | 社員ランク名:社員販売時のみ設定 社員ランクの名称を設定 | |
| StandardTaxRate | Decimal | 標準税率:標準税率(明細毎に税率変更可能な為) | |
| TaxDivision | String | 税区分:(0:税込、1:税抜、2:非課税) ※設定時そのまま設定 ※省略時、商品IDが設定されている場合、マスタから設定。以外は0:税込 | |
| TaxExcludeProportional | Integer | 外税按分:端数処理は銀行丸め。誤差は按分時に誤差が多きものから順に調整。 | |
| TaxFree | String | 免税額:免税額を設定。(免税対象額 x 税率)※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。 | |
| TaxFreeCommodityPrice | Integer | 免税対象額:免税後の税抜金額を設定。(税抜価格x数量)※免税販売時に未設定だと、日報の表示がずれる事があるので注意してください。 | |
| TaxFreeDivision | String | 免税区分:免税区分の設定。(0:対象外、1:一般品、2:消耗品) 省略時、商品IDが設定されている場合、商品マスタから設定。以外は0:対象外を設定 | |
| TaxIncludeProportional | Integer | 内税按分:端数処理は銀行丸め。誤差は按分時に誤差が多きものから順に調整。 | |
| TaxRate | Decimal | 適用税率:適用した税率(明細毎に税率変更可能な為) | |
| TransactionDetailDivision | String | 取引明細区分:取引明細を識別する区分。(1:通常、2:返品、3:部門売り) | |
| TransactionDetailId | Integer | 取引明細ID:取引毎の明細に付与するID。未設定の場合、取引毎に1から採番。設定する場合は0〜999まで。 | |
| UnitDiscountDivision | String | 単品値引き/割引区分:単品値引き/割引時に指定された割引区分を設定。 | |
| UnitDiscountedSum | Integer | 値引き後計:値引き前計 - 単品値引き計 | |
| UnitDiscountPrice | Integer | 単品値引:販売単価の値引き金額を設定。単品割引率が設定された場合、その割合から値引き金額を設定。(切捨て)。 | |
| UnitDiscountRate | Integer | 単品割引率:単品の割引率を設定。(単位:%)※設定された場合、単品値引は必須 | |
| UnitDiscountSum | Integer | 単品値引き計:単品値引き×数量 ※管理画面の取引履歴CSVで対応する項目: 単価値引き計 | |
| UnitNonDiscountSum | Integer | 値引き前計:販売価格×数量 | |
| WithDiscounts | String | 単品値引/割引の値引区分や割引区分情報を付加するか(付加する場合はall, しない場合はnone) | |
| WithDetailProductAttributes | String | 販売時の商品属性情報を付加するか(付加する場合はall, しない場合はnone) |
取置き引取時の詳細情報を取得します。
| Name | Type | References | Description |
| TransactionHeadId | Integer |
TransactionLayaways.TransactionHeadId | 取引ID |
| LayawayServerTransactionHeadId | Integer | 取置きの取引ID | |
| ReceivedDepositCash | Integer | 受領済金額:取置きの内金/手付金(現金) | |
| ReceivedDepositCredit | Integer | 受領済クレジット金額:取置きの内金/手付金(クレジット) |
回数券取引情報を取得します。
| Name | Type | References | Description |
| TransactionHeadId | Integer |
Transactions.TransactionHeadId | 回数券を購入した取引のID |
| TransactionProductSetId | Integer | 回数券取引毎に付与するID | |
| TransactionDetailId | Integer | 回数券を購入した取引明細のID | |
| ProductSetId | Integer | 回数券の商品ID | |
| ProductSetCode | String | 回数券の商品コード | |
| ProductSetName | String | 回数券の商品名 | |
| ProductSetPrice | Integer | 回数券の商品単価 | |
| ProductSetCategoryId | String | 回数券部門ID | |
| ProductSetCategoryName | String | 回数券の部門名 | |
| CustomerId | Long | 会員ID:回数券を購入した会員のID※ 会員販売でない場合nullが設定されます。 | |
| PurchaseDateTime | Datetime | 購入日時:回数券を購入した日時 | |
| ExpireDate | Date | 有効期限日 ※ 期限がない場合nullが設定されます。 | |
| ConsumeDateTime | Datetime | 最終使用日時:回数券を最後に使用した日時 ※ 未使用の場合nullが設定されます。 | |
| Status | String | 回数券取引状態区分(0: 使用中、1: 使用完了、2: 期限切れ) | |
| OptionConsumeLimit | String | オプション使用上限数:オプション商品全体の使用上限数 ※ オプションを登録していない場合nullが設定されます。 |
ストアドプロシージャはファンクションライクなインターフェースで、Smaregi の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにSmaregi から関連するレスポンスデータを返します。
| Name | Description |
| ApproveShipping | 出庫承認ステータスを更新します。未承認となっている出庫情報/出庫依頼情報に対し、出庫を承認/拒否する場合に本APIを実行します。承認済にすると、承認ステータスが承認済、ステータスが未入庫(出庫済)の状態に更新します。承認拒否にすると、承認ステータスが承認拒否の状態に更新します。 |
| CompleteShippingModificationRequest | 出庫の修正依頼を完了します。修正依頼中となっている出庫情報に対し、修正依頼を完了する際に本APIを実行します。修正依頼ステータスが 2:修正完了 に更新され、修正依頼中に行った修正を入庫に反映します。 |
| DeleteProductIconImage | 商品アイコン画像を削除します。 |
| DeleteProductImage | 商品画像を削除します。 |
| DisposeTransaction | 取引を打消取消します。指定された取引に対して、返品する取引情報を作成します。※外部決済連携を行う支払方法での決済を含む取引を取消しても、外部決済システムへの返金処理は行われません。 |
| DisposeTransactionLayaway | 取置きを打消取消します。指定された取置きに対して、返品する取置き情報を作成します。 |
| ExecuteAdjustment | 精算を実行します。 |
| ExecuteDailySummary | 締め処理を実行します。※本処理は、スマレジ・アプリにおける手動締め処理に相当する処理です。※精算を実施した取引が締めの対象となります。※キャッシュドロアを設定した店舗で締め処理を実施したい場合は管理画面から実施してください。 |
出庫承認ステータスを更新します。未承認となっている出庫情報/出庫依頼情報に対し、出庫を承認/拒否する場合に本APIを実行します。承認済にすると、承認ステータスが承認済、ステータスが未入庫(出庫済)の状態に更新します。承認拒否にすると、承認ステータスが承認拒否の状態に更新します。
| Name | Type | Required | Description |
| ShippingId | Integer | True | 出庫ID |
| ApprovalStatus | String | True | 承認ステータス:0:未承認、1:承認済、2:承認拒否、3:依頼未承認。3:依頼未承認 → 0:未承認、1:承認済に変更可。0:未承認 → 1:承認済、2:承認拒否に変更可。2:承認拒否 → 0:未承認に変更可 |
| ReceivingExpectedDateFrom | Date | False | 入庫予定日From。出庫情報の承認ステータスが3:依頼未承認時に必須 |
| ReceivingExpectedDateTo | Date | False | 入庫予定日To。出庫情報の承認ステータスが3:依頼未承認時に必須 |
| ShippingDate | Date | False | 出庫日。出庫情報の承認ステータスが3:依頼未承認時に必須 |
| Memo | String | False | メモ |
| Name | Type | Description |
| ShippingId | Integer | 出庫ID |
| ReceivingStoreId | Integer | 入庫店舗ID |
| ShippingStoreId | Integer | 出庫店舗ID |
| ReceivingDesiredDate | Date | 入庫希望日 |
| ReceivingExpectedDateFrom | Date | 入庫予定日From |
| ReceivingExpectedDateTo | Date | 入庫予定日To |
| ShippingDate | Date | 出庫日 |
| StaffId | Integer | スタッフID |
| RequestStaffId | Integer | 出庫依頼スタッフID |
| Memo | String | メモ |
| IdentificationNo | String | 識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。 |
| Status | String | 状態:出庫/入庫の状況を設定。0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了。出庫承認時に1:未入庫に自動更新される |
| ApprovalStatus | String | 承認ステータス:0:未承認、1:承認済、2:承認拒否、3:依頼未承認 3:依頼未承認 → 0:未承認、1:承認済、2:承認拒否に変更可 0:未承認 → 1:承認済、2:承認拒否に変更可 2:承認拒否 → 0:未承認に変更可 |
| ApprovalDateTime | Datetime | 承認日時:出荷承認日時/承認拒否日時 出庫承認時に自動更新される |
| ModificationRequestStatus | String | 修正依頼ステータス:出庫情報の修正依頼ステータスを設定。 0:修正依頼なし、1:修正依頼あり、2:修正完了 |
| ModificationRequestDateTime | Datetime | 修正依頼日時:修正依頼を行った日時を設定。 |
| ModificationRequestCheckedDateTime | Datetime | 修正依頼確認完了日時:修正依頼ステータスが修正完了になった日時を設定。 |
| InsDateTime | Datetime | 作成日時:登録時の日時 |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時 |
出庫の修正依頼を完了します。修正依頼中となっている出庫情報に対し、修正依頼を完了する際に本APIを実行します。修正依頼ステータスが 2:修正完了 に更新され、修正依頼中に行った修正を入庫に反映します。
| Name | Type | Required | Description |
| ShippingId | Integer | True | 出庫ID |
| Name | Type | Description |
| ShippingId | Integer | 出庫ID |
| ApprovalDateTime | Datetime | 承認日時:出庫承認日時/承認拒否日時。 |
| ApprovalStatus | String | 承認ステータス:未設定の場合 0:未承認を設定。0:未承認、1:承認済、2:承認拒否、3:依頼未承認 |
| IdentificationNo | String | 識別番号:出庫/入庫情報を管理するための任意の文字列を設定出来る項目。 |
| InsDateTime | Datetime | 作成日時:登録時の日時。 |
| Memo | String | 入庫/出庫メモ |
| ModificationRequestCheckedDateTime | Datetime | 修正依頼確認完了日時:修正依頼ステータスが修正完了になった日時を設定。 |
| ModificationRequestDateTime | Datetime | 修正依頼日時:修正依頼を行った日時を設定。 |
| ModificationRequestStatus | String | 修正依頼ステータス:出庫情報の修正依頼ステータスを設定。0:修正依頼なし、1:修正依頼あり、2:修正完了 |
| ReceivingDesiredDate | Date | 入庫希望日 |
| ReceivingExpectedDateFrom | Date | 入庫予定日From |
| ReceivingExpectedDateTo | Date | 入庫予定日To |
| ReceivingStoreId | Integer | 入庫店舗ID |
| RequestStaffId | Integer | 出庫依頼スタッフID:出庫依頼登録時のスタッフID |
| ShippingDate | Date | 出庫日 |
| ShippingStoreId | Integer | 出庫店舗ID |
| StaffId | Integer | スタッフID:出庫登録時のスタッフID |
| Status | String | 状態:出庫/入庫の状況を設定。0:未出庫、1:未入庫、2:入庫検品中、3:入庫完了 |
| UpdDateTime | Datetime | 更新日時:登録時・更新時の日時。 |
| Details | String | 出庫明細 |
商品アイコン画像を削除します。
| Name | Type | Required | Description |
| ProductId | Long | True | 商品ID ※ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。 |
商品画像を削除します。
| Name | Type | Required | Description |
| ProductId | Long | True | 商品ID ※ユーザーアクセストークンを利用する場合、ユーザーの所属する店舗で販売している商品IDを指定してください。 |
取引を打消取消します。指定された取引に対して、返品する取引情報を作成します。※外部決済連携を行う支払方法での決済を含む取引を取消しても、外部決済システムへの返金処理は行われません。
| Name | Type | Required | Description |
| TransactionHeadId | Integer | True | 取引ID |
| TerminalTranDateTime | Datetime | False | 端末で設定された取引日時。未設定の場合、自動で設定されます。 |
| DipositOthers | String | False | 個別アプリ専用支払方法IDを指定した取引を打消取消する際に、取消伝票番号を設定するのに利用します。キャンセル伝票は消込レコードに記録されます※現状は最大1つしか指定できません |
| Name | Type | Description |
| TransactionHeadId | Integer | 取引ID |
| TransactionDateTime | Datetime | 取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照。[YYYY-MM-DDThh:mm:ssTZD] |
| TransactionHeadDivision | String | 取引を識別する区分。(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証)※ 10:取置きについては、取置き登録APIをご使用ください。 ※ 8:ポイント失効、9:回数券、11:チップ、15:バリューカード入金、16:領収証は対応しておりません。 |
| CancelDivision | String | 取引の取消を識別する区分。 (0:通常、1取消) |
| UnitNonDiscountsubtotal | Integer | 取引明細の、値引き前計の合計。明細より自動算出。※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計 |
| UnitDiscountsubtotal | Integer | 単品値引き小計:取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。(例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。)※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。4:バンドル (親)、5:セット売り(親)、6:簡易セット(親)、8:バンドル値引(子) |
| UnitStaffDiscountsubtotal | Integer | 単品社員販売値引き計 |
| UnitBargainDiscountsubtotal | Integer | 単品セール販売値引き計 |
| Subtotal | Integer | 取引明細の値引き後小計の合計。 |
| SubtotalForDiscount | Integer | 取引明細の割引値引対象区分が対象の小計金額 |
| SubtotalDiscountPrice | Integer | 小計の値引き金額を設定。 |
| SubtotalDiscountRate | Integer | 小計の割引を設定 (単位%) デフォルトは未設定。設定された場合、小計値引は必須。※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。 |
| SubtotalDiscountDivision | Integer | 小計値引き/割引時に指定された区分を設定。管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。 |
| PointDiscount | Integer | |
| CouponDiscount | Integer | クーポン値引き:その取引で使用された各クーポンの値引き・割引額の合計値。 |
| Total | Integer | 小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定 |
| TaxInclude | Integer | 内税商品計 / 110 * 10。※税率が10%の場合 ※小数点以下は税の丸め方式で指定の通り |
| TaxExclude | Integer | 外税商品計 * 10 / 100。※税率が10%の場合 ※小数点以下は税の丸め方式で指定の通り |
| RoundingDivision | String | 販売時の合計金額の端数を丸めるか否かを設定する。00:なし、11:一の位を四捨五入、12:一の位を切捨、13:一の位を切上、21:十の位を四捨五入、22:十の位を切捨、23:十の位を切上31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上41:千の位を四捨五入、42:千の位を切捨、43:千の位を切上、99:手入力 |
| RoundingPrice | Integer | 端数値引額 |
| CashTotal | Integer | 合計金額の内訳 (現金払い) |
| CreditTotal | Integer | 合計金額の内訳 (クレジット払い) |
| Deposit | Integer | 会計時に預かった金額。 |
| DepositCash | Integer | 会計時に預かった現金金額。 |
| DepositCredit | Integer | 会計時に預かったクレジット金額。 |
| Change | Integer | 釣銭。 |
| TipCash | Integer | 現金チップ |
| TipCredit | Integer | クレジットチップ |
| Amount | Integer | 取引明細の返品以外の数量の合計 (取引明細区分が2返品以外の数量) |
| ReturnAmount | Integer | 取引明細の返品の数量の合計 (取引明細区分が2返品の数量) |
| CostTotal | Decimal | 明細の原価計の合計 |
| SalesHeadDivision | String | 売上明細に売上対象外商品を含むか否かの区分。 (0:売上対象のみ、1:売上対象外含む) |
| InTaxSalesTotal | Integer | 売上対象商品の内税販売合計金額。 内税販売の場合は、税込・税抜き商品を対象。 |
| OutTaxSalesTotal | Integer | 売上対象商品の外税販売の税抜き商品合計金額 |
| NonTaxSalesTotal | Integer | 売上対象商品の非課税商品の合計金額。 |
| NonSalesTargetTotal | Integer | 売上対象外商品の合計。 外税販売の場合、税を含まない。 |
| NonSalesTargetInTaxTotal | Integer | 売上対象外商品の外税合計。 |
| NonSalesTargetOutTaxTotal | Integer | 売上対象外商品の内税合計。 |
| NonSalesTargetTaxFreeTotal | Integer | 売上対象外商品の免税額合計。 |
| NonSalesTargetCostTotal | Decimal | 売上対象外商品の原価合計。 |
| NonSalesTargetAmount | Integer | 取引明細の返品以外かつ売上対象外の数量の合計。 (取引明細区分が2返品以外の数量) |
| NonSalesTargetReturnAmount | Integer | 取引明細の返品かつ売上対象外の数量の合計。 (取引明細区分が2返品の数量) |
| NewPoint | Integer | 取引で付与されるポイント。 合計 * ポイント付与率 |
| SpendPoint | Integer | 取引で使用したポイント。 |
| Point | Integer | 取引前のポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 |
| TotalPoint | Integer | 取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 |
| CurrentMile | Integer | 現在マイル。取引前のマイル ※マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 |
| EarnMile | Integer | 獲得マイル。取引で付与されるマイル。合計 * ポイント付与率 ※ 会員販売でない場合、nullが返されます。 |
| TotalMile | Integer | 合計マイル。取引後のマイル。現在マイル + 獲得マイル + 調整マイル ※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 |
| AdjustmentMile | Integer | 調整マイル。取引で手動で付与されるマイル※ 会員販売でない場合、nullが返されます。 |
| AdjustmentMileDivision | String | 調整マイル区分。1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」)3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」※ 会員販売でない場合、nullが返されます。 |
| AdjustmentMileValue | Integer | 調整マイル区分値 ※ 会員販売でない場合、nullが返されます。 |
| StoreId | Integer | 店舗毎に付与するID。※店舗情報が存在しない場合エラー ※休止中の店舗IDを指定するとエラー |
| TerminalId | Integer | 店舗の端末毎に付与するID。※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みに設定する必要あり) |
| CustomerId | Long | 会員毎に付与するID。※設定されている場合、会員販売とみなし会員ポイント情報を更新します。※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。 |
| TerminalTranId | Integer | 端末で設定された取引ID。 |
| TerminalTranDateTime | Datetime | 端末で設定された取引日時 |
| SumDivision | String | 締め処理を実施したかの区分。 (0:未処理、1:精算処理済み、2:締め処理済み) |
| AdjustmentDateTime | Datetime | 精算をした日時が入る |
| SumDate | Date | 締めをした年月日が入る |
| CustomerRank | String | 会員ランク。管理画面の[設定]→[会員設定]→[会員ランク]で設定したコードを設定してください。 |
| CustomerGroupId | Integer | 客層ID。客層セクションIDが1の客層IDを設定。 |
| CustomerGroupId2 | Integer | 客層ID2。客層セクションIDが2の客層IDを設定。 |
| CustomerGroupId3 | Integer | 客層ID3。客層セクションIDが3の客層IDを設定。 |
| CustomerGroupId4 | Integer | 客層ID4。客層セクションIDが4の客層IDを設定。 |
| CustomerGroupId5 | Integer | 客層ID5。客層セクションIDが5の客層IDを設定。 |
| StaffId | Integer | 販売員ID(スタッフID) |
| StaffName | String | スタッフIDがある場合、スタッフマスタのスタッフ名(販売員名)を設定 |
| CreditDivision | String | クレジット区分:クレジット会社を識別する区分 |
| PaymentCount | String | クレジットの支払回数。※ゼウス、ペイメントマイスターご利用時(1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い) |
| SlipNumber | String | クレジットの伝票番号。 |
| CancelSlipNumber | String | クレジットの取消伝票番号。 |
| AuthNumber | String | クレジットの承認番号。 |
| AuthDate | Date | クレジットのセンター処理日。 |
| CardCompany | String | クレジットカード会社 例) VISA、JCB、MASTER、AMEX、DINERSなど |
| Denomination | String | 11:磁気クレジットカード、12:ICクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー ※ペイメント・マイスターで使用 |
| Memo | String | 入出金時のメモなどを設定。 1000文字以内。 |
| ReceiptMemo | String | レシートに印字するメモを設定。100文字以内。 |
| Carriage | Integer | EC連携用送料。 |
| Commission | Integer | EC連携用手数料 |
| GuestNumbers | Integer | 客数 |
| GuestNumbersMale | Integer | 客数(男) |
| GuestNumbersFemale | Integer | 客数(女) |
| GuestNumbersUnknown | Integer | 客数(不明) |
| EnterDateTime | Datetime | 入店日時 |
| TaxFreeSalesDivision | String | 免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算)) ※未設定の場合、0:通常販売 |
| NetTaxFreeGeneralTaxInclude | Integerg | 内税商品の一般品免税額。 |
| NetTaxFreeGeneralTaxExclude | Integerg | 外税商品の一般品免税額。 |
| NetTaxFreeConsumableTaxInclude | Integerg | 内税商品の消耗品免税額。 |
| NetTaxFreeConsumableTaxExclude | Integerg | 外税商品の消耗品免税額。 |
| Tags | String | レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。※複数ある場合は、カンマ区切りで設定 |
| PointGivingDivision | String | 1:税額を含める + 利用ポイント分を含める、2:税額を含めない + 利用ポイント分を含める、3:税額を含める + 利用ポイント分を含めない、4:税額を含めない + 利用ポイント分を含めない ※省略時、店舗マスタから設定。 |
| PointGivingUnitPrice | Integer | ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円)(例10円ごとに2ポイントの場合、10円)※未設定の場合は店舗マスタから設定。 |
| PointGivingUnit | Decimal | ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)(例10円ごとに0.2ポイントの場合、0.2ポイント)※未設定の場合は店舗マスタから設定。 |
| PointSpendDivision | String | ポイント利用時の税を含む/含まないを判定。1:ポイント利用を現金として扱う (税を含む値引き)、2:ポイント利用を値引として扱う (税を含まない値引き) ※未設定の場合は店舗マスタから設定。 初期値:1。 |
| MileageDivision | String | マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)※未設定の場合は店舗マスタから設定。 初期値:0。 |
| MileageLabel | String | マイレージの名称。未設定の場合は「マイル」 |
| CustomerPinCode | String | 自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。 |
| ReturnSales | String | 0:通常、1:返品販売 |
| DisposeDivision | String | 0:通常、1:打消元レコード、2:打消レコード※0:通常と2:打消レコードのみ設定可能(省略時は0:通常を設定)※打消レコードの場合、取引明細区分は、(通常、部門売り)→返品に変換させて設定してください。 |
| DisposeServerTransactionHeadId | Integer | 打消元取引ID ※打消し区分が2の場合必須 ※打消元取引IDが存在しない場合エラー。省略時はnullを設定 |
| CancelDateTime | Datetime | 取消/打消しの場合自動設定。[YYYY-MM-DDThh:mm:ssTZD] |
| SellDivision | String | 取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)※省略時は0:内税販売を設定 |
| TaxRate | Decimal | 税率 (単位%)※省略時は、スマレジに設定されている消費税を設定(端末取引日時より算出) |
| TaxRounding | String | 税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ※省略時はスマレジに設定されている税の丸め方式を設定 |
| DiscountRoundingDivision | String | 割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ※省略時はスマレジに設定されている税の丸め方式を設定 |
| TransactionUuid | String | レシートに印字する番号。※省略時は、1970年から計算した現在秒の末尾9桁+端末IDゼロ詰め4桁 |
| ExchangeTicketNo | String | 引換券番号 |
| GiftReceiptValidDays | Integer | 有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。 |
| UpdDateTime | Datetime | 登録時・更新時の日時。[YYYY-MM-DDThh:mm:ssTZD] |
| Details | String | 取引明細 |
| DepositOthers | String | その他支払取引 |
| Coupons | String | 取引クーポン明細 |
| CouponItems | String | 取引クーポン商品付与明細 |
| RecordedStaff | String | 取引スタッフ |
取置きを打消取消します。指定された取置きに対して、返品する取置き情報を作成します。
| Name | Type | Required | Description |
| TransactionHeadId | Integer | True | 取引ID |
| TerminalTranDateTime | Datetime | False | 端末で設定された取引日時。未設定の場合、自動で設定されます。 |
| Name | Type | Description |
| TransactionHeadId | Integer | 取引ID |
| TransactionDateTime | Datetime | 取引日時。サーバーに送信された日時。販売日時は端末取引日時を参照 |
| TransactionHeadDivision | String | 取引を識別する区分。(1:通常、2:入金、3:出金、4:預かり金、 5:預かり金返金、6:ポイント加算、7:ポイント減算、8:ポイント失効、10:取置き、13:マイル加算、14:マイル減算、15:バリューカード入金、16:領収証)※ 取置き登録APIは、10:取置きのみ対応しています。 |
| CancelDivision | String | 取引の取消を識別する区分。 (0:通常、1取消) |
| UnitNonDiscountsubtotal | Integer | 取引明細の、値引き前計の合計。明細より自動算出。※管理画面の取引履歴CSVで対応する項目: 単価値引き前小計 |
| UnitDiscountsubtotal | Integer | 単品値引き小計:取引明細の単品値引き計の合計と商品バンドル値引按分の合計を合算した値。※ 取引明細区分が2:返品の取引明細のとき、単品値引き計及び商品バンドル値引按分は符号反転して計算されます。(例: ある取引明細の取引明細区分が2、単品値引き計が50円、商品バンドル値引按分が12円の場合、単品値引き計は-50円、商品バンドル値引按分は-12円として計算されます。)※ 以下の商品区分を持つ取引明細については、単品値引き計及び商品バンドル値引按分が0として計算されます。4:バンドル (親)、5:セット売り(親)、6:簡易セット(親)、8:バンドル値引(子) |
| UnitStaffDiscountsubtotal | Integer | 単品社員販売値引き計 |
| UnitBargainDiscountsubtotal | Integer | 単品セール販売値引き計 |
| Subtotal | Integer | 取引明細の値引き後小計の合計。 |
| SubtotalForDiscount | Integer | 取引明細の割引値引対象区分が対象の小計金額 |
| SubtotalDiscountPrice | Integer | 小計の値引き金額を設定。 |
| SubtotalDiscountRate | Integer | 小計の割引を設定 (単位%) デフォルトは未設定。設定された場合、小計値引は必須。※小計値引率から小計値引は計算しないため小計値引に値引額を設定してください。 |
| SubtotalDiscountDivision | String | 小計値引き/割引時に指定された区分を設定。管理画面->設定->販売設定->値引区分/割引区分のページで確認できるID。 |
| PointDiscount | Integer | |
| CouponDiscount | Integer | |
| Total | Integer | 小計 - 小計値引き - ポイント値引き - クーポン値引き + 端数値引額 + 外税額 + 手数料 + 送料 - 免税額 を設定 |
| TaxInclude | Integer | 内税商品計 / 110 * 10。※税率が10%の場合※小数点以下は税の丸め方式で指定の通り |
| TaxExclude | Integer | 外税商品計 * 10 / 100。※税率が10%の場合※小数点以下は税の丸め方式で指定の通り |
| RoundingDivision | String | 販売時の合計金額の端数を丸めるか否かを設定する。00:なし 11:一の位を四捨五入 12:一の位を切捨 13:一の位を切上 21:十の位を四捨五入 22:十の位を切捨 23:十の位を切上 31:百の位を四捨五入 32:百の位を切捨 33:百の位を切上 41:千の位を四捨五入 42:千の位を切捨 43:千の位を切上 99:手入力 |
| RoundingPrice | Integer | 端数値引額 |
| CashTotal | Integer | 合計金額の内訳 (現金払い) |
| CreditTotal | Integer | 合計金額の内訳 (クレジット払い) |
| Deposit | Integer | 会計時に預かった金額。 |
| DepositCash | Integer | 会計時に預かった現金金額。 |
| DepositCredit | Integer | 会計時に預かったクレジット金額。 |
| Change | Integer | 釣銭。 |
| TipCash | Integer | 現金チップ |
| TipCredit | Integer | クレジットチップ |
| Amount | Integer | 取引明細の返品以外の数量の合計 (取引明細区分が2返品以外の数量) |
| ReturnAmount | Integer | 取引明細の返品の数量の合計 (取引明細区分が2返品の数量) |
| CostTotal | Decimal | 明細の原価計の合計 |
| SalesHeadDivision | String | 売上明細に売上対象外商品を含むか否かの区分。 (0:売上対象のみ、1:売上対象外含む) |
| InTaxSalesTotal | Integer | 売上対象商品の内税販売合計金額。 内税販売の場合は、税込・税抜き商品を対象。 |
| OutTaxSalesTotal | Integer | 売上対象商品の外税販売の税抜き商品合計金額 |
| NonTaxSalesTotal | Integer | 売上対象商品の非課税商品の合計金額。 |
| NonSalesTargetTotal | Integer | 売上対象外商品の合計。 外税販売の場合、税を含まない。 |
| NonSalesTargetInTaxTotal | Integer | 売上対象外商品の外税合計。 |
| NonSalesTargetOutTaxTotal | Integer | 売上対象外商品の内税合計。 |
| NonSalesTargetTaxFreeTotal | Integer | 売上対象外商品の免税額合計。 |
| NonSalesTargetCostTotal | Decimal | 売上対象外商品の原価合計。 |
| NonSalesTargetAmount | Integer | 取引明細の返品以外かつ売上対象外の数量の合計。 (取引明細区分が2返品以外の数量) |
| NonSalesTargetReturnAmount | Integer | 取引明細の返品かつ売上対象外の数量の合計。 (取引明細区分が2返品の数量) |
| NewPoint | Integer | 取引で付与されるポイント。 合計 * ポイント付与率 |
| SpendPoint | Integer | 取引で使用したポイント。 |
| Point | Integer | 取引前のポイント。※ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます。 |
| TotalPoint | Integer | 取引後のポイント 現在ポイント + 付与ポイント - 使用ポイント。※ ポイント値の直接入力は9桁まで可能です。ただし、ポイントの加算により9桁を超える値が発生することもあり得ます |
| CurrentMile | Integer | 現在マイル。取引前のマイル ※マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 |
| EarnMile | Integer | 獲得マイル。取引で付与されるマイル。合計 * ポイント付与率 ※会員販売でない場合、nullが返されます。 |
| TotalMile | Integer | 合計マイル。取引後のマイル。現在マイル + 獲得マイル + 調整マイル※ マイルの直接入力は9桁まで可能です。ただし、マイルの加算により9桁を超える値が発生することもあり得ます。※ 会員販売でない場合、nullが返されます。 |
| AdjustmentMile | Integer | 調整マイル。取引で手動で付与されるマイル※ 会員販売でない場合、nullが返されます。 |
| AdjustmentMileDivision | String | 調整マイル区分。1:0マイル (マイルを付与しない。「調整マイル = -1 * 獲得マイル」)2:マイル指定(指定したマイルにする。「調整マイル = 入力値 - 獲得マイル」)3:マイル加算(マイルを加算/減算する。「調整マイル =入力値」)4:マイルn倍(指定倍数にする。「調整マイル = 獲得マイル * (n - 1)」※ 会員販売でない場合、nullが返されます。 |
| AdjustmentMileValue | Integer | 調整マイル区分値※ 会員販売でない場合、nullが返されます。 |
| StoreId | Integer | 店舗毎に付与するID。※店舗情報が存在しない場合エラー※休止中の店舗IDを指定するとエラー |
| TerminalId | Integer | 店舗の端末毎に付与するID。※存在しない端末IDも設定可能。(存在しない場合精算できないので、締め済みに設定する必要あり) |
| CustomerId | Long | 会員毎に付与するID。※設定されている場合、会員販売とみなし会員ポイント情報を更新します。※存在しない会員IDの場合、そのまま会員IDは登録されますが、会員ポイント情報等は更新しません。 |
| TerminalTranId | Integer | 端末で設定された取引ID。 |
| TerminalTranDateTime | Datetime | 端末で設定された取引日時 |
| SumDivision | String | 締め処理を実施したかの区分。 (0:未処理、1:精算処理済み、2:締め処理済み) |
| AdjustmentDateTime | Datetime | 精算をしたら日時が入る |
| SumDate | Date | 締めをしたら年月日が入る |
| CustomerRank | String | 会員ランク。管理画面の[設定]→[会員設定]→[会員ランク]で設定したコードを設定してください。 |
| CustomerGroupId | Integer | 客層ID。客層セクションIDが1の客層IDを設定。 |
| CustomerGroupId2 | Integer | 客層ID2。客層セクションIDが2の客層IDを設定。 |
| CustomerGroupId3 | Integer | 客層ID3。客層セクションIDが3の客層IDを設定。 |
| CustomerGroupId4 | Integer | 客層ID4。客層セクションIDが4の客層IDを設定。 |
| CustomerGroupId5 | Integer | 客層ID5。客層セクションIDが5の客層IDを設定。 |
| StaffId | Integer | 販売員ID(スタッフID) |
| StaffName | String | スタッフIDがある場合、スタッフマスタのスタッフ名(販売員名)を設定 |
| CreditDivision | String | クレジット区分:クレジット会社を識別する区分 |
| PaymentCount | String | クレジットの支払回数。※ゼウス、ペイメントマイスターご利用時(1:一括払い、99:リボ払い、100:ボーナス払い、101:ボーナス併用、n:n回払い) |
| SlipNumber | String | クレジットの伝票番号。 |
| CancelSlipNumber | String | クレジットの取消伝票番号。 |
| AuthNumber | String | クレジットの承認番号。 |
| AuthDate | Date | クレジットのセンター処理日。 |
| CardCompany | String | クレジットカード会社 例) VISA、JCB、MASTER、AMEX、DINERSなど |
| Denomination | String | 11:磁気クレジットカード、12:ICクレジットカード、13:銀聯カード、21:デビットカード、41:電子マネー※ペイメントマイスター(J-Mups)で使用 |
| Memo | String | 入出金時のメモなどを設定。 1000文字以内。 |
| ReceiptMemo | String | レシートに印字するメモを設定。100文字以内。 |
| Carriage | Integer | EC連携用送料。 |
| Commission | Integer | EC連携用手数料。 |
| GuestNumbers | Integer | 客数。 |
| GuestNumbersMale | Integer | 客数(男)。 |
| GuestNumbersFemale | Integer | 客数(女)。 |
| GuestNumbersUnknown | Integer | 客数(不明)。 |
| EnterDateTime | Datetime | 入店日時 |
| TaxFreeSalesDivision | String | 免税販売区分 (0:通常販売、1:免税販売(自動計算)、2:免税販売(強制免税適用)、3:免税販売(一般品のみ強制免税適用)、4:免税販売(消耗品のみ強制免税適用)、5:免税販売(自動計算・合算))※未設定の場合、0:通常販売 |
| NetTaxFreeGeneralTaxInclude | Integer | 内税商品の一般品免税額。 |
| NetTaxFreeGeneralTaxExclude | Integer | 外税商品の一般品免税額。 |
| NetTaxFreeConsumableTaxInclude | Integer | 内税商品の消耗品免税額。 |
| NetTaxFreeConsumableTaxExclude | Integer | 外税商品の消耗品免税額。 |
| Tags | String | レジ端末よりクイックコマンドを押下した値を設定。 和名を設定する。※複数ある場合は、カンマ区切りで設定 |
| PointGivingDivision | String | 1:税額を含める + 利用ポイント分を含める、2:税額を含めない + 利用ポイント分を含める、3:税額を含める + 利用ポイント分を含めない、4:税額を含めない + 利用ポイント分を含めない※省略時、店舗マスタから設定。 |
| PointGivingUnitPrice | Integer | ポイント付与の設定 n円をnポイントの「n円」の部分。 (設定範囲1円~99999円)(例10円ごとに2ポイントの場合、10円)※未設定の場合は店舗マスタから設定。 |
| PointGivingUnit | Decimal | ポイント付与の設定 n円をnポイントの「nポイント」の部分 (設定範囲0.00ポイント~99999.99ポイント)(例10円ごとに0.2ポイントの場合、0.2ポイント)※未設定の場合は店舗マスタから設定。 |
| PointSpendDivision | String | ポイント利用時の税を含む/含まないを判定。1:ポイント利用を現金として扱う (税を含む値引き)、2:ポイント利用を値引として扱う (税を含まない値引き)※未設定の場合は店舗マスタから設定。 初期値:1。 |
| MileageDivision | String | マイレージ機能を利用するか否か。 (0: 利用しない 1: 利用する 2: ポイントの代わりに貯める)※未設定の場合は店舗マスタから設定。 初期値:0。 |
| MileageLabel | String | マイレージの名称。未設定の場合は「マイル」 |
| CustomerPinCode | String | 自由な文字列。 PINコードなど会員を識別する任意の文字列を設定してください。 |
| ReturnSales | String | 0:通常、1:返品販売 |
| DisposeDivision | String | 0:通常、1:打消元レコード、2:打消レコード ※0:通常と2:打消レコードのみ設定可能(省略時は0:通常を設定)※打消レコードの場合、取引明細区分は、(通常、部門売り)→返品に変換させて設定してください。 |
| DisposeServerTransactionHeadId | Integer | 打消元取引ID※打消し区分が2の場合必須※打消元取引IDが存在しない場合エラー。省略時はnullを設定 |
| CancelDateTime | Datetime | 取消/打消しの場合自動設定。 |
| SellDivision | String | 取引が外税販売、内税販売かを識別する区分。 (0:内税販売、1:外税販売)※省略時は0:内税販売を設定 |
| TaxRate | Decimal | 税率 (単位%)※省略時は、スマレジに設定されている消費税を設定(端末取引日時より算出) |
| TaxRounding | String | 税の丸めを判定。 0:四捨五入、1:切り捨て、2:切り上げ ※省略時はスマレジに設定されている税の丸め方式を設定 |
| DiscountRoundingDivision | String | 割引の端数を丸める方法を指定する区分。 0:四捨五入、1:切り捨て、2:切り上げ ※省略時はスマレジに設定されている税の丸め方式を設定 |
| TransactionUuid | String | レシートに印字する番号。※省略時は、1970年から計算した現在秒の末尾9桁+端末IDゼロ詰め4桁 |
| ExchangeTicketNo | String | 引換券番号 |
| GiftReceiptValidDays | Integer | 有効日数が経過しても、ギフトレシートの引換ができなくなるわけではありません。 |
| UpdDateTime | Datetime | 登録時・更新時の日時 |
| Details | String | 取引明細 |
| Layaway | String | 取置時の詳細情報 |
精算を実行します。
| Name | Type | Required | Description |
| StoreId | Integer | True | 店舗ID |
| TerminalId | Integer | False | 端末ID。端末IDと端末UUIDのどちらかが必須。 |
| UUId | String | False | 端末UUID。端末IDと端末UUIDのどちらかが必須。 |
| CashAdjustment | String | False | 現金精算を行う際のレジ内の現金状況を保持する。店舗IDで指定された店舗の「端末精算時の現金入力」が「入力する」になっている時のみ設定可能。 |
| Name | Type | Description |
| AdjustmentDateTime | Datetime | 精算日時 |
| StoreId | Integer | 店舗ID |
| TerminalId | Integer | 端末ID |
締め処理を実行します。※本処理は、スマレジ・アプリにおける手動締め処理に相当する処理です。※精算を実施した取引が締めの対象となります。※キャッシュドロアを設定した店舗で締め処理を実施したい場合は管理画面から実施してください。
| Name | Type | Required | Description |
| SumDate | Date | True | 締め日:締め処理を実施する対象日 |
| StoreId | Integer | True | 店舗ID |
| CashInfo | String | False | 現金管理情報:「管理画面 > 日次締め画面 > 現金残高・現金管理」の入力可能項目に対応する値を設定します。 |
| Name | Type | Description |
| SumDate | Date | 締め日 |
| StoreId | Integer | 店舗ID |
| CashDrawerId | Integer | キャッシュドロアID。※ 現在は、キャッシュドロアを設定した店舗にてAPIによる手動締め処理は実施できないため、「未設定」を示す0が既に返ります |
| TerminalIdList | String | 締め処理の対象となる取引を立てた端末IDのリスト |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、Smaregi のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | データベース名。 |
| SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベース。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | テーブル名またはビュー名。 |
| TableType | String | テーブルの種類(テーブルまたはビュー)。 |
| Description | String | テーブルまたはビューの説明。 |
| IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Products テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Products'
| Name | Type | Description |
| CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
| SchemaName | String | テーブルまたはビューを含むスキーマ。 |
| TableName | String | カラムを含むテーブルまたはビューの名前。 |
| ColumnName | String | カラム名。 |
| DataTypeName | String | データ型の名前。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| Length | Int32 | カラムのストレージサイズ。 |
| DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
| NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
| IsNullable | Boolean | カラムがNull を含められるかどうか。 |
| Description | String | カラムの簡単な説明。 |
| Ordinal | Int32 | カラムのシーケンスナンバー。 |
| IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
| IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
| IsHidden | Boolean | カラムが非表示かどうか。 |
| IsArray | Boolean | カラムが配列かどうか。 |
| IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
| IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
| ColumnType | String | スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベース。 |
| SchemaName | String | ストアドプロシージャを含むスキーマ。 |
| ProcedureName | String | ストアドプロシージャの名前。 |
| Description | String | ストアドプロシージャの説明。 |
| ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、SelectEntries ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2
パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
| SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
| ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
| ColumnName | String | ストアドプロシージャパラメータの名前。 |
| Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
| DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
| DataTypeName | String | データ型の名前。 |
| NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
| Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
| NumericScale | Int32 | 数値データの小数点以下の桁数。 |
| IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
| IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
| IsArray | Boolean | パラメータが配列かどうか。 |
| Description | String | パラメータの説明。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| Values | String | このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。 |
| SupportsStreams | Boolean | パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。 |
| IsPath | Boolean | パラメータがスキーマ作成操作のターゲットパスかどうか。 |
| Default | String | 何も値が指定されていない場合に、このパラメータで使用される値。 |
| SpecificName | String | 複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。 |
| IsCDataProvided | Boolean | プロシージャがネイティブのSmaregi プロシージャではなく、CData によって追加 / 実装されているかどうか。 |
| Name | Type | Description |
| IncludeResultColumns | Boolean | 出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。 |
主キーおよび外部キーについて説明します。
次のクエリは、Products テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Products'
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
| IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| 名前 | タイプ | 説明 |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前 |
| PrimaryKeyName | String | 主キーの名前。 |
| ForeignKeyName | String | 外部キーの名前。 |
| ReferencedCatalogName | String | 主キーを含むデータベース。 |
| ReferencedSchemaName | String | 主キーを含むスキーマ。 |
| ReferencedTableName | String | 主キーを含むテーブル。 |
| ReferencedColumnName | String | 主キーのカラム名。 |
| ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | キーを含むデータベースの名前。 |
| SchemaName | String | キーを含むスキーマの名前。 |
| TableName | String | キーを含むテーブルの名前。 |
| ColumnName | String | キーカラムの名前。 |
| KeySeq | String | 主キーのシーケンス番号。 |
| KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | インデックスを含むデータベースの名前。 |
| SchemaName | String | インデックスを含むスキーマの名前。 |
| TableName | String | インデックスを含むテーブルの名前。 |
| IndexName | String | インデックス名。 |
| ColumnName | String | インデックスに関連付けられたカラムの名前。 |
| IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
| IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
| Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
| SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
| OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | 接続プロパティ名。 |
| ShortDescription | String | 簡単な説明。 |
| Type | String | 接続プロパティのデータ型。 |
| Default | String | 明示的に設定されていない場合のデフォルト値。 |
| Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
| Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
| Required | Boolean | プロパティが接続に必要かどうか。 |
| Category | String | 接続プロパティのカテゴリ。 |
| IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
| Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
| PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
| Ordinal | Int32 | パラメータのインデックス。 |
| CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
| Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
| Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
| ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
| 名前 | 説明 | 有効な値 |
| AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
| SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
| SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
| REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
| IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
| SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
| DIALECT | 使用するSQL ダイアレクトを示します。 | |
| KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
| SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
| DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
| SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
| ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
| PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
| MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
| REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
| REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
| REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
| CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
| Name | Type | Description |
| NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
| VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | データ変更処理から返された、データベース生成Id。 |
| Batch | String | バッチの識別子。1 は単一処理。 |
| Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
| Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
利用可能なシステム情報を説明します。
次のクエリは、すべてのカラムを取得します。
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | 製品名。 |
| Version | String | 製品のバージョン番号。 |
| Datasource | String | 製品が接続するデータソースの名前。 |
| NodeId | String | 製品がインストールされているマシンの固有識別子。 |
| HelpURL | String | 製品のヘルプドキュメントのURL。 |
| License | String | 製品のライセンス情報。(この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。) |
| Location | String | 製品のライブラリが格納されているファイルパスの場所。 |
| Environment | String | 製品が現在稼働している環境またはランタイムのバージョン。 |
| DataSyncVersion | String | 本コネクタを使用するために必要なCData Sync のティア。 |
| DataSyncCategory | String | CData Sync 機能のカテゴリ(例:Source、Destination)。 |
| プロパティ | 説明 |
| AuthScheme | The scheme used for authenticating to SharePoint. |
| AccessToken | 現在認証されているユーザーのアクセストークン。 |
| ContractId | 現在認証されているユーザーの契約ID。 |
| UseSandbox | A Boolean value indicating if you are using a Sandbox account. |
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Schema | The type of schema to use. |
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| MaxThreads | 最大スレッド数。 |
| Pagesize | ドライバーが各リクエストに対して取得するイシューの数を指定します。スマレジAPI の最大値は1000 です。 ただし、DailySum テーブルの最大値はexepect です。このテーブルの最大値は 100 です。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| ThrowsKeyNotFound | 更新された行がない場合に例外をスローするかどうかを指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
| プロパティ | 説明 |
| AuthScheme | The scheme used for authenticating to SharePoint. |
| AccessToken | 現在認証されているユーザーのアクセストークン。 |
| ContractId | 現在認証されているユーザーの契約ID。 |
| UseSandbox | A Boolean value indicating if you are using a Sandbox account. |
The scheme used for authenticating to SharePoint.
string
"AccessToken"
The Cloud supports the following authentication mechanisms. See the Getting Started chapter for authentication guides.
現在認証されているユーザーのアクセストークン。
string
""
現在認証されているユーザーのアクセストークン。
現在認証されているユーザーの契約ID。
string
""
現在認証されているユーザーの契約ID。
A Boolean value indicating if you are using a Sandbox account.
bool
false
A Boolean value indicating if you are using a Sandbox account.
このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。
| プロパティ | 説明 |
| OAuthClientId | カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。 |
| OAuthClientSecret | カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ) |
カスタムOAuth アプリケーションに割り当てられたクライアントID(コンシューマーキーとも呼ばれます)を指定します。このID は、認証時にOAuth 認可サーバーにアプリケーションを識別させるために必要です。
string
""
このプロパティは2つのケースで必要となります:
(ドライバーが埋め込みOAuth 資格情報を提供する場合、この値はすでにCloud によって設定されており、手動で入力する必要がないことがあります。)
OAuthClientId は、認証付きの接続を構成する際に、OAuthClientSecret やOAuthSettingsLocation などの他のOAuth 関連プロパティと一緒に使用されるのが一般的です。
OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。 この値は、通常、ID プロバイダーのアプリケーション登録設定で確認できます。 Client ID、Application ID、Consumer Key などとラベル付けされた項目を探してください。
クライアントID は、クライアントシークレットのような機密情報とは見なされませんが、アプリケーションの識別情報の一部であるため、慎重に取り扱う必要があります。公開リポジトリや共有設定ファイルでこの値を露出させないようにしてください。
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
カスタムOAuth アプリケーションに割り当てられたクライアントシークレットを指定します。この機密情報は、OAuth 認可サーバーに対してアプリケーションを認証するために使用されます。(カスタムOAuth アプリケーションのみ)
string
""
このプロパティ(アプリケーションシークレットまたはコンシューマシークレットとも呼ばれます)は、安全なクライアント認証を必要とするすべてのフローでカスタムOAuth アプリケーションを使用する場合に必要です。たとえば、Web ベースのOAuth、サービスベースの接続、証明書ベースの認可フローなどが該当します。 組み込みOAuth アプリケーションを使用する場合は必要ありません。
クライアントシークレットは、OAuth フローのトークン交換ステップで使用されます。このステップでは、ドライバーが認可サーバーにアクセストークンを要求します。 この値が欠落しているか正しくない場合、認証はinvalid_client またはunauthorized_client エラーで失敗します。
OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要がある、主要な接続パラメータの1つです。この値は、OAuth アプリケーションを登録する際にID プロバイダーから取得できます。
Notes:
接続設定時にこのプロパティを使用する方法の詳細については、接続の確立 を参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
| プロパティ | 説明 |
| SSLServerCert | TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。 |
TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。
string
""
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 |
Note:'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
| プロパティ | 説明 |
| Verbosity | ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。 |
ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。
string
"1"
このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。
デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。 より高いVerbosity レベルは主にデバッグを目的としています。 各レベルの詳細については、ログ を参照してください。
LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
| プロパティ | 説明 |
| BrowsableSchemas | レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
| Schema | The type of schema to use. |
レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。 接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。
The type of schema to use.
string
"Smaregi"
The schemas available are Smaregi and PlatformAPI.
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
| プロパティ | 説明 |
| MaxRows | 集計やGROUP BY を含まないクエリで返される最大行数を指定します。 |
| MaxThreads | 最大スレッド数。 |
| Pagesize | ドライバーが各リクエストに対して取得するイシューの数を指定します。スマレジAPI の最大値は1000 です。 ただし、DailySum テーブルの最大値はexepect です。このテーブルの最大値は 100 です。 |
| PseudoColumns | テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。 |
| ThrowsKeyNotFound | 更新された行がない場合に例外をスローするかどうかを指定します。 |
| Timeout | provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。 |
集計やGROUP BY を含まないクエリで返される最大行数を指定します。
int
-1
このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 (クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。)
MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。
このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。
最大スレッド数。
string
"1"
ドライバーが各リクエストに対して取得するイシューの数を指定します。スマレジAPI の最大値は1000 です。 ただし、DailySum テーブルの最大値はexepect です。このテーブルの最大値は 100 です。
string
"1000"
各ページで取得されるIssue エントリの数。
テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
string
""
このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。
個々の擬似カラムを指定するには、以下の形式を使用します。
Table1=Column1;Table1=Column2;Table2=Column3
すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください:
*=*
更新された行がない場合に例外をスローするかどうかを指定します。
bool
false
更新された行がない場合に例外をスローするかどうかを指定します。
provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
int
60
タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。 例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。
タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。
タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。
Note: このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.