GET api/productdbs/{id}/products

Get products from product catalog

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

product catalog id

 string

Required

Body Parameters

None.

Response Information

Resource Description

products

Collection of CloudFullProduct
NameDescriptionTypeAdditional information
Images

Images

 Collection of string

None.
Width

Width

 string

None.
Length

Length

 string

None.
Thickness

Thickness

 string

None.
HoriRepeat

Horizontal Repeat

 string

None.
VertRepeat

Vertical Repeat

 string

None.
HoriDrop

Horizontal Drop

 string

None.
VertDrop

Vertical Drop

 string

None.
EstimatingWidth

[Obsolete] Estimating Width

 string

None.
EstimatingLength

[Obsolete] Estimating Length

 string

None.
WidthMargin

Width Margin

 string

None.
LengthMargin

Length Margin

 string

None.
TileCalcMethod

Tile Calculate Method
Available for Tile/CarpetTile/VinylTile Product
Enum { WasteAddon, HalfReuse, CutAndFit, NoReuse }
Default value is WasteAddon if TileCalcMethod string is empty or no match the enum

 string

None.
TileMinimumWaste

TileMinimumWaste
Available for Tile/CarpetTile/VinylTile Product

 string

None.
TileShape

TileShape
Available for Tile/CarpetTile/VinylTile Product
Enum { Rectangle, RegularTriangle, RegularHexagon, RegularDodecagon, Irregular }
Default value is Rectangle if TileShape string is empty or no match the enum

 string

None.
TileEdgeSize

TileEdgeSize
Available for Tile/CarpetTile/VinylTile Product

 string

None.
WasteAddon

Waste Addon / Additional Percent
Percentage, for example: "10%"

 string

None.
IsAddOn

IsAddOn

 boolean

None.
AddOns

Product Add-ons

 Collection of CloudProductAddOn

None.
Datas

Product Additional Datas

 Dictionary of string [key] and string [value]

None.
ID

No./SKU

 string

None.
Type

Type
Enum { Carpet, Vinyl, CarpetTile, VinylTile, Tile, Hardwood, Laminate, AreaUnderlay, WallBase, Transition, Bullnose, Trim, AreaAdhesive, Grout, Count, Labor, Freight, WallPaper, Concrete, Paint, LinearRegular, AreaSurface }
Default value is Carpet if Type string is empty or no match the enum

 string

None.
Trade

Trade

 string

None.
Desc

Desc

 string

None.
Vendor

Vendor

 string

None.
VendorSku

Vendor SKU

 string

None.
Color

Color
Rgb or rgba, for example: AABBCC or FFAABBCC

 string

None.
Unit

Unit
Enum{ SF, SY, LF, EA, Liter, Gal }

 string

None.
Manufacturer

Manufacturer

 string

None.
SalesPrice

Sales Price

 string

None.
CostPrice

Cost Price

 string

None.
BoxName

BoxName
Enum{ Box, Bag, Barrel, Carton, Day, Hour, Piece, Roll, Pail }

 string

None.
SellByBox

Sell By BoxName

 boolean

None.
BoxSalesPrice

BoxName Sales Price

 string

None.
BoxCostPrice

BoxName Cost Price

 string

None.
UnitsPerBox

Unit/BoxName

 string

None.
Taxable

Taxable

 boolean

None.
Path

Product/Folder Path

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Path": "sample string 1",
    "Images": [
      "sample string 1",
      "sample string 2"
    ],
    "Width": "sample string 2",
    "Length": "sample string 3",
    "Thickness": "sample string 4",
    "HoriRepeat": "sample string 5",
    "VertRepeat": "sample string 6",
    "HoriDrop": "sample string 7",
    "VertDrop": "sample string 8",
    "EstimatingWidth": "sample string 9",
    "EstimatingLength": "sample string 10",
    "WidthMargin": "sample string 11",
    "LengthMargin": "sample string 12",
    "TileCalcMethod": "sample string 13",
    "TileMinimumWaste": "sample string 14",
    "TileShape": "sample string 15",
    "TileEdgeSize": "sample string 16",
    "WasteAddon": "sample string 17",
    "IsAddOn": true,
    "AddOns": [
      {
        "ID": "sample string 1",
        "Method": "sample string 2"
      },
      {
        "ID": "sample string 1",
        "Method": "sample string 2"
      }
    ],
    "Datas": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "ID": "sample string 19",
    "Type": "sample string 20",
    "Trade": "sample string 21",
    "Desc": "sample string 22",
    "Vendor": "sample string 23",
    "VendorSku": "sample string 24",
    "Color": "sample string 25",
    "Unit": "sample string 26",
    "Manufacturer": "sample string 27",
    "SalesPrice": "sample string 28",
    "CostPrice": "sample string 29",
    "BoxName": "sample string 30",
    "SellByBox": true,
    "BoxSalesPrice": "sample string 31",
    "BoxCostPrice": "sample string 32",
    "UnitsPerBox": "sample string 33",
    "Taxable": true
  },
  {
    "Path": "sample string 1",
    "Images": [
      "sample string 1",
      "sample string 2"
    ],
    "Width": "sample string 2",
    "Length": "sample string 3",
    "Thickness": "sample string 4",
    "HoriRepeat": "sample string 5",
    "VertRepeat": "sample string 6",
    "HoriDrop": "sample string 7",
    "VertDrop": "sample string 8",
    "EstimatingWidth": "sample string 9",
    "EstimatingLength": "sample string 10",
    "WidthMargin": "sample string 11",
    "LengthMargin": "sample string 12",
    "TileCalcMethod": "sample string 13",
    "TileMinimumWaste": "sample string 14",
    "TileShape": "sample string 15",
    "TileEdgeSize": "sample string 16",
    "WasteAddon": "sample string 17",
    "IsAddOn": true,
    "AddOns": [
      {
        "ID": "sample string 1",
        "Method": "sample string 2"
      },
      {
        "ID": "sample string 1",
        "Method": "sample string 2"
      }
    ],
    "Datas": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "ID": "sample string 19",
    "Type": "sample string 20",
    "Trade": "sample string 21",
    "Desc": "sample string 22",
    "Vendor": "sample string 23",
    "VendorSku": "sample string 24",
    "Color": "sample string 25",
    "Unit": "sample string 26",
    "Manufacturer": "sample string 27",
    "SalesPrice": "sample string 28",
    "CostPrice": "sample string 29",
    "BoxName": "sample string 30",
    "SellByBox": true,
    "BoxSalesPrice": "sample string 31",
    "BoxCostPrice": "sample string 32",
    "UnitsPerBox": "sample string 33",
    "Taxable": true
  }
]

application/xml, text/xml

Sample: 
<ArrayOfCloudFullProduct>
  <CloudFullProduct>
    <ID>sample string 19</ID>
    <Type>sample string 20</Type>
    <Trade>sample string 21</Trade>
    <Desc>sample string 22</Desc>
    <Vendor>sample string 23</Vendor>
    <VendorSku>sample string 24</VendorSku>
    <Color>sample string 25</Color>
    <Unit>sample string 26</Unit>
    <Manufacturer>sample string 27</Manufacturer>
    <SalesPrice>sample string 28</SalesPrice>
    <CostPrice>sample string 29</CostPrice>
    <BoxName>sample string 30</BoxName>
    <SellByBox>true</SellByBox>
    <BoxSalesPrice>sample string 31</BoxSalesPrice>
    <BoxCostPrice>sample string 32</BoxCostPrice>
    <UnitsPerBox>sample string 33</UnitsPerBox>
    <Taxable>true</Taxable>
    <Width>sample string 2</Width>
    <Length>sample string 3</Length>
    <Thickness>sample string 4</Thickness>
    <HoriRepeat>sample string 5</HoriRepeat>
    <VertRepeat>sample string 6</VertRepeat>
    <HoriDrop>sample string 7</HoriDrop>
    <VertDrop>sample string 8</VertDrop>
    <WidthMargin>sample string 11</WidthMargin>
    <LengthMargin>sample string 12</LengthMargin>
    <TileCalcMethod>sample string 13</TileCalcMethod>
    <TileMinimumWaste>sample string 14</TileMinimumWaste>
    <TileShape>sample string 15</TileShape>
    <TileEdgeSize>sample string 16</TileEdgeSize>
    <WasteAddon>sample string 17</WasteAddon>
    <IsAddOn>true</IsAddOn>
    <AddOns>
      <CloudProductAddOn>
        <ID>sample string 1</ID>
        <Method>sample string 2</Method>
      </CloudProductAddOn>
      <CloudProductAddOn>
        <ID>sample string 1</ID>
        <Method>sample string 2</Method>
      </CloudProductAddOn>
    </AddOns>
    <Datas>
      <item key="sample string 1" value="sample string 2" />
      <item key="sample string 3" value="sample string 4" />
    </Datas>
    <Images>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Images>
    <Path>sample string 1</Path>
  </CloudFullProduct>
  <CloudFullProduct>
    <ID>sample string 19</ID>
    <Type>sample string 20</Type>
    <Trade>sample string 21</Trade>
    <Desc>sample string 22</Desc>
    <Vendor>sample string 23</Vendor>
    <VendorSku>sample string 24</VendorSku>
    <Color>sample string 25</Color>
    <Unit>sample string 26</Unit>
    <Manufacturer>sample string 27</Manufacturer>
    <SalesPrice>sample string 28</SalesPrice>
    <CostPrice>sample string 29</CostPrice>
    <BoxName>sample string 30</BoxName>
    <SellByBox>true</SellByBox>
    <BoxSalesPrice>sample string 31</BoxSalesPrice>
    <BoxCostPrice>sample string 32</BoxCostPrice>
    <UnitsPerBox>sample string 33</UnitsPerBox>
    <Taxable>true</Taxable>
    <Width>sample string 2</Width>
    <Length>sample string 3</Length>
    <Thickness>sample string 4</Thickness>
    <HoriRepeat>sample string 5</HoriRepeat>
    <VertRepeat>sample string 6</VertRepeat>
    <HoriDrop>sample string 7</HoriDrop>
    <VertDrop>sample string 8</VertDrop>
    <WidthMargin>sample string 11</WidthMargin>
    <LengthMargin>sample string 12</LengthMargin>
    <TileCalcMethod>sample string 13</TileCalcMethod>
    <TileMinimumWaste>sample string 14</TileMinimumWaste>
    <TileShape>sample string 15</TileShape>
    <TileEdgeSize>sample string 16</TileEdgeSize>
    <WasteAddon>sample string 17</WasteAddon>
    <IsAddOn>true</IsAddOn>
    <AddOns>
      <CloudProductAddOn>
        <ID>sample string 1</ID>
        <Method>sample string 2</Method>
      </CloudProductAddOn>
      <CloudProductAddOn>
        <ID>sample string 1</ID>
        <Method>sample string 2</Method>
      </CloudProductAddOn>
    </AddOns>
    <Datas>
      <item key="sample string 1" value="sample string 2" />
      <item key="sample string 3" value="sample string 4" />
    </Datas>
    <Images>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </Images>
    <Path>sample string 1</Path>
  </CloudFullProduct>
</ArrayOfCloudFullProduct>