Sign in

v1

latestOpenAPI 3.1.02026-08-045901.5 MB

Add Catalog

post/catalog

Request body

item_namestring required

The name or title of the item, such as a product or service, used for identification and display purposes in catalogs, invoices, and other records.

item_type'Goods' | 'Services' required

The type of the item, typically categorized as Goods or Services.

gst_rate'18%' | 'Nil-Rated' | 'Zero-Rated' | 'Exempted Supply' | 'Non-GST Supply' | '0%' | '0.1%' | '0.25%' | '1%' | '1.5%' | '3%' | '5%' | '7.5%' | '12%' | '28%' required

The Goods and Services Tax (GST) rate applied to the item.

units'UNT-UNITS' | 'BAG-BAGS' | 'BAL-BALE' | 'BDL-BUNDLES' | 'BKL-BUCKLES' | 'BOU-BILLIONS OF UNITS' | 'BOX-BOX' | 'BTL-BOTTLES' | 'BUN-BUNCHES' | 'CAN-CANS' | 'CBM-CUBIC METERS' | 'CCM-CUBIC CENTIMETERS' | 'CMC-CENTIMETERS' | 'CTN-CARTONS' | 'DOZ-DOZENS' | 'DRM-DRUMS' | 'GGK-GREAT GROSS' | 'GMS-GRAMMES' | 'GRS-GROSS' | 'GYD-GROSS YARDS' | 'KGS-KILOGRAMS' | 'KLR-KILOLITRE' | 'KME-KILOMETRE' | 'MLT-MILILITRE' | 'MTR-METERS' | 'MTS-METRIC TON' | 'NOS-NUMBERS' | 'OTH-OTHERS' | 'PAC-PACKS' | 'PCS-PIECES' | 'PRS-PAIRS' | 'QTL-QUINTAL' | 'ROL-ROLLS' | 'SET-SETS' | 'SQF-SQUARE FEET' | 'SQM-SQUARE METERS' | 'SQY-SQUARE YARDS' | 'TBS-TABLETS' | 'TGM-TEN GROSS' | 'THD-THOUSANDS' | 'TON-TONNES' | 'TUB-TUBES' | 'UGS-US GALLONS' | 'YDS-YARDS' required

The unit of measurement for the item.

catalog_type'sales' | 'purchase' required

Indicates the type of catalog the item belongs to, such as sales or purchase.

hsn_sacinteger

The HSN (Harmonized System of Nomenclature) or SAC (Service Accounting Code) assigned to a product or service under the GST framework in India.

cessnumber float

The additional tax (Cess) amount or rate applied on top of the standard GST, as mandated for specific goods or services (such as luxury items or sin goods). This value can be a fixed amount or a percentage, depending on the item classification.

descriptionstring

A detailed explanation or summary of the item, including its features, specifications, usage, or any other relevant information.

Response

200

statusstring
messagestring
catalog_idinteger

Example response

{
  "status": "success",
  "message": "Item Added Successfully",
  "catalog_id": 3558
}