查询元字段定义

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

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

通过元字段定义 ID 查询指定资源类型（如商品、订单）下的元字段定义。

查询参数

id string required

元字段定义 ID。

例子: 71351007083

请求头

Content-Type string required

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

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

Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

状态码

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

响应头

traceId

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

响应体

definitionobject

元字段定义。
accessobject

元字段定义的权限信息。
admin string

元字段定义的访问权限。有效枚举值包含：

MERCHANT_READ_WRITE：商家可读写

MERCHANT_READ：商家只读

PUBLIC_READ：公开可读

PRIVATE：仅限当前应用访问

NONE：未明确设置权限
created_at string

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

元字段定义的描述信息。
id long

元字段定义 ID。
key string

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

元字段定义的名称。
namespace string

元字段定义的命名空间。
owner_resource string

元字段定义所归属的资源类型。有效枚举值包含：

products：商品

variants：商品款式

collections：商品分类

customers：客户

orders：订单

pages：页面

blogs：博客集合

articles：博客

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。

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

id — query required

Authorization — header required

Language

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

这篇文章对你有帮助吗？

SHOPLINE

条款协议