📦 Products

Product inventory and stock management

List products

get

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/inventory/

Get a paginated list of products with optional filters

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

Query parameters

categorystringOptional

Filter products by category

low_stockbooleanOptional

Filter only low stock products (true/false)

namestringOptional

Filter products by name/title (case-insensitive partial match)

product_typestringOptional

Filter products by product type

searchstringOptional

Search products by name, product code, or barcode

statusstringOptional

Filter products by status (active, inactive, discontinued, out_of_stock)

Responses

200Success

application/json

401

Unauthorized

403

Forbidden

get

/api/v1.0/organisation/{org_uid}/inventory/

HTTPcURLJavaScriptPython

GET /api/v1.0/organisation/{org_uid}/inventory/ HTTP/1.1
Host: skhokho.ai
Accept: */*

[
  {
    "unique_id": "text",
    "name": "text",
    "short_description": "text",
    "product_code": "text",
    "barcode": "text",
    "product_type": "manufacture",
    "category": "text",
    "brand": "text",
    "selling_price": "text",
    "current_stock": "text",
    "minimum_stock_level": "text",
    "unit_of_measure": "piece",
    "status": "active",
    "is_low_stock": true,
    "image_url": "https://example.com",
    "date_created": "2026-02-04T19:48:04.272Z"
  }
]

Create product

post

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/inventory/create/

Create a new product

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Full serializer for Product creation and updates. Handles translatable fields correctly.

namestring · min: 1 · max: 300Required

descriptionstring · nullableOptional

short_descriptionstring · max: 500 · nullableOptional

product_codestring · max: 100 · nullableOptional

barcodestring · max: 100 · nullableOptional

product_typestring · enumRequired

Product type is required.

• manufacture - Manufacture
• buy - Buy

Possible values:

categorystring · max: 200 · nullableOptional

brandstring · max: 200 · nullableOptional

model_numberstring · max: 200 · nullableOptional

unit_of_measurestring · enumOptional

• piece - Piece
• kg - Kilogram
• gram - Gram
• liter - Liter
• meter - Meter
• square_meter - Square Meter
• cubic_meter - Cubic Meter
• hour - Hour
• day - Day
• month - Month
• year - Year
• box - Box
• pack - Pack
• dozen - Dozen
• other - Other

Possible values:

cost_pricestring · decimal · nullableOptional

Cost price per unit

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

selling_pricestring · decimal · nullableOptional

Selling price per unit

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

current_stockstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$

minimum_stock_levelstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$

maximum_stock_levelstring · decimal · nullableOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued
• out_of_stock - Out of Stock

Possible values:

imagestring · binary · nullableOptional

Product image for catalogs and invoices

supplier_namestring · max: 300 · nullableOptional

Responses

201Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

post

/api/v1.0/organisation/{org_uid}/inventory/create/

HTTPcURLJavaScriptPython

POST /api/v1.0/organisation/{org_uid}/inventory/create/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 394

{
  "name": "text",
  "description": "text",
  "short_description": "text",
  "product_code": "text",
  "barcode": "text",
  "product_type": "manufacture",
  "category": "text",
  "brand": "text",
  "model_number": "text",
  "unit_of_measure": "piece",
  "cost_price": "text",
  "selling_price": "text",
  "current_stock": "text",
  "minimum_stock_level": "text",
  "maximum_stock_level": "text",
  "status": "active",
  "image": "binary",
  "supplier_name": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "product_code": "text",
  "barcode": "text",
  "product_type": "manufacture",
  "category": "text",
  "brand": "text",
  "model_number": "text",
  "unit_of_measure": "piece",
  "cost_price": "text",
  "selling_price": "text",
  "current_stock": "text",
  "minimum_stock_level": "text",
  "maximum_stock_level": "text",
  "status": "active",
  "image_url": "https://example.com",
  "supplier_name": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "is_low_stock": true,
  "profit_margin": "text",
  "date_created": "2026-02-04T19:48:04.272Z",
  "last_updated": "2026-02-04T19:48:04.272Z"
}

Retrieve product

get

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/inventory/{unique_id}/

Get detailed information about a specific product

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Responses

200Success

application/json

401

Unauthorized

403

Forbidden

404

Not Found

get

/api/v1.0/organisation/{org_uid}/inventory/{unique_id}/

HTTPcURLJavaScriptPython

GET /api/v1.0/organisation/{org_uid}/inventory/{unique_id}/ HTTP/1.1
Host: skhokho.ai
Accept: */*

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "product_code": "text",
  "barcode": "text",
  "product_type": "manufacture",
  "category": "text",
  "brand": "text",
  "model_number": "text",
  "unit_of_measure": "piece",
  "cost_price": "text",
  "selling_price": "text",
  "current_stock": "text",
  "minimum_stock_level": "text",
  "maximum_stock_level": "text",
  "status": "active",
  "image_url": "https://example.com",
  "supplier_name": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "is_low_stock": true,
  "profit_margin": "text",
  "date_created": "2026-02-04T19:48:04.272Z",
  "last_updated": "2026-02-04T19:48:04.272Z"
}

Update product

put

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/inventory/{unique_id}/update/

Update product information (PUT for full update, PATCH for partial)

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Full serializer for Product creation and updates. Handles translatable fields correctly.

namestring · min: 1 · max: 300Required

descriptionstring · nullableOptional

short_descriptionstring · max: 500 · nullableOptional

product_codestring · max: 100 · nullableOptional

barcodestring · max: 100 · nullableOptional

product_typestring · enumRequired

Product type is required.

• manufacture - Manufacture
• buy - Buy

Possible values:

categorystring · max: 200 · nullableOptional

brandstring · max: 200 · nullableOptional

model_numberstring · max: 200 · nullableOptional

unit_of_measurestring · enumOptional

• piece - Piece
• kg - Kilogram
• gram - Gram
• liter - Liter
• meter - Meter
• square_meter - Square Meter
• cubic_meter - Cubic Meter
• hour - Hour
• day - Day
• month - Month
• year - Year
• box - Box
• pack - Pack
• dozen - Dozen
• other - Other

Possible values:

cost_pricestring · decimal · nullableOptional

Cost price per unit

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

selling_pricestring · decimal · nullableOptional

Selling price per unit

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

current_stockstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$

minimum_stock_levelstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$

maximum_stock_levelstring · decimal · nullableOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued
• out_of_stock - Out of Stock

Possible values:

imagestring · binary · nullableOptional

Product image for catalogs and invoices

supplier_namestring · max: 300 · nullableOptional

Responses

200Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

put

/api/v1.0/organisation/{org_uid}/inventory/{unique_id}/update/

HTTPcURLJavaScriptPython

PUT /api/v1.0/organisation/{org_uid}/inventory/{unique_id}/update/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 394

{
  "name": "text",
  "description": "text",
  "short_description": "text",
  "product_code": "text",
  "barcode": "text",
  "product_type": "manufacture",
  "category": "text",
  "brand": "text",
  "model_number": "text",
  "unit_of_measure": "piece",
  "cost_price": "text",
  "selling_price": "text",
  "current_stock": "text",
  "minimum_stock_level": "text",
  "maximum_stock_level": "text",
  "status": "active",
  "image": "binary",
  "supplier_name": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "product_code": "text",
  "barcode": "text",
  "product_type": "manufacture",
  "category": "text",
  "brand": "text",
  "model_number": "text",
  "unit_of_measure": "piece",
  "cost_price": "text",
  "selling_price": "text",
  "current_stock": "text",
  "minimum_stock_level": "text",
  "maximum_stock_level": "text",
  "status": "active",
  "image_url": "https://example.com",
  "supplier_name": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "is_low_stock": true,
  "profit_margin": "text",
  "date_created": "2026-02-04T19:48:04.272Z",
  "last_updated": "2026-02-04T19:48:04.272Z"
}

Update product

patch

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/inventory/{unique_id}/update/

Update product information (PUT for full update, PATCH for partial)

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

Full serializer for Product creation and updates. Handles translatable fields correctly.

namestring · min: 1 · max: 300Optional

descriptionstring · nullableOptional

short_descriptionstring · max: 500 · nullableOptional

product_codestring · max: 100 · nullableOptional

barcodestring · max: 100 · nullableOptional

product_typestring · enumOptional

Product type is required.

• manufacture - Manufacture
• buy - Buy

Possible values:

categorystring · max: 200 · nullableOptional

brandstring · max: 200 · nullableOptional

model_numberstring · max: 200 · nullableOptional

unit_of_measurestring · enumOptional

• piece - Piece
• kg - Kilogram
• gram - Gram
• liter - Liter
• meter - Meter
• square_meter - Square Meter
• cubic_meter - Cubic Meter
• hour - Hour
• day - Day
• month - Month
• year - Year
• box - Box
• pack - Pack
• dozen - Dozen
• other - Other

Possible values:

cost_pricestring · decimal · nullableOptional

Cost price per unit

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

selling_pricestring · decimal · nullableOptional

Selling price per unit

Pattern: ^-?\d{0,13}(?:\.\d{0,2})?$

current_stockstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$

minimum_stock_levelstring · decimalOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$

maximum_stock_levelstring · decimal · nullableOptionalPattern: ^-?\d{0,13}(?:\.\d{0,2})?$

statusstring · enumOptional

• active - Active
• inactive - Inactive
• discontinued - Discontinued
• out_of_stock - Out of Stock

Possible values:

imagestring · binary · nullableOptional

Product image for catalogs and invoices

supplier_namestring · max: 300 · nullableOptional

Responses

200Success

application/json

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

patch

/api/v1.0/organisation/{org_uid}/inventory/{unique_id}/update/

HTTPcURLJavaScriptPython

PATCH /api/v1.0/organisation/{org_uid}/inventory/{unique_id}/update/ HTTP/1.1
Host: skhokho.ai
Content-Type: application/json
Accept: */*
Content-Length: 394

{
  "name": "text",
  "description": "text",
  "short_description": "text",
  "product_code": "text",
  "barcode": "text",
  "product_type": "manufacture",
  "category": "text",
  "brand": "text",
  "model_number": "text",
  "unit_of_measure": "piece",
  "cost_price": "text",
  "selling_price": "text",
  "current_stock": "text",
  "minimum_stock_level": "text",
  "maximum_stock_level": "text",
  "status": "active",
  "image": "binary",
  "supplier_name": "text"
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "product_code": "text",
  "barcode": "text",
  "product_type": "manufacture",
  "category": "text",
  "brand": "text",
  "model_number": "text",
  "unit_of_measure": "piece",
  "cost_price": "text",
  "selling_price": "text",
  "current_stock": "text",
  "minimum_stock_level": "text",
  "maximum_stock_level": "text",
  "status": "active",
  "image_url": "https://example.com",
  "supplier_name": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "is_low_stock": true,
  "profit_margin": "text",
  "date_created": "2026-02-04T19:48:04.272Z",
  "last_updated": "2026-02-04T19:48:04.272Z"
}

Perform action on product

get

https://skhokho.aihttp://102.209.118.152:8000/https://dev.skhokho.ai

/api/v1.0/organisation/{org_uid}/inventory/{unique_id}/action/

Perform actions on a product (deactivate, mark_out_of_stock). Uses query parameters.

Authorizations

cookieAuthbasicAuth

sessionidstringRequired

Path parameters

org_uidstringRequired

unique_idstringRequired

Query parameters

actionstring · enumRequired

Action to perform: deactivate or mark_out_of_stock

Possible values:

Responses

200Success

application/json

400

Bad Request - Invalid action

401

Unauthorized

403

Forbidden

404

Not Found

get

/api/v1.0/organisation/{org_uid}/inventory/{unique_id}/action/

HTTPcURLJavaScriptPython

GET /api/v1.0/organisation/{org_uid}/inventory/{unique_id}/action/?action=deactivate HTTP/1.1
Host: skhokho.ai
Accept: */*

{
  "unique_id": "text",
  "name": "text",
  "description": "text",
  "short_description": "text",
  "product_code": "text",
  "barcode": "text",
  "product_type": "manufacture",
  "category": "text",
  "brand": "text",
  "model_number": "text",
  "unit_of_measure": "piece",
  "cost_price": "text",
  "selling_price": "text",
  "current_stock": "text",
  "minimum_stock_level": "text",
  "maximum_stock_level": "text",
  "status": "active",
  "image_url": "https://example.com",
  "supplier_name": "text",
  "created_by": {
    "unique_id": "text",
    "full_name": "text"
  },
  "is_low_stock": true,
  "profit_margin": "text",
  "date_created": "2026-02-04T19:48:04.272Z",
  "last_updated": "2026-02-04T19:48:04.272Z"
}