Create a connection to Ponparemall by navigating to the Connections page in the Sync App application and selecting the corresponding icon in the Add Connections panel. If the Ponparemall icon is not available, click the Add More icon to download and install the Ponparemall connector from the CData site.

Required properties are listed under the Settings tab. The Advanced tab lists connection properties that are not typically required.

Connecting to Ponparemall

When using the Ponparemall Web APIs to connect to Ponparemall, ShopUrl, InventoryUserId, InventoryPassword, OrderUserId, OrderPassword, PaymentUserId, and PaymentPassword are required.

Configure Access to Ponparemall

To obtain ShopUrl, InventoryUserId, InventoryPassword, OrderUserId, OrderPassword, PaymentUserId, and PaymentPassword, follow the steps below:

• Ponparemall requires Id and Password for each API.
• Log in to Ponparemall Manager and click "Apply for Using WebAPI" from the "Various Applications" menu.
• Click "Apply for Using WebAPI Service" from the "Web API" menu to appy for use.
• ID and Password will be sent from Ponparemall at a later date.

Authenticate to Ponparemall Account

Set the following connection properties to connect:

• ShopUrl: Set Ponparemall Shop URL of your connection destination. Enter the ［sample］ part contained in ［http://storetst4.ponparemall.com/sample/］.
• InventoryUserId: Set User ID of "Inventory API". This propery is required to access the Inventory table.
• InventoryPassword: Set Password of "Inventory API". This propety is required to access the Inventory table.
• OrderUserId: Set User ID of "Orders API". This property is required to access the Orders table.
• OrderPassword: Set Password of "Orders API". This property is requred to access the Orders table.
• PaymentUserId: Set User ID of "Payments API". This property is requred to access the Payments table.
• PaymentPassword: Set Password of "Payments API". This property is requred to access the Payments table.

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

User Defined Views

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

SSL Configuration

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

Firewall and Proxy

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

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Ponparemall and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

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

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

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 Sync App models Ponparemall objects as relational tables and views. A Ponparemall 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 Ponparemall APIs.

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

The Sync App offloads as much of the SELECT statement processing as possible to the Ponparemall APIs and then processes the rest of the query in memory. See SupportEnhancedSQL for more information on how the Sync App circumvents API limitations with in-memory client-side processing.

The Sync App models the data in Ponparemall into a list of tables that can be queried using standard SQL statements.

Generally, querying Ponparemall tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Ponparemall Connector for CData Sync Tables

Name	Description
Inventory	Returns stock data from inventory API.
OrderCoupons	Returns data for coupons associated to an order.
OrderCustomers	Returns information related to the Customer which placed the order.
OrderDlvs	Return data for Order delivey information
OrderItems	Returns information for order items.
OrderPayments	Returns payment information for orders.
Orders	Returns information for Orders being placed to your store.
OrderWrappings	Returns wrapping information for Orders.

Returns stock data from inventory API.

Select

To query from Inventory table you need to specify ItemManageId or InvCntSearchRange filters. The Sync App will use the Ponparemall API to process WHERE clause conditions built for these fields. The rest of the filter is executed client side within the Sync App.

• ItemManageId column supports = and IN operators.
• InvCntSearchRange column supports the = operator.

For example, the following query is processed server side:

SELECT * FROM Inventory WHERE ItemManageId = '12345'

SELECT * FROM Inventory WHERE ItemManageId IN ('12345', '123456')

SELECT * FROM Inventory WHERE InvCntSearchRange = 2

Update

To update an inventory item of type Normal Inventory (InvKind=1) you need to specify the ItemManageId. To update an inventory item of type SKU Inventory (InvKind=1) you need to specify the ItemManageId, SkuItemHAxisId and SkuItemVAxisId.

UPDATE Inventory SET InvKind = 1, InvCntDispKind = 2, InvCnt = 10, InvCntUpdateMode = 2 WHERE ItemManageId = '0000000003'

UPDATE Inventory SET InvKind = 2, InvCntDispKind = 2, SkuMarkDispBorder = -1, InvCnt = 55, InvCntUpdateMode = 1 WHERE ItemManageId = 'cdata0003' AND SkuItemHAxisId = 'Green' AND SkuItemVAxisId = 'L'

Columns

Name	Type	ReadOnly	Description
ItemId	String	True
ItemManageId [KEY]	String	True
InvCntSearchRange	String	True
InvKind	Integer	False
InvCntDispKind	Integer	False
SkuMarkDispBorder	Integer	False
InvCnt	String	False
SkuItemHAxisId [KEY]	String	True
SkuItemVAxisId [KEY]	String	True
invCntUpdateMode	String	False

Returns data for coupons associated to an order.

Select

To query from OrderCoupons table you need to specify OrderNo filter or Date and DateRangeSearchColumn filters. By default, if no filters are specified, the driver will return OrderCoupons for Orders with OrderDate within the last 730 days (the maximum range that it returns records for). The date range you specify can filter based on OrderDate, ShipmentDate or PaymentDate based on the value set for DateRangeSearchColumn filter (respectively 1,2,3). The Sync App will use the Ponparemall API to process WHERE clause conditions built for this field. The rest of the filters is executed client side.

• OrderNo column supports = and IN operators.
• OrderStatus and DateRangeSearchColumn columns support the = operator.
• Date column supports the >=,<= and = operators.

For example, the following query is processed server side:

SELECT * FROM OrderCoupons WHERE OrderNo IN ('403593-201811261412-117905', '403595-20181156565-115656')

SELECT * FROM OrderCoupons WHERE OrderStatus = 'status' AND Date >= '2018-01-01'

Update

To update a specific order coupon you need to specify the OrderNo and OrderItemSubNo. If you specify only OrderNo in the WHERE clause, all the OrderCoupons records belonging to that Order will be updated. Only CouponCnt field can be udated.

UPDATE OrderCoupons SET CouponCnt = 1 WHERE OrderNo = '403593-201904191854-122833' AND OrderItemSubNo = 1

Delete

To delete a specific order coupon you need to specify the OrderNo and OrderItemSubNo. If you specify only OrderNo in the WHERE clause, all the OrderCoupons records belonging to that Order will be deleted.

DELETE FROM OrderCoupons WHERE OrderNo = '403593-201904191854-122833' AND OrderItemSubNo=1

Columns

Name	Type	ReadOnly	Description
OrderNo [KEY]	String	False
OrderStatus	String	True
CouponCode	String	False
OrderItemSubNo [KEY]	Integer	True
ItemManageId	String	True
CouponName	String	True
CouponCnt	Integer	False
CouponCapitalKind	Integer	True
DiscountType	Integer	True
ExpiryDate	Date	True
CouponAmount	Decimal	True
Date	Date	True
DateRangeSearchColumn	String	True

Returns information related to the Customer which placed the order.

Select

To query from OrderCustomers table you need to specify OrderNo filter or Date and DateRangeSearchColumn filters. By default, if no filters are specified, the driver will return OrderCustomer records for Orders with OrderDate within the last 730 days (the maximum range that it returns records for). The date range you specify can filter based on OrderDate, ShipmentDate or PaymentDate based on the value set for DateRangeSearchColumn filter (respectively 1,2,3). The Sync App will use the Ponparemall API to process WHERE clause conditions built for this field. The rest of the filters is executed client side.

• OrderNo column supports = and IN operators.
• OrderStatus, CustomerEmail and DateRangeSearchColumn columns support the = operator.
• Date column supports the >=,<= and = operators.

For example, the following query is processed server side:

SELECT * FROM OrderCustomers WHERE OrderNo IN ('403593-201811261412-117905', '403595-20181156565-115656')

SELECT * FROM OrderCustomers WHERE OrderStatus = 'status' AND Date >= '2018-01-01' AND DateRangeSearchColumn = 2

SELECT * FROM OrderCustomers WHERE CustomerEmail = '[email protected]'

Update

To update order customer information for a specific order you need to specify the OrderNo. All the fields that are not readonly can be updated.

UPDATE OrderCustomers SET CustomerZip1 = 655, CustomerZip2 = 1001, CustomerAddress = 'updating address', CustomerFirstName = 'FirstName', CustomerLastName = 'LastName' WHERE OrderNo = '403593-201903261426-121537'

Columns

Name	Type	ReadOnly	Description
OrderNo [KEY]	String	True
OrderStatus	String	True
CustomerZip1	String	False
CustomerZip2	String	False
CustomerPref	String	False
CustomerAddress	String	False
CustomerLastName	String	False
CustomerFirstName	String	False
CustomerLastNameKana	String	False
CustomerFirstNameKana	String	False
CustomerTel	String	False
CustomerEmail	String	False
CustomerEmailKind	String	True
Date	Date	True
DateRangeSearchColumn	String	True	Period search target column which narrows the order list to the specified range by Date column

Return data for Order delivey information

Select

To query from OrderDlvs table you need to specify OrderNo filter or Date and DateRangeSearchColumn filters. By default, if no filters are specified, the driver will return order delivery records for Orders with OrderDate within the last 730 days (the maximum range that it returns records for). The date range you specify can filter based on OrderDate, ShipmentDate or PaymentDate based on the value set for DateRangeSearchColumn filter (respectively 1,2,3). The Sync App will use the Ponparemall API to process WHERE clause conditions built for this field. The rest of the filters is executed client side.

• OrderNo column supports = and IN operators.
• OrderStatus and DateRangeSearchColumn columns support the = operator.
• Date column supports the >=,<= and = operators.

For example, the following query is processed server side:

SELECT * FROM OrderDlvs WHERE OrderNo IN ('403593-201811261412-117905', '403595-20181156565-115656')

SELECT * FROM OrderDlvs WHERE OrderStatus = 'status' AND Date = '2018-01-01' AND DateRangeSearchColumn = 2

Update

To update order delivery information for a specific order you need to specify the OrderNo. All the fields that are not readonly can be updated.

UPDATE OrderDlvs SET DlvAddrZip1 = 123, DlvAddrZip2 = 0003, DlvAddrAddress = 'testing address', DlvAddrFirstName = 'Ana', DlvAddrLastName = 'Smith' WHERE OrderNo = '403593-201903261426-121537'

Columns

Name	Type	ReadOnly	Description
OrderNo [KEY]	String	True
DlvMethodId	String	False
DlvMethodName	String	True
DlvAddrZip1	String	False
DlvAddrZip2	String	False
DlvAddrPref	String	False
DlvAddrAddress	String	False
DlvAddrLastName	String	False
DlvAddrFirstName	String	False
DlvAddrLastNameKana	String	False
DlvAddrFirstNameKana	String	False
DlvAddrTel	String	False
SlipNo	String	False
OrderStatus	String	True
Date	Date	True
DateRangeSearchColumn	String	True

Returns information for order items.

Select

To query from OrderItems table you need to specify OrderNo filter or Date and DateRangeSearchColumn filters. By default, if no filters are specified, the driver will return items for Orders with OrderDate within the last 730 days (the maximum range that it returns records for). The date range you specify can filter based on OrderDate, ShipmentDate or PaymentDate based on the value set for DateRangeSearchColumn filter (respectively 1,2,3). The Sync App will use the Ponparemall API to process WHERE clause conditions built for this field. The rest of the filters is executed client side.

• OrderNo column supports = and IN operators.
• OrderStatus and DateRangeSearchColumn columns support the = operator.
• Date column supports the >=,<= and = operators.

For example, the following query is processed server side:

SELECT * FROM OrderItems WHERE OrderNo IN ('403593-201811261412-117905', '403595-20181156565-115656')

SELECT * FROM OrderItems WHERE OrderStatus = 'status' AND Date = '2018-01-01' AND DateRangeSearchColumn = 2

Update

To update a specific order item you need to specify the OrderNo and ItemManageId. If you specify only OrderNo in the WHERE clause, all the OrderItem records belonging to that Order will be updated. All the fields that are not readonly can be updated.

UPDATE OrderItems SET taxKind = 3 WHERE OrderNo = '403593-201903261521-121545'

Columns

Name	Type	ReadOnly	Description
OrderNo [KEY]	String	True
OrderStatus	String	True
OrderItemSubNo [KEY]	Integer	True
ItemName	String	False
ItemId	String	True
ItemManageId	String	True
HSkuItemId	String	True
VSkuItemId	String	True
SalePrice	Decimal	False
ItemCnt	Integer	False
IncShippingFlg	Boolean	False
TaxKind	String	False
IncCodFeeFlg	Boolean	False
GetPointRate	Integer	True
GetPoint	Integer	True
PurchaseOption	String	False
InvKind	String	True
ItemDelFlg	Boolean	False
ItemTaxRate	String	False
ItemTaxRateKbn	String	False
Date	Date	True
DateRangeSearchColumn	String	True

Returns payment information for orders.

Select

To query from OrderPayments table you need to specify OrderNo filter or Date and DateRangeSearchColumn filters. By default, if no filters are specified, the driver will return OrderPayments for Orders with OrderDate within the last 730 days (the maximum range that it returns records for). The date range you specify can filter based on OrderDate, ShipmentDate or PaymentDate based on the value set for DateRangeSearchColumn filter (respectively 1,2,3). The Sync App will use the Ponparemall API to process WHERE clause conditions built for this field. The rest of the filters is executed client side.

• OrderNo, CardBrand, CardPaymentMethod and CCPaymentStatus columns support = and IN operators.
• OrderStatus, PaymentMethodId, PaymentMethodName, CardSignature and DateRangeSearchColumn columns support the = operator.
• Date column supports the >=,<= and = operators.

For example, the following query is processed server side:

SELECT * FROM OrderPayments WHERE OrderNo IN ('403593-201811261412-117905', '403595-20181156565-115656')

SELECT * FROM OrderPayments WHERE OrderStatus = 'status' AND Date = '2018-01-01' AND DateRangeSearchColumn = 2

SELECT * FROM OrderPayments WHERE CardSignature = 'TARO PONPARE'

SELECT * from OrderPayments WHERE CardPaymentMethod IN (1,2,3,4)

Update

To update an OrderPayments item the OrderNo. Only PymntMethodId can be updated.

UPDATE OrderPayments SET PymntMethodId = 2 WHERE OrderNo = '403593-201904051859-122065'

Columns

Name	Type	ReadOnly	Description
OrderNo [KEY]	String	True
OrderStatus	String	True
PymntMethodId	String	False
PymntMethodName	String	True
CardBrand	String	True
CardNo	String	True
CardSignature	String	True
CardExpire	String	True
CardPymntMethod	String	True
CCPaymentStatus	String	True
Date	Date	True
DateRangeSearchColumn	String	True

Returns information for Orders being placed to your store.

Select

To query from Orders table you need to specify either Date and DateRangeSearchColumn or OrderNo filters. By default, if no filters are specified, the driver will return orders with OrderDate within the last 730 days (the maximum range that it returns values for). The date range you specify can filter based on OrderDate, ShipmentDate or PaymentDate based on the value set for DateRangeSearchColumn filter (respectively 1,2,3). The Sync App will use the Ponparemall API to process WHERE clause conditions built for these fields. The rest of the filter is executed client side.

• OrderNo, CardBrand, CardPaymentMethod and CCPaymentStatus columns support = and IN operators.
• OrderStatus, OrderMemo, EncloseKind, NxDayDlvFlg, CouponUse, FirstName, LastName, NameSearchColumn, Tel, TelSearchColumn, ItemId, ItemName, PointUse, SalesRoute, UpdatedCardIconFlg and DateRangeSearchColumn columns support the = operator.
• Date column supports the >=,<= and = operators.

For example, the following query is processed server side:

SELECT * FROM Orders WHERE OrderNo IN ('403593', '403594', '403595')"

The following query will return Orders having the specified status and OrderDate from 2018-01-01 till the current date.

SELECT * FROM Orders WHERE OrderStatus = 'status' AND Date >= '2018-01-01'

The following query will return Orders having ShipmentDate from 2018-01-01 till the current date.

SELECT * FROM Payments WHERE Date >= '2018-01-01' AND DateRangeSearchColumn = '2'

The following query will return Orders having customer's first name John:

SELECT * FROM Payments WHERE FirstName > 'John' AND NameSearchColumn = '1'

Update

To update an order you need to specify the OrderNo. All the fields that are not readonly can be updated.

UPDATE Orders SET DlvKind = 1, DlvDesiredDate = '2019-05-01', GiftApplyFlg = true, UseTerminal = 0 WHERE OrderNo = '403593-201904081443-122177'

Columns

Name	Type	ReadOnly	Description
OrderNo [KEY]	String	True
OrderStatus	String	False
OrderDateTime	Datetime	True
PaymentStatus	String	False
DepositDate	Date	False
SendDate	Date	False
DlvKind	String	False
DlvDesiredDate	Date	False
DlvDesiredTimeZoneKind	String	False
DlvDesiredTimeZoneFrom	String	False
DlvDesiredTimeZoneTo	String	False
ShopUserNameInCharge	String	False
OrderMemo	String	False
MessageToCustomer	String	True
UseTerminal	String	True
MailcarrierCode	String	True
GiftApplyFlg	Boolean	False
OrderNote	String	False
TaxRate	String	False
DlvAddrCautionFlg	Boolean	True
YellowUserFlg	Boolean	True
MemberKind	String	True
EnclosableFlg	Boolean	True
ItemAmount	Decimal	True
TaxAmount	Decimal	True
DlvFee	Decimal	False
PaymentFee	Integer	False
TotalAmount	Decimal	True
UsePointAmount	Decimal	True
UseCouponTotalAmount	Decimal	True
UseCouponShopAmount	Decimal	True
UseCouponOtherAmount	Decimal	True
UseCouponTotalCnt	Integer	True
UseCouponShopCnt	Integer	True
UseCouponOtherCnt	Integer	True
TotalPymntAmount	Decimal	True
TotalPymntAmountInit	Decimal	True
Noshi	String	False
EncloseKind	String	True
EncloseOrderNo	String	True
EncloseItemAmount	Decimal	False
EncloseTaxAmount	Decimal	False
EncloseDlvFee	Decimal	False
EnclosePymntFee	Decimal	False
EncloseTotalAmount	Decimal	False
EncloseUsePointAmount	Decimal	False
EncloseUseCouponAmount	Decimal	False
EncloseTotalPymntAmount	Decimal	False
CardUpdatingIconFlg	Boolean	False
CardUpdatedIconFlg	Boolean	False
FraudOrderAlert	String	False
NxDayDlvFlg	String	False
CouponUse	String	True
Date	Date	True
DateRangeSearchColumn	String	True
FirstName	String	True
LastName	String	True
NameSearchColumn	String	True
Tel	String	True
TelSearchColumn	String	True
ItemId	String	True
ItemName	String	True
PointUse	String	True
SalesRoute	String	True
UpdatedCardIconFlg	String	True

Returns wrapping information for Orders.

Select

To query from OrderWrappings table you need to specify OrderNo filter or Date and DateRangeSearchColumn filters. By default, if no filters are specified, the driver will return OrderPayments for Orders with OrderDate within the last 730 days (the maximum range that it returns records for). The date range you specify can filter based on OrderDate, ShipmentDate or PaymentDate based on the value set for DateRangeSearchColumn filter (respectively 1,2,3). The Sync App will use the Ponparemall API to process WHERE clause conditions built for this field. The rest of the filters is executed client side.

• OrderNo column supports = and IN operators.
• OrderStatus and DateRangeSearchColumn columns support the = operator.
• Date column supports the >=,<= and = operators.

For example, the following query is processed server side:

SELECT * FROM OrderWrappings WHERE OrderNo IN ('403593-201811261412-117905', '403595-20181156565-115656')

SELECT * FROM OrderWrappings WHERE OrderStatus = 'status' AND Date = '2018-01-01' AND DateRangeSearchColumn = 2

Insert

To insert order wrapping information for a specific order you need to specify OrderNo, WrappingKind, WrappingName, WrappingPrice, WrappingDelFlg and WrappingTaxKind of the wrapping option you want to insert (wrapping 1, wrapping 2 or both).

INSERT INTO OrderWrappings (WrappingKind,WrappingName,WrappingPrice,WrappingDelFlg,WrappingTaxKind,Orderno) VALUES (1,'Ardit',20,false,1,'403593-201904191853-122817')

INSERT INTO OrderWrappings (WrappingKind2,WrappingName2,WrappingPrice2,WrappingDelFlg2,WrappingTaxKind2,Orderno) VALUES (1,'Ardit',20,false,1,'403593-201904191853-122817')

Update

To update order wrapping information for a specific order you need to specify the OrderNo. All the fields that are not readonly can be udated.

UPDATE OrderWrappings SET WrappingName2 = 'Package for customer 2' WHERE OrderNo = '403593-201903261426-121537'

Columns

Name	Type	ReadOnly	Description
OrderNo [KEY]	String	True
WrappingKind	String	False
WrappingName	String	False
WrappingPrice	Decimal	False
WrappingTaxKind	String	False
WrappingDelFlg	Boolean	False
WrappingKind2	String	False
WrappingName2	String	False
WrappingPrice2	Decimal	False
WrappingTaxKind2	String	False
WrappingDelFlg2	Boolean	False
OrderStatus	String	False
Date	Date	True
DateRangeSearchColumn	String	True

Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Ponparemall Connector for CData Sync Views

Name	Description
EnclosableOrders	Returns data for enclosable order.
OrderAsyncResults	Returns information related to the status of a request being processed by Orders API
OrderPriceTaxSums	Returns information related to the Customer which placed the order.
PaymentAsyncResults	Returns information related to the status of a request being processed by Payments API
Payments	Returns detailed payment information related to orders

Returns data for enclosable order.

Select

To query from EnclosableOrders table you need to specify OrderNo filter. The Sync App will use the Ponparemall API to process WHERE clause conditions built for this field. The rest of the filters is executed client side.

• OrderNo column supports the = operator.

For example, the following query is processed server side:

SELECT * FROM EnclosableOrders WHERE OrderNo = '403593-201811261412-117905'

Columns

Name	Type	Description
OrderNo [KEY]	String
OrderStatus	String
OrderDateTime	Datetime
PaymentStatus	String
SendDate	Date
DlvKind	String
EnclosableFlg	Boolean
DlvDesiredDate	Date
CustomerLastName	String
CustomerFirstName	String
CustomerEmail	String
PaymentMethodName	String
CardNo	String
DlvAddrZip1	String
DlvAddrZip2	String
DlvAddrPref	String
DlvAddrAddress	String
DlvAddrLastName	String
DlvAddrFirstName	String
DlvAddrTel	String
EncloseKind	String
EncloseParentOrderNo	String
EncloseChildOrderLists	String

Returns information related to the status of a request being processed by Orders API

Select

To query from OrderAsyncResults table you need to specify RequestId filter. The Sync App will use the Ponparemall API to process WHERE clause conditions built for these fields. The rest of the filter is executed client side.

• RequestId column support = and IN operators.

For example, the following query is processed server side:

SELECT * FROM OrderAsyncResults WHERE RequestId IN ('reqid1', 'reqid2')

Columns

Name	Type	Description
RequestId [KEY]	String
RequestRcvDateTime	Datetime
OrderTranKind	String
ElemNum	Integer
TranSts	String
StartDateTime	Datetime
UpdateDateTime	Datetime
CompleteOrderNoList	String

Returns information related to the Customer which placed the order.

Columns

Name	Type	Description
OrderNo [KEY]	String
OrderStatus	String
ItemTaxRate	String
PriceSbttl	Decimal
TaxSbttl	Decimal
ItemCouponDscntSbttl	Decimal
Date	Date
DateRangeSearchColumn	String

Returns information related to the status of a request being processed by Payments API

Select

To query from Payments table you need to specify RequestId filter. RequestId field supports = and IN operators. The Sync App will use the Ponparemall API to process WHERE clause conditions built for this field. The rest of the filters is executed client side.

• RequestId column supports = and IN operators.

For example, the following query is processed server side:

SELECT * FROM PaymentAsyncResults WHERE RequestId IN ('reqid1', 'reqid2')

Columns

Name	Type	Description
RequestId [KEY]	String
RequestRcvDateTime	Datetime
PaymentTranKind	String
ElemNum	Integer
TranSts	String
StartDateTime	Datetime
UpdateDateTime	Datetime
CompletePaymentInfoList	String

Returns detailed payment information related to orders

Select

To query from Payments table you need to specify Date, PeriodSearchKind and PaymentStatus filters. By default the driver will return payments of any status for orders that have OrderDate within the last 730 days (tha maximum range that it returns values for). You can use the CardBrandList, CardPymntMethodList and PaymentStatus filters with = and IN operators;CardSignature, OrderNo with = operator; Date field supports >.< and = operators. The Sync App will use the Ponparemall API to process WHERE clause conditions built for these fields. The rest of the filter is executed client side.

• CardBrandList, CardPymntMethodList and PaymentStatus columns support = and IN operator.
• OrderNo column supports the = operator.
• Date column supports the >=,<= and = operators.

For example, the following query is processed server side:

SELECT * FROM Payments WHERE PaymentStatus IN ('status1', 'status2')

SELECT * FROM Payments WHERE Date >= '2018/11/11' AND Date <= '2019/06/03' AND periodSearchKind = '1' AND PaymentStatus = 'status'

SELECT * FROM Payments WHERE OrderNo = '403593-201811261412-117905'

SELECT * FROM Payments WHERE CardBrand IN (1,2)

Columns

Name	Type	Description
AuthBillDate	Date
CardBrand	String
CardNo	String
CardPaymentMethod	String
CardSignature	String
ErrCode	String
ErrMessage	String
ExecPymntDateTime	Datetime
MerchantId	String
OrderDateTime	Datetime
OrderStatus	String
SendDate	Date
ServiceId	String
TotalPaymentAmount	Decimal
TrackingId	String
TransactionId	String
CardBrandList	String	1:VISA.2:MASTER,3:AMEX,4:JCB,5:Diners The allowed values are 1, 2, 3, 4, 5.
CardPymntMethodList	String	The allowed values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11.
OrderNo [KEY]	String
PeriodSearchKind	String	Specifies which date the range is applied for. Possible values: 1:Order date, 2:Date of shipment, 3: Authorization approval date / billing date. The allowed values are 1, 2, 3.
PaymentStatus	String
Date	Date

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
ShopURL	Shop URL of your Ponparemall store.
InventoryUserId	Inventory UserId you get from your Ponparemall store.
InventoryPassword	Inventory Password you get from your Ponparemall store.
OrderUserId	Order UserId you get from your Ponparemall store.
OrderPassword	Order Password you get from your Ponparemall store.
PaymentUserId	Payment UserId you get from your Ponparemall store.
PaymentPassword	Payment Password you get from your Ponparemall store.

SSL

---

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

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
DateRange	The default date range in days the driver sends requests for. It defaults to 90 days.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

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

---

Property	Description
ShopURL	Shop URL of your Ponparemall store.
InventoryUserId	Inventory UserId you get from your Ponparemall store.
InventoryPassword	Inventory Password you get from your Ponparemall store.
OrderUserId	Order UserId you get from your Ponparemall store.
OrderPassword	Order Password you get from your Ponparemall store.
PaymentUserId	Payment UserId you get from your Ponparemall store.
PaymentPassword	Payment Password you get from your Ponparemall store.

Shop URL of your Ponparemall store.

Remarks

Shop URL of your Ponparemall store.

Inventory UserId you get from your Ponparemall store.

Remarks

Inventory UserId you get from your Ponparemall store.

Inventory Password you get from your Ponparemall store.

Remarks

Inventory Password you get from your Ponparemall store.

Order UserId you get from your Ponparemall store.

Remarks

Order UserId you get from your Ponparemall store.

Order Password you get from your Ponparemall store.

Remarks

Order Password you get from your Ponparemall store.

Payment UserId you get from your Ponparemall store.

Remarks

Payment UserId you get from your Ponparemall store.

Payment Password you get from your Ponparemall store.

Remarks

Payment Password you get from your Ponparemall store.

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.

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 Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Ponparemall and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

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

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

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

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

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

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

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

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

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

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

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

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

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

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

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

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Ponparemall Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

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

Remarks

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

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

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

---

Property	Description
DateRange	The default date range in days the driver sends requests for. It defaults to 90 days.
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

The default date range in days the driver sends requests for. It defaults to 90 days.

Remarks

The default date range in days the driver sends requests for. It defaults to 90 days.

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

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

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.

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 Sync App throws an exception.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

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

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"