Skip to main content
POST
/
v1
/
product
Add an Item
curl --request POST \
  --url https://app.getswipe.in/api/partner/v1/product \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "ITEM123",
  "name": "Item Name",
  "quantity": 1,
  "unit_price": 100,
  "price_with_tax": 118,
  "item_type": "Product",
  "tax_rate": 18,
  "discount_percent": 10,
  "description": "Item Description",
  "hsn_code": "1234",
  "unit": "kg",
  "category": "Electronics",
  "status": "Active"
}
'
{
  "success": true,
  "message": "Product added successfully"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer , where is your auth token.

Body

application/json
​
id
string
required

Unique id for each item.

Example:

"ITEM123"

​
name
string
required

Name of the Product

Example:

"Item Name"

​
quantity
number
required

Opening Quantity

Example:

1

​
unit_price
number
required

Price per item without Tax

Example:

100

​
price_with_tax
number
required

Price per item with Tax

Example:

118

​
item_type
enum<string>
required

Product or Service enum

Available options:
Product,
Service
Example:

"Product"

​
tax_rate
number

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

Example:

18

​
discount_percent
number

Default Discount Percent

Example:

10

​
description
string

Item Description

Example:

"Item Description"

​
hsn_code
string

HSN Code

Example:

"1234"

​
unit
string

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

Example:

"kg"

​
category
string

Category

Example:

"Electronics"

​
status
string

Status of the Item

Example:

"Active"

Response

Success

​
success
boolean

Success flag

Example:

true

​
message
string

Response message

Example:

"Product added successfully"