patch
https://{subdomain}.myshoplaza.com/openapi/2025-06/metafields///
Update an existing metafield
The Get Metafield API allows to update an existing metafield with new values while maintaining its association with the original resource.
This API is especially useful for:
- Modifying the value or description of an existing metafield.
- Changing the data type of a metafield while preserving its relationship with the owner resource.
- Updating metafield information that affects product displays, order processing or shop.
Request Parameters
Public Request Parameters
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
owner_resource | string | yes | The type of resource the metafield is attached to. Available values: shop, product, product_image, product_variant, order, page, customer, collection, blog, article | product |
owner_id | string | yes | The unique ID of the resource to which the metafield is attached | prod_12345 |
id | string | yes | The unique identifier for the metafield | meta_67890 |
Body Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
value | string | yes | Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values | {"color": "blue", "size": "XL"} |
type | string | yes | The type of the metafield. Valid values: date, date_time, weight, volume, dimension, integer, number_decimal, file_reference, single_line_text_field, json, multi_line_text_field, color, rating, url, boolean | json |
description | string | no | A brief description of the metafield's purpose or content | Product color and size information |
Response Explanation
Public Response Parameters
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | "Success" | Response status (e.g., "Success"). |
message | string | "Metafield created successfully" | Response message. |
data.metafield.id | string | "mf_001" | Unique ID of the created metafield. |
data.metafield.store_id | integer | 12345 | ID of the store that owns the metafield. |
data.metafield.owner_resource | string | "product" | Resource type that owns the metafield (e.g., "product"). |
data.metafield.owner_id | string | "prod_001" | ID of the owner resource. |
data.metafield.namespace | string | "global" | Namespace of the metafield. |
data.metafield.key | string | "color" | Key of the metafield. |
data.metafield.type | string | "string" | Type of the metafield ("json" or "string"). |
data.metafield.description | string | "Product primary color" | Description of the metafield. |
data.metafield.definition_id | string | "df_12345" | ID of the metafield definition (if applicable). |
data.metafield.created_at | string | "2023-10-25T14:30:00Z" | Timestamp when the metafield was created (ISO 8601 format). |
data.metafield.updated_at | string | "2023-10-25T14:30:00Z" | Timestamp when the metafield was last updated (ISO 8601 format). |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |