Sign in

v1

latestOpenAPI 3.1.02026-08-045901.5 MB

Update Catalog

put/catalog

Headers

api-tokenstring

Generate token from authentication api

x-api-keystring

This will shared while register

Request body

catalog_idinteger required

A unique identifier for the catalog to which an item belongs.

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

Specifies the category or classification of the item, such as goods, service, or other predefined types.

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

GST rate which is approved by gov. filing portal

pricenumber float required

The monetary value assigned to an item, typically representing the selling or purchase cost per unit.

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

Units as per dropdown.

catalog_type'sales' | 'purchase' required

Defines the type or purpose of the catalog the item belongs to, such as sales, purchase, or inventory.

hsn_sacstring

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

statusinteger
messagestring
catalog_idinteger

Example response

{
  "status": 200,
  "message": "Item Updated Successfully",
  "catalog_id": 287
}