metafield-representation-object.md

Metafield representation object

{% hint style="info" %} This page is part of a series: see Metafields for an overview on how Mechanic's Liquid implementation thinks about metafields. {% endhint %}

Mechanic's metafield representation object mirrors Shopify's metafield Liquid object, in that it makes the metafield type and value easily available, in a usable form. It is not the same as Mechanic's metafield object, which contains the REST Admin API representation of a metafield.

{% hint style="warning" %} Metafield representation objects are only available for modern metafield types. They are not available for deprecated metafields (i.e. json_string, number, and string). {% endhint %}

What it contains

A metafield representation object always contains these three properties:

• type — the type of the metafield (see Shopify's reference list)
• value — the parsed, appropriately-typed value of the metafield
• metafield — the source metafield object, useful for retrieving the metafield ID

Resource references

For reference types that map to a REST API resource (e.g. page_reference, product_reference, and variant_reference), a metafield representation object also contains a property named after the resource in question.

For example, a product_reference metafield representation object contains a product property, which holds the associated product object. This means that the referenced product may be retrieved using resource.metafields.namespace.key.product.

How to access it

A metafield representation object can only be retrieved via metafield collection lookup: resource.metafields.namespace.key.