Add an item

Creates an item in your catalog keyed by your own id. Sending an ID that already exists fails with PRODUCT_ALREADY_EXISTS — use Update an item to change the catalog record. Items are also created automatically when a document references an unknown item id.

POST /v2/product

Add an item

cURL

curl --request POST \
  --url https://app.getswipe.in/api/partner/v2/product \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'product_images=<string>' \
  --form product_images.items='@example-file'

201

{
  "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",
    "alternative_units": [
      {
        "alternative_unit": "g",
        "conversion_rate": 1000
      }
    ],
    "custom_columns": [
      {
        "label": "Custom Label",
        "value": "Custom Value"
      }
    ],
    "preferences": {
      "not_for_sale": false,
      "low_stock_alert": 0,
      "show_online": false,
      "discount_percent": 10
    },
    "visibility": 1
  }
}

Uploading Product Images

To upload product images, use multipart/form-data instead of application/json. All the regular JSON fields are supported as form fields, plus:

• product_images: Array of image files (JPEG, PNG, etc.)
• For complex fields like custom_columns, alternative_units, and preferences, send them as JSON strings

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is an API key from the API Integration section of your dashboard. Keys are scoped to the company they are generated in — for testing, add a separate test company and generate the key there, so requests never touch your real books.

Query Parameters

id · string · required

Unique id for each item

name · string · required

Name of the Product

quantity · number · required

Opening Quantity

unit_price · number · required

Price per item without Tax

tax_rate · number

Tax percentage for each item

price_with_tax · number · required

Price per item with Tax

purchase_price_with_tax · number

Purchase Price per item with Tax

description · string

Item Description

hsn_code · string

HSN Code

item_type · string · required

Product or Service enum

unit · string

Item quantity unit

cess_rate · number

Cess Percent of the Item

cess_amount · number

Cess Amount of the Item

barcode · string

Barcode

category · string

Category

alternative_units · string

JSON string of alternative units

custom_columns · string

JSON string of custom fields

preferences · string

JSON string of product preferences

Body

multipart/form-data

product_images · file[]

Product images (multiple files supported)

Response

201

application/json

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