Create a metafield definition

post /api/metafield_definitions

Creates a MetafieldDefinition resource.

Declares a custom field. Give it a namespace and key (which together identify it), the ownerType it applies to, the type of data it holds, and optionally validations. Once created, you can set Metafield values for it on records of that owner type.

Request body

Property	Type	Required	Description
constraints	EmbeddedMetafieldDefinitionConstraintResource[]	-	The constraint rules scoping where this metafield definition applies (e.g. by category or channel).
Show constraints fields Property Type Required Description key "/api/metafield_definition_constraint_types/category" | "/api/metafield_definition_constraint_types/channel" | "/api/metafield_definition_constraint_types/category_channel" required The type of constraint rule values string[] required Array of constraint values. Format depends on the constraint type.
description	string | null	-
key	string	-
name	string	-
namespace	string	-
ownerType	"/api/metafield_owner_types/products" | "/api/metafield_owner_types/collections" | "/api/metafield_owner_types/variants" | "/api/metafield_owner_types/sale_offers" | "/api/metafield_owner_types/purchase_offers"	required
type	"/api/metafield_definition_types/single_line_text_field" | "/api/metafield_definition_types/multi_line_text_field" | "/api/metafield_definition_types/number_integer" | "/api/metafield_definition_types/number_decimal" | "/api/metafield_definition_types/json" | "/api/metafield_definition_types/list__single_line_text_field" | "/api/metafield_definition_types/list__number_integer" | "/api/metafield_definition_types/list__number_decimal" | "/api/metafield_definition_types/list__product_reference" | "/api/metafield_definition_types/list__media_reference" | "/api/metafield_definition_types/product_reference" | "/api/metafield_definition_types/media_reference" | "/api/metafield_definition_types/metaobject_reference" | "/api/metafield_definition_types/list__metaobject_reference"	required
validations	EmbeddedMetafieldDefinitionValidationResource[]	-	The validation rules applied to the values of metafields using this definition.
Show validations fields Property Type Required Description name "/api/metafield_definition_validation_types/min_length" | "/api/metafield_definition_validation_types/max_length" | "/api/metafield_definition_validation_types/min_value" | "/api/metafield_definition_validation_types/max_value" | "/api/metafield_definition_validation_types/max_precision" | "/api/metafield_definition_validation_types/json_schema" | "/api/metafield_definition_validation_types/media_type" | "/api/metafield_definition_validation_types/metaobject_definition" required The type of validation rule value string required The validation parameter value. Format depends on the validation type.

Response

201 - MetafieldDefinition resource created

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
constraints	EmbeddedMetafieldDefinitionConstraintResource[]	-	The constraint rules scoping where this metafield definition applies (e.g. by category or channel).
Show constraints fields Property Type Required Description key "/api/metafield_definition_constraint_types/category" | "/api/metafield_definition_constraint_types/channel" | "/api/metafield_definition_constraint_types/category_channel" required The type of constraint rule values string[] required Array of constraint values. Format depends on the constraint type.
createdAt	string	-	The date and time when the resource was created (ISO 8601 format).
description	string | null	-	The description of the metafield definition.
id	string	-	The resource's unique identifier (UUID).
key	string	-	The unique identifier for the metafield definition within its namespace.
metafieldsCount	integer	-	The count of the metafields that belong to the metafield definition.
name	string	-	The human-readable name of the metafield definition.
namespace	string	-	The container for a group of metafields that the metafield definition is associated with.
ownerType	"/api/metafield_owner_types/products" | "/api/metafield_owner_types/collections" | "/api/metafield_owner_types/variants" | "/api/metafield_owner_types/sale_offers" | "/api/metafield_owner_types/purchase_offers"	required	The resource type that the metafield definition is attached to.
type	"/api/metafield_definition_types/single_line_text_field" | "/api/metafield_definition_types/multi_line_text_field" | "/api/metafield_definition_types/number_integer" | "/api/metafield_definition_types/number_decimal" | "/api/metafield_definition_types/json" | "/api/metafield_definition_types/list__single_line_text_field" | "/api/metafield_definition_types/list__number_integer" | "/api/metafield_definition_types/list__number_decimal" | "/api/metafield_definition_types/list__product_reference" | "/api/metafield_definition_types/list__media_reference" | "/api/metafield_definition_types/product_reference" | "/api/metafield_definition_types/media_reference" | "/api/metafield_definition_types/metaobject_reference" | "/api/metafield_definition_types/list__metaobject_reference"	required	The type of data that each of the metafields that belong to the metafield definition will store.
updatedAt	string	-	The date and time when the resource was last modified (ISO 8601 format).
validations	EmbeddedMetafieldDefinitionValidationResource[]	-	The validation rules applied to the values of metafields using this definition.
Show validations fields Property Type Required Description name "/api/metafield_definition_validation_types/min_length" | "/api/metafield_definition_validation_types/max_length" | "/api/metafield_definition_validation_types/min_value" | "/api/metafield_definition_validation_types/max_value" | "/api/metafield_definition_validation_types/max_precision" | "/api/metafield_definition_validation_types/json_schema" | "/api/metafield_definition_validation_types/media_type" | "/api/metafield_definition_validation_types/metaobject_definition" required The type of validation rule value string required The validation parameter value. Format depends on the validation type.

Errors

400 - Invalid input

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
code	string	-	Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.
description	string | null	-
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
message	string	-	End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.
slug	string	-	Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.
status	integer | null	-
title	string | null	-	A short, human-readable summary of the problem. For a catalogued error it repeats the slug.
type	string	-	A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}.

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
detail	string	-
missingPermissions	string[]	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
status	integer	-
title	string	-
type	string	-

422 - An error occurred

Property	Type	Required	Description
@context	string | object	-
@id	string	required
@type	string	required
description	string	-
detail	string	-
instance	string | null	-
status	integer	-
title	string | null	-
type	string	-
violations	object[]	-
Show violations fields Property Type Required Description code string - The code of the violation hint string - An extra hint to understand the violation message string required The message associated with the violation parameters object - Dynamic placeholder values for the violation message template (substitute into the code catalogue message). payload object - The serialized payload of the violation propertyPath string required The property path of the violation slug string - Stable centralized error-code slug for this violation (see /api/error-codes).