Products
Create and manage product items for use in invoices and estimates.
Create Product
POST https://api.invoiless.com/v1/items
Create a new product item that can be used in invoices.
Example:
{
"name": "Premium Subscription",
"description": "Monthly premium subscription plan",
"price": 49.99,
"url": "https://example.com/products/premium",
"trackInventory": true,
"stock": 100,
"tags": ["subscription", "premium"]
}
Body Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| name | string | Product name (max 100 characters) | Yes |
| price | number | Product price (must be >= 0) | Yes |
| url | string | Product URL | No |
| description | string | Product description (max 1000 characters) | No |
| trackInventory | bool | Enable inventory tracking | No |
| stock | number | Stock quantity (integer, required if trackInventory is true) | No |
| tags | array[string] | Product tags (max 10 tags, each max 50 characters) | No |
Response HTTP/1.1 201 Created
Returns the created product object.
Update Product
PUT https://api.invoiless.com/v1/items/:id
PATCH https://api.invoiless.com/v1/items/:id
Update an existing product. See PUT vs PATCH for details on the differences.
Path Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| id | string | Product id | Yes |
Body Parameters
Accepts the same parameters as Create Product.
Get Product
GET https://api.invoiless.com/v1/items/:id
Retrieve a specific product by ID.
Path Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| id | string | Product id | Yes |
Get Products
GET https://api.invoiless.com/v1/items
Retrieve a paginated list of all products.
Query Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| page | number | Page number | No, default is 1 |
| limit | number | Page limit | No , default is 50 |
| search | string | Search by product name or tags | No |
Delete Product
DELETE https://api.invoiless.com/v1/items/:id
Permanently delete a product.
Path Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| id | string | Product id | Yes |