查询元字段定义列表

GET 
/openapi/2025-06/metafield_definition/:owner_resource

获取所有元字段定义的列表。

请求

Path参数

owner_resource string必填
所属资源类型：
• shop: 店铺
• product: 商品
• product_image: 商品图片
• product_variant: 商品款式
• order: 订单
• page: 自定义页面
• customer: 顾客
• collection: 商品专辑
• blog: 博客
• article: 文章
• app: 应用

响应

200

OK

application/json

数据结构

数据结构

codestring

错误码

messagestring

错误信息

data object
definitions object[]
元字段定义列表
Array [
idstring
元字段定义 ID
keystring
元字段键名
namestring
元字段定义名称
namespacestring
命名空间
owner_resourcestring
所属资源类型：
• shop: 店铺
• product: 商品
• product_image: 商品图片
• product_variant: 商品款式
• order: 订单
• page: 自定义页面
• customer: 顾客
• collection: 商品专辑
• blog: 博客
• article: 文章
• app: 应用
typestring
元字段值类型：
• date: 日期
• date_time: 日期和时间
• weight: 重量
• volume: 体积
• dimension: 外形尺寸
• integer: 整数
• number_decimal: 小数
• file_reference: 文件引用
• single_line_text_field: 单行文本
• multi_line_text_field: 多行文本
• json: JSON
• color: 颜色
• rating: 评分
• url: URL
• boolean: 布尔值（true 或 false）
• string: 字符串
descriptionstring
元字段定义描述
create_atstring
创建时间（ISO-8601 格式）
updated_atstring
最后更新时间（ISO-8601 格式）
]

示例

{
  "code": "string",
  "message": "string",
  "data": {
    "definitions": [
      {
        "id": "string",
        "key": "string",
        "name": "string",
        "namespace": "string",
        "owner_resource": "string",
        "type": "string",
        "description": "string",
        "create_at": "string",
        "updated_at": "string"
      }
    ]
  }
}