Product
/api/v1/catalog/productsA product available in the catalog.
listgetcreateupdatedeleteSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| sku | string | Stock Keeping Unit — unique product code within the tenant catalog. |
| name | string | Human-readable product name. |
| description | string | Detailed description of the product or service. |
| category | string | Free-form category label. Use ProductCategory for structured hierarchy. |
| type | string | Product type classification. |
| status | string | Lifecycle status of the product in the catalog. |
| unit_price | number | Price per unit in the specified currency. |
| currency | string | ISO 4217 three-character currency code. |
| unit | string | Human-readable unit description for the price. |
| taxable | boolean | Whether this product is subject to sales tax or VAT. |
| tags | json | Free-form tags for filtering and grouping products. |
API
client.catalog.products.*Loading manifest…