Anchor to MetaobjectFieldDefinitionCreateInputMetaobject
MetaobjectFieldDefinitionCreateInput
input_object
The input fields for creating a metaobject field definition.
Anchor to FieldsFields
- Anchor to descriptiondescription•
An administrative description of the field.
- •String!non-null
The key of the new field definition. This can't be changed.
Must be 2-64 characters long and only contain alphanumeric, hyphen, and underscore characters.
- Anchor to namename•
A human-readable name for the field. This can be changed at any time.
- Anchor to requiredrequired•BooleanDefault:false
Whether metaobjects require a saved value for the field.
- Anchor to typetype•String!non-null
The metafield type applied to values of the field.
- Anchor to validationsvalidations•
Custom validations that apply to values assigned to the field.
- Anchor to visibleToStorefrontApivisible•
To Storefront Api Whether the field is visible to the storefront API. Defaults to the visibility of the parent metaobject definition.
Was this section helpful?
Anchor to Input objects using this inputInput objects using this input
- Anchor to MetaobjectDefinitionCreateInput.fieldDefinitionsMetaobject•
Definition Create Input.field Definitions INPUT OBJECT A set of field definitions to create on this metaobject definition.
- Anchor to MetaobjectFieldDefinitionOperationInput.createMetaobject•
Field Definition Operation Input.create INPUT OBJECT The input fields for creating a metaobject field definition.
Was this section helpful?