CData Cloud は、クラウドホスト型のソリューションで、複数の標準サービスやプロトコルにまたがるShipStation へのアクセスを実現します。MySQL またはSQL Server データベースに接続できるアプリケーションであれば、CData Cloud を介してShipStation に接続できます。
CData Cloud により、他のOData エンドポイントや標準SQL Server / MySQL データベースと同じように、ShipStation への接続を標準化し、構成することができます。
このページでは、CData Cloud でのShipStation への接続の確立 のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。
接続の確立 は、CData Cloud にデータベースを作成するためのShipStation への認証方法と必要な接続プロパティの設定方法について示します。
利用可能な標準サービスを経由してShipStation からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメント で詳しく説明します。
Database タブで対応するアイコンを選択して、ShipStation に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。
ShipStation への接続には、BASIC 認証標準を使います。
デフォルトでは、Cloud はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。
別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。
Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。
さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。
次のプロパティを設定します。
このセクションでは、利用可能なAPI オブジェクトを示し、ShipStation API へのSQL の実行について詳しく説明します。
ビュー では、利用可能なビューを説明します。ビューは、Customers、Products、Orders などを静的にモデル化するように定義されています。
ストアドプロシージャ は、ShipStation のファンクションライクなインターフェースです。ストアドプロシージャを使用すると、注文のラベルの作成やオーダーへのユーザーの割り当てなど、ShipStation の操作を実行できます。
ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。
クエリは、ビューに対して通常のテーブルと同様に実行することができます。
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.
The Cloud 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 Cloud.
SELECT * FROM CarrierPackages WHERE CarrierCode = 'hermes'
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.
The Cloud 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 Cloud.
SELECT * FROM Carriers WHERE CarrierCode = 'hermes'
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.
The Cloud 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 Cloud.
SELECT * FROM CarrierServices WHERE CarrierCode = 'hermes'
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.
The Cloud 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 Cloud.
SELECT * FROM Customers WHERE CountryCode = 'US'
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. | |
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. |
Lists customer tags.
The Cloud 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 Cloud.
SELECT * FROM CustomerTags WHERE CustomerId = 1368175
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.
The Cloud 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 Cloud.
SELECT * FROM Fulfillments WHERE Id = 122224
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. |
SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。
Name | Type | Description | |
RecipientName | String | Name of the recipient. |
Lists marketplaces.
The Cloud will use the ShipStation All the filter are executed in the client side within the Cloud.
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.
The Cloud 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 Cloud.
SELECT * FROM MarketplaceUserNames WHERE CustomerId = 1368175
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.
The Cloud 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 Cloud.
SELECT * FROM OrderCustomsItems WHERE OrderId = 2810333
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.
The Cloud 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 Cloud.
SELECT * FROM OrderItems WHERE OrderId = 2810333
Name | Type | References | Description |
OrderItemId [KEY] | Integer | 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.
The Cloud 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 Cloud.
SELECT * FROM Orders WHERE Id = 2810333
Name | Type | References | Description |
Id [KEY] | Integer | 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. |
Lists all the products.
The Cloud 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 Cloud.
SELECT * FROM Products WHERE Id = 1381428
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 |
Lists product tags.
The Cloud 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 Cloud.
SELECT * FROM ProductTags WHERE ProductId = 1381428
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.
The Cloud will use the ShipStation All the filter is executed client side within the Cloud.
Name | Type | References | Description |
Id [KEY] | Integer | 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.
The Cloud 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 Cloud.
SELECT * FROM Shipments WHERE CarrierCode = 'hermes'
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. | |
RecipientCountryCode | String | Country code of the shipment recipient. | |
StoreId | Integer | Store Id of the shipment. |
Lists status of the store refresh.
The Cloud 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 Cloud.
SELECT * FROM StoreRefreshStatus WHERE StoreId = 5603
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.
The Cloud 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 Cloud.
SELECT * FROM Stores WHERE Id = 5603
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. | |
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.
The Cloud will use the ShipStation All the filter are executed client side within the Cloud.
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.
The Cloud 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 Cloud.
SELECT * FROM Users WHERE ShowInactive = 'true'
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. |
Lists warehouses.
The Cloud 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 Cloud.
SELECT * FROM Warehouses WHERE Id = 8688
Name | Type | References | Description |
Id [KEY] | Integer | Id of the warehouses. | |
WarehouseName | String | Name of the warehouse. | |
CreateDate | Datetime | Create date of the record. | |
ExtInventoryIdentity | String | Inventory Identity. | |
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. | |
RegisterFedexMeter | String | Register Fedex Meter. | |
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. | |
SellerIntegrationId | String | Seller Integration Id. |
ストアドプロシージャはファンクションライクなインターフェースで、ShipStation の単純なSELECT 処理にとどまらずCloud の機能を拡張します。
ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにShipStation から関連するレスポンスデータを返します。
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
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. |
Name | Type | Description |
Status | String | The status of the operation. |
Assigns a user to an order
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. |
Name | Type | Description |
Status | String | The status of the operation. |
Creates a label for an Order
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です。 |
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
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です。 |
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
Name | Type | Required | Description |
StoreId | Integer | True | ID of the store to deactivate. |
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
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. |
Name | Type | Description |
Status | String | The status of the operation. |
Reactivates the specified store. Note: stores are active by default
Name | Type | Required | Description |
StoreId | Integer | True | ID of the store to reactivate. |
Name | Type | Description |
Status | String | The status of the operation. |
Refreshes the specified store
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. |
Name | Type | Description |
Status | String | The status of the operation. |
Removes tag from an Order
Name | Type | Required | Description |
OrderId | Integer | True | Identifies the order whose tag will be removed. |
TagId | Integer | True | Identifies the tag to remove. |
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.
Name | Type | Required | Description |
OrderId | Integer | True | Identifies the order that will be restored to awaiting_shipment from on_hold. |
Name | Type | Description |
Status | String | The status of the operation. |
Unassigns a user from an order.
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). |
Name | Type | Description |
Status | String | The status of the operation. |
Voids the specified label by shipmentId.
Name | Type | Required | Description |
ShipmentId | Integer | True | ID of the shipment to void. |
Name | Type | Description |
Status | String | The status of the operation. |
このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。
以下のテーブルは、ShipStation のデータベースメタデータを返します。
以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。
次のテーブルは、データ変更クエリのクエリ統計を返します。
利用可能なデータベースをリストします。
次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | データベース名。 |
利用可能なスキーマをリストします。
次のクエリは、すべての利用可能なスキーマを取得します。
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | データベース名。 |
SchemaName | String | スキーマ名。 |
利用可能なテーブルをリストします。
次のクエリは、利用可能なテーブルおよびビューを取得します。
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベース。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | テーブル名またはビュー名。 |
TableType | String | テーブルの種類(テーブルまたはビュー)。 |
Description | String | テーブルまたはビューの説明。 |
IsUpdateable | Boolean | テーブルが更新可能かどうか。 |
利用可能なテーブルおよびビューのカラムについて説明します。
次のクエリは、Tags テーブルのカラムとデータ型を返します。
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tags'
Name | Type | Description |
CatalogName | String | テーブルまたはビューを含むデータベースの名前。 |
SchemaName | String | テーブルまたはビューを含むスキーマ。 |
TableName | String | カラムを含むテーブルまたはビューの名前。 |
ColumnName | String | カラム名。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | カラムのストレージサイズ。 |
DisplaySize | Int32 | 指定されたカラムの通常の最大幅(文字数)。 |
NumericPrecision | Int32 | 数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | カラムのスケール(小数点以下の桁数)。 |
IsNullable | Boolean | カラムがNull を含められるかどうか。 |
Description | String | カラムの簡単な説明。 |
Ordinal | Int32 | カラムのシーケンスナンバー。 |
IsAutoIncrement | String | カラムに固定増分値が割り当てられるかどうか。 |
IsGeneratedColumn | String | 生成されたカラムであるかどうか。 |
IsHidden | Boolean | カラムが非表示かどうか。 |
IsArray | Boolean | カラムが配列かどうか。 |
IsReadOnly | Boolean | カラムが読み取り専用かどうか。 |
IsKey | Boolean | sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。 |
利用可能なストアドプロシージャをリストします。
次のクエリは、利用可能なストアドプロシージャを取得します。
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベース。 |
SchemaName | String | ストアドプロシージャを含むスキーマ。 |
ProcedureName | String | ストアドプロシージャの名前。 |
Description | String | ストアドプロシージャの説明。 |
ProcedureType | String | PROCEDURE やFUNCTION などのプロシージャのタイプ。 |
ストアドプロシージャパラメータについて説明します。
次のクエリは、RestoreOrder ストアドプロシージャのすべての入力パラメータについての情報を返します。
SELECT * FROM sys_procedureparameters WHERE ProcedureName='RestoreOrder' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | ストアドプロシージャを含むデータベースの名前。 |
SchemaName | String | ストアドプロシージャを含むスキーマの名前。 |
ProcedureName | String | パラメータを含むストアドプロシージャの名前。 |
ColumnName | String | ストアドプロシージャパラメータの名前。 |
Direction | Int32 | パラメータのタイプに対応する整数値:input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。 |
DataTypeName | String | データ型の名前。 |
DataType | Int32 | データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。 |
Length | Int32 | 文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。 |
NumericPrecision | Int32 | 数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ(文字数)。 |
NumericScale | Int32 | 数値データの小数点以下の桁数。 |
IsNullable | Boolean | パラメータがNull を含められるかどうか。 |
IsRequired | Boolean | プロシージャの実行にパラメータが必要かどうか。 |
IsArray | Boolean | パラメータが配列かどうか。 |
Description | String | パラメータの説明。 |
Ordinal | Int32 | パラメータのインデックス。 |
主キーおよび外部キーについて説明します。
次のクエリは、Tags テーブルの主キーを取得します。
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tags'
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
IsKey | Boolean | カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。 |
IsForeignKey | Boolean | カラムがTableName フィールドで参照される外部キーかどうか。 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
外部キーについて説明します。
次のクエリは、他のテーブルを参照するすべての外部キーを取得します。
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
名前 | タイプ | 説明 |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前 |
PrimaryKeyName | String | 主キーの名前。 |
ForeignKeyName | String | 外部キーの名前。 |
ReferencedCatalogName | String | 主キーを含むデータベース。 |
ReferencedSchemaName | String | 主キーを含むスキーマ。 |
ReferencedTableName | String | 主キーを含むテーブル。 |
ReferencedColumnName | String | 主キーのカラム名。 |
ForeignKeyType | String | 外部キーがインポート(他のテーブルを指す)キーかエクスポート(他のテーブルから参照される)キーかを指定します。 |
主キーについて説明します。
次のクエリは、すべてのテーブルとビューから主キーを取得します。
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | キーを含むデータベースの名前。 |
SchemaName | String | キーを含むスキーマの名前。 |
TableName | String | キーを含むテーブルの名前。 |
ColumnName | String | キーカラムの名前。 |
KeySeq | String | 主キーのシーケンス番号。 |
KeyName | String | 主キーの名前。 |
利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。
次のクエリは、主キーでないすべてのインデックスを取得します。
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | インデックスを含むデータベースの名前。 |
SchemaName | String | インデックスを含むスキーマの名前。 |
TableName | String | インデックスを含むテーブルの名前。 |
IndexName | String | インデックス名。 |
ColumnName | String | インデックスに関連付けられたカラムの名前。 |
IsUnique | Boolean | インデックスが固有の場合はTrue。そうでない場合はFalse。 |
IsPrimary | Boolean | インデックスが主キーの場合はTrue。そうでない場合はFalse。 |
Type | Int16 | インデックスタイプに対応する整数値:statistic (0)、clustered (1)、hashed (2)、またはother (3)。 |
SortOrder | String | 並べ替え順序:A が昇順、D が降順。 |
OrdinalPosition | Int16 | インデックスのカラムのシーケンスナンバー。 |
利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。
このテーブルをクエリする際は、config 接続文字列を使用する必要があります。
jdbc:cdata:shipstation:config:
この接続文字列を使用すると、有効な接続がなくてもこのテーブルをクエリできます。
次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | 接続プロパティ名。 |
ShortDescription | String | 簡単な説明。 |
Type | String | 接続プロパティのデータ型。 |
Default | String | 明示的に設定されていない場合のデフォルト値。 |
Values | String | 可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。 |
Value | String | 設定した値またはあらかじめ設定されたデフォルト。 |
Required | Boolean | プロパティが接続に必要かどうか。 |
Category | String | 接続プロパティのカテゴリ。 |
IsSessionProperty | String | プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。 |
Sensitivity | String | プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。 |
PropertyName | String | キャメルケースの短縮形の接続プロパティ名。 |
Ordinal | Int32 | パラメータのインデックス。 |
CatOrdinal | Int32 | パラメータカテゴリのインデックス。 |
Hierarchy | String | このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。 |
Visible | Boolean | プロパティが接続UI に表示されるかどうかを通知します。 |
ETC | String | プロパティに関するその他のさまざまな情報。 |
Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。
SQL 構文の詳細については、SQL 準拠 を参照してください。
以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。
名前 | 説明 | 有効な値 |
AGGREGATE_FUNCTIONS | サポートされている集計関数。 | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | COUNT 関数がサポートされているかどうか。 | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | 識別子をエスケープするための開始文字。 | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | 識別子をエスケープするための終了文字。 | ] |
SUPPORTED_OPERATORS | サポートされているSQL 演算子。 | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。 | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | サポートされている外部結合の種類。 | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | 外部結合がサポートされているかどうか。 | YES, NO |
SUBQUERIES | サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。 | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | サポートされている文字列関数。 | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | サポートされている数値関数。 | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | サポートされている日付および時刻関数。 | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | レプリケーション中にスキップされたテーブルを示します。 | |
REPLICATION_TIMECHECK_COLUMNS | レプリケーション中に更新判断のカラムとして使用するかどうかを、(指定された順に)チェックするカラムのリストを含む文字列の配列。 | |
IDENTIFIER_PATTERN | 識別子としてどの文字列が有効かを示す文字列値。 | |
SUPPORT_TRANSACTION | プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。 | YES, NO |
DIALECT | 使用するSQL ダイアレクトを示します。 | |
KEY_PROPERTIES | Uniform データベースを特定するプロパティを示します。 | |
SUPPORTS_MULTIPLE_SCHEMAS | プロバイダー用に複数のスキームが存在するかどうかを示します。 | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | プロバイダー用に複数のカタログが存在するかどうかを示します。 | YES, NO |
DATASYNCVERSION | このドライバーにアクセスするために必要な、CData Sync のバージョン。 | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | このドライバーのCData Sync カテゴリ。 | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | API で提供されている以上の、追加SQL 機能がサポートされているかどうか。 | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | バッチ操作がサポートされているかどうか。 | YES, NO |
SQL_CAP | このドライバーでサポートされているすべてのSQL 機能。 | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | 使用したいcacheOptions を指定する文字列値。 | |
ENABLE_EF_ADVANCED_QUERY | ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。 | YES, NO |
PSEUDO_COLUMNS | 利用可能な疑似カラムを示す文字列の配列。 | |
MERGE_ALWAYS | 値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。 | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | レプリケート開始日時を返すSELECT クエリ。 | |
REPLICATION_MIN_FUNCTION | サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
REPLICATION_START_DATE | レプリケート開始日を、プロバイダーが指定できるようになります。 | |
REPLICATION_MAX_DATE_QUERY | レプリケート終了日時を返すSELECT クエリ。 | |
REPLICATION_MAX_FUNCTION | サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。 | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | 初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。 | |
CHECKCACHE_USE_PARENTID | CheckCache 構文を親キーカラムに対して実行するかどうかを示します。 | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | スキーマファイルの生成に使用できる、ストアドプロシージャを示します。 |
次のクエリは、WHERE 句で使用できる演算子を取得します。
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデル セクションを参照してください。
Name | Type | Description |
NAME | String | SQL 構文のコンポーネント、またはサーバー上で処理できる機能。 |
VALUE | String | サポートされるSQL またはSQL 構文の詳細。 |
試行された変更に関する情報を返します。
次のクエリは、バッチ処理で変更された行のId を取得します。
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | データ変更処理から返された、データベース生成Id。 |
Batch | String | バッチの識別子。1 は単一処理。 |
Operation | String | バッチ内の処理の結果:INSERTED、UPDATED、またはDELETED。 |
Message | String | SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。 |
プロパティ | 説明 |
APIKey | The API key used for accessing your ShipStation account. |
APISecret | The API secret used for accessing your ShipStation account. |
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
The API key used for accessing your ShipStation account.
string
""
The API key can be found by navigating to Account -> API Settings -> API Keys.
The API secret used for accessing your ShipStation account.
string
""
The API secret can be found by navigating to Account -> API Settings -> API Secret.
このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。
プロパティ | 説明 |
SSLServerCert | TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。 |
TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。
string
""
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 |
これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。
すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。
このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。
プロパティ | 説明 |
Verbosity | ログファイルの記述をどの程度の詳細さで記載するかを決定するverbosity レベル。 |
このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。
プロパティ | 説明 |
BrowsableSchemas | このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。 |
このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
string
""
スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、 パフォーマンスが向上します。
このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。
プロパティ | 説明 |
MaxRows | クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。 |
PseudoColumns | このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。 |
Timeout | タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。 |
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
int
-1
クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
string
""
Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。
タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
int
60
Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。
Timeout の有効期限が切れても処理が完了していない場合は、Cloud は例外をスローします。