CData Sync App は、Ponparemall データをデータベース、データレイク、またはデータウェアハウスに継続的にパイプライン化する簡単な方法を提供し、分析、レポート、AI、および機械学習で簡単に利用できるようにします。
Ponparemall コネクタはCData Sync アプリケーションから使用可能で、Ponparemall からデータを取得して、サポートされている任意の同期先に移動できます。
Sync App アプリケーションの接続 ページに移動し、接続の追加 パネルで対応するアイコンを選択して、Ponparemall への接続を作成します。Ponparemall アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからPonparemall コネクタをダウンロードおよびインストールします。
必須プロパティは[設定]タブにリストされています。[Advanced]タブには、通常は必要ない接続プロパティが表示されます。
Ponparemall Web API を使用してPonparemall に接続する場合は、 ShopUrl、InventoryUserId、InventoryPassword、OrderUserId、OrderPassword、PaymentUserId、およびPaymentPassword が必要です。
ShopUrl、InventoryUserId、InventoryPassword、OrderUserId、OrderPassword、PaymentUserId、およびPaymentPassword を取得するには、以下の手順に従ってください。
次の接続プロパティを設定して接続します。
このセクションでは、Ponparemall Sync App の高度な機能を厳選して説明します。
Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。
SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。 詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。
Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。
Sync App は、Ponparemall にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。
詳しくはクエリ処理 を参照してください。
CData ログを調整するために使用可能な設定の概要については、ログ を参照してください。基本的なロギングでは、 次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、 より洗練されたロギングをサポートする多数の機能があります。
デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
CData Sync App は、Ponparemall オブジェクトをリレーショナルテーブルおよびビューとしてモデル化します。 Ponparemall オブジェクトは他のオブジェクトとリレーションを持ちます。テーブルでは、これらのリレーションは外部キーを使用して表されます。 次のセクションでは、利用可能なAPI オブジェクトを示し、Ponparemall API へのSQL の実行について詳しく説明します。
ほとんどのデータベースオブジェクトのスキーマは、シンプルなテキストベースのコンフィギュレーションファイルで定義されます。
Sync App は、Ponparemall API にできるだけ多くのSELECT 構文処理をオフロードし、残りのクエリをインメモリで処理します。 Sync App がクライアントサイドのインメモリ処理でAPI 制限を回避する方法の詳細については、SupportEnhancedSQL を参照してください。
Sync App はPonparemall のデータを、標準のSQL ステートメントを使用してクエリできるテーブルのリストにモデル化します。
一般的には、Ponparemall テーブルのクエリは、リレーショナルデータベースのテーブルのクエリと同じです。時には特別なケースもあります。例えば、テーブルの特定のカラムデータを取得するために特定のカラムをWHERE 句に含める必要がある場合などです。これは通常、特定のカラムを取得するために行ごとに個別のリクエストを行う必要がある場合に必要です。これらの特別な状況は、以下にリンクされているテーブルページの上部に明確に文書化されています。
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.
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.
SELECT * FROM Inventory WHERE ItemManageId = '12345'
SELECT * FROM Inventory WHERE ItemManageId IN ('12345', '123456')
SELECT * FROM Inventory WHERE InvCntSearchRange = 2
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'
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.
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.
SELECT * FROM OrderCoupons WHERE OrderNo IN ('403593-201811261412-117905', '403595-20181156565-115656')
SELECT * FROM OrderCoupons WHERE OrderStatus = 'status' AND Date >= '2018-01-01'
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
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
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.
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.
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]'
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'
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
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.
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
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'
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.
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.
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
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'
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.
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.
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)
To update an OrderPayments item the OrderNo. Only PymntMethodId can be updated.
UPDATE OrderPayments SET PymntMethodId = 2 WHERE OrderNo = '403593-201904051859-122065'
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.
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.
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'
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'
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.
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.
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
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')
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'
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 |
ビューは、カラムと疑似カラムで構成されます。ビューは、データを示すという点でテーブルに似ていますが、ビューでは更新はサポートされません。通常、ビューとして表されるエンティティは、読み取り専用のエンティティです。多くの場合、これらのデータはストアドプロシージャを使用することで更新できます(その機能がデータソースに適用できる場合)。
ビューに対しては、通常のテーブルと同じようにクエリを実行でき、このときに返されるデータも同様です。
ビューとして公開されるクエリなどの動的ビューや、project_team ワークアイテムの特定の組み合わせを検索するためのビューがサポートされています。
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.
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.
SELECT * FROM EnclosableOrders WHERE OrderNo = '403593-201811261412-117905'
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
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.
SELECT * FROM OrderAsyncResults WHERE RequestId IN ('reqid1', 'reqid2')
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.
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
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.
SELECT * FROM PaymentAsyncResults WHERE RequestId IN ('reqid1', 'reqid2')
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
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.
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)
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
使用できる値は次のとおりです。1, 2, 3, 4, 5 |
CardPymntMethodList | String |
使用できる値は次のとおりです。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.
使用できる値は次のとおりです。1, 2, 3 |
PaymentStatus | String | |
Date | Date |
プロパティ | 説明 |
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. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
プロパティ | 説明 |
LogModules | ログファイルに含めるコアモジュール。 |
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
プロパティ | 説明 |
DateRange | The default date range in days the driver sends requests for. It defaults to 90 days. |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。
プロパティ | 説明 |
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.
Shop URL of your Ponparemall store.
Inventory UserId you get from your Ponparemall store.
Inventory UserId you get from your Ponparemall store.
Inventory Password you get from your Ponparemall store.
Inventory Password you get from your Ponparemall store.
Order UserId you get from your Ponparemall store.
Order UserId you get from your Ponparemall store.
Order Password you get from your Ponparemall store.
Order Password you get from your Ponparemall store.
Payment UserId you get from your Ponparemall store.
Payment UserId you get from your Ponparemall store.
Payment Password you get from your Ponparemall store.
Payment Password you get from your Ponparemall store.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。
このプロパティは、次のフォームを取ります:
説明 | 例 |
フルPEM 証明書(例では省略されています) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
証明書を保有するローカルファイルへのパス。 | C:\cert.cer |
公開鍵(例では省略されています) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
MD5 Thumbprint (hex 値はスペースおよびコロン区切り) | ecadbdda5a1529c58a1e9e09828d70e4 |
SHA1 Thumbprint (hex 値はスペースおよびコロン区切り) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。
プロパティ | 説明 |
FirewallType | プロキシベースのファイアウォールで使われるプロトコル。 |
FirewallServer | プロキシベースのファイアウォールの名前もしくはIP アドレス。 |
FirewallPort | プロキシベースのファイアウォールのTCP ポート。 |
FirewallUser | プロキシベースのファイアウォールに認証するために使うユーザー名。 |
FirewallPassword | プロキシベースのファイアウォールへの認証に使われるパスワード。 |
プロキシベースのファイアウォールで使われるプロトコル。
このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。
タイプ | デフォルトポート | 説明 |
TUNNEL | 80 | これが設定されている場合、Sync App はPonparemall への接続を開き、プロキシを経由して通信が行われます。 |
SOCKS4 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。 |
SOCKS5 | 1080 | これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。 |
HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。
プロキシベースのファイアウォールの名前もしくはIP アドレス。
ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。
Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。
プロキシベースのファイアウォールのTCP ポート。
ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。
プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。
プロキシベースのファイアウォールへの認証に使われるパスワード。
このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。
このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。
プロパティ | 説明 |
ProxyAutoDetect | これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。 |
ProxyServer | HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。 |
ProxyPort | ProxyServer プロキシが起動しているTCP ポート。 |
ProxyAuthScheme | ProxyServer プロキシへの認証で使われる認証タイプ。 |
ProxyUser | ProxyServer プロキシへの認証に使われるユーザー名。 |
ProxyPassword | ProxyServer プロキシへの認証に使われるパスワード。 |
ProxySSLType | ProxyServer プロキシへの接続時に使用するSSL タイプ。 |
ProxyExceptions | ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。 |
これは、システムプロキシ設定を使用するかどうかを示します。これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。
HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。
SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。
ProxyServer プロキシが起動しているTCP ポート。
HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。
ProxyServer プロキシへの認証で使われる認証タイプ。
この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。
Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
認証タイプは、次のどれかになります。
SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。
ProxyServer プロキシへの認証に使われるユーザー名。
ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。
ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。
user@domain domain\user
ProxyServer プロキシへの認証に使われるパスワード。
このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。
HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。
NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。
SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。
デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。
ProxyServer プロキシへの接続時に使用するSSL タイプ。
このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。
AUTO | デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。 |
ALWAYS | 接続は、常にSSL 有効となります。 |
NEVER | 接続は、SSL 有効になりません。 |
TUNNEL | 接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。 |
ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。
ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。
Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。
ログファイルに含めるコアモジュール。
指定された(';' で区切られた)モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。
概要はログ ページを参照してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
Location | テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
Tables | このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。 |
Views | 使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。 |
テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
Sync App のスキーマファイル(テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル)を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり(例えば、カラム名を変更する、カラムを無視するなど)、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。
指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\Ponparemall Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます:
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。
ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。
このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。
カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。 例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。
複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
DateRange | The default date range in days the driver sends requests for. It defaults to 90 days. |
MaxRows | クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。 |
Other | これらの隠しプロパティは特定のユースケースでのみ使用されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
UserDefinedViews | カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。 |
The default date range in days the driver sends requests for. It defaults to 90 days.
The default date range in days the driver sends requests for. It defaults to 90 days.
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
クエリで集計またはグループ化を使用しない場合に返される行数を制限します。これにより、設計時にパフォーマンスの問題を回避できます。
これらの隠しプロパティは特定のユースケースでのみ使用されます。
以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。
複数のプロパティをセミコロン区切りリストで指定します。
DefaultColumnSize | データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。 |
ConvertDateTimeToGMT | 日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。 |
RecordToFile=filename | 基底のソケットデータ転送を指定のファイルに記録します。 |
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。
カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。
また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。
このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。
次に例を示します。
{ "MyView": { "query": "SELECT * FROM Orders WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。
"UserDefinedViews", "C:\\Users\\yourusername\\Desktop\\tmp\\UserDefinedViews.json"