POST api/Product/AddProduct

Request Information

URI Parameters

None.

Body Parameters

Product
NameDescriptionTypeAdditional information
TCOeProduct

TCOeProducts

None.
TCOeProductDetail

TCOeProductDetails

None.
MonoTonerDetail

TCOeMonoTonerDetails

None.
ColorTonerDetail

TCOeColorTonerDetails

None.
SuppliesDetails

Collection of TCOeSuppliesDetails

None.

Request Formats

application/json, text/json

Sample: 
{
  "TCOeProduct": {
    "ProductID": 1,
    "ProductRefID": 2,
    "RegionID": 3,
    "RegionCode": "sample string 4",
    "ProductCategoryID": 5,
    "ProductCategory": "sample string 6",
    "ProductManufacturerID": 7,
    "ProductManufacturer": "sample string 8",
    "ProductModel": "sample string 9",
    "ProductNumber": "sample string 10",
    "ProductDescription": "sample string 11",
    "ProductFamilyID": 12,
    "ProductDeviceTypeID": 13,
    "ProductDeviceType": "sample string 14",
    "Excluded": true,
    "DataSource": "sample string 16",
    "InsertDate": "2025-11-07T09:03:50.0528603+00:00",
    "InsertUser": "sample string 18",
    "UpdateDate": "2025-11-07T09:03:50.0528603+00:00",
    "UpdateUser": "sample string 20"
  },
  "TCOeProductDetail": {
    "ProductDetailID": 1,
    "ProductID": 2,
    "InstallDate": "2025-11-07T09:03:50.0528603+00:00",
    "MonthsInService": 4,
    "DutyCycle": 5,
    "SupportsColor": true,
    "SupportsEcono": true,
    "DuplexCapable": true,
    "DuplexerCost": 9.1,
    "SpeedMono": 10.1,
    "SpeedColor": 11.1,
    "PowerSave": true,
    "PowerRateActive": 13.1,
    "PowerRateIdle": 14.1,
    "PowerRatePowerSave": 15.1,
    "IntroStreetPrice": 16.1,
    "Cost": 17.1,
    "AvgStreetPriceDate": "2025-11-07T09:03:50.0528603+00:00",
    "AvgServiceCPP": 19.1,
    "EconomodeCoveragePercent": 20,
    "MonoTonerDetailID": 21,
    "MonoTonerCoveragePercent": 22.1,
    "ColorTonerDetailID": 23,
    "ColorTonerCoveragePercent": 24.1,
    "MonoTonerCPP": 25.1,
    "ColorTonerCPP": 26.1,
    "SuppliesCPP": 27.1,
    "StarterMonoTonerPageLife": 28,
    "StarterColorTonerPageLife": 29,
    "CostPerPage": 30.1,
    "FPProductID": 31,
    "FactoryWarranty": 32,
    "PostWarrantyCost": 33.1,
    "Active": true,
    "CPPOverride": 35.1,
    "TonerCPPOverride": 36.1,
    "SupplyCPPOverride": 37.1,
    "UpdateReason": "sample string 38",
    "InsertDate": "2025-11-07T09:03:50.0528603+00:00",
    "InsertUser": "sample string 40",
    "UpdateDate": "2025-11-07T09:03:50.0528603+00:00",
    "UpdateUser": "sample string 42"
  },
  "MonoTonerDetail": {
    "MonoTonerDetailID": 1,
    "MonoTonerCostStd": 2.1,
    "MonoTonerPageLifeStd": 3,
    "MonoTonerPartNumberStd": "sample string 4",
    "StdActive": true,
    "MonoTonerCostHighCap": 6.1,
    "MonoTonerPageLifeHighCap": 7,
    "MonoTonerPartNumberHighCap": "sample string 8",
    "HighCapActive": true,
    "UpdateReason": "sample string 10",
    "InsertDate": "2025-11-07T09:03:50.0528603+00:00",
    "InsertUser": "sample string 12",
    "UpdateDate": "2025-11-07T09:03:50.0528603+00:00",
    "UpdateUser": "sample string 14",
    "MonoStarterPageLife": 15,
    "SupplyType": "sample string 16"
  },
  "ColorTonerDetail": {
    "ColorTonerDetailID": 1,
    "ColorTonerCostStd": 2.1,
    "ColorTonerPageLifeStd": 3,
    "ColorTonerPartNumberStd": "sample string 4",
    "StdActive": true,
    "ColorTonerCostHighCap": 6.1,
    "ColorTonerPageLifeHighCap": 7,
    "ColorTonerPartNumberHighCap": "sample string 8",
    "HighCapActive": true,
    "UpdateReason": "sample string 10",
    "InsertDate": "2025-11-07T09:03:50.0528603+00:00",
    "InsertUser": "sample string 12",
    "UpdateDate": "2025-11-07T09:03:50.0528603+00:00",
    "UpdateUser": "sample string 14",
    "ColorStarterPageLife": 15,
    "SupplyType": "sample string 16"
  },
  "SuppliesDetails": [
    {
      "SuppliesDetailID": 1,
      "SuppliesPartNumber": "sample string 2",
      "SuppliesDesc": "sample string 3",
      "SuppliesCost": 4.1,
      "BlackSuppliesPageLife": 5,
      "ColorSuppliesPageLife": 6,
      "AffectsBlack": true,
      "AffectsColor": true,
      "Active": true,
      "CalculateMaintCost": 10,
      "UpdateReason": "sample string 11",
      "InsertDate": "2025-11-07T09:03:50.0528603+00:00",
      "InsertUser": "sample string 13",
      "UpdateDate": "2025-11-07T09:03:50.0528603+00:00",
      "UpdateUser": "sample string 15",
      "BlackSuppliesStarterPageLife": 16,
      "ColorSuppliesStarterPageLife": 17,
      "SupplyType": "sample string 18"
    },
    {
      "SuppliesDetailID": 1,
      "SuppliesPartNumber": "sample string 2",
      "SuppliesDesc": "sample string 3",
      "SuppliesCost": 4.1,
      "BlackSuppliesPageLife": 5,
      "ColorSuppliesPageLife": 6,
      "AffectsBlack": true,
      "AffectsColor": true,
      "Active": true,
      "CalculateMaintCost": 10,
      "UpdateReason": "sample string 11",
      "InsertDate": "2025-11-07T09:03:50.0528603+00:00",
      "InsertUser": "sample string 13",
      "UpdateDate": "2025-11-07T09:03:50.0528603+00:00",
      "UpdateUser": "sample string 15",
      "BlackSuppliesStarterPageLife": 16,
      "ColorSuppliesStarterPageLife": 17,
      "SupplyType": "sample string 18"
    }
  ]
}

application/xml, text/xml

Sample: 
<Product xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HP.TCOe.DataContract">
  <ColorTonerDetail>
    <ColorStarterPageLife>15</ColorStarterPageLife>
    <ColorTonerCostHighCap>6.1</ColorTonerCostHighCap>
    <ColorTonerCostStd>2.1</ColorTonerCostStd>
    <ColorTonerDetailID>1</ColorTonerDetailID>
    <ColorTonerPageLifeHighCap>7</ColorTonerPageLifeHighCap>
    <ColorTonerPageLifeStd>3</ColorTonerPageLifeStd>
    <ColorTonerPartNumberHighCap>sample string 8</ColorTonerPartNumberHighCap>
    <ColorTonerPartNumberStd>sample string 4</ColorTonerPartNumberStd>
    <HighCapActive>true</HighCapActive>
    <InsertDate>2025-11-07T09:03:50.0528603+00:00</InsertDate>
    <InsertUser>sample string 12</InsertUser>
    <StdActive>true</StdActive>
    <SupplyType>sample string 16</SupplyType>
    <UpdateDate>2025-11-07T09:03:50.0528603+00:00</UpdateDate>
    <UpdateReason>sample string 10</UpdateReason>
    <UpdateUser>sample string 14</UpdateUser>
  </ColorTonerDetail>
  <MonoTonerDetail>
    <HighCapActive>true</HighCapActive>
    <InsertDate>2025-11-07T09:03:50.0528603+00:00</InsertDate>
    <InsertUser>sample string 12</InsertUser>
    <MonoStarterPageLife>15</MonoStarterPageLife>
    <MonoTonerCostHighCap>6.1</MonoTonerCostHighCap>
    <MonoTonerCostStd>2.1</MonoTonerCostStd>
    <MonoTonerDetailID>1</MonoTonerDetailID>
    <MonoTonerPageLifeHighCap>7</MonoTonerPageLifeHighCap>
    <MonoTonerPageLifeStd>3</MonoTonerPageLifeStd>
    <MonoTonerPartNumberHighCap>sample string 8</MonoTonerPartNumberHighCap>
    <MonoTonerPartNumberStd>sample string 4</MonoTonerPartNumberStd>
    <StdActive>true</StdActive>
    <SupplyType>sample string 16</SupplyType>
    <UpdateDate>2025-11-07T09:03:50.0528603+00:00</UpdateDate>
    <UpdateReason>sample string 10</UpdateReason>
    <UpdateUser>sample string 14</UpdateUser>
  </MonoTonerDetail>
  <SuppliesDetails>
    <TCOeSuppliesDetails>
      <Active>true</Active>
      <AffectsBlack>true</AffectsBlack>
      <AffectsColor>true</AffectsColor>
      <BlackSuppliesPageLife>5</BlackSuppliesPageLife>
      <BlackSuppliesStarterPageLife>16</BlackSuppliesStarterPageLife>
      <CalculateMaintCost>10</CalculateMaintCost>
      <ColorSuppliesPageLife>6</ColorSuppliesPageLife>
      <ColorSuppliesStarterPageLife>17</ColorSuppliesStarterPageLife>
      <InsertDate>2025-11-07T09:03:50.0528603+00:00</InsertDate>
      <InsertUser>sample string 13</InsertUser>
      <SuppliesCost>4.1</SuppliesCost>
      <SuppliesDesc>sample string 3</SuppliesDesc>
      <SuppliesDetailID>1</SuppliesDetailID>
      <SuppliesPartNumber>sample string 2</SuppliesPartNumber>
      <SupplyType>sample string 18</SupplyType>
      <UpdateDate>2025-11-07T09:03:50.0528603+00:00</UpdateDate>
      <UpdateReason>sample string 11</UpdateReason>
      <UpdateUser>sample string 15</UpdateUser>
    </TCOeSuppliesDetails>
    <TCOeSuppliesDetails>
      <Active>true</Active>
      <AffectsBlack>true</AffectsBlack>
      <AffectsColor>true</AffectsColor>
      <BlackSuppliesPageLife>5</BlackSuppliesPageLife>
      <BlackSuppliesStarterPageLife>16</BlackSuppliesStarterPageLife>
      <CalculateMaintCost>10</CalculateMaintCost>
      <ColorSuppliesPageLife>6</ColorSuppliesPageLife>
      <ColorSuppliesStarterPageLife>17</ColorSuppliesStarterPageLife>
      <InsertDate>2025-11-07T09:03:50.0528603+00:00</InsertDate>
      <InsertUser>sample string 13</InsertUser>
      <SuppliesCost>4.1</SuppliesCost>
      <SuppliesDesc>sample string 3</SuppliesDesc>
      <SuppliesDetailID>1</SuppliesDetailID>
      <SuppliesPartNumber>sample string 2</SuppliesPartNumber>
      <SupplyType>sample string 18</SupplyType>
      <UpdateDate>2025-11-07T09:03:50.0528603+00:00</UpdateDate>
      <UpdateReason>sample string 11</UpdateReason>
      <UpdateUser>sample string 15</UpdateUser>
    </TCOeSuppliesDetails>
  </SuppliesDetails>
  <TCOeProduct>
    <DataSource>sample string 16</DataSource>
    <Excluded>true</Excluded>
    <InsertDate>2025-11-07T09:03:50.0528603+00:00</InsertDate>
    <InsertUser>sample string 18</InsertUser>
    <ProductCategory>sample string 6</ProductCategory>
    <ProductCategoryID>5</ProductCategoryID>
    <ProductDescription>sample string 11</ProductDescription>
    <ProductDeviceType>sample string 14</ProductDeviceType>
    <ProductDeviceTypeID>13</ProductDeviceTypeID>
    <ProductFamilyID>12</ProductFamilyID>
    <ProductID>1</ProductID>
    <ProductManufacturer>sample string 8</ProductManufacturer>
    <ProductManufacturerID>7</ProductManufacturerID>
    <ProductModel>sample string 9</ProductModel>
    <ProductNumber>sample string 10</ProductNumber>
    <ProductRefID>2</ProductRefID>
    <RegionCode>sample string 4</RegionCode>
    <RegionID>3</RegionID>
    <UpdateDate>2025-11-07T09:03:50.0528603+00:00</UpdateDate>
    <UpdateUser>sample string 20</UpdateUser>
  </TCOeProduct>
  <TCOeProductDetail>
    <Active>true</Active>
    <AvgServiceCPP>19.1</AvgServiceCPP>
    <AvgStreetPriceDate>2025-11-07T09:03:50.0528603+00:00</AvgStreetPriceDate>
    <CPPOverride>35.1</CPPOverride>
    <ColorTonerCPP>26.1</ColorTonerCPP>
    <ColorTonerCoveragePercent>24.1</ColorTonerCoveragePercent>
    <ColorTonerDetailID>23</ColorTonerDetailID>
    <Cost>17.1</Cost>
    <CostPerPage>30.1</CostPerPage>
    <DuplexCapable>true</DuplexCapable>
    <DuplexerCost>9.1</DuplexerCost>
    <DutyCycle>5</DutyCycle>
    <EconomodeCoveragePercent>20</EconomodeCoveragePercent>
    <FPProductID>31</FPProductID>
    <FactoryWarranty>32</FactoryWarranty>
    <InsertDate>2025-11-07T09:03:50.0528603+00:00</InsertDate>
    <InsertUser>sample string 40</InsertUser>
    <InstallDate>2025-11-07T09:03:50.0528603+00:00</InstallDate>
    <IntroStreetPrice>16.1</IntroStreetPrice>
    <MonoTonerCPP>25.1</MonoTonerCPP>
    <MonoTonerCoveragePercent>22.1</MonoTonerCoveragePercent>
    <MonoTonerDetailID>21</MonoTonerDetailID>
    <MonthsInService>4</MonthsInService>
    <PostWarrantyCost>33.1</PostWarrantyCost>
    <PowerRateActive>13.1</PowerRateActive>
    <PowerRateIdle>14.1</PowerRateIdle>
    <PowerRatePowerSave>15.1</PowerRatePowerSave>
    <PowerSave>true</PowerSave>
    <ProductDetailID>1</ProductDetailID>
    <ProductID>2</ProductID>
    <SpeedColor>11.1</SpeedColor>
    <SpeedMono>10.1</SpeedMono>
    <StarterColorTonerPageLife>29</StarterColorTonerPageLife>
    <StarterMonoTonerPageLife>28</StarterMonoTonerPageLife>
    <SuppliesCPP>27.1</SuppliesCPP>
    <SupplyCPPOverride>37.1</SupplyCPPOverride>
    <SupportsColor>true</SupportsColor>
    <SupportsEcono>true</SupportsEcono>
    <TonerCPPOverride>36.1</TonerCPPOverride>
    <UpdateDate>2025-11-07T09:03:50.0528603+00:00</UpdateDate>
    <UpdateReason>sample string 38</UpdateReason>
    <UpdateUser>sample string 42</UpdateUser>
  </TCOeProductDetail>
</Product>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'Product'.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample: 
1

application/xml, text/xml

Sample: 
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>