关于元字段

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

元字段是 Genstore 平台的基础服务组件，提供灵活的业务元数据管理能力。通过元字段服务，业务系统可实现字段的动态扩展和数据值管理，确保业务模型的可扩展性。

核心功能

元字段定义管理：实现元字段的创建、更新、删除和查询，支持业务域的字段模型扩展。
元数据值管理：提供元数据的存取、更新和批量处理能力，确保业务数据的一致性。

使用场景

动态字段扩展：业务团队可通过元字段定义为已有模型增加新属性，实现业务模型的快速迭代。
灵活数据管理：运营团队可配置和管理各类业务标签与属性，提升业务数据的管理效率。

接口

POST /api/202412/metafields/{domainName}/{bizId}: 创建元字段数据值

PUT /api/202412/metafields/{domainName}/{bizId}: 更新元字段数据值

DELETE /api/202412/metafields/{domainName}/{bizId}: 删除元字段数据值

GET /api/202412/metafields/count/{domainName}/{bizId}: 获取元字段值数量

GET /api/202412/metafields/detail/{domainName}/{bizId}: 获取元字段值详情

GET /api/202412/metafields/{domainName}/{bizId}: 获取元字段值列表

元字段对象

元字段业务对象。

属性

metafieldobject

- 收起属性

definitionNamestring

元字段的名称。

descriptionstring

元字段的描述。

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识 code，不同命名空间下可以创建相同字段标识 code。

codestring

元字段的唯一标识，在同一个命名空间下唯一。

fieldTypestring

元字段的类型，不同类型的元字段存储的元数据格式不同。枚举值：
* SingleLineText - 单行文本；
* MultiLineText - 多行文本；
* Integer - 整数；
* Decimal - 小数；
* MonthDay - 月日；
* Date - 日期（支持采用 ISO 8601 格式且不包含时区的日期值）；
* DateTime - 日期和时间（支持采用 ISO 8601 格式的日期值和采用 UTC 时间的时间值）；
* Weight - 重量；
* Size - 尺寸；
* Volume - 体积；
* Product - 商品；
* Customer - 客户；
* SKU - 商品规格；
* Collection - 商品系列；
* Page - 页面；
* File - 文件；
* Color - 颜色；
* Money - 金额；
* Url - url；
* Boolean - True 或 False。

multiboolean

元字段是否支持多值列表，支持多值列表的元字段控件输入时允许用户输入多个项，元字段数据将以 JSON Array 格式存储。

schemaRuleobject

元字段的校验规则，可以限制元数据录入时的长度可输入范围等，为空时代表不校验。不同字段的校验规则不同，具体格式参考字段规则文档。

optionMapobject

元字段的扩展配置，用于存储业务方对字段定义的扩展信息，比如是否支持搜索。具体配置以 Map 格式存储。 Map 的 key 由业务方接入时确定。

元字段对象

bash

{
  "metafield": {
    "definitionName": "MyFieldName01",
    "code": "MyFieldCode1",
    "namespace": "AppleName",
    "description": "this is meta field description sample",
    "optionMap": "{"search":true}",
    "fieldType": "Weight",
    "multi": "false",
    "schemaRule": "{"min":{"value":2,"unit":"g"},"max":{"value":200,"unit":"kg"}}"
  }
}

`POST` 创建元字段数据值

批量创建业务元数据。

访问范围

需要以下任意访问权限: write_metafields

接口

POST /api/202412/metafields/{domainName}/{bizId}

请求参数

listarray

数据列表，可以一次批量设置多个元字段数据。

- 收起属性

codestring

元字段的唯一标识，在同一个命名空间下唯一。

valuestring

元数据的值。

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识 code，不同命名空间下可以创建相同字段标识 code。

响应数据

metafieldsobject

- 收起属性

listarray

数据列表，一次批量设置多个元字段数据。

+ 展开属性

POST /api/202412/metafields/{domainName}/{bizId}

bash

curl -X POST \ 
https://{shop}.genmystore.com/api/202412/metafields/{domainName}/{bizId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"list":[
		{
			"code":"MyFieldCode1",
			"namespace":"AppleName",
			"value":"{\"value\": 9,\"unit\": \"kg\"}"
		}
	]
}'

响应

json

HTTP/1.1 200 OK
{
  "metafields": {
    "list": [
      {
        "code": "MyFieldCode1",
        "namespace": "AppleName",
        "value": "{\"value\": 9,\"unit\": \"kg\"}"
      }
    ]
  }
}

`PUT` 更新元字段数据值

更新对象的单个元数据值。

访问范围

需要以下任意访问权限: write_metafields

接口

PUT /api/202412/metafields/{domainName}/{bizId}

请求参数

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识code，不同命名空间下可以创建相同字段标识code。

codestring

元字段的唯一标识，在同一个命名空间下唯一。

valuestring

元数据的值。

响应数据

metafieldsobject

- 收起属性

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识code，不同命名空间下可以创建相同字段标识code。

codestring

元字段的唯一标识，在同一个命名空间下唯一。

valuestring

元数据的值。

PUT /api/202412/metafields/{domainName}/{bizId}

bash

curl -X PUT \ 
https://{shop}.genmystore.com/api/202412/metafields/{domainName}/{bizId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \ 
-H "Content-Type: application/json" \ 
-d '{
	"code":"MyFieldKey01",
	"namespace":"AppleName",
	"value":"{\"value\": 9,\"unit\": \"kg\"}"
}'

响应

json

HTTP/1.1 200 OK
{
  "metafields": {
    "code": "MyFieldCode1",
    "namespace": "AppleName",
    "value": "{\"value\": 9,\"unit\": \"kg\"}"
  }
}

`DELETE` 删除元字段数据值

删除对象的元数据值。

访问范围

需要以下任意访问权限: write_metafields

接口

DELETE /api/202412/metafields/{domainName}/{bizId}

请求参数

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识code，不同命名空间下可以创建相同字段标识code。

codestring

元字段的唯一标识，在同一个命名空间下唯一。

valuestring

元数据的值。

响应数据

metafieldsobject

- 收起属性

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识code，不同命名空间下可以创建相同字段标识code。

codestring

元字段的唯一标识，在同一个命名空间下唯一。

valuestring

元数据的值。

DELETE /api/202412/metafields/{domainName}/{bizId}

bash

curl -X DELETE \ 
https://{shop}.genmystore.com/api/202412/metafields/{domainName}/{bizId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "metafields": {
    "code": "MyFieldCode1",
    "namespace": "AppleName",
    "value": "{\"value\": 9,\"unit\": \"kg\"}"
  }
}

`GET` 获取元字段值数量

获取对象的元数据值的数量。

访问范围

需要以下任意访问权限: read_metafields write_metafields

接口

GET /api/202412/metafields/count/{domainName}/{bizId}

请求参数

{}

响应数据

countnumber

对象的元数据数量。

GET /api/202412/metafields/count/{domainName}/{bizId}

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/metafields/count/{domainName}/{bizId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "count": "999"
}

`GET` 获取元字段值详情

获取对象的单个元数据值。

访问范围

需要以下任意访问权限: read_metafields write_metafields

接口

GET /api/202412/metafields/detail/{domainName}/{bizId}

请求参数

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识code，不同命名空间下可以创建相同字段标识code

codestring

元字段在命名空间下的唯一code

响应数据

metafieldobject

列表。

- 收起属性

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识code，不同命名空间下可以创建相同字段标识code

codestring

元字段在命名空间下的唯一code

descriptionstring

元字段的描述

valuestring

元数据内容

fieldTypestring

definitionNamestring

元字段的名称

bizIdstring

归属资源id

bizResourcestring

归属资源字段类型

GET /api/202412/metafields/detail/{domainName}/{bizId}

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/metafields/detail/{domainName}/{bizId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "metafield": {
    "code": "MyFieldKey01",
    "definitionName": "MyFieldShowName",
    "namespace": "ProductA01",
    "bizId": "102744460756584",
    "description": "This is my field description",
    "value": "hello",
    "fieldType": "SingleLineText",
    "bizResource": "SingleLineText/Integer/Weight/Customer"
  }
}

`GET` 获取元字段值列表

批量获取业务元数据值。

访问范围

需要以下任意访问权限: read_metafields write_metafields

接口

GET /api/202412/metafields/{domainName}/{bizId}

请求参数

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识 code，不同命名空间下可以创建相同字段标识 code。

codesstring

元字段在命名空间下的唯一 code，如果要查询多个则用英文逗号隔开。

fieldTypestring

limitnumber

查询数量限制，默认 50，不能超过 250。

pageTokenstring

加密后的请求参数，用于上一页、下一页，直接取该字段解析访问。

响应数据

metafieldsarray

元字段值列表。

- 收起属性

namespacestring

元字段的命名空间，业务可以根据命名空间隔离字段唯一标识 code，不同命名空间下可以创建相同字段标识 code。

codestring

元字段在命名空间下的唯一 code。

descriptionstring

元字段的描述。

valuestring

元数据的内容。

fieldTypestring

definitionNamestring

元字段的名称。

bizIdstring

资源归属的业务 id。

bizResourcestring

资源归属的元字段类型。

GET /api/202412/metafields/{domainName}/{bizId}

bash

curl -X GET \ 
https://{shop}.genmystore.com/api/202412/metafields/{domainName}/{bizId}" \ 
-H "X-Genstore-Access-Token: {access_token}" \

响应

json

HTTP/1.1 200 OK
{
  "metafields": [
    {
      "code": "MyFieldKey01",
      "definitionName": "MyFieldShowName",
      "namespace": "ProductA01",
      "bizId": "102744460756584",
      "description": "This is my field description",
      "value": "hello",
      "fieldType": "SingleLineText",
      "bizResource": "SingleLineText"
    }
  ]
}

关于元字段

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

核心功能

元字段定义管理：实现元字段的创建、更新、删除和查询，支持业务域的字段模型扩展。
元数据值管理：提供元数据的存取、更新和批量处理能力，确保业务数据的一致性。

使用场景

动态字段扩展：业务团队可通过元字段定义为已有模型增加新属性，实现业务模型的快速迭代。
灵活数据管理：运营团队可配置和管理各类业务标签与属性，提升业务数据的管理效率。

元字段对象

接口

GET /api/202412/metafields/{domainName}/{bizId}

产品

变体

系列

库存

类目

礼品卡

厂商

订单

履约

退货

客户

主题

店铺

市场

翻译

元字段

元字段定义

账户

交易

折扣

授权

消息订阅

关于 元字段 ​

元字段 对象 ​

属性 ​

POST 创建元字段数据值 ​

请求参数

响应数据

PUT 更新元字段数据值 ​

请求参数

响应数据

DELETE 删除元字段数据值 ​

请求参数

响应数据

GET 获取元字段值数量 ​

请求参数

响应数据

GET 获取元字段值详情 ​

请求参数

响应数据

GET 获取元字段值列表 ​

请求参数

响应数据

关于 元字段 ​

元字段 对象 ​

属性 ​

POST 创建元字段数据值 ​

PUT 更新元字段数据值 ​

DELETE 删除元字段数据值 ​

GET 获取元字段值数量 ​

GET 获取元字段值详情 ​

GET 获取元字段值列表 ​

关于元字段

元字段对象

属性

`POST` 创建元字段数据值

`PUT` 更新元字段数据值

`DELETE` 删除元字段数据值

`GET` 获取元字段值数量

`GET` 获取元字段值详情

`GET` 获取元字段值列表

关于元字段

元字段对象

属性

`POST` 创建元字段数据值

`PUT` 更新元字段数据值

`DELETE` 删除元字段数据值

`GET` 获取元字段值数量

`GET` 获取元字段值详情

`GET` 获取元字段值列表