The CData Sync App provides a straightforward way to continuously pipeline your Smaregi data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The Smaregi connector can be used from the CData Sync application to pull data from Smaregi and move it to any of the supported destinations.
The Sync App leverages the Smaregi API to enable bidirectional access to Smaregi.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
ContractId and AccessToken parameters are required for Smaregi driver.
After login, go to Configurations -> System linkage -> Smart API setting
ContractId : Contract ID of your account. You can also find it in the Reception setting section.
AccessToken : access token in the Reception setting section.
This section details a selection of advanced features of the Smaregi Sync App.
The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to Smaregi and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Smaregi APIs.
Tables describes the available tables. Table are statically defined to model Products, Customers, Shippings, and more.
Views describes the available views. Views are statically defined to model Stores, ShippingDetails and more. Views may not be modified, but can be used to supplement queries to the tables.
The Sync App models the data in Smaregi as a list of tables in a relational database that can be queried using standard SQL statements.
Name | Description |
BargainProducts | Usage information for the operation BargainProducts.rsd. |
Bargains | Usage information for the operation Bargains.rsd. |
BargainStores | Usage information for the operation BargainStores.rsd. |
Categories | Usage information for the operation Categories.rsd. |
Customers | Usage information for the operation Customers.rsd. |
Losses | Usage information for the operation Losses.rsd. |
ProductInventoryReservations | Usage information for the operation ProductInventoryReservations.rsd. |
ProductPrices | Usage information for the operation ProductPrices.rsd. |
ProductReserveItemLabels | Usage information for the operation ProductReserveItemLabels.rsd. |
ProductReserveItems | Usage information for the operation ProductReserveItems.rsd. |
Products | Usage information for the operation Products.rsd. |
ProductStores | Usage information for the operation ProductStores.rsd. |
Receivings | Usage information for the operation Receivings.rsd. |
Shipments | Usage information for the operation Shipments.rsd. |
Shippings | Usage information for the operation Shippings.rsd. |
Staff | Usage information for the operation Staff.rsd. |
Stocks | Usage information for the operation Stocks.rsd. |
StorageInfo | Usage information for the operation StorageInfo.rsd. |
Storages | Usage information for the operation Storages.rsd. |
Stores | Usage information for the operation Stores.rsd. |
TransactionHeads | Usage information for the operation TransactionHeads.rsd. |
Usage information for the operation BargainProducts.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT BargainId, TargetId FROM BargainProducts SELECT * FROM BargainProducts WHERE BargainId > 3 AND TargetId >= 1004 SELECT * FROM BargainProducts WHERE BargainId > 3 AND TargetId >= 1004 ORDER BY BargainProductId DESC SELECT * FROM BargainProducts WHERE TargetId LIKE '10%' ORDER BY BargainProductId ASC
To add a BargainProduct, specify the BargainId, TargetDivision, TargetId, Division and Value fields.
INSERT INTO BargainProducts (bargainId, targetDivision, targetId, division, value) VALUES (6, 2, 8, 1, 44) INSERT INTO BargainProducts (BargainProductId, bargainId, targetDivision, targetId, division, value) VALUES (7, 6, 2, 6, 1, 43)
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a BargainProduct, specify the BargainId, TargetDivision, TargetId, Division and Value fields.
UPSERT INTO BargainProducts (BargainId, TargetDivision, TargetId, Division, Value) VALUES (6, 2, 1007, 1, 44) UPSERT INTO BargainProducts (BargainProductId, bargainId, targetDivision, targetId, division, value) VALUES (7, 6, 2, 6, 1, 43)
To add/update multiple BargainProducts, specify the BargainId, TargetDivision, TargetId, Division and Value fields.
INSERT INTO BargainProducts#TEMP (bargainId, targetDivision, targetId, division, value) VALUES (6, 2, 2, 1, 44) INSERT INTO BargainProducts#TEMP (bargainId, targetDivision, targetId, division, value) VALUES (7, 2, 2, 1, 44) UPSERT INTO BargainProducts (bargainId, targetDivision, targetId, division, value) SELECT bargainId, targetDivision, targetId, division, value FROM BargainProducts#TEMP
Smaregi allows UPDATEs for the BargainId, TargetDivision, TargetId, Division and Value columns.
UPDATE BargainProducts SET BargainId = 3, TargetDivision = 3, TargetId = 1008, Value = 400, Division = 3 WHERE BargainProductId = 48
BargainProducts can be deleted by providing the BargainProductId.
DELETE FROM BargainProducts WHERE BargainProductId = 2
INSERT INTO BargainProducts#TEMP (BargainProductId) VALUES (3) INSERT INTO BargainProducts#TEMP (BargainProductId) VALUES (4) DELETE FROM BargainProducts WHERE EXISTS SELECT BargainProductId FROM BargainProducts#TEMP
Name | Type | ReadOnly | References | Description |
BargainProductId [KEY] | Long | False | ||
BargainId | Integer | False |
Bargains.BargainId | |
TargetDivision | Integer | False | ||
TargetId | String | False | ||
Division | Integer | False | ||
Value | Decimal | False |
Usage information for the operation Bargains.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime data type columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT BargainName, TermStart FROM Bargains SELECT BargainName, TermStart FROM Bargains WHERE BargainName LIKE 'TestBargain%' ORDER BY TermStart
To add a Bargain, specify all fields.
INSERT INTO Bargains (BargainId, BargainName, TermStart, TermEnd) VALUES (91, 'TestBargain91', '2019-06-28', '2019-09-28')
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a Bargain, specify all fields.
UPSERT INTO Bargains (BargainId, BargainName, TermStart, TermEnd) VALUES (8, 'TestBargain9', '2019-06-28', '2019-09-28')
To add/update multiple Bargains, specify all fields.
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
Smaregi allows updates for the BargainName, TermStart and TermEnd columns.
UPDATE Bargains SET BargainName = 'Sample', TermStart = '2019-06-25', TermEnd = '2019-11-25' WHERE BargainId = 8
Bargains can be deleted by providing the 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 | ||
BargainName | String | False | ||
TermStart | Date | False | ||
TermEnd | Date | False |
Usage information for the operation BargainStores.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime data type columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT StoreId FROM BargainStores WHERE BargainStoreId != 22 AND BargainId >= 23
To add a BargainStore, specify the BargainId and StoreId fields.
INSERT INTO BargainStores (BargainId, StoreId) VALUES (1, 1) INSERT INTO BargainStores (BargainStoreId, BargainId, StoreId) VALUES (5, 1, 1)
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a BargainStore, specify the BargainId and StoreId fields.
UPSERT INTO BargainStores (BargainStoreId, BargainId, StoreId) VALUES (4, 2, 1)
To add/update BargainStores, specify the BargainId and StoreId fields.
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
Smaregi allows updates for the BargainId and StoreId columns.
UPDATE BargainStores SET BargainId = 3, StoreId = 3 WHERE BargainStoreId = 4
BargainStores can be deleted by providing the 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 | ||
BargainId | Integer | False |
Bargains.BargainId | |
StoreId | Integer | False |
Usage information for the operation Categories.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime data type columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following query is processed server side:
SELECT CategoryName, CategoryCode FROM Categories ORDER BY CategoryCode
To add a Category, specify the CategoryId, CategoryCode and CategoryName fields.
INSERT INTO Categories (CategoryId, CategoryCode, CategoryName) VALUES (10, 'CategoryCode10', 'CategoryName10')
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a Category, specify the CategoryId, CategoryCode and CategoryName fields.
UPSERT INTO Categories (CategoryId, CategoryCode, CategoryName) VALUES (6, 'CategoryCode', 'CategoryName')
To add/update Categories, specify the CategoryId, CategoryCode and CategoryName fields.
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
Smaregi allows UPDATEs for the CategoryCode, CategoryName, CategoryAbbr, CategoryGroupId, ParentCategoryId, DisplaySequence, DisplayFlag, PointNotApplicable, TaxFreeDivision, Color and Tag columns.
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 can be deleted by providing the 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 | ||
CategoryCode | String | False | ||
CategoryName | String | False | ||
CategoryAbbr | String | False | ||
CategoryGroupId | Integer | False | ||
ParentCategoryId | Integer | False | ||
Level | Integer | True | ||
DisplaySequence | Integer | False | ||
DisplayFlag | Integer | False | ||
PointNotApplicable | Integer | False | ||
TaxFreeDivision | Integer | False | ||
Color | String | False | ||
Tag | String | False | ||
InsDateTime | Datetime | True | ||
UpdDateTime | Datetime | True |
Usage information for the operation Customers.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime data type columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT CustomerCode, CustomerNo FROM Customers WHERE FirstName LIKE 'Na%'
To add a Customer, specify the CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana and Sex fields.
INSERT INTO Customers (CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana, Sex) VALUES (123, 'CustomerCode123', 'Name123', 'Surname123', 'KanaName123', 'KanaSurname123', '2')
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a Customer, specify the CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana and Sex fields.
UPSERT INTO Customers (CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana, Sex) VALUES (216, 'CustomerCode', 'Name', 'Surname', 'KanaName', 'KanaSurname', '2')
To add/update Customers, specify the CustomerId, CustomerCode, FirstName, LastName, FirstKana, LastKana and Sex fields.
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
Smaregi allows updates for all non key columns.
UPDATE Customers SET CustomerCode = 'CustomerCode2', CustomerNo = 3 WHERE CustomerId = 216
Customers can be deleted by providing the 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 | ||
CustomerCode | String | False | ||
CustomerNo | String | False | ||
Rank | String | False | ||
StaffRank | String | False | ||
LastName | String | False | ||
FirstName | String | False | ||
LastKana | String | False | ||
FirstKana | String | False | ||
PostCode | String | False | ||
Address | String | False | ||
PhoneNumber | String | False | ||
FaxNumber | String | False | ||
MobileNumber | String | False | ||
MailAddress | String | False | ||
MailAddress2 | String | False | ||
MailAddress3 | String | False | ||
CompanyName | String | False | ||
DepartmentName | String | False | ||
ManagerialPosition | String | False | ||
Sex | Integer | False | ||
BirthDate | Date | False | ||
Mile | Integer | False | ||
Point | Integer | False | ||
PointExpireDate | Date | False | ||
LastComeDateTime | Datetime | False | ||
EntryDate | Date | False | ||
LeaveDate | Date | False | ||
PointGivingUnitPrice | Integer | False | ||
PointGivingUnit | Decimal | False | ||
PinCode | String | False | ||
PassportNo | String | False | ||
Nationality | String | False | ||
AlphabetName | String | False | ||
MailReceiveFlag | Integer | False | ||
Note | String | False | ||
Note2 | String | False | ||
FavoriteList | String | False | ||
BrowsingList | String | False | ||
Status | Integer | False | ||
StoreId | Integer | False | ||
InsDateTime | Datetime | False | ||
UpdDateTime | Datetime | False |
Usage information for the operation Losses.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT Division FROM Losses ORDER BY LossId DESC SELECT * FROM Losses WHERE LossId != 5
To add a Loss, specify the StoreId, Division, Memo, IdentificationNo, Token, LossDatetime and DetailAggregate fields.
Using temporary tables:
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')
Using aggregates:
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", } ] } ')
Upsert is not supported for this table.
Smaregi allows UPDATEs for the Division, Memo, LossDatetime, IdentificationNo, Token and DetailAggregate columns.
UPDATE Losses SET Memo = 'UpdatedMemo5', Division = '02' WHERE LossId = 1Changes of an UPDATE query for DetailAggregate column, will be reflected in LossDetails view.
Using temp table.
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
Using aggregates
UPDATE Losses set DetailAggregate = ' { "table_name": "LossDetail", "rows": [ { "lossId": "21", "productCode": "2000001000045", "color": "White", "productId": "9", "size": "S", "quantity": "2", } ] } ' WHERE LossId = 21
Losses can be deleted by providing the 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 | ||
StoreId | Integer | True |
Stores.StoreId | |
Division | String | False | ||
Memo | String | False | ||
LossDatetime | Datetime | False | ||
IdentificationNo | String | False | ||
Modified | Datetime | True | ||
Token | String | False |
Identifier. | |
DetailAggregate | String | False |
A JSON aggregate of details associated with the loss. |
Usage information for the operation ProductInventoryReservations.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT ReservationAmount FROM ProductInventoryReservations SELECT * FROM ProductInventoryReservations WHERE ReservationProductId <= 1005;
To add a ProductInventoryReservation, specify all fields.
INSERT INTO ProductInventoryReservations (ProductId, ReservationProductId, ReservationAmount) VALUES (1005, 4, 5)
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a ProductInventoryReservation, specify all fields.
UPSERT INTO ProductInventoryReservations (ProductId, ReservationProductId, ReservationAmount) VALUES (1005, 4, 5)
To add/update ProductInventoryReservations, specify all fields.
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
Smaregi allows updates for the ReservationAmount column.
UPDATE ProductInventoryReservations SET ReservationAmount = 2 WHERE ProductId = 1005 AND ReservationProductId = 15
ProductInventoryReservations can be deleted by providing the ProductId and 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 | |
ReservationProductId [KEY] | Long | False | ||
ReservationAmount | Integer | False |
Usage information for the operation ProductPrices.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM ProductPrices WHERE ProductId = 45345 SELECT ProductId, StoreId, Price FROM ProductPrices
To add a ProductPrice, specify the ProductId, StoreId , PriceDivision, Price and StartDate fields.
INSERT INTO ProductPrices (productId, storeId, priceDivision, price, StartDate) VALUES (864684, '1', 1, 100, '2019-09-30')
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a ProductPrice, specify the ProductId, StoreId, PriceDivision, Price and StartDate fields.
UPSERT INTO ProductPrices (ProductId, StoreId, PriceDivision, Price, StartDate) VALUES (45345, 1, 2, 550, '2019/02/02')
To add/update ProductPrices, specify the ProductId, StoreId, PriceDivision, Price and StartDate fields.
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
Smaregi allows updates for the PriceDivision, StartDate, EndDate and Price columns.
UPDATE ProductPrices SET PriceDivision = 1, EndDate = '2019-12-02', StartDate = '2019/12/02' WHERE ProductId = 45345
ProductPrices can be deleted by providing ProductId and 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 | |
StoreId [KEY] | String | False |
Stores.StoreId | |
PriceDivision [KEY] | Integer | False | ||
StartDate [KEY] | Date | False | ||
EndDate | Date | False | ||
Price | Decimal | False | ||
InsDateTime | Datetime | True | ||
UpdDateTime | Datetime | True |
Usage information for the operation ProductReserveItemLabels.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT Label FROM ProductReserveItemLabels SELECT * FROM ProductReserveItemLabels WHERE No != 2
To add a ProductReserveItemLabel, specify all fields.
INSERT INTO ProductReserveItemLabels (No, Label) VALUES (84, 1)
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a ProductReserveItemLabel, specify both fields.
UPSERT INTO ProductReserveItemLabels (No, Label) VALUES (84, 1)
To add/update ProductReserveItemLabels, specify all fields.
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
Smaregi allows updates for the No, Label column.
UPDATE ProductReserveItemLabels SET Label = 2 WHERE No = 84
ProductReserveItemLabels can be deleted by providing the 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 | ||
Label | String | False |
Usage information for the operation ProductReserveItems.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT Value FROM ProductReserveItems SELECT * FROM ProductReserveItems WHERE No > 5
To add a ProductReserveItem, specify all fields.
INSERT INTO ProductReserveItems (ProductId, No, Value) VALUES (45345, 2, 1)
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a ProductReserveItem, specify all fields.
UPSERT INTO ProductReserveItems (ProductId, No, Value) VALUES (45345, 2, 1)
To add/update ProductReserveItems, specify all fields.
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
Smaregi allows updates for the Value column.
UPDATE ProductReserveItems SET Value = 0 WHERE ProductId = 7 AND No = 2
ProductReserveItems can be deleted by providing the ProductId and 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 | |
No [KEY] | Integer | False | ||
Value | String | False |
Usage information for the operation Products.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
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
To add a Product, specify the ProductId, categoryId, productCode, ProductName, taxDivision, price, cost and taxFreeDivision fields.
INSERT INTO Products (ProductId, categoryId, productCode, ProductName, taxDivision, price, cost, taxFreeDivision) VALUES (68899, 3, 4453452, '58432InsertedProduct', 0, 500, 450, 0)
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a Product, specify the ProductId, categoryId, productCode, ProductName, taxDivision, price, cost and taxFreeDivision fields.
UPSERT INTO Products (ProductId, categoryId, productCode, ProductName, price) VALUES (45346, 3, 44534520, '58432InsertedProduct', 500)
To add/update Products, specify the ProductId, categoryId, productCode, ProductName, taxDivision, price, cost and taxFreeDivision fields.
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
Smaregi allows updates for the COL1 and COL2 columns.
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 can be deleted by providing the 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 | ||
CategoryId | Integer | False |
Categories.CategoryId | |
ProductCode | String | False | ||
ProductName | String | False | ||
ProductKana | String | False | ||
TaxDivision | String | False | ||
ProductPriceDivision | String | False | ||
Price | Decimal | False | ||
CustomerPrice | Decimal | False | ||
Cost | Decimal | False | ||
Attribute | String | False | ||
Description | String | False | ||
CatchCopy | String | False | ||
Size | String | False | ||
Color | String | False | ||
Tag | String | False | ||
GroupCode | String | False | ||
Url | String | False | ||
PrintReceiptProductName | String | False | ||
DisplaySequence | Integer | False | ||
SalesDivision | String | False | ||
StockControlDivision | String | False | ||
DisplayFlag | String | False | ||
Division | String | False | ||
ProductOptionGroupId | Integer | False | ||
PointNotApplicable | String | False | ||
TaxFreeDivision | String | False | ||
CalcDiscount | String | False | ||
SupplierProductNo | String | False | ||
StaffDiscountRate | Integer | False | ||
UseCategoryReduceTax | Integer | False | ||
ReduceTaxId | Integer | False | ||
ReduceTaxPrice | Decimal | False | ||
ReduceTaxCustomerPrice | Decimal | False | ||
AppStartDateTime | Datetime | False | ||
InsDateTime | Datetime | False | ||
UpdDateTime | Datetime | False |
Usage information for the operation ProductStores.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM ProductStores WHERE AssignDivision > 0
To add a ProductStore, specify all fields.
INSERT INTO ProductStores (ProductId, StoreId, AssignDivision) VALUES (45345, 1, 1)
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a ProductStore, specify all fields.
UPSERT INTO ProductStores (ProductId, StoreId, AssignDivision) VALUES (45345, 1, 1)
To add/update ProductStores, specify all fields.
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
Smaregi allows UPDATEs for the AssignDivision column.
UPDATE ProductStores SET AssignDivision = 0 WHERE ProductId = 84 AND StoreId = 2
Delete is not supported for this table.
Name | Type | ReadOnly | References | Description |
ProductId [KEY] | Long | False |
Products.ProductId | |
StoreId [KEY] | Integer | False |
Stores.StoreId | |
AssignDivision | Integer | False |
Usage information for the operation Receivings.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM Receivings WHERE ReceivingId = 3 SELECT ReceivingId, ShippingStoreId, Memo FROM Receivings ORDER BY ReceivingId
Insert is not supported for this table.
Upsert is not supported for this table.
Smaregi allows updates for the ShippingId, ShippingStoreId, ReceivingStoreId, ReceivingDate, Memo, Status, IdentificationNo, Token and DetailAggregate columns.
UPDATE Receivings SET Memo = 'ChangedMemo' WHERE ReceivingId = 1Changes of an update query for DetailAggregate column, will be reflected in ReceivingDetails view.
Using temp table.
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
Using aggregates
UPDATE Receivings SET DetailAggregate = '{ "table_name": "ReceivingDetail", "rows": [ { "receivingId": "14", "productId": "17", "inspectionQuantity": "33", } ] } ' WHERE ReceivingId = 14
Delete is not supported for this table.
Name | Type | ReadOnly | References | Description |
ReceivingId [KEY] | Integer | False | ||
ShippingId | Integer | False |
Shippings.ShippingId | |
ShippingStoreId | Integer | False | ||
ReceivingStoreId | Integer | False | ||
ReceivingDate | Date | False | ||
Memo | String | False | ||
Status | Integer | False | ||
IdentificationNo | String | False | ||
Modified | Datetime | True | ||
Token | String | False | ||
DetailAggregate | String | False |
A JSON aggregate of details associated with the receiving. |
Usage information for the operation Shipments.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM Shipments WHERE ShipmentId = 5 SELECT RecipientId, RecipientName FROM Shipments
To add a Shipment, specify the ShipmentStoreId, RecipientType, RecipientName, ShipmentDivision, ShipmentDate, Status AND DetailAggregate fields.
Using temporary tables:
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')
Using aggregates:
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" } ] } ')
Upsert is not supported for this table.
Smaregi allows updates for the RecipientType RecipientId RecipientName ShipmentDivision ShipmentDate Status IdentificationNo Token and DetailAggregate columns.
UPDATE Shipments SET IdentificationNo = '333543' WHERE ShipmentId = 5Changes of an update query for DetailAggregate column, will be reflected in ShipmentDetails view.
Using temp table.
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
Using aggregates
UPDATE Shipments SET DetailAggregate = ' { "table_name": "ShipmentDetail", "rows": [ { "shipmentId": "9", "productId": "7", "quantity": "1" } ] } ' WHERE ShipmentId = 21
Shipments can be deleted by providing the 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 | ||
ShipmentStoreId | Integer | False | ||
RecipientType | Integer | False | ||
RecipientId | Integer | False | ||
RecipientName | String | False | ||
ShipmentDivision | String | False | ||
ShipmentDate | Date | False | ||
Memo | String | False | ||
Status | Integer | False | ||
ApprovalStatus | Integer | False | ||
ApprovalDateTime | Datetime | True | ||
IdentificationNo | String | False | ||
Modified | Datetime | True | ||
Token | String | False | ||
DetailAggregate | String | False |
A JSON aggregate of details associated with the shipment. |
Usage information for the operation Shippings.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM Shippings WHERE Status != 0 SELECT ShippingId, ShippingStoreId, StorageStoreId FROM Shippings WHERE ShippingId <= 4
To add a Shipping, specify the StorageStoreId, ShippingStoreId, Status, ShippingDate, StorageDesiredDate and DetailAggregate fields.
Using temporary tables:
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')
Using aggregates:
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" } ] }')
Upsert is not supported for this table.
Smaregi allows updates for the ShippingStoreId StorageStoreId StorageExpectedDateFrom StorageExpectedDateTo ShippingDate StorageDesiredDate Memo Status ModificationRequestStatus ModificationRequestDateTime ModificationRequestCheckedDateTime IdentificationNo Token and DetailAggregate columns.
UPDATE Shippings SET Memo = 'UpdatedMemo', status = 1, storageExpectedDateFrom = '2019/02/02', modificationRequestStatus = 1, storageExpectedDateTo = '2019/02/02' WHERE ShippingId = 9
Shippings can be deleted by providing the 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 | ||
ShippingStoreId | Integer | False | ||
ReceivingStoreId | Integer | False | ||
ReceivingExpectedDateFrom | Date | False | ||
ReceivingExpectedDateTo | Date | False | ||
ShippingDate | Date | False | ||
ReceivingDesiredDate | Date | False | ||
Memo | String | False | ||
Status | Integer | False | ||
ApprovalStatus | Integer | False | ||
ApprovalDateTime | Datetime | True | ||
ModificationRequestStatus | Integer | False | ||
ModificationRequestDateTime | Datetime | False | ||
ModificationRequestCheckedDateTime | Datetime | False | ||
IdentificationNo | String | False | ||
Modified | Datetime | True | ||
Token | String | False | ||
DetailAggregate | String | False |
A JSON aggregate of details associated with the shipping. |
Usage information for the operation Staff.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM Staff WHERE StaffId = 2 SELECT * FROM Staff WHERE StaffName LIKE '%S%' AND StaffId > 3 ORDER BY StaffId DESC
To add a Staff, specify the StaffId, StaffCode, StaffName, StaffKana, Rank, Pincode, DisplayFlag, DisplaySequence, MailAddress, LoginIpAddress, RoleId and StoresAggregate fields.
Using temporary tables:
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')
Using aggregates:
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: If records already exist, insert will not be successful and driver will return 0 affected rows.
To add/update a Staff, specify the StaffId, StaffCode, StaffName, StaffKana, Rank, Pincode, DisplayFlag, DisplaySequence, MailAddress, LoginIpAddress. RoleId and StoresAggregate fields.
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')
Smaregi allows updates for the StaffCode, StaffName, StaffKana, Rank, Pincode, DisplayFlag, DisplaySequence, MailAddress, LoginIpAddress, RoleId and StoresAggregate fields.
UPDATE Staff SET StaffCode = '2', StaffName = '2343', StaffKana = 'Kana' WHERE StaffId = '1'
Staff can be deleted by providing the StaffId.
DELETE FROM Staff WHERE StaffId = 1
Name | Type | ReadOnly | References | Description |
StaffId [KEY] | Integer | False | ||
StaffCode | String | False | ||
StaffName | String | False | ||
StaffKana | String | False | ||
Rank | String | False | ||
Pincode | String | False | ||
DisplayFlag | Integer | False | ||
DisplaySequence | Integer | False | ||
MailAddress | String | False | ||
LoginIpAddress | String | False | ||
RoleId | Integer | False | ||
StoresAggregate | String | False |
A JSON aggregate of details associated with the staff. |
Usage information for the operation Stocks.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
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
To add a Stock, specify the ProductId, StoreId, StockDivision and StockAmount fields.
INSERT INTO Stocks (ProductId, StoreId, StockDivision, StockAmount) VALUES (45, 1, 05, 1)
To add/update a Stock, specify the ProductId, StoreId, StockDivision and StockAmount fields.
UPSERT INTO Stocks (ProductId, StoreId, StockDivision, StockAmount) VALUES (45, 1, 05, 1)
Using temporary tables:
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
Smaregi allows updates for the StockAmount and StockDivision columns.
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
Delete is not supported for this table.
Name | Type | ReadOnly | References | Description |
ProductId [KEY] | Long | False |
Products.ProductId | |
StoreId [KEY] | Integer | False |
Stores.StoreId | |
StockAmount | Integer | False | ||
UpdDatetime | Datetime | True | ||
StockDivision | String | False | ||
Memo | String | False |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
AmountType | String |
If you want to update the stockAmount with an absolute value use 'Absolute' and if you want to add or subtract some value from stockAmount use 'Relative' The allowed values are Absolute, Relative. The default value is Absolute. |
Usage information for the operation StorageInfo.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM StorageInfo WHERE StorageInfoId = 8 SELECT OrderedDate FROM StorageInfo WHERE Status = 2
To add a StorageInfo, specify the Status, IdentificationNo, DeliveryAggregate and DeliveryProductAggregate fields.
Using temporary tables:
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')
Using aggregates:
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: If records already exist, insert will not be successful and driver will return 0 affected rows.
Upsert is not supported for this table.
Smaregi allows updates for the RecipientOrderId, OrderedDate, Status and IdentificationNo columns.
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 can be deleted by providing the 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 | ||
RecipientOrderId | Integer | False | ||
OrderedDate | Date | False | ||
Status | Integer | False | ||
Memo | String | False | ||
IdentificationNo | String | False | ||
Modified | Datetime | True | ||
Token | String | False | ||
DeliveryAggregate | String | False |
A JSON aggregate of deliveries associated with the storage info. | |
ProductAggregate | String | False |
A JSON aggregate of products associated with the storage info product. | |
DeliveryProductAggregate | String | False |
A JSON aggregate of products associated with the storage info delivery. |
Usage information for the operation Storages.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM Storages WHERE StorageId = 3 SELECT StorageInfoId, SupplierId, StorageStoreId, StorageExpectedDateFrom FROM Storages WHERE StorageId = 3
To add a Storage, specify the SupplierId, StorageStoreId and DetailAggregate fields.
Using temporary tables:
INSERT INTO StorageDetails#TEMP (productId, inspectionQuantity) VALUES (1, 4) INSERT INTO Storages (SupplierId, StorageStoreId, DetailAggregate) VALUES (1, 1, 'StorageDetails#TEMP')
Using aggregates:
INSERT INTO Storages (StorageId, StorageInfoId, SupplierId, StorageStoreId, Memo, DetailAggregate) VALUES (21, 2, 1, 1, 'chand2233445', ' { "table_name": "StorageDetail", "rows": [ { "productId": "5", "inspectionQuantity": "3" } ] } ')
NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.
Upsert is not supported for this table.
Smaregi allows updates for the StorageInfoId, SupplierId, StorageStoreId, StorageExpectedDateFrom, StorageExpectedDateTo, StorageDate, Memo, Status, IdentificationNo, Token and DetailAggregate columns.
UPDATE Storages SET Memo = 'updated2' WHERE StorageId = 18
Delete is not supported for this table.
Name | Type | ReadOnly | References | Description |
StorageId [KEY] | Integer | False | ||
StorageInfoId | Integer | False |
StorageInfo.StorageInfoId | |
SupplierId | Integer | False | ||
StorageStoreId | Integer | False | ||
StorageExpectedDateFrom | Date | False | ||
StorageExpectedDateTo | Date | False | ||
StorageDate | Date | False | ||
Memo | String | False | ||
Status | Integer | False | ||
IdentificationNo | String | False | ||
Modified | Datetime | True | ||
Token | String | False | ||
DetailAggregate | String | False |
A JSON aggregate of details associated with the storage. |
Usage information for the operation Stores.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
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 |
Store Id. | |
StoreCode | String | False |
Store Code. | |
StoreName | String | False |
Store Name. | |
StoreAbbr | String | False |
Store name abbreviation. | |
Division | Integer | False |
Store classification, 1=Normal Store, 2=Warehouse. Its default value is 1. It cannot be changed after registeration. | |
PostCode | String | False |
Store zip code with hyphen. | |
Address | String | False |
Store address. | |
PhoneNumber | String | False |
Store phone number with hyphen. | |
FaxNumber | String | False |
Store fax number. | |
MailAddress | String | False |
Store email address. | |
Homepage | String | False |
Store homepage. | |
TempTranMailAddress | String | False |
Email address to be sent when registering a temporary transaction. Multiple specifications can be specified separated by commas. | |
PriceChangeFlag | Integer | False |
To prevent the selling price from being changed on the iPod or iPad, set 0:Cannot be changed, set 1: can be changed. Its default value is 1. | |
SellDivision | Integer | False |
Sales category, 0:Tax-included sales, 1:Tax-excluded sales. Its default value is 1. | |
SumProcDivision | Integer | False |
Distinguishable by means of association, 0:Manual tightening process, 1:Automatic tightening process. Its default value is 0. | |
SumDateChangeTime | String | False |
Date change time. Used during tightening[HHMM]. Tightening method classification is 1: Required for automatic tightening. | |
SumRefColumn | String | False |
The time to refer to when performing the tightening process. Used during closing process(0:terminal time, 1:server time). Tightening method classification is 1: Required for automatic closing process. Its default value is 0. | |
PointNotApplicable | Integer | False |
Point target classification. 0 means Add points and 1 means Do not add points. Its default value is 0. | |
TaxFreeDivision | Integer | False |
Tax free distinction. 0 means not applicable, 1 means General products and 2 means Consumables. Its default value is 0. | |
MaxBundleProductCount | Integer | False |
Maximum number of simple bundle product registrations. Set the maximum number of registered products on the simple bundle sales screen. Its Default value is from 9 upto 999. Its default value is 9. | |
RoundingDivision | String | False |
Fractional value subtraction classification. Set whether to round the total amount at the time of sale. 00:None, 11: Round off the ones place, 12: Round off the ones place, 13: Round up the ones place, 21: Round off the tens place , 22: Round the tens place, 23: Round the tens place, 31: Round the hundreds place, 32: Round the hundreds place, 33: Round the hundreds place, 41: Round the thousands place , 42: Round off the thousand's place, 43: Round up the thousand's place, 99: Manually entered. Its default value is 00. | |
DiscountRoundingDivision | String | False |
Discount Rounding Category. 0 means rounding, 1 means rounding down, 2 means rounding up and 3 means bank rounding. Its default value is 0. | |
PauseFlag | Boolean | True |
Pause flag (0:normal, 1:pause). | |
PointUseDivision | Integer | True |
Point usage classification. Determine whether to use the point function(0:not used and 1: used). Its default value is 1. | |
InsDateTime | Datetime | True |
Creation date and time: Date and time at the time of registration. [YYYY-MM-DDThh: mm: ssTZD]. | |
UpdDateTime | Datetime | True |
Update date and time: Date and time of registration / update. [YYYY-MM-DDThh: mm: ssTZD]. |
Usage information for the operation TransactionHeads.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side. Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side. For example, the following queries are processed server side:
NOTE: One or more of the following filtering conditions are required in the request. The default filtering condition is set to UpdDateTime for the last 30 days.
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'
To add a Storage, specify the SupplierId, StorageStoreId and DetailAggregate fields.
Using temporary tables:
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')
Using aggregates:
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: If records already exist, insert will not be successful and driver will return 0 affected rows.
Upsert is not supported for this table.
UPDATE is not supported for this table.
Delete is not supported for this table.
Name | Type | ReadOnly | References | Description |
TransactionHeadId | Long | True | ||
TransactionDateTime | Datetime | True | ||
TransactionHeadDivision | String | False | ||
CancelDivision | Integer | False | ||
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 | ||
TaxInclude | Decimal | False | ||
RoundingDivision | String | True | ||
RoundingPrice | Decimal | True | ||
CashTotal | Decimal | True | ||
CreditTotal | Decimal | True | ||
Deposit | Decimal | False | ||
DepositCash | Decimal | False | ||
DepositCredit | Decimal | False | ||
Charge | Decimal | False | ||
ChangeDifference | Decimal | True | ||
Amount | Integer | True | ||
ReturnAmount | Integer | True | ||
CostTotal | Decimal | True | ||
SalesHeadDivision | Integer | True | ||
InTaxSalesTotal | Decimal | True | ||
OutTaxSalesTotal | Decimal | True | ||
NonTaxSalesTotal | Decimal | True | ||
NonSalesTargetTotal | Decimal | True | ||
NonSalesTargetOutTaxTotal | Decimal | True | ||
NonSalesTargetInTaxTotal | Decimal | True | ||
NonSalesTargetTaxFreeTotal | Decimal | True | ||
NonSalesTargetCostTotal | Decimal | True | ||
NonSalesTargetAmount | Integer | True | ||
NonSalesTargetReturnAmount | Integer | True | ||
NewPoint | Decimal | False | ||
SpendPoint | Decimal | False | ||
Point | Decimal | False | ||
TotalPoint | Decimal | False | ||
CurrentMile | Decimal | False | ||
EarnMile | Decimal | False | ||
TotalMile | Decimal | False | ||
AdjustmentMile | Decimal | False | ||
AdjustmentMileDivision | Integer | False | ||
AdjustmentMileValue | Integer | False | ||
StoreId [KEY] | Integer | False | ||
StoreCode | String | True | ||
TerminalId [KEY] | Integer | False | ||
CustomerId | Long | False | ||
CustomerCode | String | True | ||
TerminalTranId [KEY] | String | False | ||
TerminalTranDateTime [KEY] | Datetime | False | ||
SumDivision | Integer | False | ||
AdjustmentDateTime | Datetime | True | ||
SumDateTime | Datetime | False | ||
CustomerRank | String | False | ||
CustomerGroupId | Integer | False | ||
CustomerGroupId2 | Integer | False | ||
CustomerGroupId3 | Integer | False | ||
CustomerGroupId4 | Integer | False | ||
CustomerGroupId5 | Integer | False | ||
StaffId | Integer | False | ||
StaffName | String | True | ||
StaffCode | String | True | ||
PaymentCount | String | True | ||
SlipNumber | String | True | ||
CancelSlipNumber | String | True | ||
AuthNumber | String | True | ||
AuthDate | String | True | ||
CardCompany | String | True | ||
Memo | String | False | ||
ReceiptMemo | String | False | ||
PaymentMethodId1 | Integer | False | ||
PaymentMethodName1 | String | True | ||
DepositOthers1 | Decimal | False | ||
PaymentMethodId2 | Integer | False | ||
PaymentMethodName2 | String | True | ||
DepositOthers2 | Decimal | False | ||
PaymentMethodId3 | Integer | False | ||
PaymentMethodName3 | String | True | ||
DepositOthers3 | Decimal | False | ||
Carriage | Decimal | False | ||
Commission | Decimal | False | ||
GuestNumbers | Integer | False | ||
TaxFreeSalesDivision | Integer | False | ||
NetTaxFreeGeneralTaxInclude | Decimal | False | ||
NetTaxFreeGeneralTaxExclude | Decimal | False | ||
NetTaxFreeConsumableTaxInclude | Decimal | False | ||
NetTaxFreeConsumableTaxExclude | Decimal | False | ||
Tags | String | False | ||
PointGivingDivision | Integer | False | ||
PointGivingUnitPrice | Integer | False | ||
PointGivingUnit | Decimal | False | ||
PointSpendDivision | Integer | False | ||
MileageDivision | Integer | False | ||
MileageLabel | String | False | ||
CustomerPinCode | String | False | ||
DisposeDivision | Integer | False | ||
DisposeServerTransactionHeadId | Long | False | ||
CancelDateTime | Datetime | True | ||
SellDivision | Integer | False | ||
TaxRate | Decimal | False | ||
TaxRounding | Integer | False | ||
DiscountRoundingDivision | Integer | True | ||
TransactionUuid | String | False | ||
GiftReceiptValidDays | Integer | False | ||
ReceiptIssueNumberOfTimes | Integer | True | ||
PickUpDate | Date | False | ||
PartPayment | Decimal | False | ||
PartPaymentClass | Integer | True | ||
LayawayServerTransactionHeadId | Long | False | ||
DisabledEdit | Integer | False | ||
UpdDateTime | Datetime | True | ||
PickupTransactionHeadId | Long | True | ||
DetailAggregate | String | False |
A JSON aggregate of details associated with the transaction head. | |
CouponDiscount | Decimal | False |
The total discount amount of each coupon used in the transaction |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
DailySums | Usage information for the operation DailySums.rsd. |
DailySumsSalesList | Usage information for the operation DailySumsSalesList.rsd. |
LossDetails | Usage information for the operation LossDetails.rsd. |
ReceivingDetails | Usage information for the operation ReceivingDetails.rsd. |
ShipmentDetails | Usage information for the operation ShipmentDetails.rsd. |
ShippingDetails | Usage information for the operation ShippingDetails.rsd. |
StaffStores | Usage information for the operation StaffStores.rsd. |
StockHistories | Usage information for the operation StockHistories.rsd. |
StocktakingDetails | Usage information for the operation StocktakingDetails.rsd. |
StocktakingHeads | Usage information for the operation StocktakingHeads.rsd. |
StocktakingInfo | Usage information for the operation StocktakingInfo.rsd. |
StocktakingStockDetails | Usage information for the operation StocktakingStockDetails.rsd. |
StorageDetails | Usage information for the operation StorageDetails.rsd. |
StorageInfoDeliveries | Usage information for the operation StorageInfoDeliveries.rsd. |
StorageInfoDeliveryProducts | Usage information for the operation StorageInfoDeliveryProducts.rsd. |
StorageInfoProducts | Usage information for the operation StorageInfoProducts.rsd. |
TransactionCoupons | Usage information for the operation TransactionCoupons.rsd. |
TransactionDepositOthers | Usage information for the operation TransactionDepositOthers.rsd. |
TransactionDetails | Usage information for the operation TransactionDetails.rsd. |
Usage information for the operation DailySums.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime data type columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM [DailySums] WHERE SumDate = '2019-08-02' SELECT * FROM [DailySums] WHERE TenThousandYen >= 0
Name | Type | References | Description |
SumDate [KEY] | Date | ||
StoreId [KEY] | Integer |
Stores.StoreId | |
CashDrawerId [KEY] | Integer | ||
Status | Integer | ||
SalesTotal | Decimal | ||
Discount | Decimal | ||
PointDiscount | Decimal | ||
TaxExcludeReceive | Decimal | ||
NonSalesTargetTotal | Decimal | ||
Total | Decimal | ||
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 | ||
ReturnDeposit | Decimal | ||
Receipt | Decimal | ||
Payment | Decimal | ||
NonSalesCashTotal | Decimal | ||
NonSalesCreditTotal | Decimal | ||
NonSalesOtherTotal | Decimal | ||
NonSalesTaxFreeTotal | Decimal | ||
ChangeDifference | Decimal | ||
CalculateBalance | Decimal | ||
RealBalance | Decimal | ||
Difference | Decimal | ||
Saving | Decimal | ||
CarryOver | Decimal | ||
TenThousandYen | Integer | ||
FiveThousandYen | Integer | ||
TwoThousandYen | Integer | ||
OneThousandYen | Integer | ||
FiveHundredYen | Integer | ||
OneHundredYen | Integer | ||
FiftyYen | Integer | ||
TenYen | Integer | ||
FiveYen | Integer | ||
OneYen | Integer | ||
Comment | String | ||
InsDateTime | Datetime | ||
UpdDateTime | Datetime | ||
SalesTotalNonSalesTargetDivision | String | ||
TotalTaxFreeDivision | String |
Usage information for the operation DailySumsSalesList.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions built with the following column and operator.
SELECT * FROM [DailySumsSalesList] WHERE StoreId = '1234'
Name | Type | References | Description |
SumDate [KEY] | Date | ||
StoreId [KEY] | Integer |
Stores.StoreId | |
CashDrawerId [KEY] | Integer | ||
Id [KEY] | Integer | ||
Name | String | ||
PaymentMethodDivision | String | ||
PaymentMethodDivisionName | String | ||
Sales | Decimal | ||
InsDateTime | Datetime | ||
UpdDateTime | Datetime |
Usage information for the operation LossDetails.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT LossId, ProductCode FROM LossDetails WHERE LossId >= 5 SELECT * FROM LossDetails WHERE LossId <= 5
Name | Type | References | Description |
LossId [KEY] | Integer |
Losses.LossId | |
ProductId [KEY] | Long |
Products.ProductId | |
ProductCode | String | ||
ProductName | String | ||
Size | String | ||
Color | String | ||
GroupCode | String | ||
SupplierProductNo | String | ||
Quantity | Integer | ||
Modified | Datetime |
Usage information for the operation ReceivingDetails.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM ReceivingDetails WHERE ReceivingId = 9 SELECT ProductId, ProductCode FROM ReceivingDetails WHERE ReceivingId != 5
Name | Type | References | Description |
ReceivingId [KEY] | Integer |
Receivings.ReceivingId | |
ProductId [KEY] | Long |
Products.ProductId | |
ProductCode | String | ||
ProductName | String | ||
Size | String | ||
Color | String | ||
GroupCode | String | ||
SupplierProductNo | String | ||
ScheduledQuantity | Integer | ||
InspectionQuantity | Integer | ||
StockoutQuantity | Integer | ||
StockoutReason | String | ||
InspectionDate | Date | ||
Status | Integer | ||
Modified | Datetime |
Usage information for the operation ShipmentDetails.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM ShipmentDetails WHERE ShipmentId = 5 SELECT ProductId, ProductCode FROM ShipmentDetails WHERE ShipmentId = 5
Name | Type | References | Description |
ShipmentId [KEY] | Integer |
Shipments.ShipmentId | |
ProductId [KEY] | Long |
Products.ProductId | |
ProductCode | String | ||
ProductName | String | ||
Size | String | ||
Color | String | ||
GroupCode | String | ||
SupplierProductNo | String | ||
Cost | Decimal | ||
Quantity | Integer | ||
Memo | String | ||
Modified | Datetime | ||
TaxRate | Decimal |
Usage information for the operation ShippingDetails.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM ShippingDetails WHERE Quantity > 2 SELECT ShippingId, ProductId, ProductCode FROM ShippingDetails
Name | Type | References | Description |
ShippingId [KEY] | Integer |
Shippings.ShippingId | |
ProductId [KEY] | Long |
Products.ProductId | |
ProductCode | String | ||
ProductName | String | ||
Size | String | ||
Color | String | ||
GroupCode | String | ||
SupplierProductNo | String | ||
RequestQuantity | Integer | ||
Quantity | Integer | ||
Modified | Datetime |
Usage information for the operation StaffStores.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
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 | ||
StoreId [KEY] | Integer | ||
ControlDivision | Integer |
Usage information for the operation StockHistories.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side. Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side. For example, the following queries are processed server side:
NOTE: One or more of the following filtering conditions are required in the request. The default filtering condition is set to UpdDateTime for the last 30 days.
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 | ||
UpdDateTime | Datetime | ||
TargetDateTime | Datetime | ||
ProductId | Long | ||
StoreId | Integer | ||
Amount | Integer | ||
StockAmount | Integer | ||
StockDivision | String | ||
FromStoreId | Integer | ||
ToStoreId | Integer |
Usage information for the operation StocktakingDetails.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side. Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side. For example, the following queries are processed server side:
NOTE: One or more of the following filtering conditions are required in the request. The default filtering condition is set to 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 | |
StocktakingHeadId [KEY] | Integer |
StocktakingHeads.StocktakingHeadId | |
ProductId [KEY] | Long |
Products.ProductId | |
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 | ||
InputStocktakingQuantity | Integer | ||
QuantityModifiedDatetime | Datetime |
Usage information for the operation StocktakingHeads.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM StocktakingHeads WHERE DivisionCode != '373838333'
Name | Type | References | Description |
StocktakingInfoId [KEY] | Integer |
StocktakingInfo.StocktakingInfoId | |
StocktakingHeadId [KEY] | Integer | ||
DivisionCode | String | ||
Modified | Datetime |
Usage information for the operation StocktakingInfo.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM StocktakingInfo WHERE StocktakingInfoId != '344'
Name | Type | References | Description |
StocktakingInfoId [KEY] | Integer | ||
StoreId | Integer | ||
DivisionUnit | Boolean | ||
TargetDate | Date | ||
AdjustmentDate | Datetime | ||
StocktakingCompleteDate | Datetime | ||
Status | Integer | ||
Created | Datetime | ||
Modified | Datetime | ||
StockCountDivision | String | ||
StocktakingInputCompleteDate | Datetime | ||
AutoFollowingFlag | Integer | ||
LayawayStockIncludeFlag | Integer |
Usage information for the operation StocktakingStockDetails.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
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 | |
StocktakingHeadId [KEY] | Integer |
StocktakingHeads.StocktakingHeadId | |
ProductId [KEY] | Long |
Products.ProductId | |
ProductCode | String | ||
ProductName | String | ||
Size | String | ||
Color | String | ||
GroupCode | String | ||
SupplierProductNo | String | ||
StockQuantity | Integer | ||
StockMoney | Decimal | ||
TransportationQuantity | Integer | ||
TransportationMoney | Decimal | ||
LayawayQuantity | Integer | ||
LayawayMoney | Decimal | ||
StoreId | Integer | ||
BaseDate | Date |
Usage information for the operation StorageDetails.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
SELECT * FROM StorageDetails WHERE StorageId = 2 SELECT ProductCode, ProductName, GroupCode FROM StorageDetails ORDER BY Size
Name | Type | References | Description |
StorageId [KEY] | Integer |
Storages.StorageId | |
ProductId [KEY] | Long |
Products.ProductId | |
ProductCode | String | ||
ProductName | String | ||
Size | String | ||
Color | String | ||
GroupCode | String | ||
SupplierProductNo | String | ||
Cost | Decimal | ||
ScheduledQuantity | Integer | ||
InspectionQuantity | Integer | ||
StockoutQuantity | Integer | ||
StockoutReason | String | ||
InspectionDate | Date | ||
CompulsoryCompleteFlag | String | ||
Status | Integer | ||
Modified | Datetime |
Usage information for the operation StorageInfoDeliveries.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side. Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side. For example, the following queries are processed server side:
NOTE: One or more of the following filtering conditions are required in the request. The default filtering condition is set to 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 | |
StorageStoreId [KEY] | Integer | ||
StorageExpectedDateFrom | Date | ||
StorageExpectedDateTo | Date | ||
Modified | Datetime | ||
StorageId | Integer |
Usage information for the operation StorageInfoDeliveryProducts.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side. Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side. For example, the following queries are processed server side:
NOTE: One or more of the following filtering conditions are required in the request. The default filtering condition is set to 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 | |
StoreId [KEY] | Integer |
Stores.StoreId | |
ProductId [KEY] | Long |
Products.ProductId | |
ProductCode | String | ||
ProductName | String | ||
Size | String | ||
Color | String | ||
GroupCode | String | ||
SupplierProductNo | String | ||
Quantity | Integer | ||
Modified | Datetime |
Usage information for the operation StorageInfoProducts.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side. Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side. For example, the following queries are processed server side:
NOTE: One or more of the following filtering conditions are required in the request. The default filtering condition is set to 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 | |
ProductId [KEY] | Long |
Products.ProductId | |
ProductCode | String | ||
ProductName | String | ||
Size | String | ||
Color | String | ||
GroupCode | String | ||
SupplierProductNo | String | ||
Cost | Decimal | ||
Quantity | Integer | ||
Modified | Datetime |
Usage information for the operation TransactionCoupons.rsd.
Name | Type | References | Description |
TransactionCouponId [KEY] | Long | ID assigned to each transaction coupon | |
TerminalTranCouponId [KEY] | Long | Terminal transaction coupon ID | |
TransactionHeadId [KEY] | Long |
TransactionHeads.TransactionHeadId | ID given to each transaction |
TerminalTranId [KEY] | Long | Terminal transaction ID | |
CouponId [KEY] | Long | Coupon ID. Coupon ID managed by smartphone register | |
CouponName | String | Name of the Coupon | |
SerialNumber | String | The coupon serial number. | |
AwardType | String | The type of Coupon | |
AwardValue | Decimal | Discount amount, discount rate, etc. What the value represents depends on the privilege type | |
DiscountPrice | Decimal | The discount price. | |
AdjustmentValue | Decimal | The Adjustment points/mile. | |
CouponOfflineDivision | String | The Coupon Offline Classification. | |
CombineDivision | String | The Combination Classification. |
Usage information for the operation TransactionDepositOthers.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side.
Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side.
For example, the following queries are processed server side:
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 | The ID assigned to each transaction |
PaymentMethodNumber [KEY] | Integer | The Sequential number for each payment method in the transaction | |
PaymentMethodId | Integer | The ID of the payment method | |
PaymentMethodName | String | The name of the payment method | |
DepositOthers | Decimal | The amount deposited at the time of accounting. | |
Denomination | String | The denomination of the payment method. |
Usage information for the operation TransactionDetails.rsd.
The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime datatype columns) and IN operator are processed client-side. Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side. For example, the following queries are processed server side:
NOTE: One or more of the following filtering conditions are required in the request. The default filtering condition is set to UpdDateTime for the last 30 days.
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 | |
TransactionDateTime | Datetime | ||
TransactionDetailId [KEY] | Integer | ||
ParentTransactionDetailId | Integer | ||
TransactionDetailDivision | Integer | ||
ProductId | Long | ||
ProductCode | String | ||
ProductName | String | ||
TaxDivision | Integer | ||
Price | Decimal | ||
SalesPrice | Decimal | ||
UnitDiscountPrice | Decimal | ||
UnitDiscountRate | Decimal | ||
UnitDiscountDivision | Integer | ||
Cost | Decimal | ||
Quantity | Integer | ||
UnitNonDiscountSum | Decimal | ||
UnitDiscountSum | Decimal | ||
UnitDiscountedSum | Decimal | ||
CostSum | Decimal | ||
CategoryId | Integer | ||
CategoryName | String | ||
DiscriminationNo | String | ||
SalesDivision | Integer | ||
ProductDivision | Integer | ||
PointNotApplicable | Integer | ||
TaxFreeDivision | Integer | ||
TaxFreeCommodityPrice | Decimal | ||
TaxFree | Decimal | ||
ProductBundleGroupId | Integer | ||
DiscountPriceProportional | Decimal | ||
DiscountPointProportional | Decimal | ||
DiscountCouponProportional | Decimal | Set coupon discount. | |
TaxIncludeProportional | Decimal | ||
TaxExcludeProportional | Decimal | ||
ProductBundleProportional | Decimal | ||
StaffDiscountProportional | Decimal | ||
BargainDiscountProportional | Decimal | ||
RoundingPriceProportional | Decimal | ||
InventoryReservationDivision | Integer | ||
GroupCode | String | ||
UpdDateTime | Datetime | ||
ProductStaffDiscountRate | Integer | ||
StaffRank | String | ||
StaffRankName | String | ||
StaffDiscountRate | Decimal | ||
StaffDiscountDivision | Integer | ||
ApplyStaffDiscountRate | Decimal | ||
ApplyStaffDiscountPrice | Decimal | ||
BargainId | Integer | ||
BargainName | String | ||
BargainDivision | Integer | ||
BargainValue | Decimal | ||
ApplyBargainValue | Decimal | ||
ApplyBargainDiscountPrice | Decimal | ||
TaxRate | Decimal | ||
StandardTaxRate | Decimal | ||
ModifiedTaxRate | Decimal | ||
ReduceTaxId | Integer | ||
ReduceTaxName | String | ||
ReduceTaxRate | String | ||
Color | String | ||
Size | String |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
AccessToken | AccessToken of the currently authenticated user. |
ContractId | ContractId of the currently authenticated user. |
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Property | Description |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MaxThreads | The Max Thread. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | Specifies how many issues the driver will retrieve for each request. The max value for a Smaregi API is 1000. However, The max value for a DailySum table exepect. This table max value is 100. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
AccessToken | AccessToken of the currently authenticated user. |
ContractId | ContractId of the currently authenticated user. |
AccessToken of the currently authenticated user.
AccessToken of the currently authenticated user.
ContractId of the currently authenticated user.
ContractId of the currently authenticated user.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate to be accepted from the server when connecting using TLS/SSL.
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the Sync App opens a connection to Smaregi and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\Smaregi Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
MaxThreads | The Max Thread. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | Specifies how many issues the driver will retrieve for each request. The max value for a Smaregi API is 1000. However, The max value for a DailySum table exepect. This table max value is 100. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
The Max Thread.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies how many issues the driver will retrieve for each request. The max value for a Smaregi API is 1000. However, The max value for a DailySum table exepect. This table max value is 100.
Number of Issue entries retrieved in each page.
This property indicates whether or not to include pseudo columns as columns to the table.
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Sync App throws an exception.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{ "MyView": { "query": "SELECT * FROM Products WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.