Create an Item

POST/api/v1/items

Register an item with full control over all Kenya Revenue Authority fields. Use this when the simplified /items/service or /items/goods endpoints do not cover your requirements.

Requires x-api-key

http://localhost:8100/api/v1/items

Headers

FieldTypeRequiredDescription
x-api-keystringRequiredYour Ushuru API key
Content-TypestringRequiredMust be application/json

Request Body

FieldTypeRequiredDescription
itemCdstringOptionalCustom item code. Auto-generated if omitted.
itemClsCdstringRequiredItem class code: SV=Service, GD=Goods
itemTyCdstringRequiredItem type code from Kenya Revenue Authority code class 20
itemNmstringRequiredItem name (max 100 chars)
itemStdNmstringOptionalStandardized item name
orgnNatCdstringOptionalOrigin nation code (default: KE)
pkgUnitCdstringRequiredPackaging unit code from Kenya Revenue Authority code class 17
qtyUnitCdstringRequiredQuantity unit code from Kenya Revenue Authority code class 10
taxTyCdstringRequiredTax type code: A, B, C, or D
btchNostringOptionalBatch number for tracked goods
bcdstringOptionalBarcode
dftPrcnumberOptionalDefault price in KES
addInfostringOptionalAdditional information
sftyQtynumberOptionalSafety/minimum stock quantity
useYnstringRequiredActive: Y or N

Request

{
  "itemClsCd": "SV",
  "itemTyCd": "2",
  "itemNm": "Annual Licence Fee",
  "pkgUnitCd": "NT",
  "qtyUnitCd": "U",
  "taxTyCd": "B",
  "dftPrc": 120000,
  "useYn": "Y"
}

Response

{
  "resultCd": "000",
  "resultMsg": "Item registered successfully",
  "data": {
    "itemCd": "SV0000000Z002",
    "itemNm": "Annual Licence Fee",
    "itemClsCd": "SV",
    "taxTyCd": "B",
    "useYn": "Y",
    "regDt": "20240115",
    "modiDt": "20240115"
  }
}
curl -X POST http://localhost:8100/api/v1/items \\
  -H "x-api-key: YOUR_API_KEY" \\
  -H "Content-Type: application/json" \\
  -d '{
    "itemClsCd": "SV",
    "itemTyCd": "2",
    "itemNm": "Annual Licence Fee",
    "pkgUnitCd": "NT",
    "qtyUnitCd": "U",
    "taxTyCd": "B",
    "dftPrc": 120000,
    "useYn": "Y"
  }'