GET https://api.d-tools.com/SI/Subscribe/ProductCatalogs?id={id}
Get a product catalog for a given catalog id.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The product catalog id. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ProductCatalogName | Description | Type | Additional information |
---|---|---|---|
Id |
Unique Id for the catalog (Required) |
string |
None. |
Name |
Name for the catalog (Required) |
string |
None. |
Description |
Catalog description |
string |
None. |
PriceType |
Price type |
string |
None. |
PriceTypeDisplayName |
Price type display name |
string |
None. |
IsMetric |
Catalog Item H,W,D are in inches for non-metric catalogs and millimeters for metric catalogs. Item weight is in pounds for non-metric catalogs and kilograms for metric catalogs. |
boolean |
None. |
Products |
Products in the catalog. |
Collection of Product |
None. |
Response Formats
application/json, text/json
Sample:
{ "Id": "sample string 1", "Name": "sample string 2", "Description": "sample string 3", "PriceType": "sample string 4", "PriceTypeDisplayName": "sample string 5", "IsMetric": true, "Products": [ { "Id": "sample string 1", "IntegrationProductId": "sample string 2", "ManufacturerId": "sample string 3", "Manufacturer": "sample string 4", "Model": "sample string 5", "PartNumber": "sample string 6", "Category": "sample string 7", "Subcategory": "sample string 8", "Description": "sample string 9", "Tags": "sample string 10", "Msrp": 11.0, "UnitCost": 12.0, "UnitPrice": 13.0, "OFE": true, "Phase": "sample string 15", "LaborHours": 16.0, "InstallPrice": 17.0, "LaborTypes": "sample string 18", "ItemLaborTypes": [ { "Name": "sample string 1", "Hours": 1.0 }, { "Name": "sample string 1", "Hours": 1.0 } ], "AcctgName": "sample string 19", "Vendor": "sample string 20", "VendorNumber": "sample string 21", "OrderUom": "sample string 22", "OrderUomUnits": 1, "DoNotOrder": true, "PurchaseCost": 1.0, "PurchaseCostCurrencyCode": "sample string 24", "Height": 1.0, "Width": 1.0, "Depth": 1.0, "Weight": 1.0, "RackMounted": true, "RackUnits": 1, "Amps": 1.0, "Volts": 1.0, "Watts": 1.0, "Btu": 1.0, "Dispersion": "sample string 26", "BulkWire": true, "InputTerminals": "sample string 28", "InputSignals": "sample string 29", "InputLabels": "sample string 30", "OutputTerminals": "sample string 31", "OutputSignals": "sample string 32", "OutputLabels": "sample string 33", "CustomField1": "sample string 34", "CustomField2": "sample string 35", "CustomField3": "sample string 36", "CustomField4": "sample string 37", "CustomField5": "sample string 38", "CustomField6": 1.0, "CustomField7": 1.0, "CustomField8": 1.0, "CustomField9": "2024-03-29T06:19:49.502901+00:00", "CustomField10": "2024-03-29T06:19:49.502901+00:00", "CustomField11": "2024-03-29T06:19:49.502901+00:00", "CustomField12": "sample string 39", "CustomField13": "sample string 40", "CustomField14": "sample string 41", "CustomField15": "sample string 42", "CustomField16": "sample string 43", "CustomField17": "sample string 44", "CustomField18": "sample string 45", "CustomField19": true, "CustomField20": true, "CustomField21": true, "CustomField22": true, "CustomField23": "sample string 46", "CustomField24": "sample string 47", "CustomField25": "sample string 48", "CustomField26": "sample string 49", "UpdatedOn": "2024-03-29T06:19:49.502901+00:00", "UpdatedOnTicks": 50, "Approved": true, "Discontinued": true }, { "Id": "sample string 1", "IntegrationProductId": "sample string 2", "ManufacturerId": "sample string 3", "Manufacturer": "sample string 4", "Model": "sample string 5", "PartNumber": "sample string 6", "Category": "sample string 7", "Subcategory": "sample string 8", "Description": "sample string 9", "Tags": "sample string 10", "Msrp": 11.0, "UnitCost": 12.0, "UnitPrice": 13.0, "OFE": true, "Phase": "sample string 15", "LaborHours": 16.0, "InstallPrice": 17.0, "LaborTypes": "sample string 18", "ItemLaborTypes": [ { "Name": "sample string 1", "Hours": 1.0 }, { "Name": "sample string 1", "Hours": 1.0 } ], "AcctgName": "sample string 19", "Vendor": "sample string 20", "VendorNumber": "sample string 21", "OrderUom": "sample string 22", "OrderUomUnits": 1, "DoNotOrder": true, "PurchaseCost": 1.0, "PurchaseCostCurrencyCode": "sample string 24", "Height": 1.0, "Width": 1.0, "Depth": 1.0, "Weight": 1.0, "RackMounted": true, "RackUnits": 1, "Amps": 1.0, "Volts": 1.0, "Watts": 1.0, "Btu": 1.0, "Dispersion": "sample string 26", "BulkWire": true, "InputTerminals": "sample string 28", "InputSignals": "sample string 29", "InputLabels": "sample string 30", "OutputTerminals": "sample string 31", "OutputSignals": "sample string 32", "OutputLabels": "sample string 33", "CustomField1": "sample string 34", "CustomField2": "sample string 35", "CustomField3": "sample string 36", "CustomField4": "sample string 37", "CustomField5": "sample string 38", "CustomField6": 1.0, "CustomField7": 1.0, "CustomField8": 1.0, "CustomField9": "2024-03-29T06:19:49.502901+00:00", "CustomField10": "2024-03-29T06:19:49.502901+00:00", "CustomField11": "2024-03-29T06:19:49.502901+00:00", "CustomField12": "sample string 39", "CustomField13": "sample string 40", "CustomField14": "sample string 41", "CustomField15": "sample string 42", "CustomField16": "sample string 43", "CustomField17": "sample string 44", "CustomField18": "sample string 45", "CustomField19": true, "CustomField20": true, "CustomField21": true, "CustomField22": true, "CustomField23": "sample string 46", "CustomField24": "sample string 47", "CustomField25": "sample string 48", "CustomField26": "sample string 49", "UpdatedOn": "2024-03-29T06:19:49.502901+00:00", "UpdatedOnTicks": 50, "Approved": true, "Discontinued": true } ] }
application/xml, text/xml
Sample:
<ProductCatalog xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DTools.SICloudAPI.DataObjects"> <Description>sample string 3</Description> <Id>sample string 1</Id> <IsMetric>true</IsMetric> <Name>sample string 2</Name> <PriceType>sample string 4</PriceType> <PriceTypeDisplayName>sample string 5</PriceTypeDisplayName> <Products> <Product> <AcctgName>sample string 19</AcctgName> <Amps>1</Amps> <Approved>true</Approved> <Btu>1</Btu> <BulkWire>true</BulkWire> <Category>sample string 7</Category> <CustomField1>sample string 34</CustomField1> <CustomField10>2024-03-29T06:19:49.502901+00:00</CustomField10> <CustomField11>2024-03-29T06:19:49.502901+00:00</CustomField11> <CustomField12>sample string 39</CustomField12> <CustomField13>sample string 40</CustomField13> <CustomField14>sample string 41</CustomField14> <CustomField15>sample string 42</CustomField15> <CustomField16>sample string 43</CustomField16> <CustomField17>sample string 44</CustomField17> <CustomField18>sample string 45</CustomField18> <CustomField19>true</CustomField19> <CustomField2>sample string 35</CustomField2> <CustomField20>true</CustomField20> <CustomField21>true</CustomField21> <CustomField22>true</CustomField22> <CustomField23>sample string 46</CustomField23> <CustomField24>sample string 47</CustomField24> <CustomField25>sample string 48</CustomField25> <CustomField26>sample string 49</CustomField26> <CustomField3>sample string 36</CustomField3> <CustomField4>sample string 37</CustomField4> <CustomField5>sample string 38</CustomField5> <CustomField6>1</CustomField6> <CustomField7>1</CustomField7> <CustomField8>1</CustomField8> <CustomField9>2024-03-29T06:19:49.502901+00:00</CustomField9> <Depth>1</Depth> <Description>sample string 9</Description> <Discontinued>true</Discontinued> <Dispersion>sample string 26</Dispersion> <DoNotOrder>true</DoNotOrder> <Height>1</Height> <Id>sample string 1</Id> <InputLabels>sample string 30</InputLabels> <InputSignals>sample string 29</InputSignals> <InputTerminals>sample string 28</InputTerminals> <InstallPrice>17</InstallPrice> <IntegrationProductId>sample string 2</IntegrationProductId> <ItemLaborTypes> <ItemLaborType> <Hours>1</Hours> <Name>sample string 1</Name> </ItemLaborType> <ItemLaborType> <Hours>1</Hours> <Name>sample string 1</Name> </ItemLaborType> </ItemLaborTypes> <LaborHours>16</LaborHours> <LaborTypes>sample string 18</LaborTypes> <Manufacturer>sample string 4</Manufacturer> <ManufacturerId>sample string 3</ManufacturerId> <Model>sample string 5</Model> <Msrp>11</Msrp> <OFE>true</OFE> <OrderUom>sample string 22</OrderUom> <OrderUomUnits>1</OrderUomUnits> <OutputLabels>sample string 33</OutputLabels> <OutputSignals>sample string 32</OutputSignals> <OutputTerminals>sample string 31</OutputTerminals> <PartNumber>sample string 6</PartNumber> <Phase>sample string 15</Phase> <PurchaseCost>1</PurchaseCost> <PurchaseCostCurrencyCode>sample string 24</PurchaseCostCurrencyCode> <RackMounted>true</RackMounted> <RackUnits>1</RackUnits> <Subcategory>sample string 8</Subcategory> <Tags>sample string 10</Tags> <UnitCost>12</UnitCost> <UnitPrice>13</UnitPrice> <UpdatedOn>2024-03-29T06:19:49.502901+00:00</UpdatedOn> <UpdatedOnTicks>50</UpdatedOnTicks> <Vendor>sample string 20</Vendor> <VendorNumber>sample string 21</VendorNumber> <Volts>1</Volts> <Watts>1</Watts> <Weight>1</Weight> <Width>1</Width> </Product> <Product> <AcctgName>sample string 19</AcctgName> <Amps>1</Amps> <Approved>true</Approved> <Btu>1</Btu> <BulkWire>true</BulkWire> <Category>sample string 7</Category> <CustomField1>sample string 34</CustomField1> <CustomField10>2024-03-29T06:19:49.502901+00:00</CustomField10> <CustomField11>2024-03-29T06:19:49.502901+00:00</CustomField11> <CustomField12>sample string 39</CustomField12> <CustomField13>sample string 40</CustomField13> <CustomField14>sample string 41</CustomField14> <CustomField15>sample string 42</CustomField15> <CustomField16>sample string 43</CustomField16> <CustomField17>sample string 44</CustomField17> <CustomField18>sample string 45</CustomField18> <CustomField19>true</CustomField19> <CustomField2>sample string 35</CustomField2> <CustomField20>true</CustomField20> <CustomField21>true</CustomField21> <CustomField22>true</CustomField22> <CustomField23>sample string 46</CustomField23> <CustomField24>sample string 47</CustomField24> <CustomField25>sample string 48</CustomField25> <CustomField26>sample string 49</CustomField26> <CustomField3>sample string 36</CustomField3> <CustomField4>sample string 37</CustomField4> <CustomField5>sample string 38</CustomField5> <CustomField6>1</CustomField6> <CustomField7>1</CustomField7> <CustomField8>1</CustomField8> <CustomField9>2024-03-29T06:19:49.502901+00:00</CustomField9> <Depth>1</Depth> <Description>sample string 9</Description> <Discontinued>true</Discontinued> <Dispersion>sample string 26</Dispersion> <DoNotOrder>true</DoNotOrder> <Height>1</Height> <Id>sample string 1</Id> <InputLabels>sample string 30</InputLabels> <InputSignals>sample string 29</InputSignals> <InputTerminals>sample string 28</InputTerminals> <InstallPrice>17</InstallPrice> <IntegrationProductId>sample string 2</IntegrationProductId> <ItemLaborTypes> <ItemLaborType> <Hours>1</Hours> <Name>sample string 1</Name> </ItemLaborType> <ItemLaborType> <Hours>1</Hours> <Name>sample string 1</Name> </ItemLaborType> </ItemLaborTypes> <LaborHours>16</LaborHours> <LaborTypes>sample string 18</LaborTypes> <Manufacturer>sample string 4</Manufacturer> <ManufacturerId>sample string 3</ManufacturerId> <Model>sample string 5</Model> <Msrp>11</Msrp> <OFE>true</OFE> <OrderUom>sample string 22</OrderUom> <OrderUomUnits>1</OrderUomUnits> <OutputLabels>sample string 33</OutputLabels> <OutputSignals>sample string 32</OutputSignals> <OutputTerminals>sample string 31</OutputTerminals> <PartNumber>sample string 6</PartNumber> <Phase>sample string 15</Phase> <PurchaseCost>1</PurchaseCost> <PurchaseCostCurrencyCode>sample string 24</PurchaseCostCurrencyCode> <RackMounted>true</RackMounted> <RackUnits>1</RackUnits> <Subcategory>sample string 8</Subcategory> <Tags>sample string 10</Tags> <UnitCost>12</UnitCost> <UnitPrice>13</UnitPrice> <UpdatedOn>2024-03-29T06:19:49.502901+00:00</UpdatedOn> <UpdatedOnTicks>50</UpdatedOnTicks> <Vendor>sample string 20</Vendor> <VendorNumber>sample string 21</VendorNumber> <Volts>1</Volts> <Watts>1</Watts> <Weight>1</Weight> <Width>1</Width> </Product> </Products> </ProductCatalog>