Metafield Properties

Metafield Properties

FieldTypeDesc
idstring
store_idintegerStore ID
definition_idstringMetafield Template ID
owner_resourcestringThe type of resource that the metafield is attached to. Available resources: shop, product, product_image, product_variant, order, page, customer, collection, blog, article.
owner_idstringThe unique ID of the resource that the metafield is attached to.
namespacestringA container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields with the same key name.
keystringThe key of the metafield.
typestringThe type of data that the metafield stores in the value field.
valuemixedThe data to store in the metafield.
descriptionstringA description of the information that the metafield contains.
created_atstringCreation time, formatted as ISO-8601
updated_atstringLast modification time, formatted as ISO-8601

MetaDefinition

FieldTypeDesc
idstring
keystringUnique Key
namestringField Name
namespacestringNamespace
owner_resourcestringResource Type
typestringField Type
descriptionstringField Description
created_atstringCreation time, formatted as ISO-8601
updated_atstringLast modification time, formatted as ISO-8601

MetaDefinition type

Type Description Example value
Date A date in ISO 8601 format without a time zone indicator. Adding custom product expiration dates, order delivery dates
Date and time A date and time in ISO 8601 format without a timezone indicator Adding an event date, and product release dates.
Weight A set of values and units of weight indicating unit weight. Valid weight values are: integers and fractional values followed by metric and imperial system. Adding weight measurements to product or ingredient, such as grams of sugar. For example:
{
  "value": 2.5,
  "unit": "kg"
}
Volume A set of values and units of volume indicating unit volume. Valid weight values are: integers and fractional values followed by metric and imperial system. Adding sizes of water bottles. For example:
{
  "value": 250,
  "unit": "ml"
}
Dimensions A set of values and units of length and height. Valid weight values are: integers and fractional values followed by metric and imperial system. Adding dimensions of a box. For example:
{
  "value": 25.0,
  "unit": "cm"
}
Integers A whole number in the range of +/-4,611,686,018,427,387,903 Adding whole numbers. For example: 11
Decimal numbers A number with decimal places in the range of +/-9999999999999.999999999. Adding decimal numbers. For example: 11.5
File reference A file of reference to your Shoplazza storefront Add photos and video descriptions of products.
multi/single line text field A multi/single line text field with line breaks Adding a list of ingredients with multiple lines of text. For example:
Water
Egg
Sugar
JSON A JSON object representing information. Example Value:
{
  "name": "John Doe",
  "age": 30,
  "isStudent": false,
  "hobbies": ["reading", "hiking", "cooking"]
}
Color An RGB color codes indicating the displaying color To display black, set all color parameters to 0, like this: rgb(0, 0, 0). To display white, set all color parameters to 255, like this: rgb(255, 255, 255).
Rating A rating measured on a specified scale. Create a rating system for your products. For example:
{
  "value": "3.5",
  "scale_min": "1.0",
  "scale_max": "5.0"
}
URL A valid URL in HTTPS format Adding a link to your content. For example: https://www.shoplazza.com
Boolean value A True or False statement Adding specifications to products. For example: If a condition is applicable, type in true.

Owner resource

Resource
product
product_variant
collection
shop
order
page
customer
blog
article