API version: unstable
API version: 2021-04 Release candidate
API version: 2021-01 Latest
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

Metafield object

Version unstable

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Version 2021-04 (Release candidate)

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Version 2021-01 (Latest)

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Version 2020-10

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Version 2020-07

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Version 2020-04

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Version 2020-01 (Unsupported)

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Version 2019-10 (Unsupported)

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Version 2019-07 (Unsupported)

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Version 2019-04 (Unsupported)

Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are composed of keys, values, and value types.

Fields

  • createdAt (DateTime!)

    The date and time when the metafield was created.

  • description (String)

    The description of a metafield.

  • id (ID!)

    Globally unique identifier.

  • key (String!)

    The key name for a metafield.

  • legacyResourceId (UnsignedInt64!)

    The ID of the corresponding resource in the REST Admin API.

  • namespace (String!)

    The namespace for a metafield.

  • ownerType (MetafieldOwnerType!)

    Owner type of a metafield visible to the Storefront API.

  • updatedAt (DateTime!)

    The date and time when the metafield was updated.

  • value (String!)

    The value of a metafield.

  • valueType (MetafieldValueType!)

    Represents the metafield value type.

Types that return Metafield

Mutations for Metafield

Implements

Samples