接続の確立

ShipStation への接続を追加

ShipStation への接続を追加するには：

アプリケーションコンソールで、接続ページに移動します。
接続の追加パネルで、追加したい接続のアイコンを選択します。
ShipStation アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからShipStation コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

ShipStation への接続には、BASIC 認証標準を使います。

ShipStation への接続

ShipStation アカウント: ShipStation Login にログインします。
右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
［アカウント］->［API 設定］をクリックします。
［API 設定］ページで、API Key とAPI Secret を書き留めます。

ShipStation への認証

APIKey：［API 設定］ページのAPI Key に設定。
APISecret：［API 設定］ページのSecret key に設定。

高度な機能

このセクションでは、ShipStation Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、ShipStation にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくは、クエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングに必要なのは2つの接続プロパティだけですが、より詳細なロギングをサポートする多くの機能があり、LogModules 接続プロパティを使用してロギングする情報のサブセットを指定することができます。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

概要

このセクションでは、利用可能なAPI オブジェクトを示し、ShipStation API へのSQL の実行について詳しく説明します。

主要機能

Sync App は、ShipStation エンティティをリレーショナルビューとしてモデル化し、SQL を記述してShipStation データをクエリできるようにします。
ストアドプロシージャを使用するとShipStation の操作を実行できます。
これらのオブジェクトへのライブ接続により、Sync App を使用するとShipStation アカウントへのあらゆる変更が即座に反映されます。

ビュー

ビューでは、利用可能なビューを説明します。ビューは、Customers、Products、Orders などを静的にモデル化するように定義されています。

ストアドプロシージャ

ストアドプロシージャは、ShipStation のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、注文のラベルの作成やオーダーへのユーザーの割り当てなど、ShipStation の操作を実行できます。

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

ShipStation Connector for CData Sync ビュー


Name	Description
CarrierPackages	Retrieves the list of packages for the specified carrier.
Carriers	Lists all shipping providers connected to this account.
CarrierServices	Lists all the available shipping services.
Customers	Lists customers.
CustomerTags	Lists customer tags.
Fulfillments	List all the fulfillments.
Marketplaces	Lists marketplaces.
MarketplaceUsernames	List all the marketplace usernames of the customers.
OrderCustomsItems	Customs Items of the Orders.
OrderItems	Items of the orders.
Orders	Lists all orders.
Products	Lists all the products.
ProductTags	Lists product tags.
ShipmentItems	Lists shipment items.
Shipments	Retrieves the list of shipments.
StoreRefreshStatus	Lists status of the store refresh.
Stores	Lists all stores.
Tags	Lists all the tags defined for this account.
Users	Lists ShipStation users.
Warehouses	Lists warehouses.

CarrierPackages

Retrieves the list of packages for the specified carrier.

Select

The Sync App will use the ShipStation 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.

CarrierCode supports the following operator: =.

Note: CarrierCode is required in order to query CarrierPackages. For example, the following query is processed server side:

SELECT * FROM CarrierPackages WHERE CarrierCode = 'hermes'

Columns


Name	Type	References	Description
CarrierCode [KEY]	String	Carriers.CarrierCode	The carrier's code.
Code	String		Unique code for the carrier Carrier Packages.
Name	String		Name of the package.
Domestic	Boolean		True or false for domestic.
International	Boolean		True or false for International.

Carriers

Lists all shipping providers connected to this account.

Select

The Sync App will use the ShipStation 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.

CarrierCode supports the following operator: =.

For example, the following query is processed server side:

SELECT * FROM Carriers WHERE CarrierCode = 'hermes'

Columns


Name	Type	References	Description
Id [KEY]	Integer		Shipment provider Id unique for the carriers.
CarrierCode	String		Unique code of the carrier.
AccountNumber	String		Carrier Account Number.
Balance	Double		Account balance of the carrier.
Name	String		Carrier name.
Nickname	String		Nick Name of the carrier.
Primary	Boolean		True or false for making carrier as primary.
RequiresFundedAccount	Boolean		True or false for requires Funded Account.

CarrierServices

Lists all the available shipping services.

Select

The Sync App will use the ShipStation 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.

CarrierCode supports the following operator: =.

Note: CarrierCode is required in order to query CarrierServices. For example, the following query is processed server side:

SELECT * FROM CarrierServices WHERE CarrierCode = 'hermes'

Columns


Name	Type	References	Description
CarrierCode [KEY]	String	Carriers.CarrierCode	Code of the carrier.
Code	String		Unique carrier service code.
Name	String		Name of the carrier service.
Domestic	Boolean		True or False for domestic.
International	Boolean		True or False for International.

Customers

Lists customers.

Select

The Sync App will use the ShipStation 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.

Id, CountryCode, StateCode, MarketplaceId and TagId support the following operator: =
The following columns will support server side sort: Name, ModifyDate and CreateDate can be sorted as ASC or DESC

For example, the following query is processed server side:

SELECT * FROM Customers WHERE CountryCode = 'US'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique customer Id.
AddressVerified	String		Address verified or not for the customer.
City	String		City of the customer.
Company	String		Company of the customer.
CountryCode	String		Country code of the customer.
CreateDate	Datetime		Customer create date.
Email	String		Email id of the customer.
ModifyDate	Datetime		Date of the Modified details of customer.
Name	String		Name of the customer.
Phone	String		Contact number of the customer.
PostalCode	String		Postal code of the customer.
State	String		Customer residence date.
Street1	String		Customer street1.
Street2	String		Customer street2.
StateCode	String		Customers that reside in the specified stateCode.
MarketplaceId	Long		Customers that purchased items from the specified marketplaceId.
TagId	String	CustomerTags.Id	Customers that have been tagged with the specified tagId.

CustomerTags

Lists customer tags.

Select

The Sync App will use the ShipStation 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.

CustomerId supports the following operator: =.

Note: CustomerId is required in order to query CustomerTags. For example, the following query is processed server side:

SELECT * FROM CustomerTags WHERE CustomerId = 1368175

Columns


Name	Type	References	Description
CustomerId	Long	Customers.Id	Id of the customer.
Id	Integer	Tags.Id	TagId of the customer.
Name	String		Name of the tag.

Fulfillments

List all the fulfillments.

Select

The Sync App will use the ShipStation 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.

Id, CreateDate, OrderId, OrderNumber, ShipDate, TrackingNumber and RecipientName support the following operator: =.
CreateDate and ShipDate support the following operators: =, <=, >=.

For example, the following query is processed server side:

SELECT * FROM Fulfillments WHERE Id = 122224

Columns


Name	Type	References	Description
Id [KEY]	Integer		Fulfillment Id of the order.
CarrierCode	String		Carrier Code for the order.
CreateDate	Datetime		Fulfillment create Date date.
CustomerEmail	String		Email Id of the customer.
DeliveryDate	Date		Delivery date of the product.
FulfillmentFee	Integer		Fulfillment date of the product.
FulfillmentProviderCod	String		Provider code of the fulfillment.
FulfillmentServiceCode	String		Service code of the fulfillment.
MarketplaceNotified	Boolean		Marketplace is notified or not.
NotifyErrorMessage	String		Error message of the notification.
OrderId	Integer	Orders.Id	Order Id of the product.
OrderNumber	String		Order number of the product.
ShipDate	Datetime		Shipping date of the product.
ShipToAddressVerified	String		Shipping address verification status.
ShipToCity	String		Shipping to city.
ShipToCompany	String		Shipping to company.
ShipToCountry	String		Shipping to country.
ShipToName	String		Shipping to name.
ShipToPhone	String		Shipping to phone number.
ShipToPostalCode	String		Shipping to postal code.
ShipToResidential	Boolean		Shipping to residential.
ShipToState	String		Shipping to State.
ShipToStreet1	String		Shipping to street1.
ShipToStreet2	String		Shipping to street2.
ShipToStreet3	String		Shipping to street3.
TrackingNumber	String		Tracking number of the product.
UserId	String	Users.Id	UserId of order.
VoidDate	Datetime		Void date of order.
Voided	Boolean		Whether or not the order is voided.
VoidRequested	Boolean		Void.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。


Name	Type	Description
RecipientName	String		Name of the recipient.

Marketplaces

Lists marketplaces.

Select

The Sync App will use the ShipStation All the filter are executed in the client side within the Sync App.

Columns


Name	Type	References	Description
Id [KEY]	Integer		Id of the marketplace.
CanConfirmShipments	Boolean		Can confirm shipments or not.
CanRefresh	Boolean		Whether or not the marketplace can refresh.
Name	String		Name of the Marketplace.
SupportsCustomMappings	Boolean		Marketplace will able to support custom mapping or not.
SupportsCustomStatuses	Boolean		Marketplace will able to support custom statuses or not.

MarketplaceUsernames

List all the marketplace usernames of the customers.

Select

The Sync App will use the ShipStation 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.

CustomerId supports the following operator: =.

Note: CustomerId is required in order to query MarketplaceUserNames. For example, the following query is processed server side:

SELECT * FROM MarketplaceUserNames WHERE CustomerId = 1368175

Columns


Name	Type	References	Description
Id [KEY]	Long		Marketplace customer user Id.
CustomerId [KEY]	Long	Customers.Id	Id of the customer.
CreateDate	Datetime		Create date of this record.
Marketplace	String		Name of the marketplace.
MarketplaceId	Integer		Id of the marketplace.
ModifyDate	Datetime		Modify date of this record.
Username	String		Username of the customers.

OrderCustomsItems

Customs Items of the Orders.

Select

The Sync App will use the ShipStation 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.

OrderId supports the following operator: =.

Note: OrderId is required in order to query OrderCustomsItems. For example, the following query is processed server side:

SELECT * FROM OrderCustomsItems WHERE OrderId = 2810333

Columns


Name	Type	References	Description
CustomsItemId [KEY]	Long		Id of the customs Item.
CountryOfOrigin	String		Origin country of the customs Item.
Description	String		Description of the customs Item.
HarmonizedTariffCode	String		Harmonized tariff code of the customers Item.
Quantity	Integer		Quantity of the customs Item.
Value	Double		Value of the customs Item.
OrderId [KEY]	Long		Id of the Order.

OrderItems

Items of the orders.

Select

The Sync App will use the ShipStation 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.

OrderId supports the following operator: =.

Note: OrderId is required in order to query OrderItems. For example, the following query is processed server side:

SELECT * FROM OrderItems WHERE OrderId = 2810333

Columns


Name	Type	References	Description
OrderItemId [KEY]	Long		Id of the Ordered Item.
ImageUrl	String		URL of the ordered Item Image.
LineItemKey	String		Key of the line Item.
Name	String		Name of the ordered Item.
Options	String		List of options associated with this order item.
Quantity	Integer		Quantity of the ordered Item.
ShippingAmount	Double		Shipping amount for the ordered Item.
SKU	String		SKU of the ordered Item.
TaxAmount	Double		Tax amount for the ordered Item.
UnitPrice	Double		Unite price of the Ordered Item.
WarehouseLocation	String		Ordered Item warehouse location.
ProductId	Integer	Products.Id	Product Id of the ordered Id.
FulfillmentSKU	String		Fulfillment SKU for the ordered Item.
Adjustment	Boolean		Adjustment is there are not for ordered Item.
Upc	String		UPC of the ordered Item.
CreateDate	Datetime		Create date of this record.
ModifyDate	Datetime		Modify date of this record.
WeightUnits	String		Weight unit of the ordered Item.
WeightValue	Double		Weight value of the ordered Item.
WeightWtUnits	Integer		A numeric value that is equivalent to the units field.
OrderId [KEY]	Long	Orders.Id	Id of the Order.

Orders

Lists all orders.

Select

The Sync App will use the ShipStation 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.

Id ,OrderNumber ,OrderStatus ,CustomerName ,ItemKeyword and TagId support the following operator: =.
CreateDate ,ModifyDate ,OrderDate and PaymentDate support the following operators: =,<=,>=.
The following columns will support server side sort: Name, OrderDate ,ModifyDate CreateDate and can be sorted as ASC or DESC

For example, the following query is processed server side:

SELECT * FROM Orders WHERE Id = 2810333

Columns


Name	Type	References	Description
Id [KEY]	Long		The system generated identifier for the order.
AdvancedOptionsBillToAccount	String		Account number of billToParty.
AdvancedOptionsBillToCountryCode	String		Country Code of billToParty.
AdvancedOptionsBillToParty	String		Identifies which party to bill.
AdvancedOptionsBillToPostalCode	String		Postal code of billToParty.
AdvancedOptionsContainsAlcohol	Boolean		Specifies whether the order contains alcohol.
AdvancedOptionsCustomField1	String		Field that allows for custom data to be associated with an order.
AdvancedOptionsCustomField2	String		Field that allows for custom data to be associated with an order.
AdvancedOptionsCustomField3	String		Field that allows for custom data to be associated with an order.
AdvancedOptionsMergedIds	String		Array of orderIds. Each orderId identifies an order that was merged with the associated order.
AdvancedOptionsMergedOrSplit	Boolean		Returns whether or not an order has been merged or split with another order.
AdvancedOptionsNonMachinable	Boolean		Specifies whether the order is non-machinable.
AdvancedOptionsParentId	Integer		If an order has been split, it will return the Parent ID of the order with which it has been split.
AdvancedOptionsSaturdayDelivery	Boolean		Specifies whether the order is to be delivered on a Saturday.
AdvancedOptionsSource	String		Identifies the original source/marketplace of the order.
AdvancedOptionsStoreId	Integer		ID of store that is associated with the order.
AdvancedOptionsWarehouseId	Integer		Specifies the warehouse where to the order is to ship from.
AmountPaid	Double		The total amount paid for the Order.
BillToAddressVerified	String		Billing to address Verified Status.
BillToCity	String		Billing to city.
BillToCompany	String		Billing to company.
BillToCountry	String		Billing to country.
BillToName	String		Billing to Name.
BillToPhone	String		Billing to phone.
BillToPostalCode	String		Billing to postal code.
BillToResidential	Boolean		Billing to residential.
BillToState	String		Billing to state.
BillToStreet1	String		Billing to street1.
BillToStreet2	String		Billing to street2.
BillToStreet3	String		Billing to shipToStreet3.
CarrierCode	String		The code for the carrier that is to be used(or was used) when this order is shipped(was shipped).
Confirmation	String		The type of delivery confirmation that is to be used(or was used) when this order is shipped(was shipped).
CreateDate	Datetime		The timestamp the order was created in ShipStation's database. Read-Only.
CustomerEmail	String		The customer's email address.
CustomerId	Integer	Customers.Id	Unique identifier for the customer. Generated by ShipStation the first time the customer record is created.
CustomerNotes	String		Notes left by the customer when placing the order.
CustomerUsername	String		Identifier for the customer in the originating system. This is typically a username or email address.
DimensionsHeight	Double		Height of the order.
DimensionsLength	Double		Length of the order.
DimensionsUnits	String		Units of the order.
DimensionsWidth	Double		Width of the order.
ExternallyFulfilled	Boolean		States whether the order has is current marked as externally fulfilled by the marketplace.
ExternallyFulfilledBy	String		If externally Fulfilled is true then this string will return how the order is being fulfilled by the marketplace.
Gift	Boolean		Specifies whether or not this Order is a gift.
GiftMessage	String		Gift message left by the customer when placing the order.
HoldUntilDate	String		If placed on hold, this date is the expiration date for this order's hold status.
InsuranceOptionsInsuredValue	Double		The shipping insurance information associated with this order.(insured Value).
InsuranceOptionsInsureShipment	Boolean		The shipping insurance information associated with this order.(insured Shipment).
InsuranceOptionsProvider	String		The shipping insurance information associated with this order.(insurance provider).
InternalNotes	String		Private notes that are only visible to the seller.
InternationalOptionsContents	String		Customs information that can be used to generate customs documents for international orders(contents).
InternationalOptionsNonDelivery	String		Customs information that can be used to generate customs documents for international orders(non Delivery).
LabelMessages	String		Label messages of the order.
ModifyDate	Datetime		The timestamp the order was modified in ShipStation. modify Date will equal create Date until a modification is made.
OrderDate	Datetime		The date the order was placed.
OrderKey	String		A user-provided key that should be unique to each order. Can only be initalized during order creation. If the orderkey isn't specified during creation, a unique value will be generated and assigned.
OrderNumber	String		A user-defined order number used to identify an order.
OrderStatus	String		The order's status. Possible values: 'awaiting_payment', 'awaiting_shipment', 'shipped', 'on_hold', 'cancelled'
OrderTotal	Double		The order total.
PackageCode	String		The code for the package type that is to be used(or was used) when this order is shipped(was shipped).
PaymentDate	Datetime		The date the order was paid for.
PaymentMethod	String		Method of payment used by the customer.
RequestedShippingService	String		Identifies the shipping service selected by the customer when placing this order. This value is given to ShipStation by the marketplace/cart.
ServiceCode	String		The code for the shipping service that is to be used(or was used) when this order is shipped(was shipped).
ShipByDate	Date		The date the order is to be shipped before or on.
ShipDate	Date		The date the order was shipped.
ShippingAmount	Double		Shipping amount paid by the customer, if any.
ShipToAddressVerified	String		The recipients shipping address Verified or not.
ShipToCity	String		The recipients shipping city.
ShipToCompany	String		The recipients shipping company.
ShipToCountry	String		The recipients shipping country.
ShipToName	String		The recipients shipping name.
ShipToPhone	String		The recipients shipping phone.
ShipToPostalCode	String		The recipients shipping postal code.
ShipToResidential	Boolean		The recipients shipping residential.
ShipToState	String		The recipients shipping state.
ShipToStreet1	String		The recipients shipping street1.
ShipToStreet2	String		The recipients shipping street2.
ShipToStreet3	String		The recipients shipping street3.
TagIds	String		Array of tagIds associated with this order.
TaxAmount	Double		The total tax amount for the Order.
UserId	String		User assigned to Order/Shipment in the GUID. Read-Only.
WeightUnits	String		Weight of the order units.
WeightValue	Double		Weight of the order value.
WeightWtUnits	Integer		A numeric value that is equivalent to the units field.
CustomerName	String		Name of the customer.
ItemKeyword	String		Returns orders that contain items that match the specified keyword. Fields searched are Sku, Description, and Options.

Products

Lists all the products.

Select

The Sync App will use the ShipStation 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.

Id, ProductCategoryId , ShowInactive, ProductTypeId and TagId support the following operator: =.
CreateDate supports the following operators: =,<=,>=.
The following columns will support server side sort: SKU, ModifyDate, CreateDate and can be sorted as ASC or DESC

For example, the following query is processed server side:

SELECT * FROM Products WHERE Id = 1381428

Columns


Name	Type	References	Description
Id [KEY]	Integer		Id of product.
Active	Boolean		Product active or not status.
Aliases	String		Aliases for the product.
CreateDate	Datetime		Create date of this record.
CustomsCountryCode	String		Customs country code of the product.
CustomsDescription	String		Customs description of the product.
CustomsTariffNo	String		Customs traffic number of the product.
CustomsValue	Double		Customs value of the product.
DefaultCarrierCode	String		Default carrier code for the product.
DefaultConfirmation	String		Default confirmation of the product.
DefaultCost	Double		Default cost for the product.
DefaultIntlCarrierCode	String		Default international carrier code of the product.
DefaultIntlConfirmation	String		Default international confirmation code of the product.
DefaultIntlPackageCode	String		Default international package code.
DefaultIntlServiceCode	String		Default international service code.
DefaultPackageCode	String		The default domestic packageType for this product.
DefaultServiceCode	String		The default domestic shipping service for this product.
FulfillmentSKU	String		Stock keeping Unit for the fulfillment of that product by a 3rd party.
Height	Double		The height of the product. Unit of measurement is UI dependent. No conversions will be made from one UOM to another. See our knowledge base here for more details.
InternalNotes	String		Seller's private notes for the product.
Length	Double		The length of the product. Unit of measurement is UI dependent. No conversions will be made from one UOM to another. See our knowledge base here for more details.
ModifyDate	Datetime		The timestamp the product record was modified in ShipStation. Read-Only.
Name	String		Name or description of the product.
NoCustoms	Boolean		If true, this product will not be included on international customs forms.
Price	Double		The unit price of the product.
ProductCategoryId	Long		The system generated identifier for the product category.
ProductCategoryName	String		Name or description for the product category.
ProductTypeCustomsCountryCode	String		Customs Country Code of the Product Type.
ProductTypeCustomsDescription	String		Customs Description of the Product Type.
ProductTypeCustomsTariffNo	String		Customs Tariff No of the Product Type.
ProductTypeCustomsValue	Double		Customs Value of the Product Type.
ProductTypeHeight	Double		Height of the Product Type.
ProductTypeDefaultCarrierCode	String		Default Carrier Code of the Product Type.
ProductTypeDefaultIntlCarrierCode	String		Default International Carrier Code of the Product Type.
ProductTypeDefaultIntlPackageCode	String		Default International Package Code of the Product Type.
ProductTypeDefaultIntlServiceCode	String		Default International Service Code of the Product Type.
ProductTypeDefaultPackageCode	String		Default Package Code of the Product Type.
ProductTypeDefaultServiceCode	String		Default Service Code of the Product Type.
ProductTypeId	Long		Specifies the product type Id.
ProductTypeLength	Double		Length of the Product Type.
ProductTypeName	String		Name of the Product Type.
ProductTypeNoCustoms	Boolean		If true, this product type will not nbe included on international customs forum.
ProductTypeWeightOz	Double		Weight of the Product Type.
ProductTypeWidth	Double		Width of the Product Type.
SKU	String		Stock keeping Unit. A user-defined value for a product to help identify the product. It is suggested that each product should contain a unique SKU.
WarehouseLocation	String		The warehouse location associated with the product record.
WeightOz	Double		The weight of a single item in ounces.
Width	Double		The width of the product. Unit of measurement is UI dependent. No conversions will be made from one UOM to another. See our knowledge base here for more details.
ShowInactive	Boolean		Whether the list should include inactive products.
TagId	Integer	Tags.Id	Tag Id of the product

ProductTags

Lists product tags.

Select

The Sync App will use the ShipStation 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.

ProductId supports the following operator: =.

Note: ProductId is required in order to query ProductTags. For example, the following query is processed server side:

SELECT * FROM ProductTags WHERE ProductId = 1381428

Columns


Name	Type	References	Description
Id	Integer	Tags.Id	The system generated identifier for the product tag.
Name	String		Name or description for the product tag.
ProductId	Long	Products.Id	Id of the product.

ShipmentItems

Lists shipment items.

Select

The Sync App will use the ShipStation All the filter is executed client side within the Sync App.

Columns


Name	Type	References	Description
Id [KEY]	Long		Id of the ordered Item.
ShipmentId	Long		Id of the Shipment.
FulfillmentSKU	String		The fulfillment SKU associated with this OrderItem if the fulfillment provider requires an identifier other then the SKU.
ImageUrl	String		The public URL to the product image.
LineItemKey	String		An identifier for the OrderItem in the originating system.
Name	String		The name of the product associated with this line item. Cannot be null.
OptionsName	String		Options of the Item.
OptionsValue	String		Options of the Item.
ProductId	Integer		Id of the product.
Quantity	Integer		The quantity of product ordered.
SKU	String		The SKU (stock keeping unit) identifier for the product associated with this line item.
UnitPrice	Double		The sell price of a single item specified by the order source.
WarehouseLocation	String		The location of the product within the seller's warehouse (e.g. Aisle 3, Shelf A, Bin 5).
WeightValue	Double		The weight value of a single item.
WeightUnits	String		The units of weight.
WeightWtUnits	Integer		A numeric value that is equivalent to the units field.

Shipments

Retrieves the list of shipments.

Select

The Sync App will use the ShipStation 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.

CarrierCode, OrderId, OrderNumber, ServiceCode, TrackingNumber, RecipientName, RecipientCountryCode and StoreId support the following operator: =.
CreateDate, ShipDate and VoidDate support the following operators: =,<=,>=.
The following columns will support server side sort: CreateDate and ShipDate can be sorted as ASC or DESC

For example, the following query is processed server side:

SELECT * FROM Shipments WHERE CarrierCode = 'hermes'

Columns


Name	Type	References	Description
Id [KEY]	Integer		Id of the Shipment.
AdvancedOptionsBillToAccount	String		Bill to Account of the shipment.
AdvancedOptionsBillToCountryCode	String		Bill to country code of the shipment.
AdvancedOptionsBillToMyOtherAccount	String		Bill to other account of the shipment.
AdvancedOptionsBillToParty	String		Bill to party of the shipment.
AdvancedOptionsBillToPostalCode	String		Bill to postal code of the shipment.
AdvancedOptionsContainsAlcohol	Boolean		Whether the shipment contains alcohol or not.
AdvancedOptionsCustomField1	String		Custom field for shipment description.
AdvancedOptionsCustomField2	String		Custom field for shipment description.
AdvancedOptionsCustomField3	String		Custom field for shipment description.
AdvancedOptionsMergedIds	String		Merge id of the shipment.
AdvancedOptionsMergedOrSplit	Boolean		Merge or split the shipment.
AdvancedOptionsNonMachinable	Boolean		None machinable or not.
AdvancedOptionsParentId	Integer		Parent Id of the shipment.
AdvancedOptionsSaturdayDelivery	Boolean		Available for Saturday delivery or not.
AdvancedOptionsSource	String		Source of the shipment.
AdvancedOptionsStoreId	Integer		Store Id of the shipment.
AdvancedOptionsWarehouseId	Integer		Warehouse Id of the shipment.
BatchNumber	String		Batch Number of the shipment.
CarrierCode	String		Carrier code of the shipment.
Confirmation	String		Confirmation of the shipment.
CreateDate	Datetime		Create date of this record.
DimensionsHeight	Double		Height of the shipment.
DimensionsLength	Double		Length of the shipment.
DimensionsUnits	String		Units of the shipment.
DimensionsWidth	Double		Width of the shipment.
FormData	String		Form data for the shipment.
InsuranceCost	Double		Insurance cost of the shipment.
InsuranceOptionsInsuredValue	Double		Insured value of the shipment.
InsuranceOptionsInsureShipment	Boolean		Shipment is insured or not.
InsuranceOptionsProvider	String		Insurance provider of the shipment.
IsReturnLabel	Boolean		Shipment is return label is there or not.
LabelData	String		Label data of the shipment.
MarketplaceNotified	Boolean		Marketplace is notified or not.
NotifyErrorMessage	String		Error message of the notification.
OrderId	Integer		Order Id of the shipment.
OrderKey	String		Order Item key of the shipment.
OrderNumber	String		Order Number of the shipment.
PackageCode	String		Package code of the shipment.
ServiceCode	String		Service code of the shipment.
ShipDate	Date		Ship date of the shipment.
ShipmentCost	Double		Shipment cost.
ShipToCity	String		Ship to city.
ShipToCompany	String		Ship to company.
ShipToCountry	String		Ship to country.
ShipToName	String		Ship to Name.
ShipToPhone	String		Ship to phone.
ShipToPostalCode	String		Ship to postal code.
ShipToResidential	Boolean		Ship to residential.
ShipToState	String		Ship to state.
ShipToStreet1	String		Ship to street.
ShipToStreet2	String		Ship to street.
ShipToStreet3	String		Ship to street.
TrackingNumber	String		Shipment tracking Number.
UserId	String		Shipment user Id.
VoidDate	Datetime		Void date of the shipment.
Voided	Boolean		Voided date of the shipment.
WarehouseId	Integer		Warehouse Id of the shipment.
WeightUnits	String		Weight units of the shipment.
WeightValue	Double		Weight value of the shipment.
WeightWtUnits	Integer		A numeric value that is equivalent to the units field.
RecipientName	String		Name of the Shipment Recipient Name.
RecipientCountryCode	String		Country code of the shipment recipient.
StoreId	Integer		Store Id of the shipment.

StoreRefreshStatus

Lists status of the store refresh.

Select

The Sync App will use the ShipStation 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.

StoreId supports the following operator: =.

Note: StoreId is required in order to execute StoreRefreshStatus. For example, the following query is processed server side:

SELECT * FROM StoreRefreshStatus WHERE StoreId = 5603

Columns


Name	Type	References	Description
StoreId [KEY]	Integer	Stores.Id	Id of the store.
Id	Integer		Store refresh status id.
LastRefreshAttempt	Date		Last date of the refresh attempt for store.
RefreshDate	Date		Refresh date of the store.
RefreshStatus	String		Refresh status of the store.

Stores

Lists all stores.

Select

The Sync App will use the ShipStation 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.

Id, MarketplaceId and ShowInactive support the following operator: =.

For example, the following query is processed server side:

SELECT * FROM Stores WHERE Id = 5603

Columns


Name	Type	References	Description
Id [KEY]	Integer		Id of the store.
AccountName	String		Account name of the store.
Active	Boolean		Whether store is active or not.
AutoRefresh	Boolean		Whether refresh is available or not.
CompanyName	String		Company name of the store.
CreateDate	Datetime		Create date of this record.
Email	String		Email id of the store.
IntegrationUrl	String		Integration URL of the store.
LastRefreshAttempt	Datetime		Last refresh attempt of the store.
MarketplaceId	Integer		Marketplace Id of the store.
MarketplaceName	String		Marketplace Name of the store.
ModifyDate	Datetime		Modify date of the store.
Phone	String		Phone number of the store.
PublicEmail	String		Public email of the store.
RefreshDate	Datetime		Refresh date of the store.
StatusMappings	String
StoreName	String		Name of the store.
Website	String		Website of the store.
ShowInactive	Boolean		Specifies whether inactive stores will be shown.

Users

Lists ShipStation users.

Select

The Sync App will use the ShipStation 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.

ShowInactive supports the following operator: =.

For example, the following query is processed server side:

SELECT * FROM Users WHERE ShowInactive = 'true'

Columns


Name	Type	References	Description
Id [KEY]	String		Id of the User.
Name	String		Name of the User.
UserName	String		User name of the User.
ShowInactive	Boolean		Specifies whether inactive stores will be shown.

Warehouses

Lists warehouses.

Select

The Sync App will use the ShipStation 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.

Id supports the following operator: =.

For example, the following query is processed server side:

SELECT * FROM Warehouses WHERE Id = 8688

Columns


Name	Type	References	Description
Id [KEY]	Integer		Id of the warehouses.
WarehouseName	String		Name of the warehouse.
CreateDate	Datetime		Create date of the record.
IsDefault	Boolean		Whether it is default warehouse or not.
OriginAddressAddressVerified	String		Origin address is verified or not.
OriginAddressCity	String		Origin city of the warehouse.
OriginAddressCompany	String		Origin country of the warehouse.
OriginAddressCountry	String		Origin name of the warehouse.
OriginAddressName	String		Origin phone of the warehouse.
OriginAddressPhone	String		Origin phone of the warehouse.
OriginAddressPostalCode	String		Origin postal code of the warehouse.
OriginAddressResidential	Boolean		Origin residential of the warehouse.
OriginAddressState	String		Origin state of the warehouse.
OriginAddressStreet1	String		Origin street of the warehouse.
OriginAddressStreet2	String		Origin street of the warehouse.
OriginAddressStreet3	String		Origin street of the warehouse.
ReturnAddressAddressVerified	String		Return address is verified or not.
ReturnAddressCity	String		Return city of the warehouse.
ReturnAddressCompany	String		Return company of the warehouse.
ReturnAddressCountry	String		Return country of the warehouse.
ReturnAddressName	String		Return Name of the warehouse.
ReturnAddressPhone	String		Return phone of the warehouse.
ReturnAddressPostalCode	String		Return postal code of the warehouse.
ReturnAddressResidential	String		Return residential of the warehouse.
ReturnAddressState	String		Return state of the warehouse.
ReturnAddressStreet1	String		Return street of the warehouse.
ReturnAddressStreet2	String		Return street of the warehouse.
ReturnAddressStreet3	String		Return street of the warehouse.

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

接続を確立する方法について詳しくは、接続の確立を参照してください。

Authentication

プロパティ	説明
APIKey	The API key used for accessing your ShipStation account.
APISecret	The API secret used for accessing your ShipStation account.

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Firewall

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

Proxy

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxThreads	同時リクエスト数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
APIKey	The API key used for accessing your ShipStation account.
APISecret	The API secret used for accessing your ShipStation account.

APIKey

The API key used for accessing your ShipStation account.

解説

The API key can be found by navigating to Account -> API Settings -> API Keys.

APISecret

The API secret used for accessing your ShipStation account.

解説

The API secret can be found by navigating to Account -> API Settings -> API Secret.

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

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

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。
FirewallServer	ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。
FirewallPort	プロキシベースのファイアウォールで使用するTCP ポートを指定します。
FirewallUser	プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。
FirewallPassword	プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

FirewallType

provider がプロキシベースのファイアウォールを介してトラフィックをトンネリングするために使用するプロトコルを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Note：デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し、次のプロキシタイプのいずれかに接続するには、ProxyAutoDetect をfalse に設定します。

次の表は、サポートされている各プロトコルのポート番号情報です。


プロトコル	デフォルトポート	説明
TUNNEL	80	Sync App がShipStation への接続を開くポート。トラフィックはこの場所のプロキシを経由して行き来します。
SOCKS4	1080	Sync App がShipStation への接続を開くポート。SOCKS 4 は次にFirewallUser 値をプロキシに渡し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	Sync App がShipStation にデータを送信するポート。SOCKS 5 プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

ファイアウォールを通過し、ユーザーのクエリをネットワークリソースに中継するために使用されるプロキシのIP アドレス、DNS 名、またはホスト名を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPort

プロキシベースのファイアウォールで使用するTCP ポートを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallUser

プロキシベースのファイアウォールに認証するアカウントのユーザーID を識別します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

FirewallPassword

プロキシベースのファイアウォールで認証するユーザーアカウントのパスワードを指定します。

解説

プロキシベースのファイアウォール（またはプロキシファイアウォール）は、ユーザーのリクエストとそれがアクセスするリソースの間に介在するネットワークセキュリティデバイスです。プロキシは認証済みのユーザーのリクエストを受け取り、ファイアウォールを通過して適切なサーバーにリクエストを送信します。

プロキシは、リクエストを送信したユーザーに代わってデータバケットを評価し転送するため、ユーザーはサーバーに直接接続することなく、プロキシのみに接続します。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。
ProxyServer	HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort	クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。
ProxyAuthScheme	ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。
ProxyUser	ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword	ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。
ProxySSLType	ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。
ProxyExceptions	ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

provider が、手動で指定されたプロキシサーバーを使用するのではなく、既存のプロキシサーバー構成についてシステムプロキシ設定をチェックするかどうかを指定します。

解説

この接続プロパティをTrue に設定すると、Sync App は既存のプロキシサーバー構成についてシステムプロキシ設定をチェックします（プロキシサーバーの詳細を手動で入力する必要はありません）。

この接続プロパティは他のプロキシ設定より優先されます。特定のプロキシサーバーに接続するためにSync App を手動で構成する場合は、False に設定します。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーを介してHTTP トラフィックをルーティングします。

ProxyPort

クライアントとの間でHTTP トラフィックをルーティングするために予約された、指定されたプロキシサーバー（ProxyServer 接続プロパティで設定）のTCP ポート。

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたプロキシサーバーポートを通じてのみHTTP トラフィックをルーティングします。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムプロキシ設定で指定されたプロキシサーバーポートを介してHTTP トラフィックをルーティングします。

その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer 接続プロパティで指定されたプロキシサーバーに対して認証する際にprovider が使用する認証方法を指定します。

解説

認証タイプは次のいずれかです。

BASIC：Sync App はHTTP BASIC 認証を行います。
DIGEST：Sync App はHTTP DIGEST 認証を行います。
NTLM：Sync App はNTLM トークンを取得します。
NEGOTIATE：Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
NONE：ProxyServer が認証を必要としない場合に設定します。

"NONE" 以外のすべての値については、ProxyUser およびProxyPassword 接続プロパティも設定する必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer 接続プロパティで指定されたプロキシサーバーに登録されているユーザーアカウントのユーザー名。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyUser に設定する値
BASIC	プロキシサーバーに登録されているユーザーのユーザー名。
DIGEST	プロキシサーバーに登録されているユーザーのユーザー名。
NEGOTIATE	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NTLM	プロキシサーバーが属するドメインまたは信頼されたドメイン内の有効なユーザーであるWindows ユーザーのユーザー名。`user@domain` または`domain\user` の形式で指定。
NONE	ProxyPassword 接続プロパティは設定しないでください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このユーザー名を使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているユーザー名を使用します。

ProxyPassword

ProxyUser 接続プロパティで指定されたユーザーに紐付けられたパスワード。

解説

ProxyUser および ProxyPassword 接続プロパティは、ProxyServer で指定されたHTTP プロキシに対して接続よび認証するために使用されます。

ProxyAuthScheme で利用可能な認証タイプを1つ選択した後、このプロパティを以下のように設定します。


ProxyAuthScheme の値	ProxyPassword に設定する値
BASIC	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
DIGEST	ProxyUser で指定したプロキシサーバーユーザーに紐付けられたパスワード。
NEGOTIATE	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NTLM	ProxyUser で指定したWindows ユーザーアカウントに紐付けられたパスワード。
NONE	ProxyPassword 接続プロパティは設定しないでください。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

Sync App は、ProxyAutoDetect がFalse に設定されている場合にのみ、このパスワードを使用します。ProxyAutoDetect がTrue に設定されている場合（デフォルト）、Sync App は代わりにシステムのプロキシ設定で指定されているパスワードを使用します。

ProxySSLType

ProxyServer 接続プロパティで指定されたプロキシサーバーに接続する際に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この接続プロパティには、以下の値を設定できます。


AUTO	デフォルト設定。ProxyServer がHTTPS URL に設定されている場合、Sync App は、TUNNEL オプションを使用します。ProxyServer がHTTP URL に設定されている場合、コンポーネントはNEVER オプションを使用します。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続はトンネリングプロキシ経由で行われます。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 接続プロパティで設定されたプロキシサーバー経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App はデフォルトでシステムプロキシ設定を使用するため、それ以上の設定は必要ありません。この接続にプロキシ例外を明示的に設定する場合は、ProxyAutoDetect をFalse に設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

LogModules

ログファイルに含めるコアモジュールを指定します。セミコロンで区切られたモジュール名のリストを使用します。デフォルトでは、すべてのモジュールがログに記録されます。

解説

このプロパティは、含めるログモジュールを指定することでログファイルの内容をカスタマイズすることができます。ログモジュールは、クエリ実行、メタデータ、SSL 通信などの異なる領域にログ情報を分類します。各モジュールは4文字のコードで表され、文字の名前の場合は末尾にスペースが必要なものもあります。

例えば、EXEC はクエリ実行をログに記録し、INFO は一般的なプロバイダーメッセージをログに記録します。複数のモジュールを含めるには、次のように名前をセミコロンで区切ります：INFO;EXEC;SSL。

Verbosity 接続プロパティは、このプロパティで指定されたモジュールベースのフィルタリングよりも優先されます。 Verbosity レベルを満たし、指定されたモジュールに属するログエントリのみが記録されます。利用可能なすべてのモジュールをログファイルに含めるには、このプロパティを空白のままにします。

利用可能なモジュールの完全なリストとログの設定に関する詳細な手引きについては、ログの「高度なログの記録」セクションを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。
Views	レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリの場所を指定します。サービスの要件に応じて、これは絶対パスまたは相対パスのいずれかで表されます。

解説

Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

指定しない場合、デフォルトの場所は%APPDATA%\\CData\\ShipStation Data Provider\\Schema となり、%APPDATA%はユーザーのコンフィギュレーションディレクトリに設定されます：


プラットフォーム	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Tables

レポートされるテーブルを利用可能なすべてのテーブルのサブセットに制限するオプション設定。例えば、 Tables=TableA,TableB,TableC です。

解説

データベースによっては、利用可能なすべてのテーブルをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にテーブルのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なテーブルがたくさんあり、すでに作業したいテーブルが決まっている場合、このプロパティを使用して対象のテーブルのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、表示する各テーブルを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するテーブルが混同されることを防ぎます。

Views

レポートされたビューを使用可能なテーブルのサブセットに制限するオプション設定。例えば、 Views=ViewA,ViewB,ViewC です。

解説

データベースによっては、利用可能なすべてのビューをリストするのに時間がかかり、パフォーマンスが低下する場合があります。接続文字列にビューのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

利用可能なビューがたくさんあり、すでに作業したいビューが決まっている場合、このプロパティを使用して対象のビューのみに表示を制限することができます。これを行うには、カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

Note：複数のスキーマまたはカタログを持つデータソースに接続する場合は、確認する各ビューを完全修飾名で指定する必要があります。これにより、複数のカタログやスキーマに存在するビューが混同されることを防ぎます。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
MaxRows	集計やGROUP BY を使用しないクエリで返される最大行数を指定します。
MaxThreads	同時リクエスト数を指定します。
Other	特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。
PseudoColumns	テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

MaxRows

集計やGROUP BY を使用しないクエリで返される最大行数を指定します。

解説

このプロパティは、集計やGROUP BY 句を含まないクエリに対してSync App が返す行数の上限を設定します。この制限により、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。 MaxRows が"-1" に設定されている場合、LIMIT 句が明示的にクエリに含まれていない限り、行の制限は行われません。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し過剰なリソース消費を防ぐのに役立ちます。

MaxThreads

同時リクエスト数を指定します。

解説

このプロパティを使用すると、複数のリクエストを同時に発行することができパフォーマンスが向上します。

Other

特定のユースケースに対して追加の隠しプロパティを指定します。これらは通常のprovider の機能では必要ありません。複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

解説

このプロパティは、シニアユーザーが特定のシナリオに対して隠しプロパティを設定できるようにします。これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。複数のプロパティをセミコロン区切りのリストで定義できます。

Note： 特定のシナリオや問題に対処するためにサポートチームから助言があった場合にのみ、これらのプロパティを設定することを強く推奨します。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

PseudoColumns

テーブルカラムとして公開する擬似カラムを指定します。'TableName=ColumnName;TableName=ColumnName' という形式を使用します。デフォルトは空の文字列で、このプロパティを無効にします。

解説

このプロパティを使用すると、Sync App がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。"Table1=Column1;Table1=Column2;Table2=Column3"

すべてのテーブルのすべての擬似カラムを含めるには、次のようにします："*=*"

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。デフォルトは60秒です。タイムアウトを無効にするには0を設定します。

解説

このプロパティは、Sync App が操作をキャンセルする前に操作の完了を待機する最大時間を秒単位で制御します。操作の完了前にタイムアウト時間が経過すると、Sync App は操作をキャンセルして例外をスローします。

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

このプロパティを0に設定するとタイムアウトが無効になり、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UserDefinedViews

カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

解説

このプロパティを使用すると、UserDefinedViews.json というJSON 形式の構成ファイルを通じてカスタムビューを定義および管理できます。これらのビューはSync App によって自動的に認識され、標準のデータベースビューのようにカスタムSQL クエリを実行できるようになります。 JSON ファイルは、各ビューをルート要素として定義し、その子要素として"query" を持ちます。この"query" にはビューのSQL クエリが含まれています。次に例を示します。

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

このプロパティを使用して、1つのファイルに複数のビューを定義し、ファイルパスを指定できます。例：UserDefinedViews=C:\Path\To\UserDefinedViews.json。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

詳しくは、ユーザー定義ビューを参照してください。

ShipStation Connector for CData Sync

ShipStation Connector for CData Sync

概要

ShipStation バージョンサポート

接続の確立

ShipStation への接続を追加

ShipStation への接続

ShipStation への認証

高度な機能

ユーザー定義ビュー

SSL の設定

ファイアウォールとプロキシ

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

概要

主要機能

ビュー

ストアドプロシージャ

ビュー

ShipStation Connector for CData Sync ビュー

CarrierPackages

Select

Columns

Carriers

Select

Columns

CarrierServices

Select

Columns

Customers

Select

Columns

CustomerTags

Select

Columns

Fulfillments

Select

Columns

Pseudo-Columns

Marketplaces

Select

Columns

MarketplaceUsernames

Select

Columns

OrderCustomsItems

Select

Columns

OrderItems

Select

Columns

Orders

Select

Columns

Products

Select

Columns

ProductTags

Select

Columns

ShipmentItems

Select

Columns

Shipments

Select

Columns

StoreRefreshStatus

Select

Columns

Stores

Select

Columns

Tags