Products
Returns product records, including dimensions, weight, pricing, and fulfillment configuration details.
View-Specific Information
Select
The add-in 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 add-in.
- Id, Sku, Name and Active support the following operator: =.
SELECT * FROM Products WHERE Id = 'se-2345'
SELECT * FROM Products WHERE Sku = '100'
SELECT * FROM Products WHERE Name = 'shoes'
SELECT * FROM Products WHERE Active = 'true'
Columns
| Name | Type | References | Description |
| Id [KEY] | Integer | A numeric Id that uniquely identifies the product. | |
| Sku | String | The SKU of the product. | |
| Name | String | The name of the product. | |
| Active | Boolean | Indicates whether the product is active. | |
| Upc | String | The UPC of the product. | |
| ThumbnailUrl | String | The URL of the product thumbnail image. | |
| PriceCurrency | String | The currency of the product price. | |
| PriceAmount | Decimal | The monetary amount of the product price. | |
| DimensionsUnit | String | The unit of measurement for the product dimensions. | |
| DimensionsLength | Double | The length of the product. | |
| DimensionsWidth | Double | The width of the product. | |
| DimensionsHeight | Double | The height of the product. | |
| WeightValue | Double | The weight of the product. | |
| WeightUnit | String | The unit of measurement for the product weight. | |
| InternalNotes | String | Internal notes about the product. | |
| FulfillmentSku | String | The fulfillment SKU of the product. | |
| CreateDate | Datetime | The date and time the product was created. | |
| ModifyDate | Datetime | The date and time the product was last modified. | |
| ProductCategoryId | Integer | The Id of the product category. | |
| ProductCategoryName | String | The name of the product category. | |
| PresetGroup | String | The preset group for the product. | |
| WarehouseLocation | String | The warehouse location of the product. | |
| DefaultCarrierCode | String | The default carrier code for the product. | |
| DefaultServiceCode | String | The default service code for the product. | |
| DefaultPackageCode | String | The default package code for the product. | |
| DefaultIntlCarrierCode | String | The default international carrier code for the product. | |
| DefaultIntlServiceCode | String | The default international service code for the product. | |
| DefaultIntlPackageCode | String | The default international package code for the product. | |
| DefaultConfirmation | String | The default delivery confirmation for the product. | |
| DefaultIntlConfirmation | String | The default international delivery confirmation for the product. | |
| CustomsDescription | String | The customs description of the product. | |
| CustomsValue | Double | The declared customs value of the product. | |
| CustomsTariffNo | String | The customs tariff number of the product. | |
| CustomsCountryCode | String | The country of origin code for customs purposes. | |
| NoCustoms | Boolean | Indicates whether the product requires no customs declaration. | |
| Tags | String | The tags associated with the product. | |
| Aliases | String | The store SKU aliases for the product. | |
| ProductType | String | The type of the product. | |
| IsReturnable | Boolean | Indicates whether the product is returnable. | |
| ShouldOverrideName | Boolean | Indicates whether the product name should override the order item name on labels. | |
| IsBundle | Boolean | Indicates whether the product is a bundle. | |
| BundleComponents | String | The component products that make up the bundle. | |
| AutoSplitOption | String | The auto-split option for the product. | |
| AutoSplitCustomQuantity | Integer | The custom quantity threshold for auto-splitting the product. |