Product
Product

Product Endpoints

Products are related to enterprises. Each enterprise can have many products, but each product can belong to only one enterprise.

Product Object

Property NameType
idinteger
namestring
descriptionstring
referencestring
pricenumber
costnumber
max_discountnumber
stockinteger
activeboolean
product_category_idinteger
servicesinteger
vat_idinteger
taxesinteger
categoryobject ( Product Category )
vatobject ( Vat )
ratesArray of object ( Rates )
EXAMPLE
{
  "id": 1,
  "reference": "ProductAPI",
  "price": 15,
  "cost": 2,
  "max_discount": null,
  "stock": 1,
  "active": true,
  "product_category_id": 1,
  "services": null,
  "vat_id": 1,
  "taxes": null,
  "name": "Product API",
  "description": "Product API description",
  "category": {
      "id": 1,
      "name": "CategoryAPI",
      "reference": "C_API",
      "parent_id": 0,
      "childs": []
  },
  "vat": {
      "id": 1,
      "vat": "21.00",
      "erp_flag": ""
  },
  "rates": [
    {
      "id": 1,
      "sku": "ProductAPI_rate_1",
      "cost": 1.00,
      "price": 5.00,
      "services": 0.00,
      "primary": 1
    }
  ]
}

Vat Object

Property NameType
idinteger
vatstring
erp_flagstring
vat
{
      "id": 1,
      "vat": "21.00",
      "erp_flag": ""
  }

Rate Object

Property NameType
idinteger
skustring
costnumber
pricenumber
servicesnumber
primaryinteger
rate
{
      "id": 1,
      "sku": "ProductAPI_rate_1",
      "cost": 1.00,
      "price": 5.00,
      "services": 0.00,
      "primary": 1
    }