Skip to main content
POST
Create Catalog Public

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Organization-Id
string | null

Body

application/json

Request to create a new catalog

name
string
required

Catalog name

Required string length: 1 - 100
unique_id_field
string
required

Legacy compatibility field required by the public create request. Include the intended business key, such as sku, in schema and item data; this request field is not a separate runtime selector.

schema_definition
Schema Definition · object
required

Initial JSON Schema for the catalog (from preview), including properties and required

description
string | null

Optional catalog description

product_id_field
string | null

Field name to use as product identifier

auto_evolve_schema
boolean
default:true

Allow automatic schema evolution

strict_mode
boolean
default:false

Reject unknown fields

product_enabled
boolean
default:false

Whether this catalog supports product variants

validation_rules
Validation Rules · object | null

Catalog-level validation rules to copy or override

catalog_md
string | null

Markdown catalog context to copy or override

master_catalog_id
string | null

Explicit master catalog to inherit defaults from

use_master_catalog_defaults
boolean
default:true

Whether to inherit defaults from the org's default master catalog

Response

Successful Response

Response model for catalog information

id
string
required
organization_id
string
required
name
string
required
current_schema_version
string
required
unique_id_field
string
required
auto_evolve_schema
boolean
required
strict_mode
boolean
required
product_enabled
boolean
required
item_count
integer
required
created_by_user_id
string
required
created_at
string<date-time>
required
description
string | null
product_id_field
string | null
updated_at
string<date-time> | null
schema
CatalogSchemaResponse · object | null

Response model for catalog schema