This page provides a guide to Establishing a Connection to ShipStation in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.

Connecting to ShipStation

Establishing a Connection shows how to authenticate to ShipStation and configure any necessary connection properties to create a database in CData Cloud

Accessing Data from CData Cloud Services

Accessing data from ShipStation through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.

Connect to ShipStation by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.

Use the BASIC Authentication standard to connect to ShipStation.

Connecting to ShipStation

1. Login to your ShipStation account: ShipStation Login.
2. Click on the settings icon in the upper right corner. A column menu will show up on the left.
3. Click Account -> API Settings.
4. On the API Settings page, note the API Key and API Secret.

Authenticating to ShipStation

• APIKey: Set this to the API key from the API settings page.
• APISecret: Set this to the Secret key from the API settings page.

Customizing the SSL Configuration

By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Cloud uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Overview

This section shows the available API objects and provides more information on executing SQL to ShipStation APIs.

Key Features

• The Cloud models ShipStation entities as relational views, allowing you to write SQL to query ShipStation data.
• Stored procedures allow you to execute operations to ShipStation
• Live connectivity to these objects means any changes to your ShipStation account are immediately reflected when using the Cloud.

Views

Views describes the available views. Views are statically defined to model Customers, Products, Orders, and more.

Stored Procedures

Stored Procedures are function-like interfaces to ShipStation. Stored procedures allow you to execute operations to ShipStation, including creating labels for orders and assigning users to orders.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

CData Cloud - ShipStation Views

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 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.

• 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 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.

• 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 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.

• 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 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.

• 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 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.

• 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 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.

• 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

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
RecipientName	String		Name of the recipient.

Lists marketplaces.

Select

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

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 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.

• 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 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.

• 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 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.

• 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 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.

• 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 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.

• 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 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.

• 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 Cloud will use the ShipStation All the filter is executed client side within the Cloud.

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 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.

• 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 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.

• 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 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.

• 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 Cloud will use the ShipStation All the filter are executed client side within the Cloud.

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 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.

• 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

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

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

Lists warehouses.

Select

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.

• 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.

Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with ShipStation.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from ShipStation, along with an indication of whether the procedure succeeded or failed.

CData Cloud - ShipStation Stored Procedures

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. The default value is false.
Encoding	String	False	The FileData input encoding type. The allowed values are NONE, BASE64. The default value is 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. The default value is false.
Encoding	String	False	The FileData input encoding type. The allowed values are NONE, BASE64. The default value is 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.

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for ShipStation:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the Cloud can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

• sys_identity: Returns information about batch operations or single updates.

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

Name	Type	Description
CatalogName	String	The database name.

Lists the available schemas.

The following query retrieves all available schemas:

          SELECT * FROM sys_schemas
          

Columns

Name	Type	Description
CatalogName	String	The database name.
SchemaName	String	The schema name.

Lists the available tables.

The following query retrieves the available tables and views:

          SELECT * FROM sys_tables
          

Columns

Name	Type	Description
CatalogName	String	The database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view.
TableType	String	The table type (table or view).
Description	String	A description of the table or view.
IsUpdateable	Boolean	Whether the table can be updated.

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Tags table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Tags' 

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the table or view.
SchemaName	String	The schema containing the table or view.
TableName	String	The name of the table or view containing the column.
ColumnName	String	The column name.
DataTypeName	String	The data type name.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
Length	Int32	The storage size of the column.
DisplaySize	Int32	The designated column's normal maximum width in characters.
NumericPrecision	Int32	The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale	Int32	The column scale or number of digits to the right of the decimal point.
IsNullable	Boolean	Whether the column can contain null.
Description	String	A brief description of the column.
Ordinal	Int32	The sequence number of the column.
IsAutoIncrement	String	Whether the column value is assigned in fixed increments.
IsGeneratedColumn	String	Whether the column is generated.
IsHidden	Boolean	Whether the column is hidden.
IsArray	Boolean	Whether the column is an array.
IsReadOnly	Boolean	Whether the column is read-only.
IsKey	Boolean	Indicates whether a field returned from sys_tablecolumns is the primary key of the table.
ColumnType	String	The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN.

Lists the available stored procedures.

The following query retrieves the available stored procedures:

          SELECT * FROM sys_procedures
          

Columns

Name	Type	Description
CatalogName	String	The database containing the stored procedure.
SchemaName	String	The schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure.
Description	String	A description of the stored procedure.
ProcedureType	String	The type of the procedure, such as PROCEDURE or FUNCTION.

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the RestoreOrder stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RestoreOrder' AND Direction = 1 OR Direction = 2

To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'RestoreOrder' AND IncludeResultColumns='True'

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the stored procedure.
SchemaName	String	The name of the schema containing the stored procedure.
ProcedureName	String	The name of the stored procedure containing the parameter.
ColumnName	String	The name of the stored procedure parameter.
Direction	Int32	An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataType	Int32	An integer indicating the data type. This value is determined at run time based on the environment.
DataTypeName	String	The name of the data type.
NumericPrecision	Int32	The maximum precision for numeric data. The column length in characters for character and date-time data.
Length	Int32	The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericScale	Int32	The number of digits to the right of the decimal point in numeric data.
IsNullable	Boolean	Whether the parameter can contain null.
IsRequired	Boolean	Whether the parameter is required for execution of the procedure.
IsArray	Boolean	Whether the parameter is an array.
Description	String	The description of the parameter.
Ordinal	Int32	The index of the parameter.
Values	String	The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated.
SupportsStreams	Boolean	Whether the parameter represents a file that you can pass as either a file path or a stream.
IsPath	Boolean	Whether the parameter is a target path for a schema creation operation.
Default	String	The value used for this parameter when no value is specified.
SpecificName	String	A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here.
IsCDataProvided	Boolean	Whether the procedure is added/implemented by CData, as opposed to being a native ShipStation procedure.

Pseudo-Columns

Name	Type	Description
IncludeResultColumns	Boolean	Whether the output should include columns from the result set in addition to parameters. Defaults to False.

Describes the primary and foreign keys.

The following query retrieves the primary key for the Tags table:

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Tags' 
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
IsKey	Boolean	Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey	Boolean	Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
PrimaryKeyName	String	The name of the primary key.
ForeignKeyName	String	The name of the foreign key.
ReferencedCatalogName	String	The database containing the primary key.
ReferencedSchemaName	String	The schema containing the primary key.
ReferencedTableName	String	The table containing the primary key.
ReferencedColumnName	String	The column name of the primary key.
ForeignKeyType	String	Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

         SELECT * FROM sys_primarykeys
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the key.
SchemaName	String	The name of the schema containing the key.
TableName	String	The name of the table containing the key.
ColumnName	String	The name of the key column.
KeySeq	String	The sequence number of the primary key.
KeyName	String	The name of the primary key.

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

          SELECT * FROM sys_indexes WHERE IsPrimary='false'
          

Columns

Name	Type	Description
CatalogName	String	The name of the database containing the index.
SchemaName	String	The name of the schema containing the index.
TableName	String	The name of the table containing the index.
IndexName	String	The index name.
ColumnName	String	The name of the column associated with the index.
IsUnique	Boolean	True if the index is unique. False otherwise.
IsPrimary	Boolean	True if the index is a primary key. False otherwise.
Type	Int16	An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder	String	The sort order: A for ascending or D for descending.
OrdinalPosition	Int16	The sequence number of the column in the index.

Returns information on the available connection properties and those set in the connection string.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

Name	Type	Description
Name	String	The name of the connection property.
ShortDescription	String	A brief description.
Type	String	The data type of the connection property.
Default	String	The default value if one is not explicitly set.
Values	String	A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value	String	The value you set or a preconfigured default.
Required	Boolean	Whether the property is required to connect.
Category	String	The category of the connection property.
IsSessionProperty	String	Whether the property is a session property, used to save information about the current connection.
Sensitivity	String	The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName	String	A camel-cased truncated form of the connection property name.
Ordinal	Int32	The index of the parameter.
CatOrdinal	Int32	The index of the parameter category.
Hierarchy	String	Shows dependent properties associated that need to be set alongside this one.
Visible	Boolean	Informs whether the property is visible in the connection UI.
ETC	String	Various miscellaneous information about the property.

Describes the SELECT query processing that the Cloud can offload to the data source.

See SQL Compliance for SQL syntax details.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name	Description	Possible Values
AGGREGATE_FUNCTIONS	Supported aggregation functions.	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	Whether COUNT function is supported.	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	The opening character used to escape an identifier.	[
IDENTIFIER_QUOTE_CLOSE_CHAR	The closing character used to escape an identifier.	]
SUPPORTED_OPERATORS	A list of supported SQL operators.	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	Whether GROUP BY is supported, and, if so, the degree of support.	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	The supported varieties of outer joins supported.	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	Whether outer joins are supported.	YES, NO
SUBQUERIES	Whether subqueries are supported, and, if so, the degree of support.	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	Supported 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	Supported 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	Supported date/time 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	Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS	A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN	String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION	Indicates if the provider supports transactions such as commit and rollback.	YES, NO
DIALECT	Indicates the SQL dialect to use.
KEY_PROPERTIES	Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS	Indicates if multiple schemas may exist for the provider.	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	Indicates if multiple catalogs may exist for the provider.	YES, NO
DATASYNCVERSION	The CData Data Sync version needed to access this driver.	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	The CData Data Sync category of this driver.	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	Whether enhanced SQL functionality beyond what is offered by the API is supported.	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	Whether batch operations are supported.	YES, NO
SQL_CAP	All supported SQL capabilities for this driver.	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	A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY	Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side.	YES, NO
PSEUDO_COLUMNS	A string array indicating the available pseudo columns.
MERGE_ALWAYS	If the value is true, The Merge Mode is forcibly executed in Data Sync.	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION	Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE	Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY	A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION	Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID	Indicates whether the CheckCache statement should be done against the parent key column.	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

Name	Type	Description
NAME	String	A component of SQL syntax, or a capability that can be processed on the server.
VALUE	String	Detail on the supported SQL or SQL syntax.

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

         SELECT * FROM sys_identity
          

Columns

Name	Type	Description
Id	String	The database-generated Id returned from a data modification operation.
Batch	String	An identifier for the batch. 1 for a single operation.
Operation	String	The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message	String	SUCCESS or an error message if the update in the batch failed.

Describes the available system information.

The following query retrieves all columns:

SELECT * FROM sys_information

Columns

Name	Type	Description
Product	String	The name of the product.
Version	String	The version number of the product.
Datasource	String	The name of the datasource the product connects to.
NodeId	String	The unique identifier of the machine where the product is installed.
HelpURL	String	The URL to the product's help documentation.
License	String	The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.)
Location	String	The file path location where the product's library is stored.
Environment	String	The version of the environment or rumtine the product is currently running under.
DataSyncVersion	String	The tier of CData Sync required to use this connector.
DataSyncCategory	String	The category of CData Sync functionality (e.g., Source, Destination).

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
APIKey	The API key used for accessing your ShipStation account.
APISecret	The API secret used for accessing your ShipStation account.

SSL

---

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

Logging

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Schema

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Miscellaneous

---

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the number of concurrent requests.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

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

---

Property	Description
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.

Data Type

string

Default Value

""

Remarks

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

The API secret used for accessing your ShipStation account.

Data Type

string

Default Value

""

Remarks

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

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

---

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

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space- or colon-separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space- or colon-separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

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

---

Property	Description
Verbosity	Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.

Data Type

string

Default Value

"1"

Remarks

This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.

The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.

When combined with the LogModules property, Verbosity can refine logging to specific categories of information.

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

---

Property	Description
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Data Type

string

Default Value

""

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

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

---

Property	Description
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the number of concurrent requests.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Data Type

int

Default Value

-1

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Specifies the number of concurrent requests.

Data Type

string

Default Value

"5"

Remarks

This property allows you to issue multiple requests simultaneously, thereby improving performance.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Data Type

string

Default Value

""

Remarks

This property allows you to define which pseudocolumns the Cloud exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Data Type

int

Default Value

60

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

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.