Skip to main content
Version: 202201

Update Metafield

PATCH 

/openapi/2022-01/:resource/:resource_id/metafields/:id

Request

Path Parameters

    resource stringrequired

    The type of resource that the metafield is attached to. Available resources: shop, product, product_image, product_variant, order, page, customer, collection, blog, article.

    resource_id stringrequired

    The unique ID of the resource that the metafield is attached to.

    id stringrequired

    Metafield's ID

Body

    valuestringrequired

    The data to store in the metafield.

    typestringrequired

    The type of data that the metafield stores in the value field.

    descriptionstring

    A description of the information that the metafield contains.

Responses

200

Schema
    metafield object
    idstring
    Example: 374050809094090794
    store_idinteger
    Default value: 0
    Example: 633130
    created_atstring
    Example: 2024-04-28T06:50:19Z
    updated_atstring
    Example: 2024-04-28T09:33:12.018134337Z
    owner_resourcestring
    Example: product
    owner_idstring
    Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
    namespacestring
    Example: shirt
    keystring
    Example: weight
    typestring
    Example: weight
    valuestring
    Example: 30
    descriptionstring
    Example:
    definition_idstring
    Example: 0