Reference
Products
Inventory catalogue with VAT categories and stock tracking.
Products are the item catalogue you reference from invoice line items. They carry pricing in kobo, VAT categorisation (standard, zero-rated, exempt), and optional stock tracking.
List products
GET
/v1/productsReturns active products, sorted by name.
Query parameters
| Field | Type | Required | Notes |
|---|---|---|---|
businessId | string | yes | |
limit | integer | no | Default 50, max 100. |
Response — 200
{
"success": true,
"data": {
"products": [
{
"id": "prd_001",
"name": "Website development",
"description": "One-off project — hourly billed",
"sku": "WEB-DEV-001",
"unitPriceKobo": 2500000,
"unitPrice": 25000,
"vatCategory": "standard",
"vatRate": 7.5,
"trackStock": false,
"isActive": true,
"createdAt": "2026-03-01T09:00:00.000Z"
}
],
"count": 1
}
}Get a single product
GET
/v1/products/{id}Fetches one product.
Create a product
POST
/v1/productsCreates a product.
Body
| Field | Type | Required | Notes |
|---|---|---|---|
name | string | yes | Display name. |
unitPrice | number | yes | In naira. |
description | string | no | |
sku | string | no | |
vatCategory | string | no | standard (7.5%), zero_rated, exempt. Defaults to standard. |
trackStock | boolean | no | Enable stock tracking for this product. Defaults to false. |
stockQuantity | number | no | Initial stock (only used when trackStock: true). |
Update a product
PUT
/v1/products/{id}Updates any product field. Pass stockQuantity to adjust inventory.
Related endpoints
- Invoices — reference products in line items
Reference index
Back to all modules