API Reference Overview

All public REST API endpoints in the ConformaESG Integration Service.

Response Codes

CodeMeaning
200 OKSuccess (GET, PATCH)
201 CreatedResource created (POST)
204 No ContentResource deleted (DELETE)
400 Bad RequestValidation error
404 Not FoundResource not found
500 Internal Server ErrorServer error

Error Format

JSON
{ "error": "Supplier not found with id: 999" }

Pagination

ParamTypeDefaultDescription
pageinteger0Zero-based page index
sizeintegervariesItems per page (see each resource)

Available Resources

ResourceBase PathDescription
Suppliers/api/v1/suppliersSupplier master data
Supplier Certifications/api/v1/supplier-certificationsCertification management
Supplier Products/api/v1/supplier/productsProducts linked to suppliers
Company Products/api/v1/company/productsCompany-owned products
Textile — Yarns/api/v1/textile/yarnsYarn products
Textile — Fibers/api/v1/textile/fibersFiber products
Textile — Fabrics/api/v1/textile/fabricsFabric products
Purchase Records/api/v1/purchasesProcurement tracking
Chemical Products/api/v1/chemicalsChemical product management
Chemical Purchases/api/v1/chemical-purchasesChemical procurement tracking
Traceability Records/api/v1/traceabilityProduct traceability
Processing Stages/api/v1/product/traceabilitySupply chain stages

Entity Metadata

Most entities support an optional metadata field — a free-form JSON object for custom attributes. Pass any key-value pairs you need without schema changes:

JSON
{
"name": "Acme Textiles",
"metadata": {
"erp_code": "SUP-0042",
"internal_rating": "A",
"custom_tags": ["priority", "eu-based"]
}
}

Swagger UI

Shell
http://localhost:8080/q/swagger-ui
http://localhost:8080/q/openapi