products with inventory
GET
/api/v1/product/products-inventory
Product Inventory List
Purpose
Why would you use this?
Information Required
| Field | Required | Description |
|---|---|---|
| api-token | Yes | Authentication token provided by VasyERP |
| branchId | Yes | Unique identifier of the branch |
| limit | Yes | Number of inventory records to retrieve per request |
| offset | Yes | Number of records to skip for pagination |
| fromDate | No | Start date and time in UTC format (ISO 8601) used to retrieve modified inventory records |
| toDate | No | End date and time in UTC format (ISO 8601) used to retrieve modified inventory records |
Information Returned
Important Notes
branchId is required.Z at the end of the timestamp to indicate UTC time.fromDate and toDate for incremental synchronization.qty field.Date Format Examples
| Purpose | Example |
|---|---|
| Start Date | 2020-01-01T00:00:00Z |
| End Date | 2026-06-20T23:59:59Z |
Request
Query Params
Header Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/api/v1/product/products-inventory?branchId=24448&limit=2&offset=00&toDate=2026-06-20T23%3A59%3A59Z&fromDate=2020-01-01T00%3A00%3A00Z' \
--header 'api-token: {{.in-api-token}}'Response Response Example
200 - Example 1
{
"status": true,
"message": "Product List",
"code": "200",
"response": {
"totalCount": 12751,
"items": [
{
"productId": 18313750,
"discount": 4.65,
"discountType": "percentage",
"itemCode": "BAR071",
"productName": "Oppo Reno 14 Pro",
"taxName": "GST 18",
"taxRate": 18.0,
"mrp": 42999.0,
"sellingPrice": 40999.55,
"hsnCode": "85171300",
"active": true,
"activeOnline": false,
"description": "<p><br></p>",
"shortDescription": "",
"productType": "Finished",
"brand": "Oppo",
"category": "Smartphone",
"department": "Other",
"lastModifiedBy": "my business",
"measurement": "PIECES",
"qty": 203.0,
"updatedDate": "2026-06-17 15:36:46.804508+05:30",
"createdDate": "2026-06-09 15:33:56.165744+05:30",
"batchUpdatedDate": "2026-06-23 17:09:26.880754+05:30"
},
{
"productId": 18313749,
"discount": 8.33,
"discountType": "percentage",
"itemCode": "BAR067",
"productName": "Dairy Milk Silk",
"taxName": "GST 18",
"taxRate": 18.0,
"mrp": 600.0,
"sellingPrice": 550.02,
"hsnCode": "",
"active": true,
"activeOnline": false,
"description": "<p><br></p>",
"shortDescription": "",
"productType": "Finished",
"brand": "Cadbury",
"category": "Fresh",
"department": "Food",
"lastModifiedBy": "my business",
"measurement": "tablet",
"qty": 90.0,
"updatedDate": "2026-06-09 15:25:28.780838+05:30",
"createdDate": "2026-06-09 15:25:28.780828+05:30",
"batchUpdatedDate": "2026-06-22 12:20:53.519144+05:30"
}
]
}
}