Metafield

object

Metafield information.

Fields

createdAt ● Date

The date and time when the metafield was created. Format: ISO 8601.

namespace ● String

The namespace of the metafield, used to group metafields. A metafield can be uniquely identified by its key and namespace.
Only letters, numbers, hyphens, and underscores are supported.
Minimum length: 2
Maximum length: 50

id ● ID

The ID of the metafiled.

type ● String

The data types available for the metafield feature. Valid values are:

single_line_text_field: A single-line text field
list.single_line_text_field: Multiple single-line text fields
multi_line_text_field: Multi-line text field
color: A single color
list.color: Multiple colors
date: A single date
list.date: Multiple dates
date_time: A single date and time. Format: ISO 8601.
list.date_time: Multiple dates and times. Format: ISO 8601.
url: A single URL
list.url: Multiple URLs
file_reference: A single file. Support a PDF or image file within 10 MB. Supported image formats: JPEG, PNG, and GIF.
list.file_reference: Multiple files. Support PDF or image files and each file must be within 10 MB. Supported image formats: JPEG, PNG, and GIF.
json: JSON
weight: A single weight with a unit
list.weight: Multiple weights with units
volume: A single volume with a unit
list.volume: Multiple volumes with units
dimension: A single size with a unit
list.dimension: Multiple sizes with units
number_integer: A single integer
list.number_integer: Multiple integers
number_decimal: A single decimal
list.number_decimal: Multiple decimals
rating: A single rating
list.rating: Multiple ratings
page_reference: A single page
list.page_reference: Multiple pages
product_reference: A single product
list.product_reference: Multiple products
variant_reference: A single product variant
list.variant_reference: Multiple product variants
collection_reference: A single product collection
list.collection_reference: Multiple product collections
customer_reference: A single customer
list.customer_reference: Multiple customers
order_reference: A single order
list.order_reference: Multiple orders
boolean: Boolean type, valid values are true and false.
money: Amount with a currency
For more information about metafields, refer to Guide to Using Metafields Feature.

value ● String

Data stored in the metafield.
Regardless of how you define the type of the metafield, SHOPLINE will store it in string format. The maximum length of the converted string is 500000.

key ● String

A unique identifier for a metafield definition within its namespace. Only letters, numbers, hyphens, and underscores are supported.
Minimum length: 3
Maximum length: 30

updatedAt ● Date

The date and time when the metafield was updated. Format: ISO 8601.

description ● String

Description of the metafield.

reference ● MetafieldReference

The resource referenced by the metafield.

references ● [MetafieldReference]

A list of resources referenced by the metafield.

Was this article helpful to you?

SHOPLINE

Legal