Get Metafield Details

GET 
/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

Responses

200

200

application/json

Schema

Schema

metafield object
idstring
Example: 374087540346466346
store_idinteger
Default value: 0
Example: 633130
created_atstring
Example: 2024-04-28T06:52:36Z
updated_atstring
Example: 2024-04-28T06:52:36Z
owner_resourcestring
Example: product
owner_idstring
Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
namespacestring
Example: shirt
keystring
Example: weight1
typestring
Example: weight
valueinteger
Default value: 0
Example: 10
descriptionstring
Example: weight
definition_idstring
Example: 374087760941687850

Example

{
  "metafield": {
    "id": "374087540346466346",
    "store_id": 633130,
    "created_at": "2024-04-28T06:52:36Z",
    "updated_at": "2024-04-28T06:52:36Z",
    "owner_resource": "product",
    "owner_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
    "namespace": "shirt",
    "key": "weight1",
    "type": "weight",
    "value": 10,
    "description": "weight",
    "definition_id": "374087760941687850"
  }
}

Result

{
  "metafield": {
    "id": "374087540346466346",
    "store_id": 633130,
    "created_at": "2024-04-28T06:52:36Z",
    "updated_at": "2024-04-28T06:52:36Z",
    "owner_resource": "product",
    "owner_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
    "namespace": "shirt",
    "key": "weight1",
    "type": "weight",
    "value": 10,
    "description": "weight",
    "definition_id": "374087760941687850"
  }
}

404

404

text/plain

No schema