创建Metafield定义

POST https://{handle}.myshopline.com/admin/openapi/v20250601/metafield_definition.json

[]

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

[]

元字段定义创建

请求头

Content-Type required
[]
字段值固定为application/json; charset=utf-8
Authorization string required
[]
资源的访问令牌。请参考应用授权获取访问令牌，然后将获取到的访问令牌以 Bearer 格式传入
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

请求体

definitionobject required
[]
元字段定义
accessobject
[]
适用于属于元字段定义的每个元字段的访问设置。
admin string
[]
用于此定义下的元字段的管理员访问设置，支持：PRIVATE、MERCHANT_READ、MERCHANT_READ_WRITE
[]
Example: MERCHANT_READ
description string
[]
元字段定义的描述。
[]
Example: 这是商品保养指南元字段的描述说明
key string required
[]
元字段定义在其名称空间中的唯一标识符。长度必须为 3-30 个字符，并且仅支持包含字母数字、连字符和下划线字符。
[]
Example: product-guide
name string required
[]
定义可读的元字段名称。
[]
Example: 商品保养指南
namespace string required
[]
元字段定义将关联的一组元字段的容器。长度必须为 2-50 个字符，并且仅支持包含字母数字、连字符和下划线字符。

如果需要设置app权限，则命名空间格式为： $app:{app-name}

如果不加$app:{app-name}，则为普通元字段定义，即使输入access, 这个access也不生效

[]
Example: $app:testapp
owner_resource string required
[]
元字段定义附加到的资源对象类型：products、customers、orders、pages、variants、collections articles、blogs、draft_orders、smart_collections locations、images、shop
[]
Example: products
type string required
[]
属于元字段定义的每个元字段将存储的数据类型。请参阅支持的类型列表。
[]
Example: multi_line_text_field

响应

[]

更多状态码信息请参考 HTTP 状态码

响应头

traceId
[]
traceId

响应体

definitionobject
[]
元字段定义
accessobject
[]
适用于属于元字段定义的每个元字段的访问设置。
admin string
[]
用于此定义下的元字段的管理员访问设置，支持：PRIVATE、MERCHANT_READ、MERCHANT_READ_WRITE
[]
Example: MERCHANT_READ
created_at string
[]
元字段定义的创建时间。
[]
Example: 2023-05-26T10:11:26+08:00
description string
[]
元字段定义的描述。
[]
Example: 这是商品保养指南元字段的描述说明
id string
[]
元字段定义ID。
[]
Example: 71213507083
key string
[]
元字段定义在其名称空间中的唯一标识符。长度必须为 3-30 个字符，并且仅支持包含字母数字、连字符和下划线字符。
[]
Example: product-guide
name string
[]
定义可读的元字段名称。
[]
Example: 商品保养指南
namespace string
[]
元字段定义将关联的一组元字段的容器。长度必须为 2-50 个字符，并且仅支持包含字母数字、连字符和下划线字符。

如果入参为$app:{app-name}，则输出会解析app id，格式为：{app}--{your-app-id}--{some-namespace}

如果入参不为$app:{app-name}，则输出为原命名空间

[]
Example: app--70303--riven 或 my_fields
owner_resource string
[]
元字段定义附加到的资源对象类型：orders、products、customers、collections、blogs、articles、pages、variants、shop
[]
Example: products
type string
[]
属于元字段定义的每个元字段将存储的数据类型。请参阅支持的类型列表。
[]
Example: multi_line_text_field
updated_at string
[]
元字段定义的最近更新时间。
[]
Example: 2023-05-26T10:11:26+08:00

API Explorer

调试台

示例代码

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "definition": {
    "access": {
      "admin": "MERCHANT_READ"
    },
    "description": "这是商品保养指南元字段的描述说明",
    "key": "product-guide",
    "name": "商品保养指南",
    "namespace": "$app:testapp",
    "owner_resource": "products",
    "type": "multi_line_text_field"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/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

条款协议