Knosc API Documentation¶

Version: 1.41 Protocol: HTTPS Data Format: JSON

Base URLs¶

Environment	URL
Production	`https://{company}.knosc.com/api`
Test	`https://{company}.knosc.io/api`

Replace {company} with your organisation's subdomain identifier provided during onboarding.

Overview¶

The Knosc REST API provides programmatic access to procurement, demand, manufacturing, inventory, forecasting, and supply chain analytics. All endpoints follow RESTful conventions. Request and response bodies are JSON-encoded. Authentication uses cookie-based JWT with CSRF protection.

Table of Contents¶

Getting Started¶

Authentication - Login, logout, token refresh, 2FA, password reset
Quick Start - Make your first API call in minutes
Errors & Status Codes - Error codes, response format, troubleshooting

Guides¶

API Reference¶

Authentication¶

Method	Endpoint	Description
POST	`/api/authenticate`	Log in
POST	`/api/logout`	Log out
POST	`/api/token-refresh`	Refresh access token
POST	`/api/first-signin`	Set password on first login
POST	`/api/forgot-password`	Request password reset link
POST	`/api/reset-password`	Reset password with token
POST	`/api/force-reset-password`	Admin: force user password reset
POST	`/api/setup-2fa/generate`	Generate 2FA secret
POST	`/api/setup-2fa/activate`	Activate 2FA
POST	`/api/verify-2fa`	Verify TOTP code during login
POST	`/api/user/{user_id}/reset-2fa`	Admin: reset user 2FA

Users¶

Method	Endpoint	Description
GET	`/api/user`	List users
GET	`/api/user/{id}`	Get user
POST	`/api/user`	Create user
PUT	`/api/user/{id}`	Update user
DELETE	`/api/user/{id}`	Delete user
GET	`/api/profile`	Get own profile

Roles & Privileges¶

Method	Endpoint	Description
GET	`/api/role`	List roles
GET	`/api/role/{id}`	Get role with privileges
GET	`/api/privilege`	Check privilege access
DELETE	`/api/privilege/{id}`	Remove privilege from role

Purchase Orders¶

Method	Endpoint	Description
GET	`/api/purchase-order`	List purchase orders
GET	`/api/purchase-order/{id}`	Get PO with line items
POST	`/api/purchase-order`	Create purchase order
PUT	`/api/purchase-order/{id}`	Update purchase order
DELETE	`/api/purchase-order/{id}`	Delete purchase order
GET	`/api/purchase-order-details`	List all PO detail lines
DELETE	`/api/purchase-order-details/{id}`	Delete detail line
GET	`/api/purchase-order-item/{item_id}`	POs for an item
GET	`/api/purchase-order-item/{item_id}/{warehouse_id}`	POs for item + warehouse
PUT	`/api/purchase-order-details-move-lines`	Move lines between POs
PUT	`/api/purchase-order-details-accept-suggested-orders`	Accept suggested orders
GET	`/api/delayed-shipments/{details}`	Delayed shipment analytics

Sales Orders¶

Method	Endpoint	Description
GET	`/api/sales-order`	List sales orders
GET	`/api/sales-order/{id}`	Get SO with line items
POST	`/api/sales-order`	Create sales order
PUT	`/api/sales-order/{id}`	Update sales order
DELETE	`/api/sales-order/{id}`	Delete sales order
GET	`/api/sales-order-details`	List all SO detail lines
DELETE	`/api/sales-order-details/{id}`	Delete SO detail line
GET	`/api/sales-order-item/{item_id}`	SOs for an item
GET	`/api/sales-order-item/{item_id}/{warehouse_id}`	SOs for item + warehouse
GET	`/api/sales-prioritized-item-inventory/{item_id}`	Prioritized inventory for item

Manufacturing Orders¶

Method	Endpoint	Description
GET	`/api/manufacturing-order`	List manufacturing orders
GET	`/api/manufacturing-order/{id}`	Get MO with details
POST	`/api/manufacturing-order`	Create manufacturing order
PUT	`/api/manufacturing-order/{id}`	Update manufacturing order
DELETE	`/api/manufacturing-order/{id}`	Delete manufacturing order
GET	`/api/manufacturing-order-item/{item_id}`	MOs for an item
GET	`/api/manufacturing-order-bom/{id}`	BOM data for MO

Forecasts¶

Method	Endpoint	Description
GET	`/api/forecast`	List forecasts
GET	`/api/forecast/{id}`	Get forecast with details
POST	`/api/forecast`	Create forecast
PUT	`/api/forecast/{id}`	Update forecast
DELETE	`/api/forecast/{id}`	Delete forecast
GET	`/api/forecast-item/{item_id}`	Forecast for an item
GET	`/api/forecast-over-time`	Historical forecast data
GET	`/api/forecast-vs-sales`	Forecast vs actual sales

Inventory¶

Method	Endpoint	Description
GET	`/api/inventory`	List inventory records
GET	`/api/inventory/{id}`	Get inventory record
POST	`/api/inventory`	Create inventory record
PUT	`/api/inventory/{id}`	Update inventory record
DELETE	`/api/inventory/{id}`	Delete inventory record
GET	`/api/inventory-item/{item_id}`	Inventory for an item
GET	`/api/inventory-planning`	Inventory planning suggestions
GET	`/api/inventory-analysis`	Inventory analysis
GET/POST	`/api/inventory-planning-settings`	Planning settings
POST	`/api/inventory-planning-settings-recalculate`	Recalculate settings

Master Data¶

Method	Endpoint	Description
GET/POST/PUT/DELETE	`/api/item-master`	Item master records
GET/POST/PUT/DELETE	`/api/sub-item-master`	Sub-item / variant records
GET/POST/PUT/DELETE	`/api/customer-master`	Customer records
GET/POST/PUT/DELETE	`/api/ship-to-master`	Customer ship-to locations
GET/POST/PUT/DELETE	`/api/supplier-master`	Supplier records
GET/POST/PUT/DELETE	`/api/ship-from-master`	Supplier ship-from locations
GET/POST/PUT/DELETE	`/api/warehouse-master`	Warehouse records
GET/POST/PUT/DELETE	`/api/unit-master`	Units of measure
GET/POST/PUT/DELETE	`/api/external-item-master`	External / third-party items

Bill of Materials¶

Method	Endpoint	Description
GET	`/api/bill-of-materials`	List BOMs
GET	`/api/bill-of-materials/{id}`	Get BOM with components
POST	`/api/bill-of-materials`	Create BOM
PUT	`/api/bill-of-materials/{id}`	Update BOM
DELETE	`/api/bill-of-materials/{id}`	Delete BOM

Advanced Shipment Notice (ASN)¶

Method	Endpoint	Description
GET	`/api/asn`	List ASNs
GET	`/api/asn/{id}`	Get ASN
POST	`/api/asn`	Create ASN
PUT	`/api/asn/{id}`	Update ASN
DELETE	`/api/asn/{id}`	Delete ASN

Supplier Allocation¶

Method	Endpoint	Description
GET/POST/PUT/DELETE	`/api/supplier-allocation`	Supplier-to-item allocations
GET	`/api/supplier-net-allocation`	Net allocation view

Issue Tracker¶

Method	Endpoint	Description
GET	`/api/issue-tracker-tickets`	List tickets
GET	`/api/issue-tracker-tickets/{id}`	Get ticket
POST	`/api/issue-tracker-tickets`	Create ticket
PUT	`/api/issue-tracker-tickets/{id}`	Update ticket
DELETE	`/api/issue-tracker-tickets/{id}`	Delete ticket
POST	`/api/issue-tracker-notes`	Add note to ticket
PUT/DELETE	`/api/issue-tracker-notes/{id}`	Update / delete note
GET/POST/DELETE	`/api/issue-tracker-tickets/{id}/subscribers`	Manage ticket subscribers

Scenario Analysis¶

Method	Endpoint	Description
GET	`/api/scenario-analysis`	List scenarios
GET	`/api/scenario-analysis/{id}`	Get scenario
POST	`/api/scenario-analysis`	Create scenario
PUT	`/api/scenario-analysis/{id}`	Update scenario
DELETE	`/api/scenario-analysis/{id}`	Delete scenario
GET	`/api/scenario-analysis-impact`	Analyse scenario impact
GET	`/api/scenario-analysis-impacted-items/{id}`	Impacted items
GET	`/api/scenario-purchase-order-details/{scenario_id}`	Scenario PO details
GET	`/api/scenario-manufacturing-order-details/{scenario_id}`	Scenario MO details
GET	`/api/scenario-forecast-details/{scenario_id}`	Scenario forecast details
GET	`/api/scenario-sales-order-details/{scenario_id}`	Scenario SO details

Dashboards¶

Endpoint	Description
`/api/dashboard-*`	25+ read-only analytics dashboards

Jobs & Uploads¶

Method	Endpoint	Description
POST	`/api/job/{trigger}`	Upload data file or trigger job
GET	`/api/job/{trigger}`	Download file / get job status
GET	`/api/job?jobs=[]`	Get status of multiple jobs

Settings¶

Method	Endpoint	Description
GET/PUT	`/api/system-settings`	System configuration
GET/PATCH	`/api/user-settings`	Per-user preferences
GET/POST/PUT/DELETE	`/api/user-notification-settings`	Notification preferences
GET/PUT	`/api/change-tracking-settings`	Change tracking configuration

Utilities¶

Method	Endpoint	Description
GET	`/api/auto-complete`	Field autocomplete search
POST	`/api/export-data`	Export table data to Excel
GET/POST/PUT/DELETE	`/api/views`	Save and manage custom views
GET/POST/PUT/DELETE	`/api/custom-columns`	Custom column management
GET	`/api/validate-privileges`	Validate route access
POST	`/api/help`	Get column help text

Privilege Matrix¶

Module	Privilege Type	View	Edit
Purchase Orders	`Procurement`	Read POs and details	Create, update, delete
Sales Orders	`Demand`	Read SOs and details	Create, update, delete
Manufacturing Orders	`Manufacturing`	Read MOs and details	Create, update, delete
Forecasts	`Forecast`	Read forecasts	Create, update, delete
Inventory	`Inventory`	Read inventory	Create, update, delete
Inventory Planning	`Inventory Planning`	Read planning data	Modify settings
Item Master	`Item Master`	Read items	Create, update, delete
Customer Master	`Customer Master`	Read customers	Create, update, delete
Supplier Master	`Supplier Master`	Read suppliers	Create, update, delete
Warehouse Master	`Warehouse Master`	Read warehouses	Create, update, delete
Bill of Materials	`Bill of Materials`	Read BOMs	Create, update, delete
ASN	`ASN`	Read ASNs	Create, update, delete
Supplier Allocation	`Supplier Allocation`	Read allocations	Modify allocations
Users	`Users`	List users	Create, update, delete
Issue Tracker	`Issue Tracker`	Read tickets	Create, update, delete
Scenarios	`Scenarios`	Read scenarios	Create, update, delete
Scenario Analysis (MO)	`Manufacturing`	Read scenario MO data	-
Custom Columns	`Custom Columns`	Read columns	Create, update, delete
Logs	`Log`	Read logs	-

Support¶

For API access, credentials, or integration assistance, contact your Knosc account representative.