The CData Sync App provides a straightforward way to continuously pipeline your GMO MakeShop data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The GMO MakeShop connector can be used from the CData Sync application to pull data from GMO MakeShop and move it to any of the supported destinations.
The Sync App leverages the GMOMakeShop API to enable bidirectional access to GMOMakeShop.
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
When using the CData Sync App to connect to GMO MakeShop, MembersAccessCode, OrdersAccessCode, ProductsAccessCode, and ShopId are required.
GMO MakeShop requires AccessCode for each API. To obtain MembersAccessCode, OrdersAccessCode, ProductsAccessCode, and ShopId, follow the steps below:
Set the following connection properties to connect:
This section details a selection of advanced features of the GMO MakeShop Sync App.
The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
For further information, see Query Processing.
By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Sync App 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 Sync App models the data in GMO MakeShop as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Members | Retrieve and query information related to members. |
Retrieve and query information related to members.
The Sync App 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 Sync App.
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'
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')
All columns except JoinDate can be updated. MemberId is required in the criteria for an update.
UPDATE Members SET MemberName = 'updName' WHERE MemberId = 'MemberIdHere'
A member can be deleted by specifying MemberId.
DELETE FROM Members WHERE MemberId = 'MemberIdHere'
| 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. |
| 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 2: No answer. The allowed values are 0, 1, 2. |
| 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. |
| LineID | String | False |
Output only if LINE ID integration is set to 'Link' |
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.
| 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.
The Sync App 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 Sync App.
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
| 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. |
| CarriagePerDelivery | Bigint | Output the shipping address. If you have modified the shipping fee, output the modified amount. |
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.
The Sync App 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 Sync App.
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
| 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 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.
The Sync App 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 Sync App.
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
| 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 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.
The Sync App 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 Sync App.
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
| 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 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.
The Sync App 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 Sync App.
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
| 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 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.
The Sync App 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 Sync App.
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
| 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 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.
The Sync App 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 Sync App.
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
| 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. |
| DetailOrderPrice | Integer | Detail OrderPrice. |
| DetailTaxPerTaxRate8 | Integer | Total tax of 8% tax rate. |
| DetailTaxPerTaxRate10 | Integer | Total tax of 10% tax rate. |
| 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. |
| TaxType | Integer | Sales tax flag. |
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.
The Sync App 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 Sync App.
SELECT * FROM ProductCategories WHERE BrandCode = 'CD12345'
| 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.
The Sync App 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 Sync App.
SELECT * FROM ProductMemberGroupPrices WHERE BrandCode = 'CD12345'
| 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.
The Sync App 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 Sync App.
SELECT * FROM ProductNameOptionGroups WHERE BrandCode = 'CD12345'
| 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 validation - Y: Can be input N: Can not be input. |
| 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.
The Sync App 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 Sync App.
SELECT * FROM ProductOptionGroupItems WHERE BrandCode = 'CD12345'
| 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.
The Sync App 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 Sync App.
SELECT * FROM ProductOptionItems WHERE BrandCode = 'CD12345'
| Name | Type | Description |
| BrandCode [KEY] | String | System product code. |
| OptionNumber [KEY] | 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.
The Sync App 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 Sync App.
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
| 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 3: Toddler 4: Infant 5: Newborn.
The allowed values are 1, 2, 3, 4, 5. |
| 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 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.
The Sync App 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 Sync App.
SELECT * FROM ProductSelectOptions WHERE BrandCode = 'CD12345'
| 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 Sync App 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.
| 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.
| 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. |
| 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.
| 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. |
| Name | Type | Description |
| Success | String | Stored procedure execution status. |
Cancel the order by specifying the order number..
| 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. |
| Name | Type | Description |
| Status | String | Stored procedure execution status. |
Uploads a file for category registration / modification.
| 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 |
| 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).
| 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 |
| Name | Type | Description |
| Response | String | Stored procedure execution status. |
Uploads a file for option registration / modification.
| 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 |
| Name | Type | Description |
| Response | String | Stored procedure execution status. |
Uploads a file for product registration / modification.
| 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 |
| Name | Type | Description |
| Response | String | Stored procedure execution status. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| 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. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
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.
Store account ID of your GMOMakeShop store.
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 Orders API.
Access code you get from your GMOMakeShop store account to access the Products API.
Access code you get from your GMOMakeShop store account to access the Products API.
Password of the currently authenticated user.
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.
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.
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 | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
The following table provides port number information for each of the supported protocols.
| Protocol | Default Port | Description |
| TUNNEL | 80 | The port where the Sync App opens a connection to GMO MakeShop. Traffic flows back and forth via the proxy at this location. |
| SOCKS4 | 1080 | The port where the Sync App opens a connection to GMO MakeShop. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted. |
| SOCKS5 | 1080 | The port where the Sync App sends data to GMO MakeShop. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the TCP port to be used for a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Identifies the user ID of the account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
Specifies the password of the user account authenticating to a proxy-based firewall.
A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.
Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
| Property | Description |
| ProxyAutoDetect | Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server. |
| ProxyServer | Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic. |
| ProxyPort | Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client. |
| ProxyAuthScheme | Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property. |
| ProxyPassword | Specifies the password of the user specified in the ProxyUser connection property. |
| ProxySSLType | Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property. |
| ProxyExceptions | Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property. |
Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).
This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.
Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.
If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.
For other proxy types, see FirewallType.
Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
Supported authentication types :
For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyUser |
| BASIC | The username of a user registered with the proxy server. |
| DIGEST | The username of a user registered with the proxy server. |
| NEGOTIATE | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NTLM | The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user. |
| NONE | Do not set the ProxyPassword connection property. |
Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.
Specifies the password of the user specified in the ProxyUser connection property.
The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:
| ProxyAuthScheme Value | Value to set for ProxyPassword |
| BASIC | The password associated with the proxy server user specified in ProxyUser. |
| DIGEST | The password associated with the proxy server user specified in ProxyUser. |
| NEGOTIATE | The password associated with the Windows user account specified in ProxyUser. |
| NTLM | The password associated with the Windows user account specified in ProxyUser. |
| NONE | Do not set the ProxyPassword connection property. |
For SOCKS 5 authentication or tunneling, see FirewallType.
Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.
Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :
| AUTO | Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option. |
| ALWAYS | The connection is always SSL enabled. |
| NEVER | The connection is not SSL enabled. |
| TUNNEL | The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note: The Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.
The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.
Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.
When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;
By default, logged operations from all modules are included.
You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP
To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res
Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.
The available modules and submodules are:
| Module Name | Module Description | Submodules |
| INFO | General Information. Includes the connection string, product version (build number), and initial connection messages. |
|
| EXEC | Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well. |
|
| HTTP | HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages. |
|
| WSDL | Messages pertaining to the generation of WSDL/XSD files. | — |
| SSL | SSL certificate messages. |
|
| AUTH | Authentication related failure/success messages. |
|
| SQL | Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages. |
|
| META | Metadata cache and schema messages. |
|
| FUNC | Information related to executing SQL functions. |
|
| TCP | Incoming and outgoing raw bytes on TCP transport layer messages. |
|
| FTP | Messages pertaining to the File Transfer Protocol. |
|
| SFTP | Messages pertaining to the Secure File Transfer Protocol. |
|
| POP | Messages pertaining to data transferred via the Post Office Protocol. |
|
| SMTP | Messages pertaining to data transferred via the Simple Mail Transfer Protocol. |
|
| CORE | Messages relating to various internal product operations not covered by other modules. | — |
| DEMN | Messages related to SQL remoting. | — |
| CLJB | Messages about bulk data uploads (cloud job). |
|
| SRCE | Miscellaneous messages produced by the product that don't belong in any other module. | — |
| TRANCE | Advanced messages concerning low-level product operations. | — |
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Tables | Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC . |
| Views | Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC . |
Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is %APPDATA%\\CData\\GMOMakeShop Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:
| Platform | %APPDATA% |
| Windows | The value of the APPDATA environment variable |
| Linux | ~/.config |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.
If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.
Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .
Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.
If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.
Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.
| Property | Description |
| DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
| ConvertDateTimeToGMT=True | Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time). |
| RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
This property allows you to define which pseudocolumns the Sync App exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.
UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Members WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
You can use this property to define multiple views in a single file and specify the filepath.
For example:
UserDefinedViews=C:\Path\To\UserDefinedViews.jsonWhen you specify a view in UserDefinedViews, the Sync App only sees that view.
For further information, see User Defined Views.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.