GEgetswipe
Product

Update an item

Changed on

v1 is deprecated — use the v2 endpoint instead. Updates an item's master record in the catalog. This is the only way to change catalog details — item fields sent inside a document apply to that document only.

put/v1/product

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v1/product
  • Auth
    HTTP bearer

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

discount_percentnumber

Default Discount Percent

descriptionstring

Item Description

hsn_codestring

HSN Code

item_typestring 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.

categorystring

Category

statusstring

Status of the Item

Example request

{
  "id": "ITEM123",
  "name": "Item Name",
  "quantity": 1,
  "unit_price": 100,
  "tax_rate": 18,
  "price_with_tax": 118,
  "discount_percent": 10,
  "description": "Item Description",
  "hsn_code": "1234",
  "item_type": "Product",
  "unit": "kg",
  "category": "Electronics",
  "status": "Active"
}

Response

Success

successboolean

Success flag

messagestring

Response message

Example response

{
  "success": true,
  "message": "Product added successfully"
}

Changes