Metafields - 友好速搭 -- 开发文档

友好速搭

开放 API
使用说明 获取授权 全部 API 特殊 API 开放功能

Metafields

Metafield

#Metafield Metafield 用于拓展数据对象,参考拓展字段的介绍。

Metafield 相关API

GET /metas获取店铺中所有的 MetafieldGET /metas/count获取店铺中 Metafield 总数GET /metas/#{id}获取店铺中指定 ID 的 MetafieldPOST /metas创建一个新的 MetafieldPUT /metas/#{id}修改指定 ID 的 Metafield 基本数据DELETE /metas/#{id}删除指定 ID 的 MetafieldPOST /metas/#{id}/fields给指定 ID 的 Metafield 设置字段GET /metas/#{id}/fields获取指定 ID 的 Metafield 所有字段DELETE /metas/#{id}/fields删除指定 ID 的 Metafield 字段

Metafield 属性

    • id
    •   { "id" : 2 }
      
      Number 类型,Metafield 的唯一整型标识。
    • name
    •   { "name" : "inventory" }
      
      String 类型,Metafield 的唯一字符串标识。
      仅支持小写字母、数字、中横和下划线,最多 200 个字符。
    • owner_id
    •   { "owner_id" : 0 }
      
      Number 类型,附属对象的整型标识。
    • owner_resource
    •   { "owner_resource" : "shop" }
      
      String 类型,附属对象的字符串标识。
    • fields
    •   { "fields" : {"key":"value"} }
      
      Object 类型,Metafield 的字段,Key-Value 结构对象。
    • description
    •   { "description" : "用途说明" }
      
      String 类型,Metafield 的说明,最多 2000 个字符。
    • created_at
    •   { "created_at" : "2015-03-12T15:35:12.242+08:00" }
      
      Datetime 类型,创建时间。
    • updated_at
    •   { "updated_at" : "2015-03-12T16:18:21.602+08:00" }
      
      Datetime 类型,上次更新时间。

GET /metas

获取店铺中所有的 Metafield

    • limit
    • 可选,返回结果条数
      默认 10,最大 50
    • page
    • 可选,显示的页码
      默认 1
    • since_id
    • 可选,返回大于指定 ID 的结果
    • name
    • 可选,获取名称的结果
    • fields
    • 可选,只返回指定的字段
      多个字段用,间隔
    • ids
    • ,拼接要显示的id范围
    • created_at_min
    • 缺省筛选创建时间在指定日期时间之后的Metafield(格式2014-09-01T01:00:01)
    • created_at_max
    • 缺省筛选创建时间在指定日期时间之前的Metafield(格式2014-09-01T01:00:01)
    • updated_at_min
    • 缺省筛选更新时间在指定日期时间之后的Metafield(格式2014-09-01T01:00:01)
    • updated_at_max
    • 缺省筛选更新时间在指定日期时间之前的Metafield(格式2014-09-01T01:00:01)
    • 获取店铺中的 Metafield 列表
    • GET /metas
    • {
      "metas": [
          {
              "created_at": "2015-03-14T01:56:38.718+08:00",
              "id": 5,
              "name": "inventory",
              "owner_id": 0,
              "fields": {},
              "owner_resource": "shop",
              "updated_at": "2015-03-15T21:09:49.467+08:00"
          }
      ]
      }
      
    • 获取大于指定 ID 的 Metafield 列表
    • GET /metas?since_id=5
    • {
      "metas": [
          {
              "created_at": "2015-03-16T15:40:23.139+08:00",
              "description": "test",
              "id": 6,
              "name": "Inventory",
              "owner_id": 0,
              "fields": {},
              "owner_resource": "shop",
              "updated_at": "2015-03-16T15:40:23.139+08:00"
          }
      ]
      }
      

GET /metas/count

获取店铺中 Metafield 总数

    • 获取店铺中的 Metafield 总数
    • GET /metas/count
    • {
      "count": 1
      }
      

GET /metas/#{id}

获取店铺中指定 ID 的 Metafield

    • 获取 ID 为 7 的 Metafield
    • GET /metas/7
    • {
      "meta": {
          "id": 7,
          "name": "extend",
          "description": "店铺积分拓展字段",
          "owner_id": 0,
          "fields": {},
          "owner_resource": "shop",
          "created_at": "2015-04-13T21:27:15.822+08:00",
          "updated_at": "2015-04-13T21:27:15.822+08:00"
      }
      }
      

POST /metas

创建一个新的 Metafield

    • 为店铺创建一个新的 Metafield
    • POST /metas
      {
          "meta" : 
          {
            "name":"shop_score",
            "owner_id":"0",
            "owner_resource":"shop",
            "fields": {
              "key1": "value1",
              "key2": "value2"
            },
            "description":"店铺积分拓展字段"  
          }
      }
      
    • {
      "meta": {
          "id": 8,
          "name": "shop_score",
          "description": "店铺积分拓展字段",
          "owner_id": 0,
          "owner_resource": "shop",
          "fields": {
              "key1": "value1",
              "key2": "value2"
          },
          "created_at": "2015-04-13T21:44:51.069+08:00",
          "updated_at": "2015-04-13T21:44:51.069+08:00"
      }
      }
      
    • 创建同名的 Metafield,会报错
    • POST /metas
      {
          "meta" : 
          {
            "name":"shop_score",
            "owner_id":"0",
            "owner_resource":"shop",
            "description":"店铺积分拓展字段"  
          }
      }
      
    • {
      "code": 422,
      "errors": [
          "名称:shop_score 已存在"
      ]
      }
      

PUT /metas/#{id}

修改指定 ID 的 Metafield 基本数据

    • 修改 ID 为 7 的 Metafield
    • put /metas/7
        {
          "meta" : 
          {
            "name":"extend_new",
            "owner_id":"0",
            "owner_resource":"shop",
            "fields": {
              "key1": "new value1",
              "key2": "new value2"
            },
            "description":"修改后的店铺积分拓展字段"  
          }
        }
      
    • {
      "meta": {
          "id": 7,
          "name": "extend_new",
          "description": "修改后的店铺积分拓展字段",
          "owner_id": 0,
          "fields": {
              "key1": "new value1",
              "key2": "new value2"
          },
          "owner_resource": "shop",
          "created_at": "2015-04-13T21:27:15.822+08:00",
          "updated_at": "2015-04-14T05:22:16.602+08:00"
      }
      }
      

DELETE /metas/#{id}

删除指定 ID 的 Metafield

    • 删除ID为7的 Metafield
    • delete /metas/7
    • {}
      

POST /metas/#{id}/fields

给指定 ID 的 Metafield 设置字段

    • 为 ID 为 8 的 Metafield 设置字段,当指定 Key 不存在时新增,存在时会更新 Value
    • post /metas/8/fields
        {
          "fields" : 
          {
            "key1":"value1",
            "key2":"value2"    
          }
        }
      
    • {
      "fields": {
          "key1": "value1",
          "key2": "value2"
      }
      }
      

GET /metas/#{id}/fields

获取指定 ID 的 Metafield 所有字段

    • 获取 ID 为 7 的 Metafield 中 Key-Value 结构数据
    • get /metas/7/fields
    • {
      "fields": {
          "key1": "value1",
          "key2": "value2"
      }
      }
      

DELETE /metas/#{id}/fields

删除指定 ID 的 Metafield 字段

    • 删除 ID 为 8 的 Metafield 中指定 Key 的字段
    • delete /metas/7
        {
          "fields" : ["key1"]
        }
      
    • {}
      
友好速搭与你一起,共赢未来
联系客服
电话咨询
服务热线
0755-83051027
获取报价
QQ咨询
微信咨询
微信二维码
在线咨询

在线获取方案和报价,专人快速响应

所选城市 *

您的称呼 *

联系电话 *

网站类型 *

请选择
展示官网 电商网站 微信商城 小程序 其他类型

您希望我们为您提供哪些服务?(可多选)

B2C商城 跨境解决方案 B2B2C平台电商 网站备案 自营电商培训
获取报价

提交成功

你好, XXX女士/先生 ,你的需求已提交成功,后续会有专门的客户经理与你电话联系。谢谢!