Get Metafield List

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

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.

Query Parameters

namespace string

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.

key string

The key of the metafield.

type string

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

limit string

Limit per page

since_id string

Show metafields created after the specified ID.

create_at_min string

Show metafields created after date, ISO-8601 format, for example: 2022-12-02T09:46:30Z

create_at_max string

Show metafields created before date, ISO-8601 format, for example: 2022-12-02T09:46:30Z

update_at_min string

Show metafields last updated after date, ISO-8601 format, for example: 2022-12-02T09:46:30Z

update_at_max string

Show metafields last updated before date, ISO-8601 format, for example: 2022-12-02T09:46:30Z

Responses

200

200

application/json

Schema

Schema

metafields object[]
Array [
idstring
Example: 374050809094090794
store_idinteger
Default value: 0
Example: 633130
created_atstring
Example: 2024-04-28T06:50:19Z
updated_atstring
Example: 2024-04-28T06:50:19Z
owner_resourcestring
Example: product
owner_idstring
Example: a1a88be0-a1d4-47e4-a2f2-ba6e131cf447
namespacestring
Example: shirt
keystring
Example: weight
typestring
Example: weight
valueinteger
Default value: 0
Example: 10
descriptionstring
Example: weight
definition_idstring
Example: 0
]
last_idstring
Example: 374087540346466346
totalinteger
Default value: 0
Example: 2
remaininteger
Default value: 0
Example: 0
pageinteger
Default value: 0
Example: 1
total_pageinteger
Default value: 0
Example: 1
have_nextboolean
Default value: true
Example: false

Example

{
  "metafields": [
    {
      "id": "374050809094090794",
      "store_id": 633130,
      "created_at": "2024-04-28T06:50:19Z",
      "updated_at": "2024-04-28T06:50:19Z",
      "owner_resource": "product",
      "owner_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
      "namespace": "shirt",
      "key": "weight",
      "type": "weight",
      "value": 10,
      "description": "weight",
      "definition_id": "0"
    }
  ],
  "last_id": "374087540346466346",
  "total": 2,
  "remain": 0,
  "page": 1,
  "total_page": 1,
  "have_next": false
}

Result

{
    "metafields": [
        {
            "id": "374050809094090794",
            "store_id": 633130,
            "created_at": "2024-04-28T06:50:19Z",
            "updated_at": "2024-04-28T06:50:19Z",
            "owner_resource": "product",
            "owner_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
            "namespace": "shirt",
            "key": "weight",
            "type": "weight",
            "value": 10,
            "description": "weight",
            "definition_id": "0"
        },
        {
            "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"
        }
    ],
    "last_id": "374087540346466346",
    "total": 2,
    "remain": 0,
    "page": 1,
    "total_page": 1,
    "have_next": false
}