Get Started
Document V2
Payment V2
Customer V2
Vendor V2
Product V2
Subscriptions V2
Utility V2
Get list of items
curl --request GET \
--url https://app.getswipe.in/api/partner/v2/product/list \
--header 'Authorization: <api-key>'
{
"success": true,
"message": "",
"error_code": "",
"errors": {},
"data": {
"items": [
{
"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",
"swipe_id": "1"
}
],
"total_records": 10
}
}
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Number of records to fetch, default : all items will be sent in response
Page number
Response
Success flag
true
Response message
""
Error Code
""
Errors
Unique id for each item. If a new id is sent, a new Item with the below details will be automatically created. if existing Item id is sent the details will not override the original item details. They will be applicable only to the current invoice
"ITEM123"
Name of the Product
"Item Name"
Current Quantity
1
Price per item without Tax
100
Price per item with Tax
118
Product or Service enum
"Product"
Tax percentage for each item . Only valid tax rates are accepted
18
Default Discount Percent
10
Item Description
"Item Description"
HSN Code
"1234"
item quantity unit
"kg"
Category
"Electronics"
Swipe ID assigned to the item
"1"
Total Records available
10
curl --request GET \
--url https://app.getswipe.in/api/partner/v2/product/list \
--header 'Authorization: <api-key>'
{
"success": true,
"message": "",
"error_code": "",
"errors": {},
"data": {
"items": [
{
"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",
"swipe_id": "1"
}
],
"total_records": 10
}
}