Metafield Definition Detail

GET 
/openapi/2022-01/metafield_definition

Retrieve a metafield definition by its unique identifier.

Request

Query Parameters

id stringrequired

Metafield definition id

Responses

200

200

application/json

Schema

Schema

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

Example

{
  "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"
}

Result

{
  "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"
}

404

404

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Metafield definition namespace and key exist"
  ]
}

Result

{
  "errors": [
    "Metafield definition namespace and key exist"
  ]
}

422

422

application/json

Schema

Schema

errorsstring[]

Example

{
  "errors": [
    "Id is required"
  ]
}

Result

{
  "errors": [
    "Id is required"
  ]
}