POST api/v1/products

Creates a product

Request Information

Body Parameters

Name Description Type Additional information
Name Name of the product string Required Max length: 150
TaxID Tax ID for the product integer Required Range: inclusive between 1 and 2147483647
DiscountRate Discount rate for the product price decimal number Range: inclusive between 0 and 100
ApplyRetention True if you want to apply retention because only the Service product type can have retention boolean No additional information available.
AutoStockHistory True if you want to save the stock history automatically boolean No additional information available.
ProductType Product type. Check the enum for more information ProductType No additional information available.
UnitID Unit of measurement ID for the product integer Required Range: inclusive between 1 and 2147483647
Reference Product Reference string Max length: 10
SellPrice Product sell price without any taxes decimal number Range: inclusive between 0 and 79228162514264337593543950335
StockCategory Stock category type StockCategory No additional information available.
ProductDetail Product description. It will show in the sales as a suggestion string Max length: 1000
StockAlertQty Stock quantity alert for the product decimal number Range: inclusive between 0 and 79228162514264337593543950335
StockQty Stock quantity for the product decimal number Range: inclusive between 0 and 79228162514264337593543950335
StandardCost Product cost without taxes decimal number Range: inclusive between 0 and 79228162514264337593543950335

Request Formats

application/json, text/json

Sample:
                    
{
  "name": "sample string 1",
  "taxID": 2,
  "discountRate": 3.0,
  "applyRetention": true,
  "autoStockHistory": true,
  "productType": 0,
  "unitID": 6,
  "reference": "sample string 7",
  "sellPrice": 8.0,
  "stockCategory": 0,
  "productDetail": "sample string 9",
  "stockAlertQty": 10.0,
  "stockQty": 11.0,
  "standardCost": 12.0
}
                        
            

Response Information

Resource Description

No information available

Response Formats

application/json, text/json

Sample:
                    
{
  "key": 1,
  "value": "sample string 2"
}