Retrieve a metafield definition type
get
/api/metafield_definition_types/{id} Retrieves a MetafieldDefinitionType resource.
Returns a single metafield definition type by id, including its allowedValidations.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | required | MetafieldDefinitionType identifier |
Response
200 - MetafieldDefinitionType resource
| Property | Type | Required | Description |
|---|---|---|---|
@context | object | - | |
@id | string | required | |
@type | string | required | |
id | string | - | The metafield definition type identifier (e.g. number_decimal). |
description | string | - | A human-readable description of the metafield definition type. |
example | string | null | - | An example value for a metafield of this type. |
allowedValidations | string[] | - | The validation types that can be applied to a metafield definition of this type. Submitting any other validation is rejected. Types that allow none return an empty array. |
| Property | Type | Required | Description |
|---|---|---|---|
id | string | - | The metafield definition type identifier (e.g. number_decimal). |
description | string | - | A human-readable description of the metafield definition type. |
example | string | null | - | An example value for a metafield of this type. |
allowedValidations | string[] | - | The validation types that can be applied to a metafield definition of this type. Submitting any other validation is rejected. Types that allow none return an empty array. |
Errors
404 - Not found
| Property | Type | Required | Description |
|---|---|---|---|
@context | object | - | |
@id | string | required | |
@type | string | required | |
title | string | null | - | A short, human-readable summary of the problem. |
detail | string | null | - | A human-readable explanation specific to this occurrence of the problem. |
status | integer | null | - | |
instance | string | null | - | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type | string | - | A URI reference that identifies the problem type |
description | string | null | - |
| Property | Type | Required | Description |
|---|---|---|---|
title | string | null | - | A short, human-readable summary of the problem. |
detail | string | null | - | A human-readable explanation specific to this occurrence of the problem. |
status | integer | null | - | |
instance | string | null | - | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type | string | - | A URI reference that identifies the problem type |