Add an Item

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/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,
  "purchase_price_with_tax": 118,
  "description": "Item Description",
  "hsn_code": "1234",
  "unit": "kg",
  "cess_rate": 0,
  "cess_amount": 0,
  "barcode": "2273546838467",
  "category": "Electronics",
  "custom_columns": [
    {
      "label": "Custom Label",
      "value": "Custom Value"
    }
  ],
  "alternative_units": [
    {
      "alternative_unit": "g",
      "conversion_rate": 1000
    }
  ],
  "preferences": {
    "not_for_sale": false,
    "low_stock_alert": 0,
    "show_online": false,
    "discount_percent": 10
  },
  "visibility": 1
}
'

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

POST

product

Add an Item

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/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,
  "purchase_price_with_tax": 118,
  "description": "Item Description",
  "hsn_code": "1234",
  "unit": "kg",
  "cess_rate": 0,
  "cess_amount": 0,
  "barcode": "2273546838467",
  "category": "Electronics",
  "custom_columns": [
    {
      "label": "Custom Label",
      "value": "Custom Value"
    }
  ],
  "alternative_units": [
    {
      "alternative_unit": "g",
      "conversion_rate": 1000
    }
  ],
  "preferences": {
    "not_for_sale": false,
    "low_stock_alert": 0,
    "show_online": false,
    "discount_percent": 10
  },
  "visibility": 1
}
'

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

Authorizations

Authorization

string

header

required

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

Body

application/json

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

purchase_price_with_tax

number

Purchase Price per item with Tax

Example:

118

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"

cess_rate

number

default:0

Cess Percent of the Item

Required range: x <= 100

Example:

0

cess_amount

number

default:0

Cess Amount of the Item

Example:

0

barcode

string

Barcode

Example:

"2273546838467"

Response

Success

success

boolean

Success flag

Example:

true

message

string

Response message

Example:

"Message"

error_code

string

Error Code

Example:

""

errors

object

Errors

data

object

Show child attributes

data.id

string

required

Unique id for each item.

Example:

"ITEM123"

data.name

string

required

Name of the Product

Example:

"Item Name"

data.quantity

number

required

Opening Quantity

Example:

1

data.unit_price

number

required

Price per item without Tax

Example:

100

data.price_with_tax

number

required

Price per item with Tax

Example:

118

data.item_type

enum<string>

required

Product or Service enum

Available options:

Product,

Service

Example:

"Product"

data.tax_rate

number

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

Example:

18

data.purchase_price_with_tax

number

Purchase Price per item with Tax

Example:

118

data.description

string

Item Description

Example:

"Item Description"

data.hsn_code

string

HSN Code

Example:

"1234"

data.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"

data.cess_rate

number

default:0

Cess Percent of the Item

Required range: x <= 100

Example:

0

data.cess_amount

number

default:0

Cess Amount of the Item

Example:

0

data.barcode

string

Barcode

Example:

"2273546838467"

data.category

string

Category

Example:

"Electronics"

data.custom_columns

object[]

Custom Fields

Show child attributes

data.custom_columns.label

string

required

data.custom_columns.value

string

required

Example:

[
  {
    "label": "Custom Label",
    "value": "Custom Value"
  }
]

data.alternative_units

object[]

Alternative Units

Show child attributes

data.alternative_units.alternative_unit

enum<string>

Alternative Unit

Available options:

LAD,

PET,

JARS,

HEGAR,

POCH,

BOR,

COIL,

FT,

IN,

PRT,

CASE,

EACH,

CPS,

PADS,

REEL,

BLISTER,

PAD,

PCS,

PRS,

QTL,

ROL,

SET,

SQF,

SQM,

SQY,

TBS,

TGM,

THD,

TON,

TUB,

UGS,

UNT,

YDS,

OTH,

HRS,

MINS,

LTR,

MTS,

MLG,

BCK,

GLS,

PLT,

CTS,

STRP,

CFT,

VIAL,

BAG,

BAL,

BDL,

BKL,

BOU,

BOX,

BTL,

BUN,

CAN,

CBM,

CCM,

CMS,

CTN,

DOZ,

DRM,

GGR,

GMS,

GRS,

GYD,

KGS,

KLR,

KME,

MLT,

MTR,

NOS,

PAC,

CNT,

RFT,

RIM,

TIN,

CHUDI,

PATTA,

KIT,

CUFT,

RMT,

MM,

AMP,

PAIR,

ANA,

CFM,

YRS,

MTH,

MAN-DAY,

NIGHT,

DAY,

SQIN,

WEEK,

PERSON,

LOT,

SAC,

REAM,

BRASS,

NONE,

COPY,

TKT,

KW,

W,

SEC,

BARREL,

SHEETS,

HOLES,

LINES,

LGTH,

TRIP,

LPSM,

WDTH,

SQCM,

SHFT,

AU,

SQKM,

JOBS,

CUIN,

IDIA,

INMT,

AC,

HA,

BARS,

PKTS

Example:

"kg"

data.alternative_units.conversion_rate

number

Conversion Rate

Example:

1

Example:

[
  {
    "alternative_unit": "g",
    "conversion_rate": 1000
  }
]

data.preferences

object

Product Preferences

Show child attributes

data.preferences.not_for_sale

boolean

Hides the item for sale and shows only while making a purchase. eg. Office equipment

Example:

false

data.preferences.low_stock_alert

integer

Low stock alert for the item

Example:

0

data.preferences.show_online

boolean

Show or hide the product in catalogue/ online store

Example:

false

data.preferences.discount_percent

number

default:0

Default Discount Percent

Example:

10

data.visibility

integer

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:

1

Delete a vendor Get Item Details

⌘I

Get Started

Document V2

Payment V2

EwayBill

Customer V2

Vendor V2

Product V2

Inventory V2

Subscriptions V2

Utility V2

Add an Item

Authorizations

Body

Response