Product
The product instance.
Properties
| Name | Type | Description |
|---|---|---|
| id | string |
the product's unique id |
| type | string |
the product type: carpet, tile, vinyl, and so on |
| unit | string |
the product unit |
| color | string |
the product hex color |
| caption | string |
readonly the product caption |
| trade | string |
the trade |
| desc | string |
the product description |
| vendor | string |
the vendor info |
| manufacturer | string |
the manufacturer info |
| costPrice | number |
the cost price |
| salesPrice | number |
the sales price |
| sellByBox | boolean |
if sell by box |
| boxName | string |
the box name |
| boxCostPrice | number |
the cost price of box |
| boxSalesPrice | number |
the sales price of box |
| unitsPerBox | number |
the unit per box |
| thickness | string |
the thickness |
| width | string |
the width |
| length | string |
the length |
| horiRepeat | string |
the horizontal repeat of the roll product |
| vertRepeat | string |
the vertical repeat of the roll product |
| horiDrop | string |
the horizontal drop of the roll product |
| vertDrop | string |
the vertical drop of the roll product |
| estWidth | string |
the estimating width of the roll product |
| estLength | string |
the estimating length of the roll product |
| tileCalcMethod | string |
the tile calculating method Enum value: WasteAddon, HalfReuse, CutAndFit, NoReuse |
| tileMinWaste | string |
the tile min waste |
| tileShape | string |
the tile shape Enum value: Rectangle, RegularTriangle, RegularHexagon, RegularDodecagon, Irregular |
| tileEdgeSize | string |
the tile edge size |
| isAddon | boolean |
if the product is addon |
| isTaxable | boolean |
if the product is taxable |