This page lists the 6 endpoints of the suppliers sub-module of the procurement module, under /api/v1/procurement. Scope: Supplier records. The module entry page is Procurement API.
Group facts¶
| Item | Value | Source |
|---|---|---|
| Base path | /api/v1/procurement |
src/cluster_erp/core/module_base.py:37-38, src/cluster_erp/modules/procurement/module.py:70 |
| Routers | 1 router objects in 1 files; listed in the section Endpoints | src/cluster_erp/modules/procurement/module.py:35 |
| Endpoints | 6, counted from the route decorators and add_api_route calls of the routers that register_routes mounts |
src/cluster_erp/modules/procurement/suppliers/routes.py |
| Authentication | Bearer header or session cookie, resolved by get_current_user; see Authentication and headers |
src/cluster_erp/modules/auth/guards.py:85-167 |
| Permission guard | 6 of 6 routes declare require_permission |
src/cluster_erp/modules/auth/guards.py:205-240 |
| App entitlement gate | require_app("procurement") on every mounted router |
src/cluster_erp/modules/procurement/module.py:82 |
| Error format | JSON body {"error": {...}}; see Errors |
src/cluster_erp/server/error_handler.py:33-46 |
Endpoints¶
| Method | Path | Handler | Permission | Request | Query | Response | Status | Source |
|---|---|---|---|---|---|---|---|---|
GET |
/api/v1/procurement/suppliers/ |
list_suppliers |
supplier.read |
none | search, active_only, party_id, limit, offset |
dict |
200 (default) | src/cluster_erp/modules/procurement/suppliers/routes.py:37 |
POST |
/api/v1/procurement/suppliers/ |
create_supplier |
supplier.create |
SupplierCreate |
none | SupplierRead |
201 |
src/cluster_erp/modules/procurement/suppliers/routes.py:73 |
GET |
/api/v1/procurement/suppliers/{supplier_id} |
get_supplier |
supplier.read |
none | none | SupplierRead |
200 (default) | src/cluster_erp/modules/procurement/suppliers/routes.py:92 |
PUT |
/api/v1/procurement/suppliers/{supplier_id} |
update_supplier |
supplier.update |
SupplierUpdate |
none | SupplierRead |
200 (default) | src/cluster_erp/modules/procurement/suppliers/routes.py:113 |
DELETE |
/api/v1/procurement/suppliers/{supplier_id} |
delete_supplier |
supplier.delete |
none | none | none | 204 |
src/cluster_erp/modules/procurement/suppliers/routes.py:135 |
POST |
/api/v1/procurement/suppliers/bulk-delete |
bulk_delete_suppliers |
supplier.bulk_delete |
BulkDeleteRequest |
none | BulkDeleteResponse |
200 (default) | src/cluster_erp/modules/procurement/suppliers/routes.py:147 |
Error codes¶
The table lists the error codes that code under src/cluster_erp/modules/procurement/suppliers/ raises, found by a syntax-tree scan for AppError(...), the factories in src/cluster_erp/core/errors.py (not_found, conflict, protected, permission_denied, privilege_escalation, check_version), and HTTPException(...). A status of 400 is the AppError default (src/cluster_erp/core/errors.py:23). Guard errors (401, 403), the entitlement codes, and validation errors (422) apply to every route and are listed on Errors.
| Code | HTTP status | Raised in | First site |
|---|---|---|---|
CONCURRENCY_VERSION_CONFLICT |
409 |
services |
src/cluster_erp/modules/procurement/suppliers/services.py:157 |
RESOURCE_NOT_FOUND |
404 |
routes |
src/cluster_erp/modules/procurement/suppliers/routes.py:102 |
VALIDATION_ERROR |
422 |
services |
src/cluster_erp/modules/procurement/suppliers/services.py:102 |
Related pages¶
Verified against commit 92f8051 on 2026-11-13.