批量查询店铺元字段

GET https://{handle}.myshopline.com/admin/openapi/v20260301/metafields.json

handle ：店铺的唯一标识符，值为店铺域名的前缀。例如，域名为 open001.myshopline.com 的店铺，其 handle 是 open001 。

批量查询店铺元字段。

查询参数

created_at_min string

要查询元字段初始创建的日期和时间。在此日期和此日期之后创建的元字段定会被返回。格式：ISO 8601。

例子: 2024-04-25T16:15:47-04:00
key string

元字段在其 namespace 下的唯一标识符。仅支持字母、数字、连字符和下划线字符。
最小长度限制：3
最大长度限制：30

例子: key_123
namespace string

元字段的命名空间。通过 key 和 namespace 可以唯一确定元字段。仅支持字母、数字、连字符和下划线字符。
最小长度限制：2
最大长度限制：50

例子: namespace_123
updated_at_max string

要查询元字段的截止更新日期和时间。在此日期和此日期之前更新的元字段会被返回。格式：ISO 8601。

例子: 2024-04-25T16:16:47-04:00
updated_at_min string

要查询元字段的起始更新日期和时间。在此日期和此日期之后更新的元字段会被返回。格式：ISO 8601。

例子: 2024-04-25T16:15:47-04:00
created_at_max string

要查询元字段截止创建的日期和时间。在此日期和此日期之前创建的元字段会被返回。格式：ISO 8601。

例子: 2024-04-25T16:16:47-04:00
fields string

指明需要返回的字段，多个字段用 , 分隔。可指定的字段有：id，key，namespace，owner_id，created_at 和 updated_at。

例子: id,key
limit string

该查询中要返回的元字段的最大个数。
取值范围：1-250
默认值：50
page_info string

分页查询的唯一标识，用于定位特定页面。

该字段值需要在你已经查询完分页信息后，在该接口响应头中的 link 字段值中获取。例如，你获取到的 link 的值为 <https://{handle}.myshopline.com/admin/openapi/{version}/metafields.json?limit=1&page_info=eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9>; rel="next" ，那么 page_info 的值为 eyJzaW5jZUlkIjoiMTYwNTc1OTAxNTM4OTA4Mjk1MjExMTI3ODgiLCJkaXJlY3Rpb24iOiJuZXh0IiwibGltaXQiOjF9 。

关于更多如何使用分页信息，请参考分页机制。
since_id string

元字段 ID 的起始查询点。传入该值后，将返回元字段 ID 大于该值的记录。

例子: 1
type string
元字段支持的数据类型，有效枚举值包含：
- single_line_text_field：单个单行文本
- list.single_line_text_field：多个单行文本
- multi_line_text_field：多行文本
- color：单个颜色
- list.color：多个颜色
- date：单个日期
- list.date：多个日期
- date_time：单个日期和时间。格式：ISO 8601。
- list.date_time：多个日期和时间。格式：ISO 8601。
- url：单个 URL
- list.url：多个 URL
- file_reference：单个文件，支持 10M 以内的 PDF 和图片文件，图片支持 JPG、JPEG、PNG 和 GIF 格式。
- list.file_reference：多个文件，支持 10M 以内的 PDF 和图片文件，图片支持 JPG、JPEG、PNG 和 GIF 格式。
- json：JSON 类型
- weight：单个重量，带单位
- list.weight：多个重量，带单位
- volume：单个体积，带单位
- list.volume：多个体积，带单位
- dimension：单个尺寸，带单位
- list.dimension：多个尺寸，带单位
- number_integer：单个整数
- list.number_integer：多个整数
- number_decimal：单个小数
- list.number_decimal：多个小数
- rating：单个等级
- list.rating：多个等级
- page_reference：单个页面
- list.page_reference：多个页面
- product_reference：单个商品
- list.product_reference：多个商品
- variant_reference：单个商品变体
- list.variant_reference：多个商品变体
- collection_reference：单个商品分类
- list.collection_reference：多个商品分类
- customer_reference：单个客户
- list.customer_reference：多个客户
- order_reference：单个订单
- list.order_reference：多个订单
- boolean：布尔类型，有效值包括 true 和 false。
- money：资金，带币种单位
关于更多元字段信息，参考元字段功能使用指南。
例子: single_line_text_field

请求头

Content-Type string required

字段值固定为 application/json; charset=utf-8。
Authorization string required

资源的访问令牌。参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入。
例子:

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

状态码

更多状态码信息，参考 HTTP 状态码。

响应头

link

提供分页数据的 URL 链接。你可以获取该字段值中的 page_info 信息用于下一次分页请求中。

当你请求的页面存在上一页或下一页的时候，该字段会被返回。关于更多如何使用分页信息，请参考分页机制。
traceId

请求的全局唯一标识符。用于追踪请求在系统中的流转，以便于问题发生时进行定位和调试。

响应体

metafieldsobject[]

元字段列表。
created_at string

元字段创建的日期和时间。格式：ISO 8601。
description string

元字段的描述。
id long

元字段 ID。
key string

元字段定义在其 namespace 下的唯一标识符。
namespace string

元字段的命名空间。
owner_id string

元字段所归属的店铺 ID。
owner_resource string

元字段所归属的资源类型。有效值固定为 shop，代表店铺元字段。
type string

元字段支持的数据类型，有效枚举值包含：

single_line_text_field：单个单行文本

list.single_line_text_field：多个单行文本

multi_line_text_field：多行文本

color：单个颜色

list.color：多个颜色

date：单个日期

list.date：多个日期

date_time：单个日期和时间。格式：ISO 8601。

list.date_time：多个日期和时间。格式：ISO 8601。

url：单个 URL

list.url：多个 URL

file_reference：单个文件，支持 10M 以内的 PDF 和图片文件，图片支持 JPG、JPEG、PNG 和 GIF 格式。

list.file_reference：多个文件，支持 10M 以内的 PDF 和图片文件，图片支持 JPG、JPEG、PNG 和 GIF 格式。

json：JSON 类型

weight：单个重量，带单位

list.weight：多个重量，带单位

volume：单个体积，带单位

list.volume：多个体积，带单位

dimension：单个尺寸，带单位

list.dimension：多个尺寸，带单位

number_integer：单个整数

list.number_integer：多个整数

number_decimal：单个小数

list.number_decimal：多个小数

rating：单个等级

list.rating：多个等级

page_reference：单个页面

list.page_reference：多个页面

product_reference：单个商品

list.product_reference：多个商品

variant_reference：单个商品变体

list.variant_reference：多个商品变体

collection_reference：单个商品分类

list.collection_reference：多个商品分类

customer_reference：单个客户

list.customer_reference：多个客户

order_reference：单个订单

list.order_reference：多个订单

boolean：布尔类型，有效值包括 true 和 false。

money：资金，带币种单位

关于更多元字段信息，参考元字段功能使用指南。
updated_at string

元字段更新的日期和时间。格式：ISO 8601。
value object

存储在元字段中的数据。

API Explorer

调试台

示例代码

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

Authorization — header required

created_at_min — query

key — query

namespace — query

updated_at_max — query

updated_at_min — query

created_at_max — query

fields — query

limit — query

page_info — query

since_id — query

type — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/metafields.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Examples

批量查询店铺元字段

Response

{
  "metafields": [
    {
      "created_at": "2022-07-28T07:21:39+00:00",
      "description": "omnisend data id",
      "id": 232182358691,
      "key": "Omnisned_snippet",
      "namespace": "Omnisned_Code",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-07-28T07:21:49+00:00",
      "value": "62e238c246ae0adf7c70f96b"
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236568508691,
      "key": "enable",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "boolean",
      "updated_at": "2022-08-03T08:44:17+00:00",
      "value": true
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236568518691,
      "key": "inquiry_config",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T08:44:28+00:00",
      "value": "{\"hideBuy\":true,\"hidePrice\":true,\"openQuote\":false,\"suspendedEnable\":true,\"suspendedPage\":[\"Home\",\"ProductsDetail\",\"Products\",\"Page\"]}"
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236590778691,
      "key": "inquiry_form_list",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T08:44:28+00:00",
      "value": "[{\"id\":\"5522860666308532608\",\"title\":\"Contact us\",\"formName\":\"Default Form\",\"submitContent\":\"Submit\",\"content\":[{\"txt\":\"Name\",\"required\":true,\"textLimit\":255,\"id\":\"5522860666308532609\",\"type\":\"singleLine\",\"placeholder\":{\"txt\":\"Text here...\",\"required\":true,\"textLimit\":20}},{\"txt\":\"Email\",\"required\":true,\"textLimit\":255,\"id\":\"5522860666308532610\",\"type\":\"email\",\"placeholder\":{\"txt\":\"Text here...\",\"required\":true,\"textLimit\":20}},{\"txt\":\"Message\",\"required\":false,\"textLimit\":1024,\"id\":\"5522860666308532611\",\"type\":\"multiline\",\"placeholder\":{\"txt\":\"Text here...\",\"required\":true,\"textLimit\":20}},{\"txt\":\"Files\",\"required\":false,\"textLimit\":5120,\"id\":\"5522860666308532612\",\"type\":\"upload\",\"ext\":\"{\\\"fileNameLengthLimit\\\":255,\\\"suffix\\\":[\\\"pdf\\\",\\\"jpeg\\\",\\\"jpg\\\",\\\"png\\\",\\\"gif\\\"]}\"}],\"createTime\":1659516257206}]"
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236590788691,
      "key": "customer_form_components",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T08:44:40+00:00",
      "value": "{\"title\":\"Wholesale Registration\",\"submitContent\":\"Submit\",\"content\":[{\"id\":\"5522860667667487110\",\"type\":\"subtitle\",\"textContent\":\"Customer Information\"},{\"required\":true,\"textLimit\":255,\"id\":\"5522860667667487111\",\"type\":\"name\"},{\"required\":true,\"textLimit\":255,\"id\":\"5522860667684264328\",\"type\":\"email\"},{\"txt\":\"Company\",\"required\":false,\"placeholder\":\"Company name\",\"id\":\"5522860667684264329\",\"type\":\"singleLine\"},{\"txt\":\"Tax ID, ABN, or VAT Number\",\"required\":false,\"placeholder\":\"Tax ID, ABN, or VAT Number\",\"id\":\"5522860667684264330\",\"type\":\"singleLine\"},{\"required\":false,\"id\":\"5522860667684264331\",\"type\":\"phoneNumber\"},{\"txt\":\"Website\",\"required\":false,\"placeholder\":\"Website\",\"id\":\"5522860667684264332\",\"type\":\"singleLine\"},{\"txt\":\"Note\",\"required\":false,\"textLimit\":1024,\"placeholder\":\"Tell us a little about yourself so that we can verify your business identity.\",\"id\":\"5522860667684264333\",\"type\":\"multiline\"},{\"id\":\"5522860667684264334\",\"type\":\"subtitle\",\"textContent\":\"Shipping Address\"},{\"required\":false,\"id\":\"5522860667684264335\",\"type\":\"address\"}]}"
    },
    {
      "created_at": "2022-08-03T08:44:17+00:00",
      "id": 236594678691,
      "key": "inquiry_form_apply",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T08:44:39+00:00",
      "value": "{\"ProductsDetail\":{\"id\":\"5522860666308532608\"},\"Suspended\":{\"id\":\"5522860666308532608\"},\"InquiryCar\":{\"id\":\"5522860666308532608\"}}"
    },
    {
      "created_at": "2022-08-03T11:54:24+00:00",
      "id": 236734448691,
      "key": "5523052043743008876",
      "namespace": "b2b_moq_plan",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-03T12:01:37+00:00",
      "value": "{\"weight\":1,\"moq\":2,\"applyType\":2,\"batchBuy\":true,\"multipleBuy\":true}"
    },
    {
      "created_at": "2022-08-04T06:37:02+00:00",
      "id": 237442018691,
      "key": "5524182034371322163",
      "namespace": "b2b_step_price_plan",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-04T06:37:06+00:00",
      "value": "{\"type\":2,\"productRelationType\":2,\"weight\":1,\"rules\":[{\"quantity\":1,\"tiered\":2000}]}"
    },
    {
      "created_at": "2022-08-05T07:06:26+00:00",
      "description": "google-site-verification",
      "id": 237987768691,
      "key": "meta_name",
      "namespace": "seo_tool",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-05T07:06:27+00:00",
      "value": ""
    },
    {
      "created_at": "2022-08-05T07:06:27+00:00",
      "description": "Whether breadcrumbs are turned on",
      "id": 237995758691,
      "key": "bread_crumbs",
      "namespace": "seo_tool",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-08-05T07:06:27+00:00",
      "value": "0"
    },
    {
      "created_at": "2022-08-08T03:03:40+00:00",
      "id": 239514908691,
      "key": "member_switch_config_list",
      "namespace": "member",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "json",
      "updated_at": "2022-08-08T03:03:54+00:00",
      "value": "{\"switchConfigs\":[{\"storeId\":\"1656987608691\",\"type\":1,\"status\":1},{\"storeId\":\"1656987608691\",\"type\":2,\"status\":0},{\"storeId\":\"1656987608691\",\"type\":3,\"status\":1},{\"storeId\":\"1656987608691\",\"type\":4,\"status\":1},{\"storeId\":\"1656987608691\",\"type\":5,\"status\":0},{\"storeId\":\"1656987608691\",\"type\":100,\"status\":1}]}"
    },
    {
      "created_at": "2022-08-08T03:10:36+00:00",
      "id": 239565968691,
      "key": "member_step_benefit_list",
      "namespace": "member",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "json",
      "updated_at": "2022-08-08T03:12:18+00:00",
      "value": "{\"levelList\":[{\"levelCode\":\"MLC5529772421483860051\",\"levelName\":\"1级会员\",\"weight\":\"1\",\"icon\":\"LEVEL_1\",\"benefitName\":\"$1 off coupon\",\"levelPrivilege\":\"[{\\\"privilegeName\\\":\\\"特权1\\\"}]\",\"levelThreshold\":\"Spend $0\"},{\"levelCode\":\"MLC5529772756524865927\",\"levelName\":\"二级会员\",\"weight\":\"2\",\"icon\":\"LEVEL_2\",\"benefitName\":\"\",\"levelThreshold\":\"Spend $100\"}]}"
    },
    {
      "created_at": "2022-10-13T06:57:41+00:00",
      "id": 306011468691,
      "key": "attachment_enable",
      "namespace": "b2b",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "boolean",
      "updated_at": "2022-10-13T06:57:41+00:00",
      "value": true
    },
    {
      "created_at": "2022-12-28T09:29:35+00:00",
      "description": "update",
      "id": 397424508691,
      "key": "key_123",
      "namespace": "shopline",
      "owner_id": "1656987608691",
      "owner_resource": "shop",
      "type": "single_line_text_field",
      "updated_at": "2022-12-28T09:56:08+00:00",
      "value": "update_value"
    }
  ]
}

这篇文章对你有帮助吗？

SHOPLINE

条款协议