Domain Overview

How the ConformaESG API is organized — the domain entities you integrate with and how they relate to each other.

The big picture

The ConformaESG API exposes your sustainability data as a handful of connected resources. At the center of the model is the supplier: every material flow, certification and purchase is ultimately anchored to the supplier that provides it.

Shell
┌──────────────┐
│ Supplier │
└──────┬───────┘
┌───────────────┼────────────────┐
▼ ▼ ▼
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
│ Certifications│ │ Products │ │ Purchases │
└──────────────┘ └──────┬───────┘ └──────┬───────┘
│ │
┌──────┴─────┐ ┌────┴─────┐
▼ ▼ ▼ ▼
Textile Chemicals Status Audit log
(fiber/yarn/ of changes
fabric)
┌─────────────────────────────────────┐
│ Product Traceability (with stages) │
└─────────────────────────────────────┘

The resources you'll use

ResourcePurposeReference
SuppliersCompanies that provide you with materials, chemicals or servicesAPI →
Supplier CertificationsDocuments that prove a supplier's compliance (REACH, GOTS, GRS…)API →
Supplier ProductsThe catalog of items a specific supplier offers youAPI →
Company ProductsItems in your own company catalogAPI →
ChemicalsChemical products with CAS number and ZDHC classificationAPI →
Textile (fibers/yarns/fabrics)Specialized product catalogs with textile-specific attributesFabrics →
PurchasesSupplier purchase orders with status lifecycle and audit logAPI →
Product TraceabilityEnd-to-end journey of a product with processing stages, distances and CO₂ emissionsAPI →
Traceability RecordsBatch-level records for individual shipments (origin, destination, certifications)API →

How the resources fit together

  1. You start by registering your suppliers and attaching their certifications.
  2. You add the items each supplier sells to you as supplier products (or fabrics / yarns / fibers for textile-specific detail).
  3. You maintain your own company products catalog — the SKUs you sell.
  4. Every time you buy from a supplier you create a purchase order, then move it through the status lifecycle as it progresses.
  5. For any company product you can build a product traceability journey composed of ordered processing stages — each stage captures the transport mode, distance and CO₂ emissions between steps.
  6. When a specific batch ships, you record it as a traceability record (batch-level, lightweight alternative to the full journey).

Multi-tenant isolation

All records are scoped to the tenant identified by your credentials. You cannot see or modify data belonging to other tenants, and no tenant identifier is required in any request. Your subscription also defines which modules are enabled — see Configuration and the /me/entitlements endpoint.