AttrItem
通用属性
Type 的枚举值
text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型
具体组合如下
- Type: "text" 文本类型, 对应值 Value: "文本字符串"
- Type: "longtext" 长文本类型, 对应值 Value: "长文本字符串, 支持换行\n"
- Type: "banner" 单图片类型, 对应图片地址 Value: "https://sample.cdn.com/xxx.jpg"
- Type: "image" 多图片类型, 对应图片地址 Values: ["https://sample.cdn.com/1.jpg", "https://sample.cdn.com/2.jpg"]
- Type: "video" 视频类型, 对应视频地址 Value: "https://sample.cdn.com/xxx.mp4"
- Type: "mp" 小程序类型, 对应配置 Values: ["WXAPPID", "WXAPP_PATH", "跳转说明"]
被如下接口引用:DescribeCodeBatchById, DescribeCodeBatches, DescribeCodeBatchs。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 字段名称 示例值:商品名称2 |
Value | String | 是 | 字段值 示例值:demo |
Type | String | 是 | 字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型 示例值:text |
ReadOnly | Boolean | 是 | 只读 示例值:false |
Hidden | Boolean | 是 | 扫码展示 示例值:false |
Values | Array of String | 是 | 多个值 |
Key | String | 是 | 类型标识 示例值:ID |
Ext | String | 是 | 扩展字段 |
Chain
上链数据
被如下接口引用:CreateChainBatch。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Code | String | 是 | 码url 注意:此字段可能返回 null,表示取不到有效值。 |
Data | Array of ChainValue | 是 | 上链数据 注意:此字段可能返回 null,表示取不到有效值。 |
ChainData
上链数据
被如下接口引用:DescribeTraceDataById, DescribeTraceDataList, ModifyTraceData。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
BlockHash | String | 否 | 区块hash 注意:此字段可能返回 null,表示取不到有效值。 示例值:0xfc7f37ba117bb01afd237c6949f7d6a0b0d4a4c785b3fb90cd9004e0335a9d |
BlockHeight | String | 否 | 区块高度 注意:此字段可能返回 null,表示取不到有效值。 示例值:28102 |
BlockTime | String | 否 | 区块时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021 |
ChainValue
上链数据 key-value
被如下接口引用:CreateChainBatch。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Label | String | 是 | 标题名字 注意:此字段可能返回 null,表示取不到有效值。 示例值:图片 |
Type | String | 是 | 类型,文字:"text",图片:"image" 注意:此字段可能返回 null,表示取不到有效值。 示例值:image |
Value | String | 是 | 值,文字类型:"abc",图片类型:""/images/img.png" 注意:此字段可能返回 null,表示取不到有效值。 示例值:/images/img.png |
CodeBatch
批次
被如下接口引用:DescribeCodeBatchById, DescribeCodeBatches, DescribeCodeBatchs。
名称 | 类型 | 描述 |
---|---|---|
BatchId | String | 批次号 注意:此字段可能返回 null,表示取不到有效值。 示例值:20121212000001 |
CorpId | Integer | 企业ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
BatchCode | String | 批次编码(未使用) 注意:此字段可能返回 null,表示取不到有效值。 示例值:20121212000001 |
CodeCnt | Integer | 码数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
MerchantId | String | 所属商户ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:eqdmnz7020bmtvi9 |
ProductId | String | 产品ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:85tfp1sn78r9m1568i |
BatchType | Integer | 批次类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Remark | String | 备注 注意:此字段可能返回 null,表示取不到有效值。 示例值:备注 |
MpTpl | String | 微信模板 注意:此字段可能返回 null,表示取不到有效值。 示例值:微信模板 |
Status | Integer | 批次状态 0: 未激活 1: 已激活 -1: 已冻结 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-12-01T06:48:45.000Z |
UpdateTime | String | 修改时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-12-01T06:48:45.000Z |
MerchantName | String | 所属商户名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:所属商户名称 |
ProductName | String | 产品名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:产品名称 |
TplName | String | 模板名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:模板名称 |
Job | Job | 调度任务 注意:此字段可能返回 null,表示取不到有效值。 |
ProductionDate | String | 生产日期 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-05-12 |
ValidDate | String | 有效期 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022 |
Attrs | Array of AttrItem | 扩展属性 |
CodeItem
码类型
被如下接口引用:CreateTraceCodes, DescribeCodesByPack。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Code | String | 否 | 无 示例值:https://anxin.mtest.qq.com/qr/eqdmnz7020bmtvi9_02135114982303292 |
CodePack
码包类型
被如下接口引用:DescribeCodePacks。
名称 | 类型 | 描述 |
---|---|---|
PackId | String | 码id 注意:此字段可能返回 null,表示取不到有效值。 示例值:aba |
CorpId | Integer | 企业id 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
MerchantId | String | 商户id 注意:此字段可能返回 null,表示取不到有效值。 示例值:aba |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-12-06T07:13:35.000Z |
UpdateTime | String | 更新时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-12-06T07:13:35.000Z |
Status | String | 制码状态 init: 初始化, pending: 执行中, done: 完成, error: 失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:aba |
Log | String | 执行日志 注意:此字段可能返回 null,表示取不到有效值。 示例值:[time] xx |
CreateUser | String | 创建人 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Amount | Integer | 码数 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CodeLength | Integer | 防伪码长度 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CodeType | String | 码类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:aba |
Cipher | Integer | 是否暗码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
TextUrl | String | [弃用] 文字码地址,通过另一个接口查 注意:此字段可能返回 null,表示取不到有效值。 示例值:aba |
PackUrl | String | [弃用] 二维码地址,通过另一个接口查 注意:此字段可能返回 null,表示取不到有效值。 示例值:aba |
MerchantName | String | 商户名 注意:此字段可能返回 null,表示取不到有效值。 示例值:aba |
RuleType | Integer | 码规则类型 0: 默认, 1: 自定义 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
CustomId | String | 自定义码规则ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
PackType | Integer | 码包类型 0: 普通码包 1: 层级码包 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
PackLevel | Integer | 生码层级 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
PackSpec | Array of PackSpec | 层级码配置 注意:此字段可能返回 null,表示取不到有效值。 示例值: 无 |
ProductName | String | 商品名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProductSpecification | String | 商品规格 注意:此字段可能返回 null,表示取不到有效值。 |
ProductId | String | 商品ID 注意:此字段可能返回 null,表示取不到有效值。 |
RelateType | Integer | 码关系是否预关联 0:否, 1:是 示例值:1 |
SceneCode | Integer | 场景码 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
CodeRule | String | 码规则 注意:此字段可能返回 null,表示取不到有效值。 |
UsedAmount | Integer | 已使用码数 注意:此字段可能返回 null,表示取不到有效值。 |
SerialStart | Integer | 开始流水号 注意:此字段可能返回 null,表示取不到有效值。 |
SerialEnd | Integer | 结束流水号 注意:此字段可能返回 null,表示取不到有效值。 |
CodePart
码段配置
被如下接口引用:CreateCodePack, CreateCustomPack, CreateCustomRule, DescribeCustomRuleById, DescribeCustomRules, DescribeTraceCodeById, DescribeTraceCodes, ModifyCustomRule。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 码段名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:码段 |
Type | String | 是 | 码段类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Value | String | 是 | 码段内容 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
Length | Integer | 是 | 码段长度 示例值:10 |
Ext | String | 是 | 扩展字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:str |
CorpQuota
渠道商的子企业额度使用情况
被如下接口引用:DescribeCorpQuotas。
名称 | 类型 | 描述 |
---|---|---|
CorpId | Integer | 企业ID 示例值:10000 |
CorpName | String | 企业名称 示例值:渠道商企业 |
Quota | Quota | 额度 示例值:{} |
UsageQuota | UsageQuota | 额度使用量 示例值:{} |
CustomRule
码规则
被如下接口引用:DescribeCustomRuleById, DescribeCustomRules。
名称 | 类型 | 描述 |
---|---|---|
CustomId | String | 码规则ID 示例值:xxxid |
Name | String | 码规则名 注意:此字段可能返回 null,表示取不到有效值。 示例值:规则名 |
CorpId | Integer | 企业ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:10000 |
MerchantId | String | 商户ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:MerchantId |
CodeLength | Integer | 码ID长度 示例值:10 |
Status | Integer | 规则状态 示例值:0 |
CodeParts | Array of CodePart | 码段配置 示例值:[] |
CreateTime | String | 创建时间 示例值:2022-09-19T11:46:53.000Z |
UpdateTime | String | 更新时间 示例值:2022-09-19T11:46:53.000Z |
Ext
预留字段
被如下接口引用:CreateProduct, DescribeProductById, DescribeProducts, ModifyProduct。
名称 | 类型 | 必选 | 描述 |
---|
InputEncryptData
业务加密入参
被如下接口引用:AuthorizedTransfer, EffectFeedback, ReportBatchCallbackStatus。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
EncryptMethod | Integer | 是 | 加密方式,0:AES加密; 示例值:1 |
EncryptMode | Integer | 是 | 加密算法中的块处理模式,1:CBC模式; 目前只支持CBC模式 示例值:1 |
PaddingType | Integer | 是 | 填充模式,0:ZeroPadding;1:PKCS5Padding;2: PKCS7Padding。 示例值:1 |
EncryptData | String | 是 | 加密数据,将AuthorizedData结构体数组(数组最大长度不超过20)序列化成JSON字符串,对得到的字符串加密并填充到该字段。 示例值:abc |
IsAuthorized | Integer | 否 | 用户是否授权,本接口取值:1,已授权。 示例值:1 |
Job
通用调度任务
被如下接口引用:DescribeCodeBatchById, DescribeCodeBatches, DescribeCodeBatchs。
名称 | 类型 | 描述 |
---|---|---|
JobId | Integer | 调度ID 示例值:1000 |
Status | String | 执行状态 init:初始化, pending: 执行中, done: 执行成功, error: 执行失败 示例值:init |
ErrorMessage | String | 任务错误信息 注意:此字段可能返回 null,表示取不到有效值。 |
Merchant
商户信息
被如下接口引用:DescribeMerchantById, DescribeMerchants。
名称 | 类型 | 描述 |
---|---|---|
MerchantId | String | 商户标识码 示例值:"eqdmnz7020bmtvi9" |
CorpId | Integer | 企业id 示例值:10000 |
Name | String | 商户名称 示例值:"demo" |
Remark | String | 备注 注意:此字段可能返回 null,表示取不到有效值。 示例值:"abcdd" |
CreateTime | String | 创建时间 示例值:"2021-11-30T08:19:40.000Z" |
UpdateTime | String | 更新时间 示例值:"2021-12-06T08:09:17.000Z" |
CodeRule | String | 商户码规则 示例值:"^https://anxin.mtest.qq.com/qr/eqdmnz7020bmtvi9_(.*)" |
CodeType | Integer | 码来源类型 0: 安心平台 1: 第三方码 示例值:0 |
CodeUrl | String | 第三方码域名前缀 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://anxin.m.qq.com |
OutputAuthorizedTransfer
业务出参
被如下接口引用:AuthorizedTransfer, EffectFeedback, ReportBatchCallbackStatus。
名称 | 类型 | 描述 |
---|---|---|
Code | Integer | 推送状态,0表示成功。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Message | String | 错误码。 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
Value | String | 错误信息描述。 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
PackSpec
层级码配置
被如下接口引用:CreateCodePack, CreateCustomPack, DescribeCodePacks, DescribeTraceCodeById, DescribeTraceCodes。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Level | Integer | 是 | 层级 示例值:1 |
Rate | Integer | 是 | 比例 示例值:1 |
Amount | Integer | 是 | 数量 示例值:1 |
CustomId | String | 否 | 码规则ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxxid |
CodeParts | Array of CodePart | 否 | 码段配置 注意:此字段可能返回 null,表示取不到有效值。 |
Unit | String | 否 | 包装单位 注意:此字段可能返回 null,表示取不到有效值。 |
SceneCode | Integer | 否 | 场景值 注意:此字段可能返回 null,表示取不到有效值。 |
PhaseData
环节数据
被如下接口引用:CreateTraceData, DescribeTraceDataById, DescribeTraceDataList, ModifyTraceData。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
HeadEnabled | Boolean | 否 | 启用头 注意:此字段可能返回 null,表示取不到有效值。 示例值:false |
HeadTitle | String | 否 | 标题 注意:此字段可能返回 null,表示取不到有效值。 示例值:标题 |
Key | String | 否 | 标识符 注意:此字段可能返回 null,表示取不到有效值。 示例值:product |
AppId | String | 否 | 小程序AppId 注意:此字段可能返回 null,表示取不到有效值。 示例值:AppId |
AppPath | String | 否 | 小程序AppPath 注意:此字段可能返回 null,表示取不到有效值。 示例值:AppPath |
AppName | String | 否 | 小程序名称AppName 注意:此字段可能返回 null,表示取不到有效值。 示例值:AppName |
PlanQRCode
安心计划二维码
被如下接口引用:DescribePlanQRCodes。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Url | String | 是 | 二维码 注意:此字段可能返回 null,表示取不到有效值。 |
Status | Integer | 是 | 状态,0:未激活 1:已激活 2:已冻结 注意:此字段可能返回 null,表示取不到有效值。 |
PlanQRCodeRecord
安心计划二维码扫码记录
被如下接口引用:DescribePlanQRCodeScanRecords。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Url | String | 是 | 二维码 注意:此字段可能返回 null,表示取不到有效值。 |
OpenId | String | 是 | OpenID 注意:此字段可能返回 null,表示取不到有效值。 |
ScanTime | String | 是 | 扫码时间 注意:此字段可能返回 null,表示取不到有效值。 |
Ip | String | 是 | IP 地址 注意:此字段可能返回 null,表示取不到有效值。 |
Country | String | 是 | 国家 注意:此字段可能返回 null,表示取不到有效值。 |
Province | String | 是 | 省份 注意:此字段可能返回 null,表示取不到有效值。 |
City | String | 是 | 城市 注意:此字段可能返回 null,表示取不到有效值。 |
Product
商品信息
被如下接口引用:DescribeProductById, DescribeProducts。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
MerchantId | String | 是 | 商户标识码 示例值:"85tfp1sn78r9m1568i" |
Name | String | 是 | 商品名称 示例值:"demo5" |
ProductId | String | 否 | 商品id 示例值:"eqdmnz7020bmtvi9" |
CorpId | Integer | 否 | 企业id 示例值:0 |
ProductCode | String | 否 | 商品编号 示例值:"85tfp1sn78r9m1568i" |
Specification | String | 否 | 商品规格 注意:此字段可能返回 null,表示取不到有效值。 示例值:”100ml“ |
Remark | String | 否 | 备注 注意:此字段可能返回 null,表示取不到有效值。 示例值:”“ |
Logo | Array of String | 否 | 商品图片 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 否 | 创建时间 示例值:"2021-11-30T09:00:33.000Z" |
UpdateTime | String | 否 | 修改时间 示例值:"2021-12-07T02:14:37.000Z" |
Ext | Ext | 否 | 预留字段 注意:此字段可能返回 null,表示取不到有效值。 |
MerchantName | String | 否 | 商户名称 示例值:"demo" |
CertState | Integer | 否 | 认证状态 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
Quota
企业配额信息
被如下接口引用:DescribeCorpQuotas。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
StartTime | String | 是 | 服务开始时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:021-05-11T16:00:00.000Z |
EndTime | String | 是 | 服务结束时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:021-05-11T16:00:00.000Z |
QuotaId | Integer | 否 | 配额ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
CorpId | Integer | 否 | 企业ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
Services | Array of String | 否 | 开通服务 注意:此字段可能返回 null,表示取不到有效值。 示例值:["track"] |
FactoryQuota | Integer | 否 | 商户配额 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
ItemQuota | Integer | 否 | 商品配额 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
TrackQuota | Integer | 否 | 溯源码配额 注意:此字段可能返回 null,表示取不到有效值。 示例值:10000 |
SaleQuota | Integer | 否 | 销售码配额 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
ChainQuota | Integer | 否 | 上链配额 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
RiskQuota | Integer | 否 | 风控配额 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
AigcTextQuota | Integer | 否 | AI文字数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
AigcImageQuota | Integer | 否 | AI图片数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
TrackType | Integer | 否 | 溯源类型 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
Version | String | 否 | 开通版本 lite:轻量版, basic:基础版, standard:标准版 注意:此字段可能返回 null,表示取不到有效值。 示例值:basic |
ProductCertify | Integer | 否 | 是否开启企业认证 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
RawScanLog
原始扫码日志
被如下接口引用:DescribeRawScanLogs。
名称 | 类型 | 描述 |
---|---|---|
LogId | Integer | 日志ID 示例值:1 |
Openid | String | 微信小程序openid 注意:此字段可能返回 null,表示取不到有效值。 |
CreateTime | String | 扫码时间 |
Code | String | 溯源码 |
CorpId | Integer | 企业ID 示例值:10000 |
MerchantId | String | 商户ID 注意:此字段可能返回 null,表示取不到有效值。 |
ProductId | String | 商品ID 注意:此字段可能返回 null,表示取不到有效值。 |
BatchId | String | 批次ID 注意:此字段可能返回 null,表示取不到有效值。 |
Province | String | 省份 注意:此字段可能返回 null,表示取不到有效值。 示例值:广东省 |
City | String | 地市 注意:此字段可能返回 null,表示取不到有效值。 示例值:广州市 |
District | String | 区/县 注意:此字段可能返回 null,表示取不到有效值。 示例值:天河区 |
ScanLog
扫码明细
被如下接口引用:DescribeScanLogs。
名称 | 类型 | 描述 |
---|---|---|
LogId | Integer | 行ID 示例值:1000 |
Openid | String | 微信openid 注意:此字段可能返回 null,表示取不到有效值。 示例值:abc |
Nickname | String | 微信昵称 注意:此字段可能返回 null,表示取不到有效值。 示例值:aba |
CreateTime | String | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-12-06T07:13:35.000Z |
Code | String | 码 注意:此字段可能返回 null,表示取不到有效值。 示例值:xxx |
CorpId | Integer | 企业ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:10000 |
MerchantId | String | 商户ID 注意:此字段可能返回 null,表示取不到有效值。 |
ProductId | String | 商品ID 注意:此字段可能返回 null,表示取不到有效值。 |
Ip | String | ip地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:127.0.0.1 |
Country | String | 国家 注意:此字段可能返回 null,表示取不到有效值。 |
Province | String | 省份 注意:此字段可能返回 null,表示取不到有效值。 示例值:广东省 |
City | String | 城市 注意:此字段可能返回 null,表示取不到有效值。 示例值:广州市 |
District | String | 县/区 注意:此字段可能返回 null,表示取不到有效值。 示例值:天河区 |
Unionid | String | 微信 unionid 注意:此字段可能返回 null,表示取不到有效值。 |
First | Integer | 首次扫码 0:否, 1:是 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
BatchId | String | 批次ID 注意:此字段可能返回 null,表示取不到有效值。 |
Type | Integer | 扫码类型 0:无效扫码 1: 小程序扫码 2: 商家扫码 示例值:0 |
MerchantName | String | 商户名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProductName | String | 产品名称 注意:此字段可能返回 null,表示取不到有效值。 |
ProductLogo | String | 产品Logo 注意:此字段可能返回 null,表示取不到有效值。 |
Status | Integer | 风险状态 0: 未知, 1:通过, 2:失败/风险, 3:存疑 示例值:0 |
Verify | Integer | 是否开启验证 0:否, 1:是 示例值:0 |
ScanStat
扫码统计
被如下接口引用:DescribeScanStats。
名称 | 类型 | 描述 |
---|---|---|
Code | String | 安心码 示例值:https://anxin.m.qq.com/qr/bmy7uus50t54 |
CorpId | Integer | 企业ID 示例值:10000 |
MerchantId | String | 商户ID |
ProductId | String | 产品ID |
BatchId | String | 批次ID |
Pv | Integer | 扫码次数 示例值:10 |
Uv | Integer | 扫码人数 示例值:1 |
CreateTime | String | 创建时间 |
UpdateTime | String | 更新时间 |
MerchantName | String | 商户名称 |
ProductName | String | 产品名称 |
TraceCode
溯源码
被如下接口引用:DescribeTraceCodeById, DescribeTraceCodes。
名称 | 类型 | 描述 |
---|---|---|
Code | String | 二维码 示例值:https://anxin.mtest.qq.com/qr/eqdmnz7020bmtvi9_00024381374200500 |
CorpId | Integer | 企业ID 示例值:1000 |
PackId | String | 码包ID 示例值:z1vt4ma2jpladh362o |
BatchId | String | 批次ID 示例值:xfetmgoiky2nms6nk8 |
MerchantId | String | 所属商户ID 示例值:eqdmnz7020bmtvi9 |
ProductId | String | 产品ID 示例值:85tfp1sn78r9m1568i |
Status | Integer | 码状态 0: 冻结 1: 激活 示例值:0 |
CreateTime | String | 创建时间 示例值:2021-12-01T09:04:50.000Z |
UpdateTime | String | 修改时间 示例值:2021-12-01T09:04:50.000Z |
MerchantName | String | 商户名称 示例值:商户名称 |
ProductName | String | 产品名称 示例值:产品名称 |
AgentId | Integer | 渠道商ID 示例值:100 |
Level | Integer | 码层级 0: 最小级, 1: 一级, 2: 二级 示例值:0 |
PackSpec | Array of PackSpec | 码层级详情 注意:此字段可能返回 null,表示取不到有效值。 |
SceneCode | Integer | 场景码 注意:此字段可能返回 null,表示取不到有效值。 |
SerialCode | Integer | 流水码 注意:此字段可能返回 null,表示取不到有效值。 |
TraceData
溯源数据
被如下接口引用:CreateTraceData, DescribeTraceDataById, DescribeTraceDataList, ModifyTraceData。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TraceId | String | 是 | 溯源ID 示例值:VyKxxkmi_myRD6ulG6HFo |
CorpId | Integer | 是 | 企业ID 示例值:10 |
Type | Integer | 是 | 码类型 0: 批次, 1: 码, 2: 生产任务 示例值:码类型 |
Code | String | 是 | 码值,跟码类型一一对应 注意:此字段可能返回 null,表示取不到有效值。 示例值:xfetmgoiky2nms6nk8 |
Rank | Integer | 是 | 排序,在Phase相同情况下,值越小排名靠前 示例值:1 |
Phase | Integer | 是 | 溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源 示例值:0 |
PhaseName | String | 是 | 溯源环节名称 示例值:环节名称 |
TraceTime | String | 是 | 溯源时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-12-03T02:58:48.000Z |
CreateTime | String | 是 | 创建时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-12-06T09:20:57.000Z |
ChainStatus | Integer | 是 | 上链状态 0: 未上链 1: 上链中 2: 已上链 -1: 异常 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
ChainTime | String | 是 | 上链时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-12-06T09:20:57.000Z |
ChainData | ChainData | 是 | 上链数据 注意:此字段可能返回 null,表示取不到有效值。 |
PhaseData | PhaseData | 是 | 溯源阶段配置 注意:此字段可能返回 null,表示取不到有效值。 |
Status | Integer | 是 | 溯源阶段状态 0: 无效, 1: 有效 示例值:1 |
TraceItems | Array of TraceItem | 否 | 无 |
TraceItem
溯源数据项 Type 的枚举值
text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型
具体组合如下
- Type: "text" 文本类型, 对应值 Value: "文本字符串"
- Type: "longtext" 长文本类型, 对应值 Value: "长文本字符串, 支持换行\n"
- Type: "banner" 单图片类型, 对应图片地址 Value: "https://sample.cdn.com/xxx.jpg"
- Type: "image" 多图片类型, 对应图片地址 Values: ["https://sample.cdn.com/1.jpg", "https://sample.cdn.com/2.jpg"]
- Type: "video" 视频类型, 对应视频地址 Value: "https://sample.cdn.com/xxx.mp4"
- Type: "mp" 小程序类型, 对应配置 Values: ["WXAPPID", "WXAPP_PATH", "跳转说明"]
被如下接口引用:CreateTraceData, DescribeTraceDataById, DescribeTraceDataList, ModifyTraceData。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 字段名称 示例值:商品名称2 |
Value | String | 是 | 字段值 示例值:demo |
Type | String | 是 | 字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型 示例值:text |
Values | Array of String | 是 | 多个值 |
ReadOnly | Boolean | 否 | 只读 示例值:false |
Hidden | Boolean | 否 | 扫码展示 示例值:false |
Key | String | 否 | 类型标识 示例值:ID |
Ext | String | 否 | 扩展字段 |
Attrs | Array of TraceItem | 否 | 额外属性 |
List | Array of TraceData | 否 | 子页面,只读 |
UsageQuota
付费信息使用量
被如下接口引用:DescribeCorpQuotas。
名称 | 类型 | 描述 |
---|---|---|
CorpId | Integer | 企业ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
FactoryCnt | Integer | 商户配额 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
ItemCnt | Integer | 商品数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
TrackCnt | Integer | 溯源码量 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
SaleCnt | Integer | 营销码额度 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
ChainCnt | Integer | 区块链上链次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
RiskCnt | Integer | 营销风控次数 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
UpdateTime | String | 时间 注意:此字段可能返回 null,表示取不到有效值。 示例值:2020-05-20 |