MetafieldDefinitionInput
The input fields required to create a metafield definition.
Anchor to FieldsFields
- Anchor to accessaccess•
The access settings that apply to each of the metafields that belong to the metafield definition.
- Anchor to capabilitiescapabilities•
The capabilities of the metafield definition.
- Anchor to constraintsconstraints•
The constraints that determine what resources a metafield definition applies to.
- Anchor to descriptiondescription•
The description for the metafield definition.
- •String!non-null
The unique identifier for the metafield definition within its namespace.
Must be 2-64 characters long and only contain alphanumeric, hyphen, and underscore characters.
- Anchor to namename•String!non-null
The human-readable name for the metafield definition.
- Anchor to namespacenamespace•
The container for a group of metafields that the metafield definition will be associated with. If omitted, the app-reserved namespace will be used.
Must be 3-255 characters long and only contain alphanumeric, hyphen, and underscore characters.
- Anchor to ownerTypeowner•
Type MetafieldOwner non-nullType! The resource type that the metafield definition is attached to.
- Anchor to typetype•String!non-null
The type of data that each of the metafields that belong to the metafield definition will store. Refer to the list of supported types.
- Anchor to validationsvalidations•
A list of validation options for the metafields that belong to the metafield definition. For example, for a metafield definition with the type
date, you can set a minimum date validation so that each of the metafields that belong to it can only store dates after the specified minimum.- Anchor to useAsCollectionConditionuse•
As Collection Condition Whether the metafield definition can be used as a collection condition. Deprecated in API version 2024-10. Use
capability instead.