JDBC Driver for ShipStation

Build 22.0.8462

Products

Lists all the products.

Select

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

  • Id, Name, ProductCategoryId ,SKU, 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
You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refers to other columns will cause an error.

Columns

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

Tags.Id

Tag Id of the product

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462