This page provides a guide to Establishing a Connection to Smaregi in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to Smaregi

Establishing a Connection shows how to authenticate to Smaregi and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from Smaregi through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to Smaregi by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Connecting to Smaregi

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

Authenticating to Smaregi

• 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 Cloud automatically refresh the OAuth access token:

1. 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 Cloud to save the OAuth values, which persist across connections.

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

1. To manually refresh the OAuthAccessToken after the ExpiresIn period (returned by GetOAuthAccessToken) has elapsed, call the RefreshOAuthAccessToken stored procedure.
2. Set these connection properties:
   • OAuthClientId: The Client Id in your custom OAuth application settings.
   • OAuthClientSecret: The Client Secret in your custom OAuth application settings.

3. Call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken.
4. 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.

Creating a Custom OAuth Application

• Control branding of the authentication dialog.
• Control the redirect URI that the application redirects the user to after the user authenticates.
• Customize the permissions that you are requesting from the user.

To register a custom OAuth application and obtain the OAuth client credentials, client id, and client secret:

1. Login to the Developer Account Portal. Create a Developer Account if you have not already done so.
2. On the application list screen, click Register new public/private app.
3. After entering your information, click Register.
4. The OAuthClientId and ClientSecret are displayed along with the information you specified when setting up the application. Record the OAuthClientID and ClientSecret for future use.
5. Then set the scope. In the Smaregi Developers page, goto Application -> Private/Public Application.
6. Click on View Summary of the application to configure the settings.
7. Click on the Scope tab.
8. Click Smaregi as the service to be configured.
9. Select the scope to be linked to the application. All scopes must be selected to use all functions of the driver. After completing the settings, click Save.
10. Then activate the application. In the Smaregi Developers page, goto Application -> Private/Public Application.
11. Click on View Summary of the application to configure the settings.
12. Enter the Contract ID to use the application and click Activate.
13. When a confirmation dialog box appears, click Yes.
14. An email with the subject "[SMAREGI] Application Activation Application" will be sent to the email address registered with the relevant Contract ID.
15. Click on the link in the body of the email sent to confirm the contents.
16. Click Terms of Use to confirm the contents and check the box if you agree.
17. Click on I agree to the above terms and conditions and check the box if you agree.
18. Log out and then log back in to use the application.

Customizing the SSL Configuration

By default, the Cloud 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.

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

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.

Overview

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

Key Features

• The Cloud 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 Cloud.

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.

The Cloud models the data in Smaregi as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Smaregi Tables

Usage information for the operation BargainProducts.rsd.

Columns

Usage information for the operation Bargains.rsd.

Select

The Cloud 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

Usage information for the operation BargainStores.rsd.

Select

The Cloud 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

Usage information for the operation Categories.rsd.

Select

The Cloud will use the Smaregi API to process WHERE clause conditions and selected columns. LIKE (for date and dateTime data type columns) and IN operator are processed client-side. Operators: =, !=, <>, >, <, >=, <=, AND, LIKE, ORDER BY are processed server-side. For example, the following query is processed server side:

SELECT CategoryName, CategoryCode FROM Categories ORDER BY CategoryCode

Insert

To add a Category, specify the CategoryId, CategoryCode and CategoryName fields.

INSERT INTO Categories (CategoryId, CategoryCode, CategoryName) VALUES (10, 'CategoryCode10', 'CategoryName10')

NOTE: If records already exist, insert will not be successful and driver will return 0 affected rows.

Upsert

To add/update a Category, specify the CategoryId, CategoryCode and CategoryName fields.

UPSERT INTO Categories (CategoryId, CategoryCode, CategoryName) VALUES (6, 'CategoryCode', 'CategoryName')

Bulk Upsert

To add/update Categories, specify the CategoryId, CategoryCode and CategoryName fields.

INSERT INTO Categories#TEMP (CategoryId, CategoryCode, CategoryName) VALUES (11, 'CategoryCode11', 'CategoryName11')
INSERT INTO Categories#TEMP (CategoryId, CategoryCode, CategoryName) VALUES (12, 'CategoryCode12', 'CategoryName12')
UPSERT INTO Categories (CategoryId, CategoryCode, CategoryName) SELECT CategoryId, CategoryCode, CategoryName FROM Categories#TEMP

Update

Smaregi allows UPDATEs for the CategoryCode, CategoryName, CategoryAbbr, CategoryGroupId, ParentCategoryId, DisplaySequence, DisplayFlag, PointNotApplicable, TaxFreeDivision, Color and Tag columns.

UPDATE Categories SET CategoryCode = 'CatCode', CategoryName = 'Updated', CategoryAbbr = 'CatAbbr', CategoryGroupId = 2, ParentCategoryId = 1, DisplaySequence = 1, DisplayFlag = 0, PointNotApplicable = 1, TaxFreeDivision = 1, Tag = 'test' WHERE CategoryId = 13

Delete

Categories can be deleted by providing the CategoryId.

DELETE FROM Categories WHERE CategoryId = 2

Bulk Delete

INSERT INTO Categories#TEMP (CategoryId) VALUES (11)
INSERT INTO Categories#TEMP (CategoryId) VALUES (12)
DELETE FROM Categories WHERE EXISTS SELECT CategoryId FROM Categories#TEMP

Columns

Usage information for the operation Customers.rsd.

Select

The Cloud 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

Usage information for the operation Losses.rsd.

Select

The Cloud 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

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

Usage information for the operation ProductInventoryReservations.rsd.

Select

The Cloud 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

Usage information for the operation ProductPrices.rsd.

Select

The Cloud 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

Usage information for the operation ProductReserveItemLabels.rsd.

Select

The Cloud 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

Usage information for the operation ProductReserveItems.rsd.

Select

The Cloud 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

Usage information for the operation Products.rsd.

Select

The Cloud 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

Usage information for the operation ProductStores.rsd.

Select

The Cloud 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

Usage information for the operation Receivings.rsd.

Select

The Cloud 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

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

Usage information for the operation Shipments.rsd.

Select

The Cloud 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

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

Usage information for the operation Shippings.rsd.

Select

The Cloud 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

Usage information for the operation Staff.rsd.

Select

The Cloud 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

Usage information for the operation Stocks.rsd.

Select

The Cloud 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

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.

Usage information for the operation StorageInfo.rsd.

Select

The Cloud 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

Usage information for the operation Storages.rsd.

Select

The Cloud 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

Usage information for the operation Stores.rsd.

Select

The Cloud 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

Usage information for the operation TransactionHeads.rsd.

Select

The Cloud 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

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.

CData Cloud - Smaregi Views

Usage information for the operation DailySums.rsd.

Select

The Cloud 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

Usage information for the operation DailySumsSalesList.rsd.

Select

The Cloud 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

Usage information for the operation LossDetails.rsd.

Select

The Cloud 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

Usage information for the operation ReceivingDetails.rsd.

Select

The Cloud 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

Usage information for the operation ShipmentDetails.rsd.

Select

The Cloud 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

Usage information for the operation ShippingDetails.rsd.

Select

The Cloud 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

Usage information for the operation StaffStores.rsd.

Select

The Cloud 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

Usage information for the operation StockHistories.rsd.

Select

The Cloud 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

Usage information for the operation StocktakingDetails.rsd.

Select

The Cloud 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

Usage information for the operation StocktakingHeads.rsd.

Select

The Cloud 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

Usage information for the operation StocktakingInfo.rsd.

Select

The Cloud 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

Usage information for the operation StocktakingStockDetails.rsd.

Select

The Cloud 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

Usage information for the operation StorageDetails.rsd.

Select

The Cloud 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

Usage information for the operation StorageInfoDeliveries.rsd.

Select

The Cloud 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

Usage information for the operation StorageInfoDeliveryProducts.rsd.

Select

The Cloud 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

Usage information for the operation StorageInfoProducts.rsd.

Select

The Cloud 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

Usage information for the operation TransactionCoupons.rsd.

Columns

Usage information for the operation TransactionDepositOthers.rsd.

Select

The Cloud 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

Usage information for the operation TransactionDetails.rsd.

Select

The Cloud 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

Stored procedures are function-like interfaces that extend the functionality of the Cloud 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.

CData Cloud - Smaregi Stored Procedures

Overview

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

Key Features

• The Cloud 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 Cloud.

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.

The Cloud models the data in Smaregi as a list of tables in a relational database that can be queried using standard SQL statements.

CData Cloud - Smaregi Tables