Skip to main content
POST
Add Catalog Field 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

Path Parameters

catalog_id
string
required

Body

application/json

Request to add a field to catalog schema

field_name
string
required

Name of the field to add

field_type
string
required

Field type: string, number, boolean, array, object

description
string | null

Field description

required
boolean
default:false

Whether field is required

scope
string
default:variant

Field scope: variant, product, both. Accepted by the request model; the single-field public route does not apply scope metadata.

field_category
string
default:input

Field category: input or generated. Stored as workflow-tracking metadata when workflow_id is provided.

position
string
default:bottom

Where to add field: top or bottom

workflow_id
string | null

Workflow ID that's adding this field

validation_rules
Validation Rules · object | null

JSON Schema validation rules (pattern, enum, minLength, etc.)

unit
string | null

Unit of measurement (e.g., 'V', 'W', 'kg', 'm')

sample_values
string[] | null

Sample values to help understand expected formats

Response

Successful Response

Response for schema field operations

success
boolean
required
catalog_id
string
required
new_schema_version
string
required
previous_schema_version
string
required
message
string
required
fields_added
string[]
fields_updated
string[]
fields_removed
string[]