Create a custom field definition

Creates a new custom field definition for a given entity type. A factory may have at most 50 definitions.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

New custom field definition details

string
required
length ≤ 255

Human-readable label of the custom field.

string
enum
required

Type of value the field stores. Immutable after creation.

  • shortText — string
  • number — number
  • singleSelect — integer choice id (requires options.choices)
  • date — YYYY-MM-DD string
  • boolean — true / false
  • url — string
Allowed:
string
enum
required

Entity the custom field applies to. Immutable after creation.

  • SalesOrder / SalesOrderRow — the field lives on a sales order, or on one of its rows.
  • ProductVariant / MaterialVariant / ServiceVariant — the field lives on an item. In Katana these are the Products, Materials, and Services an item can be. Values are held per variant, not on the product / material / service itself: a ProductVariant definition is set and read on each of a product’s variants, and a product with one variant simply has one place to set it.
  • PurchaseOrder / PurchaseOrderRow / OutsourcedPurchaseOrder / OutsourcedPurchaseOrderRow — the field lives on a purchase order, standard or outsourced, or on one of its rows.
  • ManufacturingOrder — the field lives on a manufacturing order. A variant definition can also reach manufacturing orders through appearsOn.
  • ProductionOperation — the field lives on a production operation.
  • RecipeBom — the field lives on a BOM row. The same definitions are used on manufacturing order recipe rows and outsourced purchase order recipe rows.
  • Supplier — the field lives on a supplier.
  • Customer — the field lives on a customer.

Two groups each share a single pool of definitions, so a definition is accepted beyond the exact entity type it was created with:

  • The three variant entity types — a definition created with any one of them is accepted on any variant, whatever kind of item it belongs to.
  • Standard and outsourced purchase orders — PurchaseOrder and OutsourcedPurchaseOrder definitions are both accepted on any purchase order, and likewise PurchaseOrderRow / OutsourcedPurchaseOrderRow on any purchase order row.

Katana’s own UI still scopes each definition to the item type or kind of order it was created for, so pick the entity_type that matches where you want the field to appear.

The variant entity types, the four purchase order entity types, Customer, ManufacturingOrder, and ProductionOperation are behind feature flags — contact [email protected] to enable. ProductionOperation additionally requires the Advanced Manufacturing or Manufacturing Management add-on.

string
required
length ≤ 255

Caller-provided identifier of the integration that owns the field — for example your application slug. Used to namespace and audit field definitions.

string | null

Optional free-text description shown alongside the field in Katana.

options
object | null

Extra configuration for the definition. choices is only meaningful when field_type is singleSelect; appearsOn is only meaningful on a variant definition. Omit (or send null) when neither applies.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json