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

Connecting to GMO MakeShop

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

Accessing Data from CData Cloud Services

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

Connect to GMO MakeShop 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 GMO MakeShop

When using the CData Cloud to connect to GMO MakeShop, MembersAccessCode, OrdersAccessCode, ProductsAccessCode, and ShopId are required.

Configuring Access to GMO MakeShop

GMO MakeShop requires AccessCode for each API. To obtain MembersAccessCode, OrdersAccessCode, ProductsAccessCode, and ShopId, follow the steps below:

• Log in to the GMO MakeShop Store Manager and click Create Shop.
• Click any target connection setting from External System Connection in the left-hand navigation menu. If you cannot find it in the menu, please contact GMO Makeshop.
• Product Data Connection Settings: Click Issue to retrieve the authentication code and ProductsAccessCode.
• Order Data Connection Settings: First select Get Order Information > Change Order Information settings. Then click Issue to retrieve the authentication code and OrdersAccessCode.
• Members Data Connection Settings: Select Get/Post/Update/Delete Members Information settings. Then click Issue to retrieve the authentication code and MembersAccessCode.
• Members Authentication Connection Settings: Click Issue to retrieve the authentication code and ProductsAccessCode.

Authenticating to GMO MakeShop Account

Set the following connection properties to connect:

• ShopId: Set the GMO MakeShop Store ID of the connection destination. The GMO MakeShop Store ID is the same as the ID for login.
• OrdersAccessCode: Set the orders access code retrieved from Order Data Connection Settings. This property is required to access the Orders table.
• ProductsAccessCode: Set the products access code retrieved from Product Data Connection Settings. This property is required to access the Products table.
• MembersAccessCode: Set the members access code retrieved from Members Data Connection Settings. This property is required to access the Members table.
• MemberAuthenticationCode: Set the member authentication code retrieved from Members Authentication Connection Settings. This property is required to execute MemberAuthenticationConfirm.
• Password: Specify the password for the GMO MakeShop Store Manager login user. This property is required to execute ProductCategoryRegistrationOrModification, ProductMemberGroupPriceRegistrationOrModification, ProductOptionRegistrationOrModification, and ProductRegistrationOrModification.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

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.

The CData Cloud models GMO MakeShop objects as relational tables and views. The information that comes from the server is URL encoded. We have a hidden connection property 'DecodeValues' which defaults to true and exposes decoded data. To display raw encoded data, set this to false inside the Other connection property. A GMO MakeShop object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to GMO MakeShop APIs.

Schemas for most database objects are defined in simple, text-based configuration files.

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

CData Cloud - GMO MakeShop Tables

Name	Description
Members	Retrieve and query information related to members.

Retrieve and query information related to members.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• MemberId, MemberNameKana columns support the = operator.
• JoinDate column supports the >,>=,=,<=,< operators.
• GetDeleted pseudo-column supports the = operator.

Ordering is supported for JoinDate. For example, the following queries are processed server side:

SELECT * FROM Members WHERE MemberId = 'MemberIdHere' AND JoinDate >= '2018-09-04 22:54:43+01:00' AND JoinDate <= '2018-09-04 23:54:43+01:00' ORDER BY JoinDate ASC

SELECT * FROM Members WHERE MemberNameKana = 'Firstname Lastname' AND JoinDate > '2018-09-04 22:54:43+01:00' AND JoinDate < '2018-09-04 23:54:43+01:00'  ORDER BY JoinDate DESC

SELECT * FROM Members WHERE JoinDate = '2018-09-04 23:54:43+01:00' AND GetDeleted = '1' 

Insert

All columns except JoinDate can be specified. MemberId, MemberName, MemberNameKana, Email, MemberPassword, HomePost, HomePrefecture, HomePrefectureCode, HomeAddress1, HomePhone are required for an insert.

INSERT INTO Members (MEmberId, MemberName, MemberNameKana, Email, MemberPassword, HomePost, HomePrefecture, HomePrefectureCode, HomeAddress1, HomePhone) VALUES ('mymemberid', 'the name', 'Firstname Lastname', '[email protected]', 'Passw0rd', '1508512', 'Prefecture', '13', 'Address here', '453-345') 

Update

All columns except JoinDate can be updated. MemberId is required in the criteria for an update.

UPDATE Members SET MemberName = 'updName' WHERE MemberId = 'MemberIdHere'  

Delete

A member can be deleted by specifying MemberId.

DELETE FROM Members WHERE MemberId = 'MemberIdHere'  

Columns

Name	Type	ReadOnly	Description
MemberId [KEY]	String	False	Member ID.
MemberName	String	False	Member name.
MemberNameKana	String	False	Member name phonetic.
JoinDate	Date	True	Date of registration.
GroupId	Integer	False	Member group ID.
GroupName	String	False	Member group name.
Email	String	False	Member email address.
MemberPassword	String	False	Member password - specified on an Insert.
EmailMagazineReceive	String	False	Indicator whether to receive mail magazine - Y: Wish to distribute e-mail newsletter, N: I do not wish to deliver e-mail newsletters. The allowed values are Y, N.
Sex	Integer	False	Member gender - 0: Male 1: Female. The allowed values are 0, 1.
Birthday	Date	False	Member birthday.
MemberPoint	Integer	False	Store shop points owned by members.
MemberPointExpireDate	Date	False	Owned shop point expiration date.
RecommendMemberId	String	False	Store introducer's member ID.
HomePost	String	False	Home zip code.
HomePrefectureCode	String	False	Home prefecture code.
HomePrefecture	String	False	Home prefecture name.
HomeAddress1	String	False	Home address.
HomeAddress2	String	False	Other address.
HomePhone	String	False	Home phone number.
HomeFax	String	False	Home fax number.
MobilePhone	String	False	Mobile phone number.
MobileEmail	String	False	Mobile email address.
OfficeName	String	False	Company name.
OfficeNameKana	String	False	Company name phonetic.
OfficeDepartment	String	False	Company department.
OfficePost	String	False	Company zip code.
OfficePrefectureCode	String	False	Company prefecture code.
OfficePrefecture	String	False	Company prefecture name.
OfficeAddress	String	False	Company address.
OfficePhone	String	False	Company phone number.
AdditionalOption1	String	False	Additional input item 1.
AdditionalOption2	String	False	Additional input item 2.
AdditionalOption3	String	False	Additional input item 3.
AdditionalOption4	String	False	Additional input item 4.
AdditionalOption5	String	False	Additional input item 5.
AdditionalOption6	String	False	Additional input item 6.
AdditionalOption7	String	False	Additional input item 7.
LoginEmail	String	False	Mail address authentication setting - Y: allow member login with e-mail address N: do not allow member login with e-mail address.
Memo	String	False	Member information memo. The allowed values are Y, N.

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
GetDeleted	Integer	Specify this as 1 to acquire deleted members. Defaults to 0 and deleted members will not be retrieved. The allowed values are 0, 1.

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 - GMO MakeShop Views

Name	Description
OrderDeliveries	Returns data regarding shipping destinations.
OrderDeliveryCarriages	Returns data regarding delivery carriage.
OrderDeliveryLineItems	Returns data regarding order delivery specific items.
OrderDeliveryNotes	Returns data regarding order delivery notes.
OrderLineItems	Returns data regarding order details.
OrderNotes	Returns data regarding order notes.
Orders	Returns information regarding orders.
ProductCategories	Returns information regarding categories for the products.
ProductMemberGroupPrices	Returns information regarding prices by member groups.
ProductNameOptionGroups	Returns information related to product naming option groups and items.
ProductOptionGroupItems	Returns data related to option groups and their items.
ProductOptionItems	Returns data related to item selection options for product.
Products	Returns information related to products.
ProductSelectOptions	Returns data related to option selections.

Returns data regarding shipping destinations.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDeliveries WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveries WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveries WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
DeliveryId [KEY]	Integer	Id of the order delivery.
DeliveryNumber	String	Shipping slip number.
DeliveryOrder	Integer	Shipping instructions - 0: not instructed, 1: shipping instructed, 2: shipping preparation in progress
Status	Integer	Status of the order delivery.
OfficeName	String	Destination company name.
OfficeNameKana	String	Destination company name phonetic.
Department	String	Destination department name.
Name	String	Destination name.
NameKana	String	Destination name phonetic.
PhoneNumber	String	Destination phone number.
Zip	String	Destination postal code.
Area	String	Destination prefecture.
Address	String	Destination street address.
DeliveryDate	Date	Desired delivery day.
DeliveryTime	String	Desired delivery time.
ScheduledShippingDate	Date	Estimated shipping date.
ShippingDate	Datetime	Delivery completion date and time.
Carrier	String	Delivery trader code.

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
Canceled	Integer	Specify this as 1 to acquire canceled orders. Defaults to 0 and canceled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding delivery carriage.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDeliveryCarriages WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryCarriages WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryCarriages WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
DeliveryId [KEY]	Integer	Id of the order delivery.
Date	Datetime	Order date.
CarriageName [KEY]	String	Shipping method name.
CarriagePrice	Integer	Shipping method price.
CarriageCost	Integer	Shipping fee.
CarriageDetail	String	Shipping details.
CarriageCommodityBrandCode	String	Commodity brandcode.
CarriageCommodityName	String	Commodity name.

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
Canceled	Integer	Specify this as 1 to acquire cancelled orders. Defaults to 0 and cancelled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding order delivery specific items.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDeliveryLineItems WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryLineItems WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryLineItems WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
DeliveryId [KEY]	Integer	Id of the order delivery.
BrandCode [KEY]	String	System product code.
OriginalCode	String	Original product code.
Name	String	Product name.
Price	Integer	Selling price.
Point	Integer	Product points.
Amount	Integer	Order quantity.
ConsumptionTaxRate	Integer	Sales tax rate.
Option	String	Product option names.
OriginalOptionCode	String	Original option code.
NameOptions	String	Original option code.

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
Canceled	Integer	Specify this as 1 to acquire cancelled orders. Defaults to 0 and cancelled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding order delivery notes.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderDeliveryNotes WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryNotes WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderDeliveryNotes WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
DeliveryId [KEY]	Integer	Delivery ID.
NoteNumber [KEY]	String	Delivery note number.
NoteTitle	String	Delivery note title.
NoteValue	String	Delivery note.

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
Canceled	Integer	Specify this as 1 to acquire canceled orders. Defaults to 0 and canceled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding order details.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderLineItems WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderLineItems WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderLineItems WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
BrandCode [KEY]	String	System product code.
OriginalCode	String	Original product code.
Name	String	Product name.
JanCode	String	JAN code.
DiscountRate	Integer	Discount percentage.
Price	Integer	Product price.
ShopPoints	Integer	Shop use points.
GMOPoints	Integer	GMO use points.
YahooPoints	Integer	Yahoo use points.
Amount	Integer	Order quantity.
ConsumptionTaxRate	Integer	Sales tax rate.
Option	String	Product option names.
OriginalOptionCode	String	Original option code.
NameOptions	String	Item name options.

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
Canceled	Integer	Specify this as 1 to acquire cancelled orders. Defaults to 0 and cancelled orders will not be retrieved. The allowed values are 0, 1.

Returns data regarding order notes.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving information related to orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM OrderNotes WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderNotes WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM OrderNotes WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
NoteNumber [KEY]	String	Order note number.
NoteTitle	String	Order note title.
NoteValue	String	Order note.

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
Canceled	Integer	Specify this as 1 to acquire canceled orders. Defaults to 0 and canceled orders will not be retrieved. The allowed values are 0, 1.

Returns information regarding orders.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• OrderNumber column supports the = operator.
• Date column supports the >,>=,=,<=,< operators. When no column filters are specified, we will default to retrieving orders from the last 6 months.
• Canceled pseudo-column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM Orders WHERE OrderNumber = 'ORD12345' AND Date >= '2018-09-04 22:54:43+01:00' AND Date <= '2018-09-04 23:54:43+01:00' 

SELECT * FROM Orders WHERE Date > '2018-09-04 22:54:43+01:00' AND Date < '2018-09-04 23:54:43+01:00' 

SELECT * FROM Orders WHERE Date = '2018-09-04 23:54:43+01:00' AND Canceled = 1 

Columns

Name	Type	Description
OrderNumber [KEY]	String	Order number.
Date	Datetime	Order date.
Status	Integer	Order status - 0: Canceled 1: Normal 99: Temporary order.
RepeatSaleCount	Integer	Number of subscriptions.
PaymentMethod	String	Payment method.
PaymentMethodType	String	Payment method type.
PaymentStatus	Integer	Deposit status - 0: Not received 1: Deposit complete.
OrderMemo	String	Notes in detailed order information
DetailTotalPrice	Integer	Total order price.
DetailPricePerTaxRate8	Integer	Total price of 8% tax rate.
DetailPricePerTaxRate10	Integer	Total price of 10% tax rate.
DetailCommission	Integer	Settlement fee.
DetailCommissionName	String	Settlement name fee.
DetailPoint	Integer	Order points. Displayed when the point grant (rate and amount) is set in the member group setting.
DetailDiscountPrice	Integer	Discount price. Displayed when the point grant (rate and amount) is set in the member group setting..
DetailCorrection	Integer	Amendment amount.
DetailCarriage	Integer	Shipping cost.
DetailCouponName	String	Coupon name.
DetailCouponCode	String	Coupon code.
DetailCouponDiscount	Integer	Coupon Discount Amount.
DetailBulkDiscount	Integer	Bulk Discount Amount.
ShopPoints	Integer	Shop use points.
GMOPoints	Integer	GMO use points.
YahooPoints	Integer	Yahoo use points.
BuyerId	String	Buyer ID.
BuyerOfficeName	String	Buyer company name.
BuyerOfficeNameKana	String	Buyer company name phonetic.
BuyerDepartment	String	Buyer department name.
BuyerName	String	Buyer name.
BuyerNameKana	String	Buyer name phonetic.
BuyerPhoneNumber	String	Buyer phone number.
BuyerPhoneNumber2	String	Second buyer phone number.
BuyerEmail	String	Buyer email address.
BuyerZip	String	Buyer postal code.
BuyerAddress	String	Buyer street address.
BuyerMembergroupid	Integer	Buyer member group code.
BuyerMembergroupname	String	Buyer member group name.
CombinedPaymethodType	String	Combined payment method.
CombinedPaymethod	String	Combined payment method type.
CombinedPrice	Integer	Combined payment price.

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
Canceled	Integer	Specify this as 1 to acquire canceled orders. Defaults to 0 and canceled orders will not be retrieved. The allowed values are 0, 1.

Returns information regarding categories for the products.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductCategories WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
CategoryCode [KEY]	String	Category Code.
CategoryPath	String	Category Path.

Returns information regarding prices by member groups.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductMemberGroupPrices WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
GroupId [KEY]	Integer	Member group ID.
GroupName	String	Member group name.
Price	Integer	Price by member group.
Point	Integer	Points by member group.
PointType	Integer	Point type - 0: Absolute value of point 1: Rate according to price.

Returns information related to product naming option groups and items.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductNameOptionGroups WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
NameOptionGroupId	Integer	Insert name group ID.
NameOptionGroupLabel	String	Insert name group name.
NameOptionGroupDescription	String	Insert name group description.
ItemId [KEY]	Integer	Item ID.
AdminItemName	String	Administrator item name.
DisplayItemName	String	Display item name.
IsRequired	String	Selection requirement - Y: Required input N: Optional input.
IsAlphabet	String	Alphabetical validation - Y: Can be input N: Can not be input.
IsNumber	String	Numerical validation - Y: Can be input N: Can not be input.
IsSymbol	String	Symbols
IsDoubleByte	String	Double byte character validation - Y: Can be input N: Can not be input.
RowMaxlength	Integer	Number of characters per line.
MaxRow	Integer	Number of lines.
MaxLength	Integer	Maximum number of characters.

Returns data related to option groups and their items.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductOptionGroupItems WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
GroupCode	String	Group code.
GroupName	String	Group name.
OptionId [KEY]	Integer	Option ID.
OptionName	String	Option name.
IsRequired	String	Indicates if the option is required - Y: Required input N: Optional input.
ItemId [KEY]	Integer	Item ID.
ItemName	String	Item name.
PriceType	Integer	Item price type - 0: Designate by amount 1: Specify at rate according to selling price.
ItemPrice	Integer	Item price.
Default	String	Indicator if item is initial selection - Y: Selected in initial display N: Not selected in initial display.

Returns data related to item selection options for product.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductOptionItems WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
OptionNumber	String	Option item number (Option item 1 or 2).
ItemId [KEY]	Integer	Selection item ID.
ItemName	String	Selection item name.
Default	String	Indicator if option item is initial selection - Y: Selected in initial display N: Not selected in initial display.

Returns information related to products.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• BrandCode, UbrandCode columns support the = operator.
• ModifiedDate column supports the >,>=,=,<=,< operators.
• CategoryCode pseudo-column supports the = operator.

Ordering is supported for one of CreatedDate, ModifiedDate, ProductName, Price. For example, the following queries are processed server side:

SELECT * FROM Products WHERE BrandCode = 'CD12345' AND ModifiedDate >= '2018-09-04 22:54:43+01:00' AND ModifiedDate <= '2018-09-04 23:54:43+01:00' ORDER BY CreatedDate ASC

SELECT * FROM Products WHERE UbrandCode = 'CD0012345' AND ModifiedDate > '2018-09-04 22:54:43+01:00' AND ModifiedDate < '2018-09-04 23:54:43+01:00' ORDER BY ProductName ASC

SELECT * FROM Products WHERE ModifiedDate = '2018-09-04 23:54:43+01:00' AND CategoryCode = 'CT001' ORDER BY Price DESC

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
UbrandCode	String	Original product code.
CreatedDate	Datetime	Date and time information of product registration.
ModifiedDate	Datetime	Date and time information of product last modification.
IsDisplayed	String	Product display availability - Y: Displayed N: Not displayed.
IsMemberOnly	String	Members only setting.Y: This is a member exclusive product N: Not a member exclusive product
IsReducedTaxRateBrand	Boolean	Boolean displaying if the brand is eligible for reduced tax rate
DisplayableMemberGroups	String	Displayable member group names. List seperated by pipeline.
BasicCategoryCode	String	Code of the lowest hierarchical node of the basic category.
BasicCategoryPath	String	Path of the lowest hierarchical node of the basic category.
ProductID	Integer	Product ID.
ProductName	String	Product name.
Weight	Integer	Product weight.
Price	Integer	Selling price.
ConsumptionTaxRate	Integer	Sales tax rate.
GroupId	Integer	.
GroupName	String	.
Point	String	Product points.
PointType	Integer	Point type - 0: Absolute value of point 1: Rate with respect to price.
FixedPrice	Integer	List price.
PurchasePrice	Integer	Purchase price.
JANcode	String	JAN code of the product.
Vendor	String	Product manufacturer.
Origin	String	Place of origin.
IsDisplayOrigin	Integer	Place of origin display flag - 0: Show Origin 1: Do not. The allowed values are 0, 1.
Stock	Integer	Product quantity.
IsDiplayStock	Integer	Quantity display flag - 0: Do not display stock number 1: Display stock number. The allowed values are 0, 1.
MinimumQuantity	Integer	Minimum order limit.
MaximumQuantity	Integer	Maximum order limit.
Collections	Integer	Display position - 0: New item 1: Special item 2: Recommended 3: Category Recommended items.
IndividualShipping	Long	Individual postage setting.
IsPublishDateFrom	Integer	Posting date designation flag - 0: Do not set posting start date 1: Set posting start date. The allowed values are 0, 1.
PublishDateFrom	Datetime	Posting start date.
IsPublishDateTo	Integer	Posting end date designation flag - 0: Do not set the posting end date 1: Set posting end date. The allowed values are 0, 1.
PublishDateTo	Datetime	Posting end date.
IsDiscountRate	Integer	Discount use flag - 0: Enable discount 1: Disable discount.
DiscountRate	Integer	Discount rate percentage.
DiscountTerm	String	Discount period interval dates.
ItemGroup	String	Product group.
SearchKeyword	String	Product search term.
Note	String	Product specific display note.
OptionName1	String	First name of the lowest product option.
OptionName2	String	Second name of the lowest product option..
OptionGroupCode	String	Option group code of the lowest set product.
OptionGroupName	String	Option group name of the lowest set product.
NameOptionGroupId	String	Insert name group ID of the lowest set name insertion group.
NameOptionGroupLabel	String	Insert name group label of the lowest set name insertion group.
NameOptionGroupDescription	String	Insert name group description of the lowest set name insertion group..
ProductPageUrl	String	Product details page URL .
ZoomImageUrl	String	URL of enlarged image. Multiple product images are not displayed.
ImageUrl	String	Regular image URL. Multiple product images are not displayed.
ThumbnailImageUrl	String	URL of thumbnail image .
MobileImageUrl	String	Mobile image URL.
SubImage1Url	String	URL of additional product image 1.
IsDisplayMobileSubImage1	Integer	Additional product image mobile display - 0: Display additional product image 1 on mobile, 1: Do not display.
SubImage1Content	String	Product image 1 description.
SubImage2Url	String	URL of additional product image 2.
IsDisplayMobileSubImage2	Integer	Additional product image mobile display - 0: Display additional product image 2 on mobile, 1: Do not display..
SubImage2Content	String	Product image 2 description.
SubImage3Url	String	URL of additional product image 3.
IsDisplayMobileSubImage3	Integer	Additional product image mobile display - 0: Display additional product image 3 on mobile, 1: Do not display..
SubImage3Content	String	Product image 3 description.
SubImageLayout	String	Layout specification - A/B/C/D.
MainContent	String	Main product description for PC.
MainContent2	String	Additional description for PC.
MobileContent	String	Mobile item description.
SmartphoneContent1	String	First product description for smartphones.
SmartphoneContent2	String	Second product description for smartphones.
IsDisplayMobileContent	String	Mobile display of first description on smartphone product - Y: Display explanatory text N: Do not display explanatory text.
ProductListContent	String	Product description for product category.
IsDisplayProductListContent	String	Possibility to display product description for product category - Y: Display explanatory text N: Do not display explanatory text.
OrderPageNote	String	Settlement screen remarks .
IsRestockNotification	String	Stock notice - Y: Restocked Notification N: Not Receiving Notification.
GoogleShoppingCondition	String	Google shopping product status flag - New/Second hand/Refurbished.
GoogleShoppingTitle	String	Google shopping product name.
GoogleShoppingDescription	String	Google shopping product details.
GoogleShoppingOptionLayoutType	String	Google shopping product option display format.
GoogleShoppingIsbnCode	String	Google shopping product ISBN code.
GoogleShoppingBrand	String	Google shopping product brand name.
GoogleShoppingMnp	String	Google shopping product manufacturer model number.
GoogleShoppingGoogleProductCategory	String	Google shopping product google category.
GoogleShoppingGender	Integer	Google shopping product gender - 1: Male 2: Female 3: Unisex.
GoogleShoppingAgeGroup	Integer	Google shopping product age group - 1: Adult 2: Child.
GoogleShoppingColor	String	Google shopping product color.
GoogleShoppingSize	String	Google shopping product size.
GoogleShoppingMaterial	String	Google shopping product material.
GoogleShoppingPattern	String	Google shopping product pattern.
GoogleShoppingItemGroupId	String	Google shopping product group ID.
GoogleShoppingAdwordsGrouping	String	Google shopping product adwords group.
GoogleShoppingAdwordsLabels	String	Google shopping product adwords label.

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
CategoryCode	String	Products in exactly matched categories are displayed as search results.

Returns data related to option selections.

Select

The Cloud will use the GMO MakeShop API to process WHERE clause conditions built with the following columns and operators. The rest of the filter is executed client side within the Cloud.

• BrandCode column supports the = operator.

For example, the following queries are processed server side:

SELECT * FROM ProductSelectOptions WHERE BrandCode = 'CD12345'

Columns

Name	Type	Description
BrandCode [KEY]	String	System product code.
OptionId [KEY]	String	Option id. [Option 1 node option ID]_[Option 2 node option ID].
OptionUbrandCode	String	Option-specific code.
OptionPrice	Integer	Option-specific price.
OptionStock	Integer	Option stock quantity.
OptionJanCode	String	Option JAN code.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with GMO MakeShop.

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

CData Cloud - GMO MakeShop Stored Procedures

Name	Description
DeliveryStatusChange	Change the delivery status by specifying the order number.
MemberAuthenticationConfirm	It verifies whether the combination of the specified user's member ID and password is correct and returns the result.
OrderStatusChange	Cancel the order by specifying the order number..
ProductCategoryRegistrationOrModification	Uploads a file for category registration / modification.
ProductMemberGroupPriceRegistrationOrModification	Uploads a file for price registration / modification by member group (contract of BtoB option is required).
ProductOptionRegistrationOrModification	Uploads a file for option registration / modification.
ProductRegistrationOrModification	Uploads a file for product registration / modification.

Change the delivery status by specifying the order number.

Input

Name	Type	Required	Description
OrderNumber	String	True	Order ID.
DeliveryId	Integer	True	If there is more than one delivery, specify the sequential number after 1 with half-width numerals. The default value is 0.
DeliveryStatus	String	True	Change the delivery status. 1: Delivery instruction completed 2: Preparation for delivery 3: Delivery completed 9: Return. The allowed values are 1, 2, 3, 9.
Carrier	String	False	Specify the shipping voucher with the shipping company code (refer to the next shipping company code).
DeliveryNumber	String	False	Enter the delivery slip number.
CancelReason	Integer	False	Enter the reason for cancellation. The input value is added to the memo field of the management screen.

Result Set Columns

Name	Type	Description
Status	String	Stored procedure execution status.

It verifies whether the combination of the specified user's member ID and password is correct and returns the result.

Input

Name	Type	Required	Description
MemberId	String	True	Login ID of the shop member. If you allow login with e-mail address in shop settings, you can also specify the e-mail address.
MemberPassword	String	True	Specify the shop member's password.

Result Set Columns

Name	Type	Description
Success	String	Stored procedure execution status.

Cancel the order by specifying the order number..

Input

Name	Type	Required	Description
OrderNumber	String	True	Order Number.
DeliveryId	Integer	False	If there is more than one delivery, specify the sequential number after 1 with half-width numerals. The default value is 0.
CancelReason	String	False	Enter the reason for cancellation. The input value is added to the memo field of the management screen.

Result Set Columns

Name	Type	Description
Status	String	Stored procedure execution status.

Uploads a file for category registration / modification.

Input

Name	Type	Required	Description
FilePath	String	False	A zip file or a CSV file path.
FileName	String	False	Name of the file to be uploaded only when content is given. For example: test.csv

Result Set Columns

Name	Type	Description
Response	String	Stored procedure execution status.

Uploads a file for price registration / modification by member group (contract of BtoB option is required).

Input

Name	Type	Required	Description
FilePath	String	False	A zip file or a CSV file path.
FileName	String	False	Name of the file to be uploaded only when content is given. For example: test.csv

Result Set Columns

Name	Type	Description
Response	String	Stored procedure execution status.

Uploads a file for option registration / modification.

Input

Name	Type	Required	Description
FilePath	String	False	A zip file or a CSV file path.
FileName	String	False	Name of the file to be uploaded only when content is given. For example: test.csv

Result Set Columns

Name	Type	Description
Response	String	Stored procedure execution status.

Uploads a file for product registration / modification.

Input

Name	Type	Required	Description
FilePath	String	False	A zip file or a CSV file path.
FileName	String	False	Name of the file to be uploaded only when content is given. For example: test.csv

Result Set Columns

Name	Type	Description
Response	String	Stored procedure execution status.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for GMO MakeShop:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Members table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Members' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the DeliveryStatusChange stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='DeliveryStatusChange' AND Direction=1 OR Direction=2

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName	String	The name of the data type.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Members table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Members' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:gmomakeshop:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported string functions.	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	Supported numeric functions.	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	Supported date/time functions.	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

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
ShopId	Store account ID of your GMOMakeShop store.
OrdersAccessCode	Access code you get from your GMOMakeShop store account to access the Orders API.
ProductsAccessCode	Access code you get from your GMOMakeShop store account to access the Products API.
Password	Password of the currently authenticated user.
MembersAccessCode	Access code you get from your GMOMakeShop store account to access the Members API.
MemberAuthenticationCode	Authentication code you get from your GMOMakeShop store account to access the MemberAuthenticationConfirm stored procedure.

SSL

---

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

Logging

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

Schema

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Miscellaneous

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

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

---

Property	Description
ShopId	Store account ID of your GMOMakeShop store.
OrdersAccessCode	Access code you get from your GMOMakeShop store account to access the Orders API.
ProductsAccessCode	Access code you get from your GMOMakeShop store account to access the Products API.
Password	Password of the currently authenticated user.
MembersAccessCode	Access code you get from your GMOMakeShop store account to access the Members API.
MemberAuthenticationCode	Authentication code you get from your GMOMakeShop store account to access the MemberAuthenticationConfirm stored procedure.

Store account ID of your GMOMakeShop store.

Data Type

string

Default Value

""

Remarks

Store account ID of your GMOMakeShop store.

Access code you get from your GMOMakeShop store account to access the Orders API.

Data Type

string

Default Value

""

Remarks

Access code you get from your GMOMakeShop store account to access the Orders API.

Access code you get from your GMOMakeShop store account to access the Products API.

Data Type

string

Default Value

""

Remarks

Access code you get from your GMOMakeShop store account to access the Products API.

Password of the currently authenticated user.

Data Type

string

Default Value

""

Remarks

Password of the currently authenticated user. This property is required to execute product stored procedures.

Access code you get from your GMOMakeShop store account to access the Members API.

Data Type

string

Default Value

""

Remarks

Access code you get from your GMOMakeShop store account to access the Members API.

Authentication code you get from your GMOMakeShop store account to access the MemberAuthenticationConfirm stored procedure.

Data Type

string

Default Value

""

Remarks

Authentication code you get from your GMOMakeShop store account to access the MemberAuthenticationConfirm stored procedure.

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

---

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

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

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

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

---

Property	Description
Verbosity	The verbosity level that determines the amount of detail included in the log file.

The verbosity level that determines the amount of detail included in the log file.

Data Type

string

Default Value

"1"

Remarks

The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.

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

---

Property	Description
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

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

---

Property	Description
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Cloud throws an exception.