Metafield Definition List

GET 
/openapi/2022-01/metafield_definition/:owner_resource

Retrieve a list of all metafield definitions.

Request

Path Parameters

owner_resource stringrequired

Owner resource type of meta field definition, for example: product_variant | product | collection

Responses

200

200

application/json

Schema

Schema

definitions object[]
Array [
idstring
Example: 374034306256875562
keystring
Example: key2
namestring
Example: Big
namespacestring
Example: test
owner_resourcestring
Example: product
typestring
Example: boolean
descriptionstring
Example: boolean
create_atstring
Example: 2024-04-28T03:18:59Z
updated_atstring
Example: 2024-04-28T03:18:59Z
]
totalinteger
Default value: 0
Example: 3

Example

{
  "definitions": [
    {
      "id": "374034306256875562",
      "key": "key2",
      "name": "Big",
      "namespace": "test",
      "owner_resource": "product",
      "type": "boolean",
      "description": "boolean",
      "create_at": "2024-04-28T03:18:59Z",
      "updated_at": "2024-04-28T03:18:59Z"
    }
  ],
  "total": 3
}

Result

{
  "definitions": [
    {
      "id": "374034306256875562",
      "key": "key2",
      "name": "Big",
      "namespace": "test",
      "owner_resource": "product",
      "type": "boolean",
      "description": "boolean",
      "create_at": "2024-04-28T03:18:59Z",
      "updated_at": "2024-04-28T03:18:59Z"
    },
    {
      "id": "374032579801653802",
      "key": "key1",
      "name": "Big",
      "namespace": "test",
      "owner_resource": "product",
      "type": "boolean",
      "description": "boolean",
      "create_at": "2024-04-28T03:13:49Z",
      "updated_at": "2024-04-28T03:13:49Z"
    },
    {
      "id": "373310224787861546",
      "key": "config",
      "name": "config",
      "namespace": "custom",
      "owner_resource": "product",
      "type": "date",
      "description": "desc",
      "create_at": "2024-04-26T05:33:18Z",
      "updated_at": "2024-04-26T05:33:18Z"
    }
  ],
  "total": 3
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "invalid own resources"
  ]
}

Result

{
  "errors": [
    "invalid own resources"
  ]
}