Skip to main content
Version: 202607

Create metafield

POST 
/openapi/2026-07/metafields/:owner_resource/:owner_id

Create a metafield for the specified resource.

Request​

Path Parameters

    owner_resource stringrequired

    Resource type the metafield is attached to:

    • shop: Shop
    • product: Product
    • product_image: Product image
    • product_variant: Product variant
    • order: Order
    • page: Custom page
    • customer: Customer
    • collection: Collection
    • blog: Blog
    • article: Article
    • app: App
    owner_id stringrequired

    The ID of the resource the metafield is attached to

Bodyrequired

    definition_idstringrequired

    The ID of the associated metafield definition

    namespacestringrequired

    A container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields with the same key name. For example, "global"

    keystringrequired

    The key of the metafield (unique within the namespace). For example, "color"

    valueGoogleProtobufValuerequired

    The value of the metafield; its data type is determined by the type field. For example, { "mediaContentType": "IMAGE", "image": { "path": "6181b00da510ae8cf04673695cecf4c8.jpg", "alt": "", "width": 750, "height": 750, "aspect_ratio": 1, "src": "https://cdn.shoplazza.com/6181b00da510ae8cf04673695cecf4c8.jpg", "size": 775566 } }

    typestringrequired

    Field type of the metafield:

    • date: Date
    • date_time: Date and time
    • weight: Weight
    • volume: Volume
    • dimension: Dimension
    • integer: Integer
    • number_decimal: Decimal
    • file_reference: File reference
    • single_line_text_field: Single-line text
    • multi_line_text_field: Multi-line text
    • json: JSON
    • color: Color
    • rating: Rating
    • url: URL
    • boolean: Boolean (true or false)
    descriptionstring

    A brief description of the metafield

Responses​

OK

Schema
    codestring

    error code

    messagestring

    error message

    data object
    metafield object

    The created metafield

    idstring

    The unique identifier for the metafield

    store_iduint32

    The ID of the store that owns the metafield

    owner_resourcestring

    Resource type the metafield is attached to:

    • shop: Shop
    • product: Product
    • product_image: Product image
    • product_variant: Product variant
    • order: Order
    • page: Custom page
    • customer: Customer
    • collection: Collection
    • blog: Blog
    • article: Article
    • app: App
    owner_idstring

    The ID of the resource the metafield is attached to. For example, the product ID

    namespacestring

    A container for a group of metafields. Grouping metafields within a namespace prevents your metafields from conflicting with other metafields with the same key name. For example, "global"

    keystring

    The key of the metafield (unique within the namespace). For example, "color"

    typestring

    Field type of the metafield:

    • date: Date
    • date_time: Date and time
    • weight: Weight
    • volume: Volume
    • dimension: Dimension
    • integer: Integer
    • number_decimal: Decimal
    • file_reference: File reference
    • single_line_text_field: Single-line text
    • multi_line_text_field: Multi-line text
    • json: JSON
    • color: Color
    • rating: Rating
    • url: URL
    • boolean: Boolean (true or false)
    • string: String
    valueGoogleProtobufValue

    The value of the metafield; its data type is determined by the type field. For example, "red"

    descriptionstring

    A brief description of the metafield. For example, "The color of the product"

    definition_iduint64

    The ID of the associated metafield definition. For example, "123456"

    created_atstring

    The time when the metafield was created, in ISO-8601 format

    updated_atstring

    The time when the metafield was last updated, in ISO-8601 format