ShipStation への接続を追加

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

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

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

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

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

ShipStation への接続

1. ShipStation アカウント: ShipStation Login にログインします。
2. 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
3. ［アカウント］->［API 設定］をクリックします。
4. ［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 設定のカスタマイズ

デフォルトでは、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.

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.

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.

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.

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.
MarketplaceUsernames	String		List the information for the MarketPlace usernames.
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.

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.

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.

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.

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.

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.

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.

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.
AdvancedOptionsBillToMyOtherAccount	String		When using my_other_account as the billToParty value, the shippingProviderId value that is associated with the desired account.Make a List Carriers call to obtain shippingProviderId values.
InsuranceOptionsCustomItems	String		Custom Items.
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.

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.
Tags	String		List of Tags of the product.
UPC	String		Return a product that matches the specified UPC code.
ShowInactive	Boolean		Whether the list should include inactive products.
TagId	Integer	Tags.Id	Tag Id of the product

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.

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.

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.

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.

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.

Lists all the tags defined for this account.

Select

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

Columns

Name	Type	References	Description
Id [KEY]	Integer		Globally unique ID for the tag.
Color	String		Color associated with this tag.
Name	String		Name of the tag.

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.

Pseudo-Columns

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

Name	Type	Description
ShowInactive	Boolean		Specifies whether inactive stores will be shown.

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.

ストアドプロシージャはファンクションライクなインターフェースで、ShipStation の単純なSELECT 処理にとどまらずSync App の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにShipStation から関連するレスポンスデータを返します。

ShipStation Connector for CData Sync ストアドプロシージャ

Name	Description
AddTagToOrder	Adds a tag to an order
AssignUserToOrder	Assigns a user to an order
CreateLabelForOrder	Creates a label for an Order
CreateLabelForShipment	Creates a label for a shipment
DeactivateStore	Deactivates a specified store
HoldOrder	This method will change the status of the given order to On Hold until the date specified or will change the status of the given order from On Hold to Awaiting Shipment
ReactivateStore	Reactivates the specified store. Note: stores are active by default
RefreshStore	Refreshes the specified store
RemoveTagFromOrder	Removes tag from an Order
RestoreOrder	This method will change the status of the given order from On Hold to Awaiting Shipment. This endpoint is used when a HoldUntil Date is attached to an order.
UnassignUserFromOrder	Unassigns a user from an order.
VoidShipmentLabel	Voids the specified label by shipmentId.

Adds a tag to an order

Input

Name	Type	Required	Description
OrderId	Integer	True	Identifies the order that will be tagged.
TagId	Integer	True	Identifies the tag that will be applied to the order.

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

Assigns a user to an order

Input

Name	Type	Required	Description
OrderIds	Integer	True	Identifies set of orders that will be assigned the user. Please note that if ANY of the orders within the array are not found, no orders will have a user assigned to them (Multiple OrderIds can be passed as comma separated).
UserId	String	True	Identifies the user that will be applied to the orders. It should contain a GUID of the user to be assigned to the array of orders.

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

Creates a label for an Order

Input

Name	Type	Required	Description
DownloadLocation	String	False	The location on the disk where to download the label.
OrderId	Integer	True	Identifies the order that will be shipped.
CarrierCode	String	True	The code for the carrier that is to be used for the label.
ServiceCode	String	True	The code for the shipping service that is to be used for the label.
Confirmation	String	True	The type of delivery confirmation that is to be used once the shipment is created. Possible values: none, delivery, signature, adult_signature, and direct_signature. direct_signature is available for FedEx only.
ShipDate	String	True	The date the order should be shipped.
WeightValue	Integer	True	Weight_value of the order.
WeightUnits	String	True	Weight_units of the order.
WeightWeightUnits	Integer	False	Weight_WeightUnits of the order.
DimensionsLength	String	False	Length of package.
DimensionsWidth	String	False	Width of package.
DimensionsHeight	String	False	Height of package.
DimensionsUnits	String	False	Units of measurement. Allowed units are: 'inches', or 'centimeters'.
InsuranceOptionsProvider	String	False	Preferred Insurance provider. Available options: shipsurance, carrier, or provider. The provider option is used to indicate that a shipment was insured by a third party other than ShipSurance or the carrier. The insurance is handled outside of ShipStation, and will not affect the cost of processing the label.
InsuranceOptionsInsureShipment	String	False	Indicates whether shipment should be insured.
InsuranceOptionsInsuredValue	String	False	Value to insure.
InternationalOptionsContents	String	False	Contents of international shipment. Available options are: merchandise, documents, gift, returned_goods, or sample.
InternationalOptionsCustomsItemsCustomsItemId	String	False	If this field is included when submitting an order through Order/CreateOrder, then it will look for the corresponding customs line and update any values.(Multiple values can be given as input with comma separator like: '121221,21211,12121')
InternationalOptionsCustomsItemsDescription	String	False	A short description of the CustomsItem(Multiple Description for the corresponding CustomsItemId can be given as input with comma separator like: 'desc1,desc2,desc3').
InternationalOptionsCustomsItemsQuantity	String	False	The quantity for this line item(Multiple Quantity for the corresponding CustomsItemId can be given as input with comma separator like: '5,1,4').
InternationalOptionsCustomsItemsValue	String	False	The value (in USD) of the line item(Multiple Value for the corresponding CustomsItemId can be given as input with comma separator like: '10,50,100').
InternationalOptionsCustomsItemsHarmonizedTariffCode	String	False	The Harmonized Commodity Code for this line item(Multiple HarmonizedTariffCode for the corresponding CustomsItemId can be given as input with comma separator like: '12312,12312,12312').
InternationalOptionsCustomsItemsCountryOfOrigin	String	False	The 2-character ISO country code where the item originated(Multiple CountryOfOrigin for the corresponding CustomsItemId can be given as input with comma separator like: 'US,US,US').
InternationalOptionsNonDelivery	String	False	Non-Delivery option for international shipment. Available options are: return_to_sender or treat_as_abandoned. Please note: If the shipment is created through the Orders/CreateLabelForOrder endpoint and the nonDelivery field is not specified then value defaults based on the International Setting in the UI. If the call is being made to the Shipments/CreateLabel endpoint and the nonDelivery field is not specified then the value will default to return_to_sender.
AdvancedOptionsWarehouseId	Integer	False	Specifies the warehouse where to the order is to ship from. If the order was fulfilled using a fill provider, no warehouse is attached to these orders and will result in a null value being returned. *Please see note below
AdvancedOptionsNonMachinable	Boolean	False	Specifies whether the order is non-machinable.
AdvancedOptionsSaturdayDelivery	Boolean	False	Specifies whether the order is to be delivered on a Saturday.
AdvancedOptionsContainsAlcohol	Boolean	False	Specifies whether the order contains alcohol.
AdvancedOptionsStoreId	Integer	False	ID of store that is associated with the order. If not specified in the CreateOrder call either to create or update an order, ShipStation will default to the first manual store on the account. Can only be specified during order creation.
AdvancedOptionsCustomField1	String	False	Field that allows for custom data to be associated with an order. *Please see note below
AdvancedOptionsCustomField2	String	False	Field that allows for custom data to be associated with an order. *Please see note below
AdvancedOptionsCustomField3	String	False	Field that allows for custom data to be associated with an order. *Please see note below
AdvancedOptionsSource	String	False	Identifies the original source/marketplace of the order. *Please see note below
AdvancedOptionsMergedOrSplit	Boolean	False	Returns whether or not an order has been merged or split with another order. Read Only
AdvancedOptionsMergedIds	Integer	False	Array of orderIds. Each orderId identifies an order that was merged with the associated order. Read Only
AdvancedOptionsParentId	Integer	False	If an order has been split, it will return the Parent ID of the order with which it has been split. If the order has not been split, this field will return null. Read Only
AdvancedOptionsBillToParty	String	False	Identifies which party to bill. Possible values: my_account, my_other_account (see note below), recipient, third_party. billTo values can only be used when creating/updating orders.
AdvancedOptionsBillToAccount	String	False	Account number of billToParty. billTo values can only be used when creating/updating orders.
AdvancedOptionsBillToPostalCode	String	False	Postal Code of billToParty. billTo values can only be used when creating/updating orders.
AdvancedOptionsBillToCountryCode	String	False	Country Code of billToParty. billTo values can only be used when creating/updating orders.
AdvancedOptionsBillToMyOtherAccount	String	False	When using my_other_account billToParty value, the shippingProviderId value associated with the desired account. Make a List Carriers call to obtain shippingProviderId values.
TestLabel	Boolean	False	Specifies whether a test label should be created. デフォルト値はfalseです。
Encoding	String	False	The FileData input encoding type. 使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.
FileData	String	If the DownloadLocation and FileStream are not provided, this contains the content of the file.

Creates a label for a shipment

Input

Name	Type	Required	Description
DownloadLocation	String	False	The location on the disk where to download the label.
CarrierCode	String	True	The code for the carrier that is to be used for the label.
ServiceCode	String	True	The code for the shipping service that is to be used for the label.
PackageCode	String	True	Identifies the packing type that should be used for this label.
Confirmation	String	False	The type of delivery confirmation that is to be used once the shipment is created. Possible values: none, delivery, signature, adult_signature, and direct_signature. direct_signature is available for FedEx only.
ShipDate	String	True	The date the order should be shipped.
WeightValue	Integer	True	Weight_value of the order.
WeightUnits	String	True	Weight_units of the order.
WeightWeightUnits	Integer	False	Weight_WeightUnits of the order.
DimensionsLength	String	False	Length of package.
DimensionsWidth	String	False	Width of package.
DimensionsHeight	String	False	Height of package
DimensionsUnits	String	False	Units of measurement. Allowed units are: 'inches', or 'centimeters'
ShipFromName	String	True	Name of person.
ShipFromCompany	String	True	Name of company.
ShipFromStreet1	String	True	First line of address.
ShipFromStreet2	String	False	Second line of address.
ShipFromStreet3	String	False	Third line of address.
ShipFromCity	String	True	City.
ShipFromState	String	True	State.
ShipFromPostalCode	String	True	Postal Code.
ShipFromCountry	String	True	Country Code. The two-character ISO country code is required.
ShipFromPhone	String	False	Telephone number.
ShipFromResidential	Boolean	True	Residential.
ShipFromAddressVerified	String	False	Identifies whether the address has been verified by ShipStation (read only). Possible values: Address not yet validated, Address validated successfully, Address validation warning, Address validation failed.
ShipToName	String	True	Name of person.
ShipToCompany	String	True	Name of company.
ShipToStreet1	String	True	First line of address.
ShipToStreet2	String	False	Second line of address.
ShipToStreet3	String	False	Third line of address.
ShipToCity	String	True	City.
ShipToState	String	True	State.
ShipToPostalCode	String	True	Postal Code.
ShipToCountry	String	True	Country Code. The two-character ISO country code is required.
ShipToPhone	String	False	Telephone number.
ShipToResidential	Boolean	True	Residential.
ShipToAddressVerified	String	False	Identifies whether the address has been verified by ShipStation (read only). Possible values: Address not yet validated, Address validated successfully, Address validation warning, Address validation failed.
InsuranceOptionsProvider	String	False	Preferred Insurance provider. Available options: shipsurance, carrier, or provider. The provider option is used to indicate that a shipment was insured by a third party other than ShipSurance or the carrier. The insurance is handled outside of ShipStation, and will not affect the cost of processing the label.
InsuranceOptionsInsureShipment	String	False	Indicates whether shipment should be insured.
InsuranceOptionsProvider	String	False	Value to insure.
InternationalOptionsContents	String	False	Contents of international shipment. Available options are: merchandise, documents, gift, returned_goods, or sample
InternationalOptionsCustomsItemsCustomsItemId	String	False	If this field is included when submitting an order through Order/CreateOrder, then it will look for the corresponding customs line and update any values.(Multiple values can be given as input with comma separator like: '121221,21211,12121').
InternationalOptionsCustomsItemsDescription	String	False	A short description of the CustomsItem(Multiple Description for the corresponding CustomsItemId can be given as input with comma separator like: 'desc1,desc2,desc3').
InternationalOptionsCustomsItemsQuantity	String	False	The quantity for this line item(Multiple Quantity for the corresponding CustomsItemId can be given as input with comma separator like: '5,1,4').
InternationalOptionsCustomsItemsValue	String	False	The value (in USD) of the line item(Multiple Value for the corresponding CustomsItemId can be given as input with comma separator like: '10,50,100').
InternationalOptionsCustomsItemsHarmonizedTariffCode	String	False	The Harmonized Commodity Code for this line item(Multiple HarmonizedTariffCode for the corresponding CustomsItemId can be given as input with comma separator like: '12312,12312,12312').
InternationalOptionsCustomsItemsCountryOfOrigin	String	False	The 2-character ISO country code where the item originated(Multiple CountryOfOrigin for the corresponding CustomsItemId can be given as input with comma separator like: 'US,US,US').
InternationalOptionsNonDelivery	String	False	Non-Delivery option for international shipment. Available options are: return_to_sender or treat_as_abandoned. Please note: If the shipment is created through the Orders/CreateLabelForOrder endpoint and the nonDelivery field is not specified then value defaults based on the International Setting in the UI. If the call is being made to the Shipments/CreateLabel endpoint and the nonDelivery field is not specified then the value will default to return_to_sender.
AdvancedOptionsWarehouseId	Integer	False	Specifies the warehouse where to the order is to ship from. If the order was fulfilled using a fill provider, no warehouse is attached to these orders and will result in a null value being returned. *Please see note below
AdvancedOptionsNonMachinable	Boolean	False	Specifies whether the order is non-machinable.
AdvancedOptionsSaturdayDelivery	Boolean	False	Specifies whether the order is to be delivered on a Saturday.
AdvancedOptionsContainsAlcohol	Boolean	False	Specifies whether the order contains alcohol.
AdvancedOptionsStoreId	Integer	False	ID of store that is associated with the order. If not specified in the CreateOrder call either to create or update an order, ShipStation will default to the first manual store on the account. Can only be specified during order creation.
AdvancedOptionsCustomField1	String	False	Field that allows for custom data to be associated with an order. *Please see note below
AdvancedOptionsCustomField2	String	False	Field that allows for custom data to be associated with an order. *Please see note below
AdvancedOptionsCustomField3	String	False	Field that allows for custom data to be associated with an order. *Please see note below
AdvancedOptionsSource	String	False	Identifies the original source/marketplace of the order. *Please see note below
AdvancedOptionsMergedOrSplit	Boolean	False	Read-Only: Returns whether or not an order has been merged or split with another order. Read Only
AdvancedOptionsMergedIds	Integer	False	Read-Only: Array of orderIds. Each orderId identifies an order that was merged with the associated order. Read Only
AdvancedOptionsParentId	Integer	False	Read-Only: If an order has been split, it will return the Parent ID of the order with which it has been split. If the order has not been split, this field will return null. Read Only
AdvancedOptionsBillToParty	String	False	Identifies which party to bill. Possible values: my_account, my_other_account (see note below), recipient, third_party. billTo values can only be used when creating/updating orders..
AdvancedOptionsBillToAccount	String	False	Account number of billToParty. billTo values can only be used when creating/updating orders..
AdvancedOptionsBillToPostalCode	String	False	Postal Code of billToParty. billTo values can only be used when creating/updating orders.
AdvancedOptionsBillToCountryCode	String	False	Country Code of billToParty. billTo values can only be used when creating/updating orders.
AdvancedOptionsBillToMyOtherAccount	String	False	When using my_other_account billToParty value, the shippingProviderId value associated with the desired account. Make a List Carriers call to obtain shippingProviderId values.
TestLabel	Boolean	False	Specifies Whether A Test Label Should Be Created. デフォルト値はfalseです。
Encoding	String	False	The FileData input encoding type. 使用できる値は次のとおりです。NONE, BASE64 デフォルト値はBASE64です。

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.
FileData	String	If the DownloadLocation and FileStream are not provided, this contains the content of the file.

Deactivates a specified store

Input

Name	Type	Required	Description
StoreId	Integer	True	ID of the store to deactivate.

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

This method will change the status of the given order to On Hold until the date specified or will change the status of the given order from On Hold to Awaiting Shipment

Input

Name	Type	Required	Description
OrderId	Integer	True	Identifies the order that will be held.
HoldUntilDate	String	True	Date when order is moved from on_hold status to awaiting_shipment.

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

Reactivates the specified store. Note: stores are active by default

Input

Name	Type	Required	Description
StoreId	Integer	True	ID of the store to reactivate.

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

Refreshes the specified store

Input

Name	Type	Required	Description
StoreId	Integer	False	Specifies the store which will get refreshed. If the storeId is not specified, a store refresh will be initiated for all refreshable stores on that account.
RefreshDate	String	False	Specifies the starting date for new order imports. If the refreshDate is not specified, ShipStation will use the last recorded refreshDate for that store.

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

Removes tag from an Order

Input

Name	Type	Required	Description
OrderId	Integer	True	Identifies the order whose tag will be removed.
TagId	Integer	True	Identifies the tag to remove.

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

This method will change the status of the given order from On Hold to Awaiting Shipment. This endpoint is used when a HoldUntil Date is attached to an order.

Input

Name	Type	Required	Description
OrderId	Integer	True	Identifies the order that will be restored to awaiting_shipment from on_hold.

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

Unassigns a user from an order.

Input

Name	Type	Required	Description
OrderIds	Integer	True	Identifies set of orders that will have the user unassigned. Please note that if ANY of the orders within the array are not found, then no orders will have their users unassigned (Multiple Ids can be given as comma separated input).

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

Voids the specified label by shipmentId.

Input

Name	Type	Required	Description
ShipmentId	Integer	True	ID of the shipment to void.

Result Set Columns

Name	Type	Description
Status	String	The status of the operation.

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

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

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 トラフィックをルーティングするために予約された、指定されたプロキシサーバーの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	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

---

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

The API key used for accessing your ShipStation account.

解説

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

The API secret used for accessing your ShipStation account.

解説

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

このセクションでは、本プロバイダーの接続文字列で設定可能な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

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

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

---

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

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 を使ってください。

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

解説

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

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

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

解説

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

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

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

解説

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

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

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

解説

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

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

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

---

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

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

解説

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

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

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

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

解説

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

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

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

解説

ProxyAutoDetect がFalse に設定されている場合、Sync App はこの接続プロパティで指定されたProxyServer ポートを通じてのみHTTP トラフィックをルーティングします。

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

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

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

解説

サポートされる認証の種類：

• BASIC：Sync App はHTTP Basic 認証を行います。
• DIGEST：Sync App はHTTP ダイジェスト認証を行います。
• NTLM：Sync App はNTLM トークンを取得します。
• NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
• NONE：ProxyServer が認証を必要としないことを示します。

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

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

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 接続プロパティは設定しないでください。

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

ProxyUser 接続プロパティで指定されたユーザーのパスワードを指定します。

解説

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

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

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

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

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

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

解説

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

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

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

解説

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

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

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

---

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

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

解説

Sync App は、実行する各操作の詳細を Logfile 接続プロパティで指定されたログファイルに書き込みます。

ログに記録される各操作は、モジュールと呼ばれるカテゴリに分類されます。各モジュールには対応する短いコードがあり、個々の Sync App の操作がどのモジュールに属するかを示すラベルとして使用されます。

この接続プロパティにモジュールコードをセミコロン区切りのリストで設定すると、指定したモジュールに属する操作のみがログファイルに書き込まれます。この設定は今後のログ記録にのみ適用され、既存のログファイルの内容には影響しません。例: INFO;EXEC;SSL;META;

デフォルトでは、すべてのモジュールの操作がログに含まれます。

モジュールを明示的に除外するには、先頭に「-」を付けます。例: -HTTP

サブモジュールにフィルターを適用するには、<モジュール名>.<サブモジュール名> の構文で指定します。たとえば、次の値を設定すると、Sync App は HTTP モジュールに属するアクションのみをログに記録し、さらに HTTP モジュールの Res サブモジュールに属するアクションを除外します: HTTP;-HTTP.Res

Verbosity 接続プロパティによるログファイルのフィルタリングは、この接続プロパティによるフィルタリングよりも優先されます。そのため、Verbosity 接続プロパティで指定したレベルよりも高い詳細レベルの操作は、この接続プロパティで指定したモジュールに属していても、ログファイルには出力されません。

使用可能なモジュールとサブモジュールは次のとおりです。

モジュール名	モジュールの説明	サブモジュール
INFO	一般情報。接続文字列、製品バージョン（ビルド番号）、および初期接続メッセージが含まれます。	Connec — 接続の作成または破棄に関連する情報。 Messag — 接続、接続文字列、製品バージョンに関するメッセージの汎用ラベル。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。
EXEC	クエリ実行。ユーザーが記述した SQL クエリ、解析済み SQL クエリ、正規化済み SQL クエリの実行メッセージが含まれます。クエリおよびクエリページの成功/失敗メッセージもここに表示されます。	Messag — クエリ実行に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Normlz — クエリの正規化ステップ。クエリの正規化とは、ユーザーが送信したクエリを、最適なパフォーマンスで同じ結果を得られるように書き換える処理です。 Origin — ユーザーの元のクエリ（ユーザーが実行した正確で未変更の非正規化クエリ）を記録するメッセージに適用されるラベル。 Page — クエリのページングに関連するメッセージ。 Parsed — クエリの解析ステップ。解析とは、ユーザーが送信したクエリを、処理しやすい標準化された形式に変換するプロセスです。
HTTP	HTTP プロトコルメッセージ。HTTP リクエスト/レスポンス（POST メッセージを含む）、および Kerberos 関連のメッセージが含まれます。	KERB — Kerberos に関連する HTTP リクエスト。 Messag — HTTP プロトコルに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 Unpack — サービス API から返された圧縮データを製品が解凍する際のメッセージに適用されるラベル。 Res — HTTP レスポンスを含むメッセージ。 Req — HTTP リクエストを含むメッセージ。
WSDL	WSDL/XSD ファイルの生成に関するメッセージ。	—
SSL	SSL 証明書メッセージ。	Certif — SSL 証明書に関するメッセージ。
AUTH	認証関連の失敗/成功メッセージ。	Messag — 認証に関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 OAuth — OAuth 認証に関連するメッセージ。 Krbros — Kerberos 関連の認証メッセージ。
SQL	SQL トランザクション、SQL 一括転送メッセージ、および SQL 結果セットメッセージが含まれます。	Bulk — 一括クエリ実行に関するメッセージ。 Cache — パフォーマンス向上のため、製品のキャッシュへの行データの読み書きに関連するメッセージ。 Messag — SQL トランザクションに関するメッセージ。これらのメッセージは通常、サービスから直接受信して転送されるものではなく、Sync App 固有のものです。 ResSet — クエリの結果セット。 Transc — 実行されたジョブ数やバックアップテーブルの処理に関する情報を含む、トランザクション処理に関連するメッセージ。
META	メタデータキャッシュとスキーマメッセージ。	Cache — パフォーマンス向上のため、製品のキャッシュ内のカラムおよびテーブル定義の読み取りと変更に関連するメッセージ。 Schema — サービススキーマからのメタデータの取得またはサービススキーマの変更に関連するメッセージ。 MemSto — インメモリメタデータキャッシュへの書き込みまたは読み取りに関連するメッセージ。 Storag — メモリ内ではなく、ディスクまたは外部データストアへのメタデータの保存に関連するメッセージ。
FUNC	SQL 関数の実行に関連する情報。	Errmsg — SQL 関数の実行に関連するエラーメッセージ。
TCP	TCP トランスポートレイヤーメッセージでの送受信生バイト。	Send — TCP プロトコル経由で送信された生データ。 Receiv — TCP プロトコル経由で受信した生データ。
FTP	File Transfer Protocol に関するメッセージ。	Info — FTP プロトコルでの通信に関連するステータスメッセージ。 Client — FTP 通信中に FTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — FTP 通信中に FTP サーバーが実行したアクションに関連するメッセージ。
SFTP	Secure File Transfer Protocol に関するメッセージ。	Info — SFTP プロトコルでの通信に関連するステータスメッセージ。 To_Server — SFTP 通信中に SFTP クライアント（製品）が実行したアクションに関連するメッセージ。 From_Server — SFTP 通信中に SFTP サーバーが実行したアクションに関連するメッセージ。
POP	Post Office Protocol 経由で転送されるデータに関するメッセージ。	Client — POP 通信中に POP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — POP 通信中に POP サーバーが実行したアクションに関連するメッセージ。 Status — POP プロトコルでの通信に関連するステータスメッセージ。
SMTP	Simple Mail Transfer Protocol 経由で転送されるデータに関するメッセージ。	Client — SMTP 通信中に SMTP クライアント（製品）が実行したアクションに関連するメッセージ。 Server — SMTP 通信中に SMTP サーバーが実行したアクションに関連するメッセージ。 Status — SMTP プロトコルでの通信に関連するステータスメッセージ。
CORE	他のモジュールでカバーされていない、さまざまな製品内部操作に関連するメッセージ。	—
DEMN	SQL リモーティングに関連するメッセージ。	—
CLJB	一括データアップロード（クラウドジョブ）に関するメッセージ。	Commit — 一括データアップロードの送信。
SRCE	他のモジュールに属さない、製品が生成するその他のメッセージ。	—
TRANCE	低レベルの製品操作に関する高度なメッセージ。	—

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

---

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

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

解説

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

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

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

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

解説

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

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

解説

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

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

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

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

解説

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

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

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

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

---

プロパティ	説明
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
MaxThreads	同時リクエスト数を指定します。
Other	特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UserDefinedViews	カスタムビューを定義するJSON 構成ファイルへのファイルパスを指定します。provider は、このファイルで指定されたビューを自動的に検出して使用します。

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

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。 （クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

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

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

解説

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

特定の問題に対処するため、特殊なシナリオ向けの高度な接続プロパティを指定します。このプロパティは、サポートチームの指示がある場合にのみ使用してください。

解説

このプロパティにより、シニアユーザーはサポートチームのアドバイスに基づいて、特定の状況に対応する隠しプロパティを設定できます。 これらの設定は通常のユースケースには必要ありませんが、特定の要件に対応したり、追加の機能を提供したりすることができます。 複数のプロパティを定義するには、セミコロンで区切られたリストを使用します。

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

統合およびフォーマット

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

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

解説

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

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

解説

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

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

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

解説

UserDefinedViews を使用すると、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

UserDefinedViews でビューを指定すると、Sync App はそのビューだけを参照します。

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

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.