Sign in

v1

latestOpenAPI 3.0.12026-07-263591116.9 KB
Product V2

Add an Item

post/v2/product

Request body

idstring required

Unique id for each item.

namestring required

Name of the Product

quantitynumber required

Opening Quantity

unit_pricenumber required

Price per item without Tax

tax_ratenumber

Tax percentage for each item . Only valid tax rates are accepted

price_with_taxnumber required

Price per item with Tax

purchase_price_with_taxnumber

Purchase Price per item with Tax

descriptionstring

Item Description

hsn_codestring

HSN Code

item_type'Product' | 'Service' required

Product or Service enum

unitstring

Item quantity unit. You can find the GST-approved units in the UQC Codes section at: https://einvoice1.gst.gov.in/Others/MasterCodes.

cess_ratenumber

Cess Percent of the Item

cess_amountnumber

Cess Amount of the Item

barcodestring

Barcode

categorystring

Category

visibilityinteger

If set to 1, the product will be visible to all branches. If set to 0, the product will be visible only to the branch it was created in.

Example request

{
  "id": "ITEM123",
  "name": "Item Name",
  "quantity": 1,
  "unit_price": 100,
  "tax_rate": 18,
  "price_with_tax": 118,
  "purchase_price_with_tax": 118,
  "description": "Item Description",
  "hsn_code": "1234",
  "item_type": "Product",
  "unit": "kg",
  "barcode": "2273546838467",
  "category": "Electronics",
  "custom_columns": [
    {
      "label": "Custom Label",
      "value": "Custom Value"
    }
  ],
  "alternative_units": [
    {
      "alternative_unit": "g",
      "conversion_rate": 1000
    }
  ],
  "preferences": {
    "discount_percent": 10
  },
  "visibility": 1
}

Response

Success

successboolean

Success flag

messagestring

Response message

error_codestring

Error Code

errorsobject

Errors

Example response

{
  "success": true,
  "message": "Message",
  "data": {
    "id": "ITEM123",
    "name": "Item Name",
    "quantity": 1,
    "unit_price": 100,
    "tax_rate": 18,
    "price_with_tax": 118,
    "purchase_price_with_tax": 118,
    "description": "Item Description",
    "hsn_code": "1234",
    "item_type": "Product",
    "unit": "kg",
    "barcode": "2273546838467",
    "category": "Electronics",
    "custom_columns": [
      {
        "label": "Custom Label",
        "value": "Custom Value"
      }
    ],
    "alternative_units": [
      {
        "alternative_unit": "g",
        "conversion_rate": 1000
      }
    ],
    "preferences": {
      "discount_percent": 10
    },
    "visibility": 1
  }
}