Product Model

Name Data Type Description
productId number The system generated identifier for the product. This is a read-only field.
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.
name string Name or description of the product.
price number The unit price of the product.
defaultCost number The seller's cost for this product.
length number 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.
width number 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.
height number 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.
weightOz number The weight of a single item in ounces.
internalNotes string Seller's private notes for the product.
fulfillmentSku string Stock keeping Unit for the fulfillment of that product by a 3rd party.
createDate string The timestamp the product record was created in ShipStation's database. Read-Only.
modifyDate string The timestamp the product record was modified in ShipStation. Read-Only.
active boolean Specifies whether or not the product is an active record.
productCategory ProductCategory The Product Category used to organize and report on similar products. See our knowledge base here for more information on Product Categories.
productType string Specifies the product type. See our knowledge base here for more information on Product Types.
warehouseLocation string The warehouse location associated with the product record.
defaultCarrierCode string The default domestic shipping carrier for this product.
defaultServiceCode string The default domestic shipping service for this product.
defaultPackageCode string The default domestic packageType for this product.
defaultIntlCarrierCode string The default international shipping carrier for this product.
defaultIntlServiceCode string The default international shipping service for this product.
defaultIntlPackageCode string The default international packageType for this product.
defaultConfirmation string The default domestic Confirmation type for this Product.
defaultIntlConfirmation string The default international Confirmation type for this Product.
customsDescription string The default customs Description for the product.
customsValue number The default customs Declared Value for the product.
customsTariffNo string The default Harmonized Code for the Product.
customsCountryCode string The default 2 digit ISO Origin Country for the Product.
noCustoms boolean If true, this product will not be included on international customs forms.
tags ProductTag The Product Tag used to organize and visually identify products. See our knowledge base here for more information on Product Defaults and tags.