x-cpod-domain: catalog

Catalog

Product catalog and categories.

Try in explorer client.catalog

Product

A product available in the catalog.

REST path/api/v1/catalog/products

Operations

listgetcreateupdatedelete

SDK

// list — returns only your records; add filters/search:
await client.catalog.products.list()

// create:
await client.catalog.products.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
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	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
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.

ProductCategory

A category in the product catalog.

REST path/api/v1/catalog/categories

Operations

listgetcreateupdatedelete

SDK

// list — returns only your records; add filters/search:
await client.catalog.categories.list()

// create:
await client.catalog.categories.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
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	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
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.
name	string	Human-readable category name.
slug	string	URL-safe kebab-case identifier that is unique within the tenant catalog.
description	string	Optional description of what this category contains.
parent_category_id	uuid	UUID of the parent ProductCategory. Null for root-level categories.
status	string	Whether this category is visible and usable in the catalog.

Docs

Product

ProductCategory