Skip to content

katana_public_api_client.models.custom_field_definition

katana_public_api_client.models.custom_field_definition

Classes

CustomFieldDefinition

A custom field definition registered through POST /custom_field_definitions. Values are keyed by its UUID in the entity custom_fields property. See CustomFieldEntityType for supported entities and account feature requirements. A factory may hold at most 50 definitions. field_type, entity_type, and source are immutable; 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}