需要 read_metafileds 权限点。
更多权限点使用信息,请参考:
GET https://{handle}.myshopline.com/admin/openapi/v20250601/metafield_definitions.json
handle :店铺的唯一标识符,值为店铺域名的前缀。例如,域名为 open001.myshopline.com 的店铺,其 handleopen001
分页查询metafield定义
查询参数
  • access_admin string
    按acess权限过滤元字段定义。(默认包含MERCHANT_READ_WRITE、MERCHANT_READ、PUBLIC_READ、null、及该APP对应的PRIVATE的元字段定义。)
    Example: MERCHANT_READ
  • created_at_max string
    显示在日期之前创建的元字段定义 Example: 2021-04-25T16:16:47-04:00
    Example: 2021-04-25T16:16:47-04:00
  • created_at_min string
    显示在日期之后创建的元字段定义 Example: 2021-04-25T16:16:47-04:00
    Example: 2021-04-25T16:16:47-04:00
  • definition_state string
    定义状态:CREATED,ALL ,默认CREATED
    Example: CREATED
  • key string
    按秘钥过滤元字段定义 Example: key_123
    Example: key_123
  • limit integer
    查询数量限制,默认50,不能超过1000 Example: 10
    Example: 50
  • namespace string
    按命名空间过滤元字段定义 Example: n_123
    Example: n_123
  • owner_resource string required
    按特定所有者类型过滤元字段定义 Example: products、customers、orders、pages、variants、collections articles、blogs、draft_orders、smart_collections locations、images、shop
    Example: products
  • page_info string
    调用方不需要使用和关注此字段,由Shopline自动封装 Example: eyJzaW5jZUlkIjoiMTYwNTc4NTY3NjcxMTc3MDcyNTEwNjAyODIiLCJkaXJlY3Rpb24iOiJuZXh0Iiwic29ydFR5cGUiOiJjcmVh
  • since_id long
    将结果限制在指定 ID 之后 Example: 1
    Example: 1
  • type string
    按数据类型过滤元字段定义 Example: single_line_text_field
    Example: single_line_text_field
  • updated_at_max string
    显示在日期之前更新的元字段定义 Example: 2021-04-25T16:16:47-04:00
    Example: 2021-04-25T16:16:47-04:00
  • updated_at_min string
    显示在日期之后更新的元字段定义 Example: 2021-04-25T16:16:47-04:00
    Example: 2021-04-25T16:16:47-04:00
请求头
  • Content-Type required
    字段值固定为application/json; charset=utf-8
  • Authorization string required
    资源的访问令牌。请参考 应用授权 获取访问令牌,然后将获取到的访问令牌以 Bearer 格式传入
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
响应
更多状态码信息请参考 HTTP 状态码

响应头
  • link
    访问查询结果的下一页
  • traceId
    traceId
响应体
  • dataobject
    data
  • metafield_definitionsobject[]
    metafield定义分页列表
  • accessobject
    返回该元字段定义的权限。
  • admin string
    返回该元字段定义的权限。
    Example: MERCHANT_READ
  • created_at string
    返回该元字段定义的创建时间。
    Example: 2021-04-25T16:16:47-04:00
  • description string
    返回该元字段定义的描述。
    Example: A list of ingredients used to make the product.
  • id long
    返回该元字段定义的metafieldsDefinitions ID,全局唯一标识符
    Example: 33646782314
  • key string
    返回该元字段定义的秘钥。
    Example: key123
  • name string
    返回该元字段定义名称。
    Example: 副标题字段
  • namespace string
    返回该元字段定义的命名空间。
    Example: n_123
  • owner_resource string
    返回该元字段定义的所有者资源对象名称。
    Example: products
  • type string
    返回该元字段定义将存储的数据类型。
    Example: single_line_text_field
  • updated_at string
    返回该元字段定义的更新时间。
    Example: 2021-04-30T16:16:47-04:00
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

query required
header required
query
query
query
query
query
query
query
query
query
query
query
query

Language

curl --request GET \
--url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/metafield_definitions.json \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
--header 'Content-Type: application/json; charset=utf-8' \
--header 'accept: application/json'
这篇文章对你有帮助吗?

Error loading component.

Error loading component.