Skip to main content

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

NameTypeDescriptionRequired
namestringProduct name (max 100 characters)Yes
pricenumberProduct price (must be >= 0)Yes
urlstringProduct URLNo
descriptionstringProduct description (max 1000 characters)No
trackInventoryboolEnable inventory trackingNo
stocknumberStock quantity (integer, required if trackInventory is true)No
tagsarray[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

NameTypeDescriptionRequired
idstringProduct idYes

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

NameTypeDescriptionRequired
idstringProduct idYes

Get Products

GET https://api.invoiless.com/v1/items

Retrieve a paginated list of all products.

Query Parameters

NameTypeDescriptionRequired
pagenumberPage numberNo, default is 1
limitnumberPage limitNo , default is 50
searchstringSearch by product name or tagsNo

Delete Product

DELETE https://api.invoiless.com/v1/items/:id

Permanently delete a product.

Path Parameters

NameTypeDescriptionRequired
idstringProduct idYes