元字段

元字段Metafield资源允许您将其他信息添加到其他Admin API资源。可以通过多种方式使用元字段，例如将摘要添加到博客文章中。您还可以使用元字段与其他Shopify应用共享信息。

可以具有元字段的资源

可以将元字段添加到以下资源：

资源类型 元字段的位置
文章 /admin/blogs/#{id}/articles/#{id}/metafields.json
博客 /admin/blogs/#{id}/metafields.json
CustomCollection和SmartCollection /admin/collections/#{id}/metafields.json
顾客 /admin/customers/#{id}/metafields.json
汇票草稿 /admin/draft_orders/#{id}/metafields.json
命令 /admin/orders/#{id}/metafields.json
页 /admin/pages/#{id}/metafields.json
产品 /admin/products/#{id}/metafields.json
产品变体 /admin/products/#{id}/variants/#{id}/metafields.json
产品图片 /admin/metafields.json?metafield[owner_id]=#{id}&metafield[owner_resource]=product_image
该端点将使您可以查看产品图像的元字段。要添加或更改产品图像元字段，请使用产品图像端点。
店铺 /admin/metafields.json

您可以使用Metafield做什么

Shopify API使您可以使用Metafield资源执行以下操作。这些常规操作的更详细的版本可能可用：

元字段属性

created_at 只读 plain "created_at": "2012-03-13T16:09:54-04:00" 创建元字段 的日期和时间（ISO 8601格式）。
Updated_at 只读 plain "updated_at": "2012-08-24T14:02:15-04:00" 最后一次更新元字段 的日期和时间（ISO 8601格式）。
描述 plain "description": null 对元字段包含的信息的描述。
ID 只读 plain "id": 915396206 元字段的唯一ID。
钥匙 必需的 plain "key": "warehouse" 元字段的名称。最小长度：3个字符。最大长度：30个字符。
命名空间 必需的 plain "namespace": "inventory" 一组元字段的容器。您需要为您的元字段定义一个自定义名称空间，以将其与其他应用程序使用的元字段区分开。最小长度：2个字符。最大长度：20个字符。
owner_id plain "owner_id": 690933842 元字段附加到的资源的唯一ID。
owner_resource plain "owner_resource": "product" 元字段附加到的资源的类型。
价值 必需的 plain "value": 25 要存储为元数据的信息。最大长度：当metafield名称空间等于tags和key等于时，为512个字符alt。
的最大长度value取决于value_type：
+ 如果value_type为string，则最大长度：5,000,000个字符。
+ 如果value_type为integer，则最大长度：100,000个字符。
+ 如果value_type为json_string，则最大长度：100,000个字符。
值类型 必需的 plain "value_type": "integer" 元字段的信息类型。有效值：string，integer，json_string。

终点

得到/admin/api/2021-01/metafields.json 检索属于资源的元字段的列表。注意：从2019-07版本开始，此端点通过使用响应标头中提供的链接来实现分页。发送<font style="background-color:#F4F6F8;">page</font>参数将返回错误。要了解更多信息，请参阅向分页的REST Admin API端点发出请求。
限制 结果数量
（默认值：50
最大：250
）
since_id 将结果限制为指定的ID之后
created_at_min 显示在日期之后创建的元字段（格式：2014-04-25T16：15：47-04：00）
created_at_max 显示在日期之前创建的元字段（格式：2014-04-25T16：15：47-04：00）
Updated_at_min 显示日期之后最后更新的元字段（格式：2014-04-25T16：15：47-04：00）
Updated_at_max 显示上次更新日期之前的元字段（格式：2014-04-25T16：15：47-04：00）
命名空间 显示具有给定名称空间的元字段
钥匙 显示具有给定键的元字段
值类型 + string：仅显示具有字符串值类型的元字段
+ 整数：仅显示具有整数值类型的元字段
领域 以逗号分隔的要包含在响应中的字段列表

检索属于Shop资源的元字段

GET /admin/api/2021-01/metafields.json

查看回应

在指定ID后面检索属于Shop资源的元字段

GET /admin/api/2021-01/metafields.json?since_id=721389482

查看回应

检索属于产品资源的元字段列表

GET /admin/api/2021-01/products/632910392/metafields.json

查看回应

得到/admin/api/2021-01/metafields.json?metafield[owner_id]=850703190&metafield[owner_resource]=product_image 检索属于产品映像资源的元字段的列表。

检索属于产品图像资源的元字段的列表

GET /admin/api/2021-01/metafields.json?metafield[owner_id]=850703190&metafield[owner_resource]=product_image

查看回应

得到/admin/api/2021-01/metafields/count.json 检索资源的元字段的计数。

检索属于Shop资源的元字段计数

GET /admin/api/2021-01/metafields/count.json

查看回应

检索属于产品资源的元字段计数

GET /admin/api/2021-01/products/632910392/metafields/count.json

查看回应

得到/admin/api/2021-01/metafields/{metafield_id}.json 通过资源ID检索资源中的单个元字段。
领域 仅显示某些字段，这些字段由逗号分隔的字段名称列表指定。

通过ID检索单个元字段

GET /admin/api/2021-01/metafields/721389482.json

查看回应

通过ID检索单个元字段

GET /admin/api/2021-01/products/632910392/metafields/845366454.json

查看回应

邮政/admin/api/2021-01/metafields.json 为资源创建一个新的元字段。

为Shop资源创建一个新的元字段

POST /admin/api/2021-01/metafields.json

{

“ metafield” ： {

  1. “ namespace” ：“库存”，
  3. “ key” ：“仓库”，
  5. “值” ：25，
  7. “ value_type” ：“整数”

}

}

查看回应

为产品资源创建一个新的元字段

POST /admin/api/2021-01/products/632910392/metafields.json

{

“ metafield” ： {

  1. “ namespace” ：“库存”，
  3. “ key” ：“仓库”，
  5. “值” ：25，
  7. “ value_type” ：“整数”

}

}

查看回应

创建没有键的元字段将失败并返回错误

POST /admin/api/2021-01/metafields.json

{

“ metafield” ： {

  1. “ key” ：null

}

}

查看回应

放/admin/api/2021-01/metafields/{metafield_id}.json 更新元字段。

更新元字段。现有元字段的名称空间和键不能更改。

PUT /admin/api/2021-01/metafields/721389482.json

{

“ metafield” ： {

  1. “ id” ：721389482，
  3. “ value” ：“新事物”，
  5. “ value_type” ：“字符串”

}

}

查看回应

更新元字段。现有元字段的名称空间和键不能更改。

PUT /admin/api/2021-01/products/632910392/metafields/845366454.json

{

“ metafield” ： {

  1. “ id” ：845366454，
  3. “ value” ：“ titre”，
  5. “ value_type” ：“字符串”

}

}

查看回应

删除/admin/api/2021-01/metafields/{metafield_id}.json 通过其ID删除元字段。

通过ID删除元字段

删除/admin/api/2021-01/metafields/721389482.json

查看回应

通过ID删除元字段

删除/admin/api/2021-01/products/632910392/metafields/845366454.json

查看回应