Establishing a Connection

Adding a Connection to Smaregi

To add a connection to Smaregi:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the Smaregi icon is not available, click the Add More icon to download and install the Smaregi connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Smaregi

Smaregi makes its data available via two distinct APIs. Specify the API you want to use by setting the Schema connection property to one of the following:

Smaregi is an older API.
PlatformAPI is the newer API.

Authenticating to Smaregi

Smaregi offers the following authentication mechanisms:

Access Token based Authentication : Only available for for Smaregi API.
OAuth Authentication : Only available for for Platform API.

Access Token based Authentication for Smaregi API

The ContractId and AccessToken parameters are required for the Smaregi driver. After logging into Smaregi, navigate to Settings -> System Integration -> Smaregi API Settings. In the API Receiving Settings section, change the Use Receiving function to Enable and click Generate AccessToken to obtain an AccessToken. Next, in order to enable the required API access, change the required functionality to Use in the Feature Settings section.

ContractId : Contract ID of your account. You can also find it in the Reception setting section.
AccessToken : access token in the Reception setting section.

OAuth authentication for Platform API

To authenticate with OAuth, AuthScheme must be set to OAuth or OAuthClient . OAuth authentication uses UserAccssToken and OAuthClient authentication uses AppAccessToken. For full functionality, use OAuthClient authentication with AppAccessToken. To use OAuthClient authentication, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

Automatic Refresh of the OAuth Access Token

To have the Sync App automatically refresh the OAuth access token:

Before connecting to data for the first time, set these connection parameters:
- InitiateOAuth: REFRESH.
- OAuthClientId: The Key displayed when you created your custom OAuth application.
- OAuthClientSecret: The Secret displayed when you created your custom OAuth application.
- OAuthAccessToken: The access token returned by GetOAuthAccessToken.
- OAuthSettingsLocation: The path where you want the Sync App to save the OAuth values, which persist across connections.
On subsequent data connections, set:
- InitiateOAuth
- OAuthSettingsLocation

Manual refresh of the OAuth access token:

The only value needed to manually refresh the OAuth access token is the OAuth refresh token.

To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
Set these connection properties:
- OAuthClientId: The Client Id in your custom OAuth application settings.
- OAuthClientSecret: The Client Secret in your custom OAuth application settings.
Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
After the new tokens have been retrieved, set the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken. This opens a new connection.

Store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

OAuth JWT

To authenticate with OAuth JWT, AuthScheme must be set to OAuthJWT. You must also create a custom OAuth application, as described in Creating a Custom OAuth Application.

After setting the following connection properties, you are ready to connect:

AuthScheme: OAuthJWT.
OAuthClientId: The Key displayed when you created your custom OAuth application.
OAuthJWTCertType: PEMKEY_FILE.
OAuthJWTCert: The path to the .pem file you generated.

Advanced Features

This section details a selection of advanced features of the Smaregi Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

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).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

Using Smaregi API

See Smaregi Data Model for the available entities in the Smaregi Data Model.

Using Platform API

See PlatformAPI Data Model for the available entities in the Platform API Data Model.

Smaregi Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Smaregi APIs.

Key Features

The Sync App models Smaregi entities like products, customers, and shippings as relational tables, allowing you to write SQL to query and modify Smaregi data.
Live connectivity to these objects means any changes to your Smaregi account are immediately reflected when using the Sync App.

Tables

Tables describes the available tables. Table are statically defined to model Products, Customers, Shippings, and more.

Views

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.

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.

Smaregi Connector for CData Sync Tables


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.

BargainProducts

Usage information for the operation BargainProducts.rsd.

Columns


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

Bargains

Usage information for the operation Bargains.rsd.

Select

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

Insert

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.

Upsert

To add/update a Bargain, specify all fields.

UPSERT INTO Bargains (BargainId, BargainName, TermStart, TermEnd) VALUES (8, 'TestBargain9', '2019-06-28', '2019-09-28')

Bulk Upsert

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

Update

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

Delete

Bargains can be deleted by providing the BargainId.

DELETE FROM Bargains WHERE BargainId = 1

Bulk Delete

INSERT INTO Bargains#TEMP (BargainId) VALUES (90)
INSERT INTO Bargains#TEMP (BargainId) VALUES (91)
DELETE FROM Bargains WHERE EXISTS SELECT BargainId FROM Bargains#TEMP

Columns


Name	Type	ReadOnly	References	Description
BargainId [KEY]	Integer	False
BargainName	String	False
TermStart	Date	False
TermEnd	Date	False

BargainStores

Usage information for the operation BargainStores.rsd.

Select

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

Insert

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.

Upsert

To add/update a BargainStore, specify the BargainId and StoreId fields.

UPSERT INTO BargainStores (BargainStoreId, BargainId, StoreId) VALUES (4, 2, 1)

Bulk Upsert

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

Update

Smaregi allows updates for the BargainId and StoreId columns.

UPDATE BargainStores SET BargainId = 3, StoreId = 3 WHERE BargainStoreId = 4

Delete

BargainStores can be deleted by providing the BargainProductId.

DELETE FROM BargainStores WHERE BargainStoreId = 4

Bulk Delete

INSERT INTO BargainStores#TEMP (BargainStoreId) VALUES (5)
INSERT INTO BargainStores#TEMP (BargainStoreId) VALUES (6)
DELETE FROM BargainStores WHERE EXISTS SELECT BargainStoreId FROM BargainStores#TEMP

Columns


Name	Type	ReadOnly	References	Description
BargainStoreId [KEY]	Long	False
BargainId	Integer	False	Bargains.BargainId
StoreId	Integer	False

Customers

Usage information for the operation Customers.rsd.

Select

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%'

Insert

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.

Upsert

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')

Bulk Upsert

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

Update

Smaregi allows updates for all non key columns.

UPDATE Customers SET CustomerCode = 'CustomerCode2', CustomerNo = 3 WHERE CustomerId = 216

Delete

Customers can be deleted by providing the CustomerId.

DELETE FROM Customers WHERE CustomerId = 2

Bulk Delete

INSERT INTO Customers#TEMP (CustomerId) VALUES (123)
INSERT INTO Customers#TEMP (CustomerId) VALUES (124)
DELETE FROM Customers WHERE EXISTS SELECT CategoryId FROM Customers#TEMP

Columns


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

Losses

Usage information for the operation Losses.rsd.

Select

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

Insert

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

Upsert is not supported for this table.

Update

Smaregi allows UPDATEs for the Division, Memo, LossDatetime, IdentificationNo, Token and DetailAggregate columns.

UPDATE Losses SET Memo = 'UpdatedMemo5', Division = '02' WHERE LossId = 1

Changes 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

Delete

Losses can be deleted by providing the ProductId.

DELETE FROM Losses WHERE LossId = 12

Bulk Delete

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

Columns


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.

ProductInventoryReservations

Usage information for the operation ProductInventoryReservations.rsd.

Select

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;

Insert

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.

Upsert

To add/update a ProductInventoryReservation, specify all fields.

UPSERT INTO ProductInventoryReservations (ProductId, ReservationProductId, ReservationAmount) VALUES (1005, 4, 5)

Bulk Upsert

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

Update

Smaregi allows updates for the ReservationAmount column.

UPDATE ProductInventoryReservations SET ReservationAmount = 2 WHERE ProductId = 1005 AND ReservationProductId = 15

Delete

ProductInventoryReservations can be deleted by providing the ProductId and ReservationProductId.

DELETE FROM ProductInventoryReservations WHERE ProductId = 1005 AND ReservationProductId = 15

Bulk Delete

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

Columns


Name	Type	ReadOnly	References	Description
ProductId [KEY]	Long	False	Products.ProductId
ReservationProductId [KEY]	Long	False
ReservationAmount	Integer	False

ProductPrices

Usage information for the operation ProductPrices.rsd.

Select

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

Insert

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.

Upsert

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')

Bulk Upsert

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

Update

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

Delete

ProductPrices can be deleted by providing ProductId and StoreId.

DELETE FROM ProductPrices WHERE ProductId = 18 AND StoreId = 1

Bulk Delete

INSERT INTO ProductPrices#TEMP (productId) VALUES (45)
INSERT INTO ProductPrices#TEMP (productId) VALUES (56)
DELETE FROM ProductPrices WHERE EXISTS SELECT ProductId FROM ProductPrices#TEMP

Columns


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

ProductReserveItemLabels

Usage information for the operation ProductReserveItemLabels.rsd.

Select

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

Insert

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.

Upsert

To add/update a ProductReserveItemLabel, specify both fields.

UPSERT INTO ProductReserveItemLabels (No, Label) VALUES (84, 1)

Bulk Upsert

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

Update

Smaregi allows updates for the No, Label column.

UPDATE ProductReserveItemLabels SET Label = 2 WHERE No = 84

Delete

ProductReserveItemLabels can be deleted by providing the No.

DELETE FROM ProductReserveItemLabels WHERE No = 4

Bulk Delete

INSERT INTO ProductReserveItemLabels#TEMP (No) VALUES (83)
INSERT INTO ProductReserveItemLabels#TEMP (No) VALUES (84)
DELETE FROM ProductReserveItemLabels WHERE EXISTS SELECT No FROM ProductReserveItemLabels#TEMP

Columns


Name	Type	ReadOnly	References	Description
No [KEY]	Integer	False
Label	String	False

ProductReserveItems

Usage information for the operation ProductReserveItems.rsd.

Select

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

Insert

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.

Upsert

To add/update a ProductReserveItem, specify all fields.

UPSERT INTO ProductReserveItems (ProductId, No, Value) VALUES (45345, 2, 1)

Bulk Upsert

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

Update

Smaregi allows updates for the Value column.

UPDATE ProductReserveItems SET Value = 0 WHERE ProductId = 7 AND No = 2

Delete

ProductReserveItems can be deleted by providing the ProductId and No.

DELETE FROM ProductReserveItems WHERE ProductId = 7 AND No = 4

Bulk Delete

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

Columns


Name	Type	ReadOnly	References	Description
ProductId [KEY]	Long	False	Products.ProductId
No [KEY]	Integer	False
Value	String	False

Products

Usage information for the operation Products.rsd.

Select

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

Insert

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.

Upsert

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)

Bulk Upsert

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

Update

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'

Delete

Products can be deleted by providing the ProductId.

DELETE FROM Products WHERE ProductId = 5843055

Bulk Delete

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

Columns


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

ProductStores

Usage information for the operation ProductStores.rsd.

Select

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

Insert

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.

Upsert

To add/update a ProductStore, specify all fields.

UPSERT INTO ProductStores (ProductId, StoreId, AssignDivision) VALUES (45345, 1, 1)

Bulk Upsert

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

Update

Smaregi allows UPDATEs for the AssignDivision column.

UPDATE ProductStores SET AssignDivision = 0 WHERE ProductId = 84 AND StoreId = 2

Delete

Delete is not supported for this table.

Columns


Name	Type	ReadOnly	References	Description
ProductId [KEY]	Long	False	Products.ProductId
StoreId [KEY]	Integer	False	Stores.StoreId
AssignDivision	Integer	False

Receivings

Usage information for the operation Receivings.rsd.

Select

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

Insert is not supported for this table.

Upsert

Upsert is not supported for this table.

Update

Smaregi allows updates for the ShippingId, ShippingStoreId, ReceivingStoreId, ReceivingDate, Memo, Status, IdentificationNo, Token and DetailAggregate columns.

UPDATE Receivings SET Memo = 'ChangedMemo' WHERE ReceivingId = 1

Changes 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

Delete is not supported for this table.

Columns


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.

Shipments

Usage information for the operation Shipments.rsd.

Select

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

Insert

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

Upsert is not supported for this table.

Update

Smaregi allows updates for the RecipientType RecipientId RecipientName ShipmentDivision ShipmentDate Status IdentificationNo Token and DetailAggregate columns.

UPDATE Shipments SET IdentificationNo = '333543' WHERE ShipmentId = 5

Changes 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

Delete

Shipments can be deleted by providing the ShipmentId.

DELETE FROM Shipments WHERE ShipmentId = 4

Bulk Delete

INSERT INTO Shipments#TEMP (ShipmentId) VALUES (2)
INSERT INTO Shipments#TEMP (ShipmentId) VALUES (3)
DELETE FROM Shipments WHERE EXISTS SELECT ShipmentId FROM Shipments#TEMP

Columns


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.

Shippings

Usage information for the operation Shippings.rsd.

Select

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

Insert

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

Upsert is not supported for this table.

Update

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

Delete

Shippings can be deleted by providing the ShippingId.

DELETE FROM Shippings WHERE ShippingId = 6

Bulk Delete

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

Columns


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.

Staff

Usage information for the operation Staff.rsd.

Select

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

Insert

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.

Upsert

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')

Update

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'

Delete

Staff can be deleted by providing the StaffId.

DELETE FROM Staff WHERE StaffId = 1

Columns


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.

Stocks

Usage information for the operation Stocks.rsd.

Select

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

Insert

To add a Stock, specify the ProductId, StoreId, StockDivision and StockAmount fields.

INSERT INTO Stocks (ProductId, StoreId, StockDivision, StockAmount) VALUES (45, 1, 05, 1)

Upsert

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)

Bulk Upsert

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

Update

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

Delete is not supported for this table.

Columns


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-Columns

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.

StorageInfo

Usage information for the operation StorageInfo.rsd.

Select

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

Insert

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

Upsert is not supported for this table.

Update

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

Delete

StorageInfo can be deleted by providing the StorageInfoId.

DELETE FROM StorageInfo WHERE StorageInfoId = 7

Bulk Delete

INSERT INTO StorageInfo#TEMP (StorageInfoId) VALUES (9);
INSERT INTO StorageInfo#TEMP (StorageInfoId) VALUES (6);
DELETE FROM StorageInfo WHERE EXISTS SELECT StorageInfoId FROM StorageInfo#TEMP

Columns


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.

Storages

Usage information for the operation Storages.rsd.

Select

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

Insert

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

Upsert is not supported for this table.

Update

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

Delete is not supported for this table.

Columns


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.

Stores

Usage information for the operation Stores.rsd.

Select

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

Insert

To add a Store, specify the StoreId, StoreCode and StoreName.

INSERT INTO Stores (StoreId, StoreCode, StoreName) VALUES (35, 'YSM', 'TATA')

Update

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

Columns


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].

TransactionHeads

Usage information for the operation TransactionHeads.rsd.

Select

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.

Transaction ID [TransactionHeadId] ID specification, From-To (From-To can be specified within 100, 000).
Transaction Date Time [TransactionDateTime] From-To (Period is 31 days (not 1 month)).
Terminal transaction date and time [TerminalTranDateTime] From-To (Period is 31 days (not 1 month)).
Adjustment date and time [AdjustmentDateTime] From-To (Period is 31 days (not 1 month)).
Sum date and time [SumDateTime] From-To (Period is 31 days (not 1 month)).
Cancel date and time [CancelDateTime] From-To (Period is 31 days (not 1 month)).
Updated date and time [UpdDateTime] From-To (Period is 31 days (not 1 month)).

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'

Insert

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

Upsert is not supported for this table.

Update

UPDATE is not supported for this table.

Delete

Delete is not supported for this table.

Columns


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

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.

Smaregi Connector for CData Sync Views


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.

DailySums

Usage information for the operation DailySums.rsd.

Select

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

Columns


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

DailySumsSalesList

Usage information for the operation DailySumsSalesList.rsd.

Select

The Sync App will use the Smaregi API to process WHERE clause conditions built with the following column and operator.

Id supports the '=,!=,>,<,>=,<=,LIKE' comparison.

SELECT * FROM [DailySumsSalesList] WHERE StoreId = '1234'

Columns


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

LossDetails

Usage information for the operation LossDetails.rsd.

Select

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

Columns


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

ReceivingDetails

Usage information for the operation ReceivingDetails.rsd.

Select

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

Columns


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

ShipmentDetails

Usage information for the operation ShipmentDetails.rsd.

Select

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

Columns


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

ShippingDetails

Usage information for the operation ShippingDetails.rsd.

Select

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

Columns


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

StaffStores

Usage information for the operation StaffStores.rsd.

Select

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

Columns


Name	Type	References	Description
StaffId [KEY]	Integer
StoreId [KEY]	Integer
ControlDivision	Integer

StockHistories

Usage information for the operation StockHistories.rsd.

Select

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.

ID [id] ID specified, From-To (From-To can be specified within 100,000).
Product ID [productId] ID Direct specification only.
Updated date and time [UpdDateTime] From-To (Period is 31 days (not 1 month)).
Target date and time [TargetDateTime] From-To (Period is 31 days (not 1 month)).

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'

Columns


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

StocktakingDetails

Usage information for the operation StocktakingDetails.rsd.

Select

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.

StocktakingInfo ID [StocktakingInfoId] specification, From-To (From-To can be specified within 100,000).
Modified date and time [Modified] From-To (Period is 31 days (not 1 month)).

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'

Columns


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

StocktakingHeads

Usage information for the operation StocktakingHeads.rsd.

Select

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'

Columns


Name	Type	References	Description
StocktakingInfoId [KEY]	Integer	StocktakingInfo.StocktakingInfoId
StocktakingHeadId [KEY]	Integer
DivisionCode	String
Modified	Datetime

StocktakingInfo

Usage information for the operation StocktakingInfo.rsd.

Select

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'

Columns


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

StocktakingStockDetails

Usage information for the operation StocktakingStockDetails.rsd.

Select

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

Columns


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

StorageDetails

Usage information for the operation StorageDetails.rsd.

Select

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

Columns


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

StorageInfoDeliveries

Usage information for the operation StorageInfoDeliveries.rsd.

Select

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.

StorageInfo ID [StorageInfoId] ID specification, From-To (From-To can be specified within 100,000).
Modified date and time [Modified] From-To (Period is 31 days (not 1 month)).

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'

Columns


Name	Type	References	Description
StorageInfoId [KEY]	Integer	StorageInfo.StorageInfoId
StorageStoreId [KEY]	Integer
StorageExpectedDateFrom	Date
StorageExpectedDateTo	Date
Modified	Datetime
StorageId	Integer

StorageInfoDeliveryProducts

Usage information for the operation StorageInfoDeliveryProducts.rsd.

Select

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.

StorageInfo ID [StorageInfoId] ID specification, From-To (From-To can be specified within 100,000).
Modified date and time [Modified] From-To (Period is 31 days (not 1 month)).

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'

Columns


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

StorageInfoProducts

Usage information for the operation StorageInfoProducts.rsd.

Select

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.

StorageInfo ID [StorageInfoId] ID specification, From-To (From-To can be specified within 100,000).
Modified date and time [Modified] From-To (Period is 31 days (not 1 month)).

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'

Columns


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

TransactionCoupons

Usage information for the operation TransactionCoupons.rsd.

Columns


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.

TransactionDepositOthers

Usage information for the operation TransactionDepositOthers.rsd.

Select

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

Columns


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.

TransactionDetails

Usage information for the operation TransactionDetails.rsd.

Select

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.

Transaction ID [TransactionHeadId] ID specification, From-To (From-To can be specified within 100,000).
TransactionDate Time [TransactionDateTime] From-To (Period is 31 days (not 1 month)).
Updated date and time [UpdDateTime] From-To (Period is 31 days (not 1 month)).

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'

Columns


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

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Smaregi.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Smaregi, along with an indication of whether the procedure succeeded or failed.

Smaregi Connector for CData Sync Stored Procedures


Name	Description

ProductImageUpload

To Upload Product Image

To execute the ProductImageUpload procedure use the following code:

INSERT INTO aggregate#TEMP (ProductId, ImageUrl) VALUES ('1234', 'https://www.mywebsite.com/sample.png')
EXEC ProductImageUpload aggregate = 'aggregate#TEMP'
OR
EXEC ProductImageUpload ProductId = '123', ImageUrl = 'https://www.mywebsite.com/sample.png'

Input


Name	Type	Required	Description
ProductId	Long	False	ProductId
ImageUrl	String	False	ImageUrl
Aggregate	String	False	Use aggregate in case of multiple Image upload with the help of temp table.

Result Set Columns


Name	Type	Description
Status	String	The status of the operation

PlatformAPI Data Model

Overview

This section shows the available API objects and provides more information on executing SQL to Smaregi APIs.

Key Features

The Sync App models Smaregi entities like products, customers, and shippings as relational tables, allowing you to write SQL to query and modify Smaregi data.
Live connectivity to these objects means any changes to your Smaregi account are immediately reflected when using the Sync App.

Tables

Tables describes the available tables. Table are statically defined to model Products, Customers, Shippings, and more.

Views

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.

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.

Smaregi Connector for CData Sync Tables


Name	Description
AppPaymentMethods	Returns a list of app payment methods.
BargainProducts	Returns a list of products for a specified bargain.
Bargains	Returns a list of bargains.
BargainStores	Returns a list of products for a specified store.
BudgetStaffs	Returns a list of budgets by staff.
BundleProducts	Returns a list of products for a specified bundle group
Bundles	Returns a list of bundles.
Categories	Returns a list of categories.
CategoryGroups	Returns a list of category groups.
CouponItems	Returns a list of items tied to the specified coupon.
Coupons	Returns a list of coupons.
CustomerGroups	Returns a list of customer groups.
CustomerGroupSections	Returns a list of customer group sections.
CustomerPoints	Returns a list of customer points.
CustomerRanks	Returns a list of customer ranks.
Customers	Returns a list of customers.
DailyBudget	Returns daily budget of the specified date.
LossDivisions	Returns a list of loss divisions.
Losses	Returns a list of losses.
PaymentMethodGroups	Returns a list of payment method groups.
PaymentMethods	Returns a list of payment methods.
ProductAttributeItems	Returns a list of product attribute items.
ProductAttributes	Returns a list of product attributes.
ProductInventoryReservations	Returns inventory reservations of the specified product.
ProductOptionGroupProducts	Returns a list of products for a specified product option group.
ProductOptionGroups	Returns a list of product option groups.
ProductPrices	Retuns prices of the specified product.
ProductReserveItemLabels	Returns a list of product reserve item labels.
ProductReserveItems	Returns a list of product reserve items.
Products	Returns a list of products.
PurchaseOrders	Returns a list of purchase orders.
Receiving	Returns a list of receiving transaction.
Roles	Returns a list of roles.
Shipments	Generated schema file.
Shipping	Returns a list of shipping transactions.
ShippingModificationRequests	Returns a list of shipping modification requests.
StaffRanks	Returns a list of staff ranks.
Stock	Returns a list of stock.
Storage	Returns a list of storage transactions.
StoreClasses	Returns a list or store classes.
StoreClassItemRelations	Reads or deletes a list of relationship information between stores and store classification items.
StoreClassItems	Returns a list of store class items.
Stores	Returns a list of stores.
SupplierDivisions	Generated schema file.
SupplierProducts	Generated schema file.
Suppliers	Generated schema file.
TemporaryTransactionDetails	Returns temprary transaction details.
TemporaryTransactions	Returns a list of temprary transactions.
Terminals	Returns a list of terminals.
TransactionLayaways	Generated schema file.
Transactions	Generated schema file.

AppPaymentMethods

Returns a list of app payment methods.

Columns


Name	Type	ReadOnly	References	Description
PaymentMethodId [KEY]	Integer	True
PaymentMethodName	String	False

BargainProducts

Returns a list of products for a specified bargain.

Columns


Name	Type	ReadOnly	References	Description
BargainId [KEY]	Integer	True	Bargains.BargainId
BargainProductId [KEY]	Long	True
Division	String	False
InsDateTime	Datetime	True
TargetDivision	String	False
TargetId	String	False
UpdDateTime	Datetime	True
Value	Decimal	False

Bargains

Returns a list of bargains.

Columns


Name	Type	ReadOnly	References	Description
BargainId [KEY]	Integer	True
BargainName	String	False
InsDateTime	Datetime	True
TermEnd	Date	False
TermStart	Date	False
UpdDateTime	Datetime	True
BargainProductId	Long	False

BargainStores

Returns a list of products for a specified store.

Columns


Name	Type	ReadOnly	References	Description
BargainId [KEY]	Integer	True	Bargains.BargainId
BargainStoreId [KEY]	Integer	True
InsDateTime	Datetime	True
StoreId	Integer	False	Stores.StoreId
UpdDateTime	Datetime	True

BudgetStaffs

Returns a list of budgets by staff.

Columns


Name	Type	ReadOnly	References	Description
StoreId [KEY]	Integer	False	Stores.StoreId
StaffId [KEY]	Integer	False	Staffs.StaffId
InsDateTime	Datetime	False
salesTargetStaff	Decimal	False
UpdDateTime	Datetime	False
Ym	String	False

Pseudo-Columns

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
Year	Integer
Month	Integer

BundleProducts

Returns a list of products for a specified bundle group

Columns


Name	Type	ReadOnly	References	Description
ProductBundleGroupId [KEY]	Integer	False	Bundles.ProductBundleGroupId
ProductBundleId [KEY]	Integer	False
ProductCategoryId	Integer	False
ProductId	Long	False
ProductGroupCode	String	False

Bundles

Returns a list of bundles.

Columns


Name	Type	ReadOnly	References	Description
ProductBundleGroupId [KEY]	Integer	False
CalcDiscount	String	False
InsDateTime	Datetime	True
PointNotApplicable	String	False
Priority	Integer	False
ProductBundleGroupName	String	False
Quantity	Integer	False
ReduceTaxId	Integer	False
ReduceTaxValue	Integer	False
TaxDivision	String	False
TaxFreeDivision	String	False
TermFrom	Date	False
TermTo	Date	False
Type	String	False
UpdDateTime	Datetime	True
Value	Integer	False
Products	String	False

CategoryGroups

Returns a list of category groups.

Columns


Name	Type	ReadOnly	References	Description
CategoryGroupId [KEY]	Integer	True
CategoryGroupCode	String	False
CategoryGroupName	String	False
DisplaySequence	Integer	False
InsDateTime	Datetime	True
UpdDateTime	Datetime	True

CouponItems

Returns a list of items tied to the specified coupon.

Columns


Name	Type	ReadOnly	References	Description
CouponId [KEY]	Integer	True	Coupons.CouponId
CouponItemId	Integer	True
Division [KEY]	String	False
ItemId [KEY]	Integer	False
Type [KEY]	String	False
SalesPrice	Integer	False

Coupons

Returns a list of coupons.

Columns


Name	Type	ReadOnly	References	Description
CouponId [KEY]	Integer	True
ApplyConditionDivision	String	False
AwardType	String	False
AwardValue	Integer	False
CombineDivision	String	False
CouponDivision	String	False
CouponName	String	False
EndDate	Date	False
InsDateTime	Datetime	True
MaxTargetPrice	Integer	False
MinTargetPrice	Integer	False
SerialNumber	String	False
StartDate	Date	False
Summary	String	False
UpdDateTime	Datetime	True
Items	String	False
Applicable	Date	False

CustomerGroups

Returns a list of customer groups.

Columns


Name	Type	ReadOnly	References	Description
CustomerGroupId [KEY]	Integer	True
CustomerGroupSectionId	Integer	False	CustomerGroupSections.CustomerGroupSectionId
DisplayFlag	String	False
DisplaySequence	Integer	False
InsDateTime	Datetime	True
Label	String	False
UpdDateTime	Datetime	True

CustomerGroupSections

Returns a list of customer group sections.

Columns


Name	Type	ReadOnly	References	Description
CustomerGroupSectionId [KEY]	String	True
CustomerGroupSectionLabel	String	False
InsDateTime	Datetime	True
UpdDateTime	Datetime	True

CustomerPoints

Returns a list of customer points.

Columns


Name	Type	ReadOnly	References	Description
CustomerId [KEY]	Long	True
InsDateTime	Datetime	True
Mile	Integer	False
Point	Integer	False
PointExpireDate	Date	False
UpdDateTime	Datetime	True

CustomerRanks

Returns a list of customer ranks.

Columns


Name	Type	ReadOnly	References	Description
Rank [KEY]	String	True
DisplayFlag	String	False
DisplaySequence	Integer	False
InsDateTime	Datetime	True
Name	String	False
PointGivingUnit	Decimal	False
PointGivingUnitPrice	Integer	False
UpdDateTime	Datetime	True

Customers

Returns a list of customers.

Columns


Name	Type	ReadOnly	References	Description
CustomerId [KEY]	Long	True
Address	String	False
AlphabetName	String	False
BirthDate	Date	False
BrowsingList	String	False
CompanyName	String	False
CustomerCode	String	False
CustomerNo	String	False
DepartmentName	String	False
EntryDate	Date	False
FavoriteList	String	False
FaxNumber	String	False
FirstKana	String	False
FirstName	String	False
InsDateTime	Datetime	True
LastComeDateTime	Datetime	False
LastKana	String	False
LastName	String	False
LeaveDate	Date	False
MailAddress	String	False
MailAddress2	String	False
MailAddress3	String	False
MailReceiveFlag	String	False
ManagerialPosition	String	False
MobileNumber	String	False
Nationality	String	False
Note	String	False
Note2	String	False
PassportNo	String	False
PhoneNumber	String	False
PinCode	String	False
PointExpireDate	Date	False
PointGivingUnitPrice	Integer	False
PointGivingUnit	Decimal	False
PostCode	String	False
Rank	String	False
Sex	Integer	False
StaffRank	String	False
Status	String	False
StoreId	Integer	False
UpdDateTime	Datetime	True

DailyBudget

Returns daily budget of the specified date.

Columns


Name	Type	ReadOnly	References	Description
StoreId [KEY]	Integer	False
InsDateTime	Datetime	False
SalesTargetDaily	Decimal	False
UpdDateTime	Datetime	False
Ym	String	False
Day	Integer	False
Year [KEY]	Integer	False
Month [KEY]	Integer	False

LossDivisions

Returns a list of loss divisions.

Columns


Name	Type	ReadOnly	References	Description
Code [KEY]	String	True
ActiveFlag	String	False
Color	String	False
DisplaySequence	Integer	False
InsDateTime	Datetime	True
Name	String	False
UpdDateTime	Datetime	True

Losses

Returns a list of losses.

Columns


Name	Type	ReadOnly	References	Description
LossId [KEY]	Integer	True
Division	String	False
IdentificationNo	String	False
InsDateTime	Datetime	True
LossDateTime	Datetime	False
Memo	String	False
StaffId	Integer	False
StaffName	String	False
StoreId	Integer	False
UpdDateTime	Datetime	True
Details	String	False

PaymentMethodGroups

Returns a list of payment method groups.

Columns


Name	Type	ReadOnly	References	Description
PaymentMethodGroupId [KEY]	Integer	False
Code	String	False
DisplayFlag	String	False
DisplaySequence	Integer	False
InsDateTime	Datetime	False
Name	String	False
UpdDateTime	Datetime	False

PaymentMethods

Returns a list of payment methods.

Columns


Name	Type	ReadOnly	References	Description
PaymentMethodId [KEY]	Integer	False
ChangeFlag	String	False
DisplayFlag	String	False
DisplaySequence	Integer	False
InsDateTime	Datetime	False
PaymentMethodCode	String	False
PaymentMethodGroupId	Integer	False
PaymentMethodName	String	False
PointGivingUnit	Decimal	False
PointGivingUnitPrice	Integer	False
SecuritiesFlag	String	False
UnitPrice	Integer	False
UpdDateTime	Datetime	False
Stores	String	False

ProductAttributeItems

Returns a list of product attribute items.

Columns


Name	Type	ReadOnly	References	Description
Code [KEY]	String	False
DisplaySequence	Integer	False
No	String	False
Name	String	False

ProductAttributes

Returns a list of product attributes.

Columns


Name	Type	ReadOnly	References	Description
No [KEY]	String	True
Name	String	False

ProductInventoryReservations

Returns inventory reservations of the specified product.

Columns


Name	Type	ReadOnly	References	Description
ProductId [KEY]	Long	False	Products.ProductId
ReservationProductId [KEY]	Long	False
ReservationAmount	Integer	False

ProductOptionGroupProducts

Returns a list of products for a specified product option group.

Columns


Name	Type	ReadOnly	References	Description
ProductOptionGroupId [KEY]	String	False	ProductOptionGroups.ProductOptionGroupId
ProductId [KEY]	Long	False	Products.ProductId
SyncDivision	String	False
insDateTime	Datetime	False
updDateTime	Datetime	False

ProductOptionGroups

Returns a list of product option groups.

Columns


Name	Type	ReadOnly	References	Description
ProductOptionGroupId [KEY]	String	False
ConditionId	String	False
InsDateTime	Datetime	False
Max	String	False
Min	String	False
ProductOptionGroupName	String	False
SyncDivision	String	False
UpdDateTime	Datetime	False
Products	String	False

ProductPrices

Retuns prices of the specified product.

Select

The Sync App will use the Smaregi API to process WHERE clause conditions and selected columns. Operators: =, ORDER BY are processed server-side. For example, the following queries are processed server side:

SELECT * from ProductPrices where ProductId=202504301729112

NOTE: The pseudo columns are intended to be supported only for INSERT and UPDATE operations

Insert

To add to ProductPrices, specify the following columns: Price, ProductName, CategoryId, StoreId, PriceDivision, StartDate, EndDate and ProductPrice.

INSERT INTO ProductPrices (Price, ProductName, CategoryId, StoreId, PriceDivision, StartDate, EndDate, ProductPrice)  VALUES (90,testingproductname,1,35,2,2000-01-23,2000-01-24,12345678)

Update

Smaregi allows updates for the ProductPrice column.

UPDATE ProductPrices SET ProductPrice=89 WHERE ProductId=202504301729109

NOTE: Updating ProductPrice will update the value for Price column.

Delete

ProductPrices can be deleted by providing the ProductId, PriceDivision, StoreId and StartDate.

DELETE FROM ProductPrices WHERE ProductId = 1 AND PriceDivision = 2 AND StoreId = 3 AND StartDate = '2025/3/3'

Columns


Name	Type	ReadOnly	References	Description
ProductId [KEY]	Long	False	Products.ProductId
PriceDivision [KEY]	String	False
StartDate [KEY]	Date	False
StoreId [KEY]	Integer	False
Price	Integer	False
EndDate	Date	False

Pseudo-Columns

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
CategoryId	Integer
ProductName	String
ProductPrice	String

ProductReserveItemLabels

Returns a list of product reserve item labels.

Columns


Name	Type	ReadOnly	References	Description
No [KEY]	String	False	ProductReserveItems.No
Label	String	False

ProductReserveItems

Returns a list of product reserve items.

Columns


Name	Type	ReadOnly	References	Description
No [KEY]	String	False
ProductId [KEY]	Long	False	Products.ProductId
Value	String	False

Products

Returns a list of products.

Columns


Name	Type	ReadOnly	References	Description
ProductId [KEY]	Long	False
AppStartDateTime	Datetime	False
Attribute	String	False
CalcDiscount	String	False
CatchCopy	String	False
CategoryId	Integer	False
Color	String	False
Cost	Decimal	False
CustomerPrice	Integer	False
Description	String	False
DisplayFlag	String	False
DisplaySequence	Integer	False
Division	String	False
GroupCode	String	False
InsDateTime	Datetime	False
OrderPoint	Integer	False
PointNotApplicable	String	False
Price	Integer	False
PrintReceiptProductName	String	False
ProductCode	String	False
ProductKana	String	False
ProductName	String	False
ProductOptionGroupId	Integer	False
ProductPriceDivision	String	False
PurchaseCost	Decimal	False
ReduceTaxCustomerPrice	Integer	False
ReduceTaxId	Integer	False
ReduceTaxPrice	String	False
SalesDivision	String	False
Size	String	False
StaffDiscountRate	Integer	False
StockControlDivision	String	False
SupplierProductNo	String	False
Tag	String	False
TaxDivision	String	False
TaxFreeDivision	String	False
UpdDateTime	Datetime	False
Url	String	False
UseCategoryReduceTax	String	False
ReserveItems	String	False
Prices	String	False
Stores	String	False
AttributeItems	String	False
InventoryReservations	String	False
OrderSettings	String	False

PurchaseOrders

Returns a list of purchase orders.

Columns


Name	Type	ReadOnly	References	Description
PurchaseOrderId [KEY]	Integer	False
StorageInfoId	Integer	False
CategoryGroupId	Integer	False
DivisionUnit	String	False
IdentificationNo	String	False
InsDateTime	Datetime	False
Memo	String	False
OrderedDate	Date	False
RecipientOrderId	Integer	False
RoundingDivision	String	False
StaffId	Integer	False
Status	String	False
StorageInfoId	Integer	False
UpdDateTime	Datetime	False
Products	String	False
Stores	String	False

Receiving

Returns a list of receiving transaction.

Columns


Name	Type	ReadOnly	References	Description
ReceivingId [KEY]	Integer	True
ReceivingDate [KEY]	Date	True
IdentificationNo	String	False
InsDateTime	Datetime	False
Memo	String	False
ReceivingExpectedDateFrom	Date	False
ReceivingExpectedDateTo	Date	False
ReceivingStoreId	Integer	False
ShippingId	Integer	False
ShippingStoreId	Integer	False
StaffId	Integer	False
Status	String	False
UpdDateTime	Datetime	False
Details	String	False

Roles

Returns a list of roles.

Columns


Name	Type	ReadOnly	References	Description
RoleId [KEY]	Integer	True
RoleName	String	False
Note	String	False
InsDateTime	Datetime	False
UpdDateTime	Datetime	False
FunctionControls	String	False
InventoryFunctionControls	String	False
AlertFunctionControls	String	False

Shipments

Generated schema file.

Columns


Name	Type	ReadOnly	References	Description
ShipmentId [KEY]	Integer	True
ApprovalDateTime	Datetime	False
ApprovalStatus	String	False
IdentificationNo	String	False
InsDateTime	Datetime	False
Memo	String	False
RecipientId	Integer	False
RecipientName	String	False
RecipientType	String	False
RoundingDivision	String	False
ShipmentDate	Date	False
ShipmentDivision	String	False
ShipmentStoreId	Integer	False
StaffId	Integer	False
Status	String	False
TaxRate	Decimal	False
UpdDateTime	Datetime	False
Details	String	False

Shipping

Returns a list of shipping transactions.

Columns


Name	Type	ReadOnly	References	Description
ShippingId [KEY]	Integer	True
ApprovalDateTime	Datetime	False
ApprovalStatus	String	False
IdentificationNo	String	False
InsDateTime	Datetime	False
Memo	String	False
ModificationRequestCheckedDateTime	Datetime	False
ModificationRequestDateTime	Datetime	False
ModificationRequestStatus	String	False
ReceivingDesiredDate	Date	False
ReceivingExpectedDateFrom	Date	False
ReceivingExpectedDateTo	Date	False
ReceivingStoreId	Integer	False
RequestStaffId	Integer	False
ShippingDate	Date	False
ShippingStoreId	Integer	False
StaffId	Integer	False
Status	String	False
UpdDateTime	Datetime	False
Details	String	False

ShippingModificationRequests

Returns a list of shipping modification requests.

Columns


Name	Type	ReadOnly	References	Description
ShippingId [KEY]	String	True
ApprovalDateTime	Datetime	False
ApprovalStatus	String	False
Details	String	False
IdentificationNo	String	False
InsDateTime	Datetime	False
Memo	String	False
ModificationRequestCheckedDateTime	String	False
ModificationRequestDateTime	String	False
ModificationRequestStatus	String	False
Receiving	String	False
ReceivingDesiredDate	Date	False
ReceivingExpectedDateFrom	Date	False
ReceivingExpectedDateTo	Date	False
ReceivingStoreId	String	False
RequestStaffId	String	False
ShippingDate	Date	False
ShippingStoreId	String	False
StaffId	Integer	False
Status	String	False
UpdDateTime	Datetime	False
ModificationRequestDate	Date	False

Pseudo-Columns

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
WithDetails	String
WithReceiving	String

StaffRanks

Returns a list of staff ranks.

Columns


Name	Type	ReadOnly	References	Description
StaffRank [KEY]	String	True
DisplayFlag	String	False
DisplaySequence	Integer	False
InsDateTime	Datetime	True
StaffApplicationSellingPriceDivision	String	False
StaffDiscountRate	Integer	False
StaffRankDisplayName	String	False
StaffRankFullName	String	False
UpdDateTime	Datetime	True
UseProductStaffDiscountRateDivision	String	False

Stock

Returns a list of stock.

Columns


Name	Type	ReadOnly	References	Description
ProductId [KEY]	Long	False
StoreId [KEY]	Integer	False
LayawayStockAmount	Integer	False
StockAmount	Integer	False
UpdDateTime	Datetime	False
StockHistory	String	False

Storage

Returns a list of storage transactions.

Columns


Name	Type	ReadOnly	References	Description
StorageId [KEY]	Integer	False
IdentificationNo	String	False
InsDateTime	Datetime	False
Memo	String	False
RoundingDivision	String	False
StaffId	Integer	False
Status	String	False
StorageDate	Date	False
StorageExpectedDateFrom	Date	False
StorageExpectedDateTo	Date	False
StorageInfoId	Integer	False
StorageStoreId	Integer	False
SupplierId	Integer	False
UpdDateTime	Datetime	False
Details	String	False

StoreClasses

Returns a list or store classes.

Columns


Name	Type	ReadOnly	References	Description
StoreClassId [KEY]	Integer	False
DisplaySequence	Integer	False
InsDateTime	Datetime	False
StoreClassName	String	False
UpdDateTime	Datetime	False

StoreClassItemRelations

Reads or deletes a list of relationship information between stores and store classification items.

Columns


Name	Type	ReadOnly	References	Description
StoreClassId [KEY]	Integer	False	StoreClasses.StoreClassId
StoreId [KEY]	Integer	False	Stores.StoreId
StoreClassItemId	Integer	False	StoreClassItems.StoreClassItemId

StoreClassItems

Returns a list of store class items.

Columns


Name	Type	ReadOnly	References	Description
StoreClassId [KEY]	Integer	True	StoreClasses.StoreClassId
StoreClassItemId [KEY]	Integer	True
DisplaySequence	Integer	False
InsDateTime	Datetime	True
StoreClassItemName	String	False
UpdDateTime	Datetime	True

Stores

Returns a list of stores.

Columns


Name	Type	ReadOnly	References	Description
StoreId [KEY]	Integer	False
Address	String	False
CancelSettingDivision	String	False
CardCompanySelectDivision	String	False
CarriageDisplayFlag	String	False
DiscountRoundingDivision	String	False
DisplaySequence	Integer	False
Division	String	False
FaxNumber	String	False
GiftReceiptValidDays	Integer	False
Homepage	String	False
InsDateTime	Datetime	False
InvoiceRegistrationNo	String	False
MailAddress	String	False
MaxBundleProductCount	Integer	False
MaxDiscountRate	Integer	False
PauseFlag	String	False
PhoneNumber	String	False
PointNotApplicable	String	False
PostCode	String	False
PriceChangeFlag	String	False
PrintReceiptStoreName	String	False
PrintStockReceiptStoreName	String	False
RoundingDivision	String	False
SavingAutoDivision	String	False
SavingAutoPrice	Integer	False
SellDivision	String	False
StoreAbbr	String	False
StoreCode	String	False
StoreName	String	False
SumDateChangeTime	String	False
SumProcDivision	String	False
SumRefColumn	String	False
TaxFreeDivision	String	False
TaxLabelNormal	String	False
TaxLabelReduce	String	False
TempTranMailAddress	String	False
TerminalAdjustmentCashFlag	String	False
TerminalCheckCashFlag	String	False
UpdDateTime	Datetime	False
WaiterAdjustmentDivision	String	False
PointCondition	String	False
ReceiptPrintInfo	String	False
WithPointCondition	String	False
WithReceiptPrintInfo	String	False

SupplierDivisions

Generated schema file.

Columns


Name	Type	ReadOnly	References	Description
SupplierDivisionId [KEY]	Integer	False
DisplayFlag	String	False
DisplaySequence	Integer	False
InsDateTime	Datetime	False
Name	String	False
UpdDateTime	Datetime	False

SupplierProducts

Generated schema file.

Columns


Name	Type	ReadOnly	References	Description
SupplierId [KEY]	Integer	False	Suppliers.SupplierId
CategoryId	Integer	False
InsDateTime	Datetime	False
ProductId	Long	False	Products.ProductId
TargetId [KEY]	String	False
Division [KEY]	String	False

Suppliers

Generated schema file.

Columns


Name	Type	ReadOnly	References	Description
SupplierId [KEY]	Integer	False
Address	String	False
FaxNumber	String	False
InsDateTime	Datetime	False
MailAddress	String	False
OrderPriority	Integer	False
PhoneNumber	String	False
StaffName	String	False
SupplierAbbr	String	False
SupplierCode	String	False
SupplierDivisionId	Integer	False	SupplierDivisions.SupplierDivisionId
SupplierName	String	False
UpdDateTime	Datetime	False

TemporaryTransactionDetails

Returns temprary transaction details.

Columns


Name	Type	ReadOnly	References	Description
TransactionHeadId	Integer	False
ApplyBargainDiscountPrice	Integer	False
ApplyBargainValue	String	False
ApplyStaffDiscountPrice	Integer	False
ApplyStaffDiscountRate	Integer	False
BargainDiscountProportional	Integer	False
BargainDivision	String	False
BargainId	Integer	False
BargainName	String	False
BargainValue	Integer	False
CalcDiscount	String	False
CategoryId	Integer	False
CategoryName	String	False
Color	String	False
Cost	Decimal	False
CostSum	Decimal	False
DiscountCouponProportional	Integer	False
DiscountPointProportional	Integer	False
DiscountPriceProportional	Integer	False
DiscriminationNo	String	False
GroupCode	String	False
InventoryReservationDivision	String	False
Memo	String	False
ModifiedTaxRate	Decimal	False
ParentTransactionDetailId	Integer	False
PointNotApplicable	String	False
Price	Integer	False
PrintReceiptProductName	String	False
ProductBundleGroupId	Integer	False
ProductBundleProportional	Integer	False
ProductCode	String	False
ProductDivision	String	False
ProductId	Long	False
ProductName	String	False
ProductStaffDiscountRate	Integer	False
Quantity	Integer	False
ReduceTaxId	Integer	False
ReduceTaxMemberPrice	Integer	False
ReduceTaxName	String	False
ReduceTaxPrice	Integer	False
ReduceTaxRate	Decimal	False
RfidTags	String	False
RoundingPriceProportional	Integer	False
SalesDivision	String	False
SalesPrice	Integer	False
Size	String	False
StaffDiscountDivision	String	False
StaffDiscountProportional	Integer	False
StaffDiscountRate	Integer	False
StaffRank	String	False
StaffRankName	String	False
StandardTaxRate	String	False
TaxDivision	String	False
TaxExcludeProportional	Integer	False
TaxFree	String	False
TaxFreeCommodityPrice	Integer	False
TaxFreeDivision	String	False
TaxIncludeProportional	Integer	False
TaxRate	Decimal	False
TransactionDetailDivision	String	False
TransactionDetailId	Integer	False
UnitDiscountDivision	String	False
UnitDiscountedSum	Integer	False
UnitDiscountPrice	Integer	False
UnitDiscountRate	Integer	False
UnitDiscountSum	Integer	False
UnitNonDiscountSum	Integer	False

TemporaryTransactions

Returns a list of temprary transactions.

Columns


Name	Type	ReadOnly	References	Description
TransactionHeadId [KEY]	Integer	True
AdjustmentDateTime	Datetime	False
AdjustmentMile	Integer	False
AdjustmentMileDivision	String	False
AdjustmentMileValue	Integer	False
Amount	Integer	False
AuthDate	Date	False
AuthNumber	String	False
Barcode	String	False
CancelDateTime	Datetime	False
CancelDivision	String	False
CancelSlipNumber	String	False
CardCompany	String	False
Carriage	Integer	False
CashTotal	Integer	False
Change	Integer	False
Commission	Integer	False
CostTotal	Decimal	False
CouponDiscount	Integer	False
CreditDivision	String	False
CreditTotal	Integer	False
CurrentMile	Integer	False
Customer	String	False
CustomerCode	String	False
CustomerGroupId	Integer	False
CustomerGroupId2	Integer	False
CustomerGroupId3	Integer	False
CustomerGroupId4	Integer	False
CustomerGroupId5	Integer	False
CustomerGroups	String	False
CustomerId	Long	False
CustomerPinCode	String	False
CustomerRank	String	False
Denomination	String	False
Deposit	Integer	False
DepositCash	Integer	False
DepositCredit	Integer	False
DiscountRoundingDivision	String	False
DisposeDivision	String	False
DisposeServerTransactionHeadId	Integer	False
EarnMile	Integer	False
EnterDateTime	Datetime	False
ExchangeTicketNo	String	False
GiftReceiptValidDays	Integer	False
GuestNumbers	Integer	False
GuestNumbersFemale	Integer	False
GuestNumbersMale	Integer	False
GuestNumbersUnknown	Integer	False
InTaxSalesTotal	Integer	False
Memo	String	False
MileageDivision	String	False
MileageLabel	String	False
NetTaxFreeConsumableTaxExclude	Integer	False
NetTaxFreeConsumableTaxInclude	Integer	False
NetTaxFreeGeneralTaxExclude	Integer	False
NetTaxFreeGeneralTaxInclude	Integer	False
NewPoint	Integer	False
NonSalesTargetAmount	Integer	False
NonSalesTargetCostTotal	Decimal	False
NonSalesTargetInTaxTotal	Integer	False
NonSalesTargetOutTaxTotal	Integer	False
NonSalesTargetReturnAmount	Integer	False
NonSalesTargetTaxFreeTotal	Integer	False
NonSalesTargetTotal	Integer	False
NonTaxSalesTotal	Integer	False
OutTaxSalesTotal	Integer	False
PaymentCount	Integer	False
Point	Integer	False
PointDiscount	Integer	False
PointGivingDivision	String	False
PointGivingUnit	Decimal	False
PointGivingUnitPrice	Integer	False
PointSpendDivision	String	False
ReceiptMemo	String	False
ReturnAmount	String	False
ReturnSales	String	False
RoundingDivision	String	False
RoundingPrice	Integer	False
SalesHeadDivision	String	False
SequentialNumber	Integer	False
SellDivision	String	False
SlipNumber	String	False
SpendPoint	Integer	False
Staff	String	False
StaffCode	String	False
StaffId	Integer	False
StaffName	String	False
Status	String	False
Store	String	False
StoreCode	String	False
StoreId	Integer	False
Subtotal	Integer	False
SubtotalDiscountDivision	String	False
SubtotalDiscountPrice	Integer	False
SubtotalDiscountRate	Integer	False
SubtotalForDiscount	String	False
SumDate	Date	False
SumDivision	String	False
Tags	String	False
TaxExclude	Integer	False
TaxFreeSalesDivision	String	False
TaxInclude	Integer	False
TaxRate	Decimal	False
TaxRounding	String	False
TerminalId	Integer	False
TerminalTranDateTime	Datetime	False
TerminalTranId	Integer	False
TipCash	String	False
TipCredit	String	False
Total	Integer	False
TotalMile	Integer	False
TotalPoint	Integer	False
TransactionDateTime	Datetime	False
TransactionHeadDivision	String	False
TransactionUuid	String	False
UnitBargainDiscountsubtotal	Integer	False
UnitDiscountsubtotal	Integer	False
UnitNonDiscountsubtotal	Integer	False
UnitStaffDiscountsubtotal	Integer	False
UpdDateTime	Datetime	False
Details	String	False

Pseudo-Columns

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
WithCustomer	String
WithCustomerGroups	String
WithStore	String
WithStaff	String

Terminals

Returns a list of terminals.

Columns


Name	Type	ReadOnly	References	Description
TerminalId [KEY]	Integer	False
AppVersion	String	False
CashDrawerId	Integer	False
CreditTerminalId	Integer	False
InsDateTime	Datetime	False
ParentTerminalId	Integer	False
SelfCheckoutAvailableFlag	String	False
SmartIdEngineAvailableFlag	String	False
StoreId	Integer	False
TerminalName	String	False
TransactionEditableFlag	String	False
UpdDateTime	Datetime	False
UseStopDivision	String	False
Uuid	String	False

TransactionLayaways

Generated schema file.

Columns


Name	Type	ReadOnly	References	Description
TransactionHeadId [KEY]	Integer	True
AdjustmentDateTime	Datetime	False
AdjustmentMile	Integer	False
AdjustmentMileDivision	String	False
AdjustmentMileValue	Integer	False
Amount	Integer	False
AuthDate	Date	False
AuthNumber	String	False
CancelDateTime	Datetime	False
CancelDivision	String	False
CancelSlipNumber	String	False
CardCompany	String	False
Carriage	Integer	False
CashTotal	Integer	False
Change	Integer	False
Commission	Integer	False
CostTotal	Decimal	False
CreditDivision	String	False
CreditTotal	Integer	False
CurrentMile	Integer	False
Customer	String	False
CustomerCode	String	False
CustomerGroupId	Integer	False
CustomerGroupId2	Integer	False
CustomerGroupId3	Integer	False
CustomerGroupId4	Integer	False
CustomerGroupId5	Integer	False
CustomerGroups	String	False
CustomerId	Long	False
CustomerPinCode	String	False
CustomerRank	String	False
Denomination	String	False
Deposit	Integer	False
DepositCash	Integer	False
DepositCredit	Integer	False
DiscountRoundingDivision	String	False
Discounts	String	False
DisposeDivision	String	False
DisposeServerTransactionHeadId	String	False
EarnMile	Integer	False
EnterDateTime	Datetime	False
ExchangeTicketNo	String	False
GiftReceiptValidDays	Integer	False
GuestNumbers	Integer	False
GuestNumbersFemale	Integer	False
GuestNumbersMale	Integer	False
GuestNumbersUnknown	Integer	False
InTaxSalesTotal	Integer	False
Layaway	String	False
LayawayPickUp	String	False
Memo	String	False
MileageDivision	String	False
MileageLabel	String	False
NetTaxFreeConsumableTaxExclude	Integer	False
NetTaxFreeConsumableTaxInclude	Integer	False
NetTaxFreeGeneralTaxExclude	Integer	False
NetTaxFreeGeneralTaxInclude	Integer	False
NewPoint	Integer	False
NonSalesTargetAmount	Integer	False
NonSalesTargetCostTotal	Decimal	False
NonSalesTargetInTaxTotal	Integer	False
NonSalesTargetOutTaxTotal	Integer	False
NonSalesTargetReturnAmount	Integer	False
NonSalesTargetTaxFreeTotal	Integer	False
NonSalesTargetTotal	Integer	False
NonTaxSalesTotal	Integer	False
OutTaxSalesTotal	Integer	False
PaymentCount	Integer	False
Point	Integer	False
PointDiscount	Integer	False
PointGivingDivision	String	False
PointGivingUnit	Decimal	False
PointGivingUnitPrice	Integer	False
PointSpendDivision	String	False
ReceiptMemo	String	False
ReturnAmount	Integer	False
ReturnSales	String	False
RoundingDivision	String	False
RoundingPrice	Integer	False
SalesHeadDivision	String	False
SellDivision	String	False
SlipNumber	String	False
SpendPoint	Integer	False
Staff	String	False
StaffCode	String	False
StaffId	Integer	False
StaffName	String	False
Store	String	False
StoreCode	String	False
StoreId	Integer	False
Subtotal	Integer	False
SubtotalDiscountDivision	Integer	False
SubtotalDiscountPrice	Integer	False
SubtotalDiscountRate	Integer	False
SubtotalForDiscount	String	False
SumDate	Date	False
SumDivision	String	False
Tags	String	False
TaxExclude	Integer	False
TaxFreeSalesDivision	String	False
TaxInclude	Integer	False
TaxRate	Decimal	False
TaxRounding	String	False
TerminalId	Integer	False
TerminalTranDateTime	Datetime	False
TerminalTranId	Integer	False
TipCash	Integer	False
TipCredit	Integer	False
Total	Integer	False
TotalMile	Integer	False
TotalPoint	Integer	False
TransactionDateTime	Datetime	False
TransactionHeadDivision	String	False
TransactionUuid	String	False
UnitBargainDiscountsubtotal	Integer	False
UnitDiscountsubtotal	Integer	False
UnitNonDiscountsubtotal	Integer	False
UnitStaffDiscountsubtotal	Integer	False
UpdDateTime	Datetime	False
Details	String	False

Pseudo-Columns

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
WithCustomer	String
WithCustomerGroups	String
WithDiscounts	String
WithStore	String
WithStaff	String
WithLayway	String
WithLaywayPickUp	String

Transactions

Generated schema file.

Columns


Name	Type	ReadOnly	References	Description
TransactionHeadId [KEY]	Integer	True
AdjustmentDateTime	Datetime	False
AdjustmentMile	Integer	False
AdjustmentMileDivision	String	False
AdjustmentMileValue	Integer	False
Amount	Integer	False
AuthDate	Date	False
AuthNumber	String	False
Barcode	String	False
CancelDateTime	Datetime	False
CancelDivision	String	False
CancelSlipNumber	String	False
CardCompany	String	False
Carriage	Integer	False
CashTotal	Integer	False
Change	Integer	False
Commission	Integer	False
CostTotal	Decimal	False
CouponDiscount	String	False
CreditDivision	String	False
CreditTotal	String	False
CurrentMile	Integer	False
Customer	String	False
CustomerCode	String	False
CustomerGroupId	Integer	False
CustomerGroupId2	Integer	False
CustomerGroupId3	Integer	False
CustomerGroupId4	Integer	False
CustomerGroupId5	Integer	False
CustomerGroups	String	False
CustomerId	Long	False
CustomerPinCode	String	False
CustomerRank	String	False
Denomination	String	False
Deposit	Integer	False
DepositCash	Integer	False
DepositCredit	Integer	False
DiscountRoundingDivision	String	False
Discounts	String	False
DisposeDivision	String	False
DisposeServerTransactionHeadId	Integer	False
EarnMile	Integer	False
EnterDateTime	Datetime	False
ExchangeTicketNo	String	False
GiftReceiptValidDays	Integer	False
GuestNumbers	Integer	False
GuestNumbersFemale	Integer	False
GuestNumbersMale	Integer	False
GuestNumbersUnknown	Integer	False
InTaxSalesTotal	Integer	False
Layaway	String	False
Layaways	String	False
LayawayPickUp	String	False
Memo	String	False
MileageDivision	String	False
MileageLabel	String	False
MoneyControls	String	False
NetTaxFreeConsumableTaxExclude	Integer	False
NetTaxFreeConsumableTaxInclude	Integer	False
NetTaxFreeGeneralTaxExclude	Integer	False
NetTaxFreeGeneralTaxInclude	Integer	False
NewPoint	Integer	False
NonSalesTargetAmount	Integer	False
NonSalesTargetCostTotal	Decimal	False
NonSalesTargetInTaxTotal	Integer	False
NonSalesTargetOutTaxTotal	Integer	False
NonSalesTargetReturnAmount	Integer	False
NonSalesTargetTaxFreeTotal	Integer	False
NonSalesTargetTotal	Integer	False
NonTaxSalesTotal	Integer	False
OutTaxSalesTotal	Integer	False
PaymentCount	Integer	False
Point	Integer	False
PointDiscount	Integer	False
PointGivingDivision	String	False
PointGivingUnit	Decimal	False
PointGivingUnitPrice	Integer	False
PointSpendDivision	String	False
ReceiptMemo	String	False
RecordedStaffs	String	False
ReturnAmount	String	False
ReturnSales	String	False
RoundingDivision	String	False
RoundingPrice	Integer	False
SalesHeadDivision	String	False
SellDivision	String	False
SlipNumber	String	False
SpendPoint	Integer	False
Staff	String	False
StaffCode	String	False
StaffId	Integer	False
StaffName	String	False
Store	String	False
StoreCode	String	False
StoreId	Integer	False
Subtotal	Integer	False
SubtotalDiscountDivision	Integer	False
SubtotalDiscountPrice	Integer	False
SubtotalDiscountRate	Integer	False
SubtotalForDiscount	String	False
SumDate	Date	False
SumDivision	String	False
Tags	String	False
TaxExclude	Integer	False
TaxFreeSalesDivision	String	False
TaxInclude	Integer	False
TaxRate	Decimal	False
TaxRounding	String	False
TerminalId	Integer	False
TerminalTranDateTime	Datetime	False
TerminalTranId	Integer	False
TipCash	Integer	False
TipCredit	Integer	False
Total	Integer	False
TotalMile	Integer	False
TotalPoint	Integer	False
TransactionDateTime	Datetime	False
TransactionHeadDivision	String	False
TransactionUuid	String	False
UnitBargainDiscountsubtotal	Integer	False
UnitDiscountsubtotal	Integer	False
UnitNonDiscountsubtotal	Integer	False
UnitStaffDiscountsubtotal	Integer	False
UpdDateTime	Datetime	False
Details	String	False
DepositOthers	String	False
Coupons	String	False
CouponItems	String	False
LayawayPickUps	String	False

Pseudo-Columns

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
WithCustomer	String
WithCustomerGroups	String
WithDiscounts	String
WithStore	String
WithStaff	String
WithRecordedStaff	String
WithLayway	String
WithLayways	String
WithLaywayPickUp	String
WithMoneyControl	String

Views

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.

Smaregi Connector for CData Sync Views


Name	Description
Adjustments	Returns a list of adjustments.
CatCardCompanies	Returns a list of CAT/CCT card comanies.
ConsumptionTaxRates	Returns a list of consumption tax rates.
CustomerRequiredColumnSettings	Returns a list of customer required column settings.
DailySummaries	Returns daily summaries.
DiscountDivisions	Returns a list of discount divisions.
LossDetails	Returns details of the specified loss.
MonthlyBudget	Read the monthly budget.
PaymentMethodsStore	Returns stores using the specified payment method.
ProductImages	Returns a list of urls of product images.
ProductOrderPoints	Returns a list of product order points.
ProductsOrderSettings	Returns product order settings of the specified product.
ProductsPricesChanges	Returns price changes of the specified product.
ProductStores	Returns a list of stores of the specified product.
PurchaseOrdersProducts	Returns a list of products for a specified purchase order.
PurchaseOrdersProductsDeliveryStores	Returns a list of delivery stores for a specified purchase order.
PurchaseOrdersStores	Returns a list of stores for a specified purchase order.
ReceiptProvisoes	Returns a list of receipt provisoes.
ReceivingDetails	Returns receiving details for a specified receiving transaction.
ReduceTaxRates	Returns a list or reduce tax rates.
RoleAlertFunctionControls	Returns a list of alert function controls for a specified role.
RoleFunctionControls	Returns a list of function controls for a specified role.
RoleInventoryFunctionControls	Returns a list of inventory function controls for a specified role.
ShipmentDetails	Generated schema file.
ShippingDetails	Generated schema file.
Staffs	Returns a list of staffs.
StaffStores	Generated schema file.
StockChanges	Returns a list of stock changes.
Stocktaking	Returns a list of stocktaking transactions.
StocktakingCategories	Returns a list of stocktaking categories.
StocktakingDetails	Generated schema file.
StocktakingProducts	Generated schema file.
StorageDetails	Returns a list of storage.
StorePaymentMethods	Generated schema file.
StorePointConditions	Generated schema file.
StoreProductPrices	Generated schema file.
StoreProducts	Generated schema file.
StoreReceiptPrintInfo	Generated schema file.
TransactionCouponItems	Generated schema file.
TransactionCoupons	Generated schema file.
TransactionDepositOthers	Generated schema file.
TransactionDetails	Generated schema file.
TransactionDetailsDiscounts	Returns a list of discounts for a specified transaction details.
TransactionDetailsProductAttributes	Returns a list of product attributes for a specified transaction details.
TransactionDiscounts	Returns a list of discounts for a specified transaction.
TransactionLayawayDetails	Generated schema file.
TransactionLayawayPickUps	Generated schema file.
TransactionProductSets	Returns a list of coupon transactions

Adjustments

Returns a list of adjustments.

Columns

References Description Integer Datetime Decimal Decimal Decimal Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Integer Decimal String Decimal Integer Decimal Decimal Decimal String Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Decimal Integer Decimal Decimal Decimal Integer Date />


Name	Type style="white-space:nowrap">StoreId
AdjustmentDateTime
CalculateBalance
CashAdjustmentCarryOver
CashAdjustmentDifference
CashAdjustmentFiftyYen
CashAdjustmentFiveHundredYen
CashAdjustmentFiveThousandYen
CashAdjustmentFiveYen
CashAdjustmentOneHundredYen
CashAdjustmentOneThousandYen
CashAdjustmentOneYen
CashAdjustmentRealBalance
CashAdjustmentSaving
CashAdjustmentTenThousandYen
CashAdjustmentTenYen
CashAdjustmentTwoThousandYen
CashSales
ChildTerminals
CreditSales
Deposit
NonSalesCashTotal
NonSalesCreditTotal
NonSalesOtherTotal
OtherSalesList
PartPayment
PartPaymentCancel
PartPaymentCash
PartPaymentCashCancel
PartPaymentCredit
PartPaymentCreditCancel
Payment
PreparationCash
Receipt
ReceivedDeposit
ReceivedDepositCash
ReceivedDepositCredit
ReturnDeposit
TerminalId
Tip
TipCash
TipCredit
TransactionCount
AdjustmentDate

CatCardCompanies

Returns a list of CAT/CCT card comanies.

Columns


Name	Type	References	Description
CatCardCompanyCode	String
CatCardCompanyName	String
DisplayFlag	String
DisplaySequence	Integer
InsDateTime	Datetime
Kid	String
UpdDateTime	Datetime

ConsumptionTaxRates

Returns a list of consumption tax rates.

Columns


Name	Type	References	Description
ApplyStartDate	Date
TaxRate	Decimal
TaxRounding	String
TargetDate	Date

CustomerRequiredColumnSettings

Returns a list of customer required column settings.

Columns


Name	Type	References	Description
ColumnName	String
DisplaySequence	Integer
InitialValue	String
InsDateTime	Datetime
UpdDateTime	Datetime
Value	String

DailySummaries

Returns daily summaries.

Columns


Name	Type	References	Description
Amount	Integer
CalculateBalance	Integer
Carriage	Integer
CarryOver	Integer
CashDrawerId	Integer
CashSales	Integer
ChangeDifference	Integer
Comment	String
Commission	Integer
CostTotal	Decimal
CreditSales	Integer
Deposit	Integer
Difference	Integer
Discount	Integer
FiftyYen	Integer
FiveHundredYen	Integer
FiveThousandYen	Integer
FiveYen	Integer
GrossMargin	Integer
InsDateTime	Datetime
InTaxSalesTotal	Integer
NonSalesCashTotal	Integer
NonSalesCreditTotal	Integer
NonSalesOtherTotal	Integer
NonSalesTargetTaxFreeTotal	Integer
NonSalesTargetTotal	Integer
NonSalesTaxFreeTotal	Integer
NonTaxSalesTotal	Integer
OneHundredYen	Integer
OneThousandYen	Integer
OneYen	Integer
OtherSalesList	String
OutTaxSalesTotal	Integer
PartPayment	Integer
PartPaymentCancel	Integer
PartPaymentCash	Integer
PartPaymentCashCancel	Integer
PartPaymentCredit	Integer
PartPaymentCreditCancel	Integer
Payment	Integer
PointDiscount	Integer
PreparationCash	Integer
RealBalance	Integer
Receipt	Integer
ReceivedDepositCash	Integer
ReceivedDepositCashTotal	Integer
ReceivedDepositCreditTotal	Integer
ReturnAmount	Integer
ReturnDeposit	Integer
SalesTotal	Integer
SalesTotalNonSalesTargetDivision	String
Saving	Integer
Status	String
StoreId	Integer
SumDate	Date
TaxDetailList	String
TaxExclude	Integer
TaxExcludeReceive	Integer
TaxFreeTotal	Integer
TaxInclude	Integer
TaxTotal	Integer
TenThousandYen	Integer
TenYen	Integer
Total	Integer
TotalExcludeTax	Integer
TotalExcludTax	Integer
TotalTaxFreeDivision	String
TransactionCount	Integer
TwoThousandYen	Integer
UpdDateTime	Datetime

DiscountDivisions

Returns a list of discount divisions.

Columns


Name	Type	References	Description
AwardType	String
DiscountDivision	String
DiscountDivisionName	String
DisplayFlag	String
DisplaySequence	Integer
InsDateTime	Datetime
UpdDateTime	Datetime

LossDetails

Returns details of the specified loss.

Columns


Name	Type	References	Description
LossId [KEY]	Integer	Losses.LossId
LossDetailId [KEY]	Integer
ProductId	Long
TaxRate	Decimal
Cost	Decimal
Quantity	Integer
RfidTags	String
InsDateTime	Datetime
UpdDateTime	Datetime

MonthlyBudget

Read the monthly budget.

Columns


Name	Type	References	Description
StoreId [KEY]	Integer	Stores.StoreId
InsDateTime	Datetime
SalesTargetMonthly	Decimal
UpdDateTime	Datetime
Ym	String

PaymentMethodsStore

Returns stores using the specified payment method.

Columns


Name	Type	References	Description
PaymentMethodId [KEY]	Integer	PaymentMethods.PaymentMethodId
StoreId [KEY]	Integer	Stores.StoreId
AssignDivision	String

ProductImages

Returns a list of urls of product images.

Columns


Name	Type	References	Description
ProductId	Long
Url	String

ProductOrderPoints

Returns a list of product order points.

Columns


Name	Type	References	Description
StoreId	Integer	Stores.StoreId
ProductId	Long	Products.ProductId
OrderPoint	Number
UpdDateTime	Datetime

ProductsOrderSettings

Returns product order settings of the specified product.

Columns


Name	Type	References	Description
ProductId [KEY]	Long	Products.ProductId
ContinuationDivision	String
OrderStatusDivision	String
OrderNoReasonDivision	String
OrderLimitAmount	Integer
OrderSupplierEditable	String
PbDivision	String
DisplayFlag	String
OrderUnit	String
Stores	String

ProductsPricesChanges

Returns price changes of the specified product.

Columns


Name	Type	References	Description
ProductId [KEY]	Long	Products.ProductId
Id	Integer
AfterPrice	Integer
AfterTaxDivision	String
BeforePrice	Integer
BeforeTaxDivision	String
PriceDivision	String
ProcDetailDivision	String
ProcDivision	String
UpdDateTime	Datetime

ProductStores

Returns a list of stores of the specified product.

Columns


Name	Type	References	Description
ProductId [KEY]	Long	Products.ProductId
StoreId [KEY]	Integer
AssignDivision	String

PurchaseOrdersProducts

Returns a list of products for a specified purchase order.

Columns


Name	Type	References	Description
StorageInfoId [KEY]	Integer
Cost	Decimal
InsDateTime	Datetime
ProductId	Long
Quantity	Integer
StorageInfoProductId	Integer
TaxDivision	String
TaxRate	Decimal
UpdDateTime	Datetime
DeliveryStores	String

PurchaseOrdersProductsDeliveryStores

Returns a list of delivery stores for a specified purchase order.

Columns


Name	Type	References	Description
PurchaseOrderId [KEY]	Integer
StoreId	Integer
StorageInfoDeliveryProductId	Integer
Quantity	Integer

PurchaseOrdersStores

Returns a list of stores for a specified purchase order.

Columns


Name	Type	References	Description
StorageInfoId [KEY]	Integer
InsDateTime	Datetime
StorageExpectedDateFrom	Date
StorageExpectedDateTo	Date
StorageInfoDeliveryId	Integer
StorageStoreId	Integer
UpdDateTime	Datetime

ReceiptProvisoes

Returns a list of receipt provisoes.

Columns


Name	Type	References	Description
DisplayFlag	String
DisplaySequence	Integer
InitialValueFlag	String
InsDateTime	Datetime
ReceiptProvisoCode	String
ReceiptProvisoName	String
UpdDateTime	Datetime

ReceivingDetails

Returns receiving details for a specified receiving transaction.

Columns


Name	Type	References	Description
ReceivingId	Integer	Receiving.ReceivingId
InsDateTime	Datetime
InspectionDate	Date
InspectionQuantity	Integer
ProductId	Long
ReceivingDetailId	Integer
RfidTags	String
ScheduledQuantity	Integer
Status	String
StockoutQuantity	Integer
StockoutReason	String
UpdDateTime	Datetime

ReduceTaxRates

Returns a list or reduce tax rates.

Columns


Name	Type	References	Description
AdvancedCondition	String
Condition	String
Division	String
InsDateTime	Datetime
Name	String
Rate	Decimal
ReduceTaxId	Integer
TermEnd	Date
TermStart	Date
UpdDateTime	Datetime
TargetDate	Date

RoleAlertFunctionControls

Returns a list of alert function controls for a specified role.

Columns


Name	Type	References	Description
RoleId [KEY]	Integer
AlertType	String
ControlDivision	String

RoleFunctionControls

Returns a list of function controls for a specified role.

Columns


Name	Type	References	Description
RoleId [KEY]	Integer
FunctionId	Integer
ControlDivision	String

RoleInventoryFunctionControls

Returns a list of inventory function controls for a specified role.

Columns


Name	Type	References	Description
RoleId [KEY]	Integer
FunctionId	Integer
ControlDivision	String

ShipmentDetails

Generated schema file.

Columns


Name	Type	References	Description
ShipmentId	Integer	Shipments.ShipmentId
Cost	Decimal
InsDateTime	Datetime
Memo	String
Price	Integer
ProductId	Long
Quantity	Integer
RfidTags	String
ShipmentDetailId	Integer
TaxRate	Decimal
UpdDateTime	Datetime

ShippingDetails

Generated schema file.

Columns


Name	Type	References	Description
ShippingId	Integer	Shipping.ShippingId
Cost	Decimal
InsDateTime	Datetime
Price	Integer
ProductId	Long
Quantity	Integer
RequestQuantity	Integer
RfidTags	String
ShippingDetailId	Integer
Status	String
UpdDateTime	Datetime

Staffs

Returns a list of staffs.

Columns


Name	Type	References	Description
StaffId [KEY]	Integer
DisplayFlag	String
DisplaySequence	Integer
Email	String
InsDateTime	Datetime
LoginIpAddress	String
LoginStaffFlag	String
Rank	String
RoleId	Integer
StaffCode	String
StaffName	String
StaffNameKana	String
UpdDateTime	Datetime
Stores	String
UserId	String

StaffStores

Generated schema file.

Columns


Name	Type	References	Description
StaffId [KEY]	Integer	Staffs.StaffId
StoreId [KEY]	Integer	Stores.StoreId
ControlDivision	String

StockChanges

Returns a list of stock changes.

Columns


Name	Type	References	Description
ProductId [KEY]	Long
StoreId [KEY]	Integer
Amount	Integer
Cost	Decimal
FromStoreId	Integer
Id	Integer
LayawayStockAmount	Integer
Memo	String
Price	Integer
StaffId	Integer
StaffName	String
StockAmount	Integer
StockDivision	String
TargetDateTime	Datetime
TaxDivision	String
ToStoreId	Integer
UpdDateTime	Datetime

Stocktaking

Returns a list of stocktaking transactions.

Columns


Name	Type	References	Description
StocktakingInfoId	Integer
AdjustmentDateTime	Datetime
AutoFollowingFlag	String
DivisionUnit	String
InsDateTime	Datetime
LayawayStockIncludeFlag	String
Status	String
StockCountDivision	String
StocktakingCompleteDateTime	Datetime
StocktakingInputCompleteDate	String
StoreId	Integer
TargetDate	Date
UpdDateTime	Datetime

StocktakingCategories

Returns a list of stocktaking categories.

Columns


Name	Type	References	Description
StocktakingInfoId [KEY]	Integer	Stocktaking.StocktakingInfoId
CategoryId	Integer

StocktakingDetails

Generated schema file.

Columns


Name	Type	References	Description
StocktakingInfoId [KEY]	Integer	Stocktaking.StocktakingInfoId
CategoryId	Integer
LayawayMoney	Integer
LayawayQuantity	Integer
ProductId	Long	Products.ProductId
StockMoney	Integer
StockQuantity	Integer
StoreId	Integer	Stores.StoreId
TransportationMoney	Integer
TransportationQuantity	Integer
BaseDate	Date

StocktakingProducts

Generated schema file.

Columns


Name	Type	References	Description
CategoryId	Integer
Cost	Decimal
InputStocktakingQuantity	Integer
InsDateTime	Datetime
LayawayStockQuantity	Integer
Memo	String
ProductId	Long
QuantityModifiedDatetime	Datetime
RfidTags	String
StockQuantityBeforeAdjustment	Integer
StocktakingQuantity	Integer
TransportationStockQuantity	Integer
UpdDateTime	Datetime
StocktakingInfoId	Integer

StorageDetails

Returns a list of storage.

Columns


Name	Type	References	Description
StorageId	Integer	Storage.StorageId
CompulsoryCompleteFlag	String
Cost	Decimal
DateMemo	String
InsDateTime	Datetime
InspectionDate	Date
InspectionQuantity	Integer
NumberMemo	String
ProductId	Long	Products.ProductId
RfidTags	String
ScheduledQuantity	Integer
Status	String
StockoutQuantity	Integer
StockoutReason	String
StorageDetailId	Integer
StorageInfoId	Integer
TaxRate	Decimal
UpdDateTime	Datetime

StorePaymentMethods

Generated schema file.

Columns


Name	Type	References	Description
ChangeFlag	String
DisplayFlag	String
DisplaySequence	Integer
InsDateTime	Datetime
PaymentMethodCode	String
PaymentMethodGroupId	Integer
PaymentMethodId	String
PaymentMethodName	String
PointGivingUnit	Decimal
PointGivingUnitPrice	Integer
SecuritiesFlag	String
UnitPrice	Integer
UpdDateTime	Datetime
StoreId	Integer	Stores.StoreId

StorePointConditions

Generated schema file.

Columns


Name	Type	References	Description
StoreId	Integer	Stores.StoreId
PointUseDivision	String
SpendRate	String
PointGivingUnitPrice	Integer
PointGivingUnit	Decimal
PointGivingDivision	String
PointUseUnit	String
PointSpendDivision	String
PointSpendLimitDivision	String
ExpireDivision	String
ExpireLimit	String
MileageDivision	String
MileageLimit	String

StoreProductPrices

Generated schema file.

Columns


Name	Type	References	Description
StoreId	Integer	Stores.StoreId
EndDate	Date
Price	Integer
PriceDivision	String
ProductId	Long	Products.ProductId
StartDate	Date
UpdDateTime	Datetime
TargetDate	Date

StoreProducts

Generated schema file.

Columns


Name	Type	References	Description
AppStartDateTime	Datetime
Attribute	String
CalcDiscount	String
CatchCopy	String
CategoryId	Integer
Color	String
Cost	Decimal
CustomerPrice	Integer
Description	String
DisplayFlag	String
DisplaySequence	Integer
Division	String
GroupCode	String
InsDateTime	Datetime
OrderPoint	Integer
PointNotApplicable	String
Price	Integer
PrintReceiptProductName	String
ProductCode	String
ProductId	Long
ProductKana	String
ProductName	String
ProductOptionGroupId	Integer
ProductPriceDivision	String
PurchaseCost	Decimal
ReduceTaxCustomerPrice	Integer
ReduceTaxId	Integer
ReduceTaxPrice	Integer
SalesDivision	String
Size	String
StaffDiscountRate	Integer
StockControlDivision	String
SupplierProductNo	String
Tag	String
TaxDivision	String
TaxFreeDivision	String
UpdDateTime	Datetime
Url	String
UseCategoryReduceTax	String
Stores	String
StoreId	Integer	Stores.StoreId
WithStores	String

StoreReceiptPrintInfo

Generated schema file.

Columns


Name	Type	References	Description
StoreId	Integer	Stores.StoreId
header	String
footer	String
receiptTaxOfficeStampComment	String
taxOfficeName	String
airPrintLogo	String
advertisementImage	String
giftReceiptImage	String
giftReceiptNote	String
discountReceiptHeader	String
discountReceiptFooter	String

TransactionCouponItems

Generated schema file.

Columns


Name	Type	References	Description
TransactionHeadId [KEY]	Integer
TransactionCouponDetailId	Integer
TransactionCouponId	Integer
TerminalTranCouponId	Integer
TransactionDetailId	Integer
CouponItemId	Integer

TransactionCoupons

Generated schema file.

Columns


Name	Type	References	Description
TransactionHeadId [KEY]	Integer
TransactionCouponId	Integer
TerminalTranCouponId	Integer
CouponId	Integer
CouponName	String
CouponDivision	String
SerialNumber	String
AwardType	String
AwardValue	Integer
DiscountPrice	Integer

TransactionDepositOthers

Generated schema file.

Columns


Name	Type	References	Description
TransactionHeadId	Integer
No	String
paymentMethodId	Integer
paymentMethodCode	String
paymentMethodName	String
depositOthers	String
paymentUnitPrice	Integer
paymentChangeFlag	String
paymentDivision	String
paymentSecuritiesFlag	String
denominationCode	String
denominationName	String
cardCompanyName	String
slipNumber	String
cancelSlipNumber	String
pointGivingUnitPrice	Integer
pointGivingUnit	Decimal

TransactionDetails

Generated schema file.

Columns


Name	Type	References	Description
TransactionHeadId	Integer	Transactions.TransactionHeadId
TransactionDetailId	Integer
ApplyBargainDiscountPrice	Integer
ApplyBargainValue	String
ApplyStaffDiscountPrice	Integer
ApplyStaffDiscountRate	Integer
BargainDiscountProportional	Integer
BargainDivision	String
BargainId	Integer
BargainName	String
BargainValue	Integer
CalcDiscount	String
CategoryId	Integer
CategoryName	String
Color	String
Cost	Decimal
CostSum	Decimal
DiscountCouponProportional	Integer
DiscountPointProportional	Integer
DiscountPriceProportional	Integer
DiscriminationNo	String
GroupCode	String
InventoryReservationDivision	String
Memo	String
ModifiedTaxRate	Decimal
ParentTransactionDetailId	Integer
PointNotApplicable	String
Price	Integer
PrintReceiptProductName	String
ProductBundleGroupId	Integer
ProductBundleProportional	Integer
ProductCode	String
ProductDivision	String
ProductId	Long	Products.ProductId
ProductName	String
ProductStaffDiscountRate	Integer
Quantity	Integer
ReduceTaxId	Integer
ReduceTaxMemberPrice	Integer
ReduceTaxName	String
ReduceTaxPrice	Integer
ReduceTaxRate	Decimal
RfidTags	String
RoundingPriceProportional	Integer
SalesDivision	String
SalesPrice	Integer
Size	String
StaffDiscountDivision	String
StaffDiscountProportional	Integer
StaffDiscountRate	Integer
StaffRank	String
StaffRankName	String
StandardTaxRate	String
TaxDivision	String
TaxExcludeProportional	Integer
TaxFree	String
TaxFreeCommodityPrice	Integer
TaxFreeDivision	String
TaxIncludeProportional	Integer
TaxRate	Decimal
TransactionDetailDivision	String
UnitDiscountDivision	String
UnitDiscountedSum	Integer
UnitDiscountPrice	Integer
UnitDiscountRate	Integer
UnitDiscountSum	Integer
UnitNonDiscountSum	Integer
Discounts	String
ProductAttributesunts	String
WithDiscounts	String
WithDetailProductAttributes	String

TransactionDetailsDiscounts

Returns a list of discounts for a specified transaction details.

Columns


Name	Type	References	Description
TransactionHeadId	Integer	Transactions.TransactionHeadId
TransactionDetailId	Integer	TransactionDetails.TransactionDetailId
TransactionDiscountDivision	String
DiscountDivision	String
DiscountDivisionName	String
AwardType	String
AwardValue	Integer
DiscountPrice	Integer

TransactionDetailsProductAttributes

Returns a list of product attributes for a specified transaction details.

Columns


Name	Type	References	Description
TransactionHeadId	Integer	Transactions.TransactionHeadId
TransactionDetailId	Integer	TransactionDetails.TransactionDetailId
Code	String
Name	String

TransactionDiscounts

Returns a list of discounts for a specified transaction.

Columns


Name	Type	References	Description
TransactionHeadId	Integer	Transactions.TransactionHeadId
TransactionDetailId	Integer
TransactionDiscountDivision	String
DiscountDivision	String
DiscountDivisionName	String
AwardType	String
AwardValue	Integer
DiscountPrice	Integer

TransactionLayawayDetails

Generated schema file.

Columns


Name	Type	References	Description
TransactionHeadId	Integer	TransactionLayaways.TransactionHeadId
ApplyBargainDiscountPrice	Integer
ApplyBargainValue	Integer
ApplyStaffDiscountPrice	Integer
ApplyStaffDiscountRate	Integer
BargainDiscountProportional	Integer
BargainDivision	String
BargainId	Integer
BargainName	String
BargainValue	Integer
CalcDiscount	String
CategoryId	Integer
CategoryName	String
Color	String
Cost	Decimal
CostSum	Decimal
DiscountCouponProportional	Integer
DiscountPointProportional	Integer
DiscountPriceProportional	Integer
DiscriminationNo	String
GroupCode	String
InventoryReservationDivision	String
Memo	String
ModifiedTaxRate	Decimal
ParentTransactionDetailId	Integer
PointNotApplicable	String
Price	Integer
PrintReceiptProductName	String
ProductBundleGroupId	Integer
ProductBundleProportional	Integer
ProductCode	String
ProductDivision	String
ProductId	Long
ProductName	String
ProductStaffDiscountRate	Integer
Quantity	Integer
ReduceTaxId	Integer
ReduceTaxMemberPrice	Integer
ReduceTaxName	String
ReduceTaxPrice	Integer
ReduceTaxRate	Decimal
RfidTags	String
RoundingPriceProportional	Integer
SalesDivision	String
SalesPrice	Integer
Size	String
StaffDiscountDivision	String
StaffDiscountProportional	Integer
StaffDiscountRate	Integer
StaffRank	String
StaffRankName	String
StandardTaxRate	Decimal
TaxDivision	String
TaxExcludeProportional	Integer
TaxFree	String
TaxFreeCommodityPrice	Integer
TaxFreeDivision	String
TaxIncludeProportional	Integer
TaxRate	Decimal
TransactionDetailDivision	String
TransactionDetailId	Integer
UnitDiscountDivision	String
UnitDiscountedSum	Integer
UnitDiscountPrice	Integer
UnitDiscountRate	Integer
UnitDiscountSum	Integer
UnitNonDiscountSum	Integer
WithDiscounts	String
WithDetailProductAttributes	String

TransactionLayawayPickUps

Generated schema file.

Columns


Name	Type	References	Description
TransactionHeadId	Integer	TransactionLayaways.TransactionHeadId
LayawayServerTransactionHeadId	Integer
ReceivedDepositCash	Integer
ReceivedDepositCredit	Integer

TransactionProductSets

Returns a list of coupon transactions

Columns


Name	Type	References	Description
TransactionHeadId	Integer	Transactions.TransactionHeadId
TransactionProductSetId	Integer
TransactionDetailId	Integer
ProductSetId	Integer
ProductSetCode	String
ProductSetName	String
ProductSetPrice	Integer
ProductSetCategoryId	String
ProductSetCategoryName	String
CustomerId	Long
PurchaseDateTime	Datetime
ExpireDate	Date
ConsumeDateTime	Datetime
Status	String
OptionConsumeLimit	String

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Smaregi.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Smaregi, along with an indication of whether the procedure succeeded or failed.

Smaregi Connector for CData Sync Stored Procedures


Name	Description
ApproveShipping	Approve a shipping.
CompleteShippingModificationRequest	Complete a shipping modification request.
DeleteProductIconImage	Delete a product icon image.
DeleteProductImage	Delete a product image.
DisposeTransaction	Dispose a transaction.
DisposeTransactionLayaway	Dispose a transaction layaway.
ExecuteAdjustment	Execute adjustment.
ExecuteDailySummary	Execute daily summary.

ApproveShipping

Approve a shipping.

Input


Name	Type	Required	Description
ShippingId	Integer	True
ApprovalStatus	String	True
ReceivingExpectedDateFrom	Date	False
ReceivingExpectedDateTo	Date	False
ShippingDate	Date	False
Memo	String	False

Result Set Columns


Name	Type	Description
ProductId	Long
ShippingId	Integer
ReceivingStoreId	Integer
ShippingStoreId	Integer
ReceivingDesiredDate	Date
ReceivingExpectedDateFrom	Date
ReceivingExpectedDateTo	Date
ShippingDate	Date
StaffId	Integer
RequestStaffId	Integer
Memo	String
IdentificationNo	String
Status	String
ApprovalStatus	String
ApprovalDateTime	Datetime
ModificationRequestStatus	String
ModificationRequestDateTime	Datetime
ModificationRequestCheckedDateTime	Datetime
InsDateTime	Datetime
UpdDateTime	Datetime

CompleteShippingModificationRequest

Complete a shipping modification request.

Input


Name	Type	Required	Description
ShippingId	Integer	True
Memo	String	False

DeleteProductIconImage

Delete a product icon image.

Input


Name	Type	Required	Description
ProductId	Long	True

DeleteProductImage

Delete a product image.

Input


Name	Type	Required	Description
ProductId	Long	True	ProductId

DisposeTransaction

Dispose a transaction.

Input


Name	Type	Required	Description
TransactionHeadId	Integer	True
TerminalTranDateTime	Datetime	False
DipositOthers	String	False

Result Set Columns


Name	Type	Description
TransactionHeadId	Integer
TransactionDateTime	Datetime
TransactionHeadDivision	String
CancelDivision	String
UnitNonDiscountsubtotal	Integer
UnitDiscountsubtotal	Integer
UnitStaffDiscountsubtotal	Integer
UnitBargainDiscountsubtotal	Integer
Subtotal	Integer
SubtotalForDiscount	Integer
SubtotalDiscountPrice	Integer
SubtotalDiscountRate	Integer
SubtotalDiscountDivision	Integer
PointDiscount	Integer
CouponDiscount	Integer
Total	Integer
TaxInclude	Integer
TaxExclude	Integer
RoundingDivision	String
RoundingPrice	Integer
CashTotal	Integer
CreditTotal	Integer
Deposit	Integer
DepositCash	Integer
DepositCredit	Integer
Change	Integer
TipCash	Integer
TipCredit	Integer
Amount	Integer
ReturnAmount	Integer
CostTotal	Decimal
SalesHeadDivision	String
InTaxSalesTotal	Integer
OutTaxSalesTotal	Integer
NonTaxSalesTotal	Integer
NonSalesTargetTotal	Integer
NonSalesTargetInTaxTotal	Integer
NonSalesTargetOutTaxTotal	Integer
NonSalesTargetTaxFreeTotal	Integer
NonSalesTargetCostTotal	Decimal
NonSalesTargetAmount	Integer
NonSalesTargetReturnAmount	Integer
NewPoint	Integer
SpendPoint	Integer
Point	Integer
TotalPoint	Integer
CurrentMile	Integer
EarnMile	Integer
TotalMile	Integer
AdjustmentMile	Integer
AdjustmentMileDivision	String
AdjustmentMileValue	Integer
StoreId	Integer
TerminalId	Integer
CustomerId	Long
TerminalTranId	Integer
TerminalTranDateTime	Datetime
SumDivision	String
AdjustmentDateTime	Datetime
SumDate	Date
CustomerRank	String
CustomerGroupId	Integer
CustomerGroupId2	Integer
CustomerGroupId3	Integer
CustomerGroupId4	Integer
CustomerGroupId5	Integer
StaffId	Integer
StaffName	String
CreditDivision	String
PaymentCount	String
SlipNumber	String
CancelSlipNumber	String
AuthNumber	String
AuthDate	Date
CardCompany	String
Denomination	String
Memo	String
ReceiptMemo	String
Carriage	Integer
Commission	Integer
GuestNumbers	Integer
GuestNumbersMale	Integer
GuestNumbersFemale	Integer
GuestNumbersUnknown	Integer
EnterDateTime	Datetime
TaxFreeSalesDivision	String
NetTaxFreeGeneralTaxInclude	Integerg
NetTaxFreeGeneralTaxExclude	Integerg
NetTaxFreeConsumableTaxInclude	Integerg
NetTaxFreeConsumableTaxExclude	Integerg
Tags	String
PointGivingDivision	String
PointGivingUnitPrice	Integer
PointGivingUnit	Decimal
PointSpendDivision	String
MileageDivision	String
MileageLabel	String
CustomerPinCode	String
ReturnSales	String
DisposeDivision	String
DisposeServerTransactionHeadId	Integer
CancelDateTime	Datetime
SellDivision	String
TaxRate	Decimal
TaxRounding	String
DiscountRoundingDivision	String
TransactionUuid	String
ExchangeTicketNo	String
GiftReceiptValidDays	Integer
UpdDateTime	Datetime
Details	String
DepositOthers	String
Coupons	String
CouponItems	String
RecordedStaff	String

DisposeTransactionLayaway

Dispose a transaction layaway.

Input


Name	Type	Required	Description
TransactionHeadId	Integer	True
TerminalTranDateTime	Datetime	False

Result Set Columns


Name	Type	Description
TransactionHeadId	Integer
TransactionDateTime	Datetime
TransactionHeadDivision	String
CancelDivision	String
UnitNonDiscountsubtotal	Integer
UnitDiscountsubtotal	Integer
UnitStaffDiscountsubtotal	Integer
UnitBargainDiscountsubtotal	Integer
Subtotal	Integer
SubtotalForDiscount	Integer
SubtotalDiscountPrice	Integer
SubtotalDiscountRate	Integer
SubtotalDiscountDivision	String
PointDiscount	Integer
CouponDiscount	Integer
Total	Integer
TaxInclude	Integer
TaxExclude	Integer
RoundingDivision	String
RoundingPrice	Integer
CashTotal	Integer
CreditTotal	Integer
Deposit	Integer
DepositCash	Integer
DepositCredit	Integer
Change	Integer
TipCash	Integer
TipCredit	Integer
Amount	Integer
ReturnAmount	Integer
CostTotal	Decimal
SalesHeadDivision	String
InTaxSalesTotal	Integer
OutTaxSalesTotal	Integer
NonTaxSalesTotal	Integer
NonSalesTargetTotal	Integer
NonSalesTargetInTaxTotal	Integer
NonSalesTargetOutTaxTotal	Integer
NonSalesTargetTaxFreeTotal	Integer
NonSalesTargetCostTotal	Decimal
NonSalesTargetAmount	Integer
NonSalesTargetReturnAmount	Integer
NewPoint	Integer
SpendPoint	Integer
Point	Integer
TotalPoint	Integer
CurrentMile	Integer
EarnMile	Integer
TotalMile	Integer
AdjustmentMile	Integer
AdjustmentMileDivision	String
AdjustmentMileValue	Integer
StoreId	Integer
TerminalId	Integer
CustomerId	Long
TerminalTranId	Integer
TerminalTranDateTime	Datetime
SumDivision	String
AdjustmentDateTime	Datetime
SumDate	Date
CustomerRank	String
CustomerGroupId	Integer
CustomerGroupId2	Integer
CustomerGroupId3	Integer
CustomerGroupId4	Integer
CustomerGroupId5	Integer
StaffId	Integer
StaffName	String
CreditDivision	String
PaymentCount	String
SlipNumber	String
CancelSlipNumber	String
AuthNumber	String
AuthDate	Date
CardCompany	String
Denomination	String
Memo	String
ReceiptMemo	String
Carriage	Integer
Commission	Integer
GuestNumbers	Integer
GuestNumbersMale	Integer
GuestNumbersFemale	Integer
GuestNumbersUnknown	Integer
EnterDateTime	Datetime
TaxFreeSalesDivision	String
NetTaxFreeGeneralTaxInclude	Integer
NetTaxFreeGeneralTaxExclude	Integer
NetTaxFreeConsumableTaxInclude	Integer
NetTaxFreeConsumableTaxExclude	Integer
Tags	String
PointGivingDivision	String
PointGivingUnitPrice	Integer
PointGivingUnit	Decimal
PointSpendDivision	String
MileageDivision	String
MileageLabel	String
CustomerPinCode	String
ReturnSales	String
DisposeDivision	String
DisposeServerTransactionHeadId	Integer
CancelDateTime	Datetime
SellDivision	String
TaxRate	Decimal
TaxRounding	String
DiscountRoundingDivision	String
TransactionUuid	String
ExchangeTicketNo	String
GiftReceiptValidDays	Integer
UpdDateTime	Datetime
Details	String
Layaway	String

ExecuteAdjustment

Execute adjustment.

Input


Name	Type	Required	Description
StoreId	Integer	True
TerminalId	Integer	False
UUId	String	False
CashAdjustment	String	False

Result Set Columns


Name	Type	Description
AdjustmentDateTime	Datetime
StoreId	Integer
TerminalId	Integer

ExecuteDailySummary

Execute daily summary.

Input


Name	Type	Required	Description
SumDate	Date	True
StoreId	Integer	True
CashInfo	String	False

Result Set Columns


Name	Type	Description
SumDate	Date
StoreId	Integer
CashDrawerId	Integer
TerminalIdList	String

GetOAuthAccessToken

Gets an authentication token from Smaregi.

Input


Name	Type	Required	Description
AuthMode	String	False	The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is WEB.
Scope	String	False	A space list of permissions to request from the user. Please check the Smaregi API for a list of available permissions.
CallbackUrl	String	False	The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Smaregi app settings. Only needed when the Authmode parameter is Web.
Verifier	String	False	The verifier returned from Smaregi after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL.
State	String	False	Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Smaregi authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.
OAuthPasswordGrantMode	String	False	The default value is POST.
GrantType	String	False	Authorization grant type. Only available for OAuth 2.0. If left unspecified, the default value is the value of the OAuthGrantType connection property. The allowed values are CODE, CLIENT. The default value is CLIENT.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The access token used for communication with Smaregi.
OAuthRefreshToken	String	The OAuth refresh token. This is the same as the access token in the case of Smaregi.
ExpiresIn	String	The remaining lifetime on the access token. A -1 denotes that it will not expire.

GetOAuthAuthorizationURL

Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. You will request the OAuthAccessToken from this URL.

Input


Name	Type	Required	Description
CallbackUrl	String	False	The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL in the Bcart app settings.
Scope	String	False	A comma-separated list of scopes to request from the user. Please check the Bcart API documentation for a list of available permissions.
State	String	False	Indicates any state which may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Bcart authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.

Result Set Columns


Name	Type	Description
URL	String	The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app.

RefreshOAuthAccessToken

Refreshes the OAuth access token used for authentication with Smaregi.

Input


Name	Type	Required	Description
OAuthRefreshToken	String	True	Set this to the token value that expired.

Result Set Columns


Name	Type	Description
OAuthAccessToken	String	The authentication token returned from Smaregi. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken	String	This is the same as the access token.
ExpiresIn	String	The remaining lifetime on the access token.

UploadProductIconImage

Upload a product icon image.

Input


Name	Type	Required	Description
ProductId	String	True
ImageUrl	String	True
CallbackUrl	String	False
State	String	False

Result Set Columns


Name	Type	Description
ProductId	String
CallbackUrl	String
State	String

UploadProductImage

Upload a product image.

Input


Name	Type	Required	Description
ProductId	String	True
ImageUrl	String	True
CallbackUrl	String	False
State	String	False

Result Set Columns


Name	Type	Description
ProductId	String
CallbackUrl	String
State	String

Connection String Options

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.

Authentication

Property	Description
AuthScheme	The scheme used for authenticating to SharePoint.
AccessToken	AccessToken of the currently authenticated user.
ContractId	ContractId of the currently authenticated user.
UseSandbox	A Boolean value indicating if you are using a Sandbox account.

OAuth

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	This determines the scopes that the OAuth application requests from Smaregi.

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Schema	The type of schema to use.

Miscellaneous

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	The Max Thread.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
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	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
AuthScheme	The scheme used for authenticating to SharePoint.
AccessToken	AccessToken of the currently authenticated user.
ContractId	ContractId of the currently authenticated user.
UseSandbox	A Boolean value indicating if you are using a Sandbox account.

AuthScheme

The scheme used for authenticating to SharePoint.

Remarks

The Sync App supports the following authentication mechanisms. See the Getting Started chapter for authentication guides.

AccessToken:
OAuth:
OAuthClient:

AccessToken

AccessToken of the currently authenticated user.

Remarks

AccessToken of the currently authenticated user.

ContractId

ContractId of the currently authenticated user.

Remarks

ContractId of the currently authenticated user.

UseSandbox

A Boolean value indicating if you are using a Sandbox account.

Remarks

A Boolean value indicating if you are using a Sandbox account.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
OAuthClientSecret	Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
Scope	This determines the scopes that the OAuth application requests from Smaregi.

OAuthClientId

Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.

Remarks

This property is required in two cases:

When using a custom OAuth application, such as in web-based authentication flows, service-based authentication, or certificate-based flows that require application registration.
If the driver does not provide embedded OAuth credentials.

(When the driver provides embedded OAuth credentials, this value may already be provided by the Sync App and thus not require manual entry.)

OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.

OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.

While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.

For more information on how this property is used when configuring a connection, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).

Remarks

This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.

The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.

OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.

Notes:

This value should be stored securely and never exposed in public repositories, scripts, or unsecured environments.
Client secrets may also expire after a set period. Be sure to monitor expiration dates and rotate secrets as needed to maintain uninterrupted access.

For more information on how this property is used when configuring a connection, see Establishing a Connection

Scope

This determines the scopes that the OAuth application requests from Smaregi.

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested.

When InitiateOAuth is set to either REFRESH or OFF, you can change which scopes are requested using either this property or the Scope input.

By default the Sync App will request that the user authorize all required scopes. If you want to override this, you can set this property to a space-separated list of OAuth scopes. Please make sure that OAuth App Settings also has these scopes.

The default scopes are: "pos.products:read pos.products:write pos.customers:read pos.customers:write pos.stock:read pos.stock:write pos.stock-changes:read pos.transactions:read pos.transactions:write pos.suppliers:read pos.suppliers:write pos.stores:read pos.stores:write pos.staffs:read pos.staffs:write pos.losses:read pos.losses:write pos.orders:read pos.orders:write pos.transfers:read pos.transfers:write pos.stocktaking:read".

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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`

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: 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.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Smaregi. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Smaregi. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Smaregi. If the SOCKS 5 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.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

Supported authentication types :

BASIC: The Sync App performs HTTP basic authentication.
DIGEST: The Sync App performs HTTP digest authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The username of a user registered with the proxy server.
DIGEST	The username of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note: 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, set ProxyAutoDetect to False.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:


Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Schema	The type of schema to use.

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Schema

The type of schema to use.

Remarks

The schemas available are Smaregi and PlatformAPI.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	The Max Thread.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
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	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
UserDefinedViews	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

MaxRows

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

MaxThreads

The Max Thread.

Remarks

Other

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Integration and Formatting


Property	Description
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=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

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.

Remarks

Number of Issue entries retrieved in each page.

PseudoColumns

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM Products WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Smaregi Connector for CData Sync

Smaregi Connector for CData Sync

Overview

Smaregi Version Support

Establishing a Connection

Adding a Connection to Smaregi

Connecting to Smaregi

Authenticating to Smaregi

Access Token based Authentication for Smaregi API

OAuth authentication for Platform API

OAuth JWT

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Using Smaregi API

Using Platform API

Smaregi Data Model

Overview

Key Features

Tables

Views

Tables

Smaregi Connector for CData Sync Tables

BargainProducts

Columns

Bargains

Select

Insert

Upsert

Bulk Upsert

Update

Delete

Bulk Delete

Columns

BargainStores

Select

Insert

Upsert

Bulk Upsert

Update

Delete

Bulk Delete

Columns

Categories

Select

Insert

Upsert

Bulk Upsert

Update

Delete

Bulk Delete

Columns

Customers

Select

Insert

Upsert

Bulk Upsert

Update

Delete

Bulk Delete

Columns

Losses

Select

Insert

Upsert

Update

Delete

Bulk Delete

Columns

ProductInventoryReservations