katana_public_api_client.models.custom_field_definition

katana_public_api_client.models.custom_field_definition

Classes

CustomFieldDefinition

A partner-defined custom field that callers register once via POST /custom_field_definitions and then attach values for on a sales order (or sales order row) through that resource's custom_fields property, keyed by this definition's id (UUID).

Scope today: entity_type is limited to SalesOrder / SalesOrderRow (see CustomFieldEntityType). A factory may hold at most 50 definitions. field_type, entity_type, and source are immutable after creation; only label, description, and options may be updated.

Example:
    {'id': '0c8f1d6e-3c2a-4f5b-9d77-12ab34cd56ef', 'label': 'Channel', 'field_type': 'shortText', 'entity_type':
        'SalesOrder', 'source': 'your-integration', 'description': 'Customer-facing sales channel classification',
        'options': None, 'created_at': '2026-05-14T10:00:00Z', 'updated_at': '2026-05-14T10:00:00Z', 'deleted_at': None}