{ "name": "trp", "display_name": "T-Sec-安心平台(RP)", "description": "实现安心平台在业务过程中创建企业、查询付费状态、查询账号权限、二维码信息同步、二维码上链、查询商品溯源信息、数据上报等能力", "domain": "other", "api_version": "2021-05-15", "endpoint": "trp.tencentcloudapi.com", "actions": [ { "name": "AuthorizedTransfer", "description": "接收客户侧的用户已授权的号码。", "status": "online", "parameters": [ { "name": "BusinessSecurityData", "type": "object", "required": true, "description": "业务加密入参。", "example": "无", "children": [ { "name": "EncryptMethod", "type": "integer", "required": true, "description": "加密方式，0：AES加密；", "example": "1" }, { "name": "EncryptMode", "type": "integer", "required": true, "description": "加密算法中的块处理模式，1：CBC模式；目前只支持CBC模式", "example": "1" }, { "name": "PaddingType", "type": "integer", "required": true, "description": "填充模式，0：ZeroPadding；1：PKCS5Padding；2： PKCS7Padding。", "example": "1" }, { "name": "EncryptData", "type": "string", "required": true, "description": "加密数据，将AuthorizedData结构体数组（数组最大长度不超过20）序列化成JSON字符串，对得到的字符串加密并填充到该字段。", "example": "051pk8tyhgc9" }, { "name": "IsAuthorized", "type": "integer", "required": false, "description": "用户是否授权，本接口取值：1，已授权。", "example": "1" } ] } ], "required": [ "BusinessSecurityData" ] }, { "name": "CreateChainBatch", "description": "批量上链接口", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": true, "description": "企业ID", "example": "1000" }, { "name": "ChainList", "type": "array", "required": true, "description": "溯源ID", "example": "[]", "item_type": "object", "children": [ { "name": "Code", "type": "string", "required": true, "description": "码url", "example": "https://anxin.qq.com/q99j9ovp5c6sok7l5g" }, { "name": "Data", "type": "array", "required": true, "description": "上链数据", "example": "[{ Label: '商品名称', Type: 'text', Value: '安全中心' }];", "item_type": "object", "children": [ { "name": "Label", "type": "string", "required": true, "description": "标题名字", "example": "图片" }, { "name": "Type", "type": "string", "required": true, "description": "类型，文字：\"text\"，图片：\"image\"", "example": "image" }, { "name": "Value", "type": "string", "required": true, "description": "值，文字类型：\"abc\"，图片类型：\"\"/images/img.png\"", "example": "/images/img.png" } ] } ] } ], "required": [ "CorpId", "ChainList" ] }, { "name": "CreateCodeBatch", "description": "新增批次", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "MerchantId", "type": "string", "required": false, "description": "商户ID", "example": "eqdmnz7020bmtvi9" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品ID", "example": "tz6jpscwky41u23o9b" }, { "name": "BatchType", "type": "integer", "required": false, "description": "批次类型 0:溯源 1:营销", "example": "1" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID，留空时系统自动生成", "example": "uevdikb06zy5" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "MpTpl", "type": "string", "required": false, "description": "模板ID，或者活动ID", "example": "1" }, { "name": "CloneId", "type": "string", "required": false, "description": "克隆批次ID，同时会复制溯源信息", "example": "10000" }, { "name": "BatchCode", "type": "string", "required": false, "description": "批次编号，业务字段不判断唯一性", "example": "202210" }, { "name": "ValidDate", "type": "string", "required": false, "description": "有效期", "example": "2023-05-01" }, { "name": "ProductionDate", "type": "string", "required": false, "description": "生产日期", "example": "2022-05-01" } ], "required": [] }, { "name": "CreateCodePack", "description": "生成普通码包", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户ID", "example": "jjzrg8llvl4a" }, { "name": "CodeLength", "type": "integer", "required": true, "description": "码长度", "example": "18" }, { "name": "CodeType", "type": "string", "required": true, "description": "码类型 alphabet 字母, number 数字, mixin 混合", "example": "number" }, { "name": "Amount", "type": "integer", "required": false, "description": "生码数量普通码包时必填", "example": "10" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "PackType", "type": "integer", "required": false, "description": "码包类型 0: 普通码包 1: 层级码包", "example": "1" }, { "name": "PackLevel", "type": "integer", "required": false, "description": "码包层级", "example": "1" }, { "name": "PackSpec", "type": "array", "required": false, "description": "码包规格", "example": "无", "item_type": "object", "children": [ { "name": "Level", "type": "integer", "required": true, "description": "层级", "example": "1" }, { "name": "Rate", "type": "integer", "required": true, "description": "比例", "example": "1" }, { "name": "Amount", "type": "integer", "required": true, "description": "数量", "example": "1" }, { "name": "CustomId", "type": "string", "required": false, "description": "码规则ID", "example": "10001" }, { "name": "CodeParts", "type": "array", "required": false, "description": "码段配置", "example": "[{ Name: '名称', Type: '类型', Value: '具体的值', Length: 8, Ext: '' }];", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "码段名称", "example": "码段" }, { "name": "Type", "type": "string", "required": true, "description": "码段类型", "example": "0" }, { "name": "Value", "type": "string", "required": true, "description": "码段内容", "example": "20250219" }, { "name": "Length", "type": "integer", "required": true, "description": "码段长度", "example": "10" }, { "name": "Ext", "type": "string", "required": true, "description": "扩展字段", "example": "str" } ] }, { "name": "Unit", "type": "string", "required": false, "description": "包装单位", "example": "个" }, { "name": "SceneCode", "type": "integer", "required": false, "description": "场景值", "example": "1" } ] }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID，如果传了生码后会同时绑定批次，并激活码", "example": "id" }, { "name": "SerialType", "type": "integer", "required": false, "description": "是否有流水码 0:无 1:有", "example": "number" }, { "name": "ProductId", "type": "string", "required": false, "description": "关联产品ID", "example": "grodcygelxn7364rmm" }, { "name": "RelateType", "type": "integer", "required": false, "description": "层级码时是否提前生成关联关系，默认为 1", "example": "1" }, { "name": "SceneCode", "type": "integer", "required": false, "description": "场景值", "example": "1" } ], "required": [ "MerchantId", "CodeLength", "CodeType" ] }, { "name": "CreateCorporationOrder", "description": "以订单方式新建企业信息/配额信息", "status": "online", "parameters": [ { "name": "CorpName", "type": "string", "required": true, "description": "企业名称", "example": "安心" }, { "name": "Owner", "type": "string", "required": true, "description": "所有者ID", "example": "1000" }, { "name": "CodeQuota", "type": "integer", "required": true, "description": "溯源码额度", "example": "100000" }, { "name": "ExpireTime", "type": "string", "required": true, "description": "额度过期时间", "example": "2021-05-05 00:00:00" }, { "name": "Amount", "type": "integer", "required": true, "description": "金额", "example": "10000" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "ContactPerson", "type": "string", "required": false, "description": "联系人", "example": "张三" }, { "name": "ContactNumber", "type": "string", "required": false, "description": "联系电话", "example": "13912345678" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "张三创建企业" } ], "required": [ "CorpName", "Owner", "CodeQuota", "ExpireTime", "Amount" ] }, { "name": "CreateCustomPack", "description": "生成自定义码包", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户ID", "example": "jjzrg8llvl4a" }, { "name": "Amount", "type": "integer", "required": false, "description": "生码数量, 普通码包时必填", "example": "10" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "PackType", "type": "integer", "required": false, "description": "码包类型 0: 普通码包 1: 层级码包", "example": "1" }, { "name": "PackLevel", "type": "integer", "required": false, "description": "码包层级", "example": "1" }, { "name": "PackSpec", "type": "array", "required": false, "description": "层级码包规则", "example": "无", "item_type": "object", "children": [ { "name": "Level", "type": "integer", "required": true, "description": "层级", "example": "1" }, { "name": "Rate", "type": "integer", "required": true, "description": "比例", "example": "1" }, { "name": "Amount", "type": "integer", "required": true, "description": "数量", "example": "1" }, { "name": "CustomId", "type": "string", "required": false, "description": "码规则ID", "example": "10001" }, { "name": "CodeParts", "type": "array", "required": false, "description": "码段配置", "example": "[{ Name: '名称', Type: '类型', Value: '具体的值', Length: 8, Ext: '' }];", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "码段名称", "example": "码段" }, { "name": "Type", "type": "string", "required": true, "description": "码段类型", "example": "0" }, { "name": "Value", "type": "string", "required": true, "description": "码段内容", "example": "20250219" }, { "name": "Length", "type": "integer", "required": true, "description": "码段长度", "example": "10" }, { "name": "Ext", "type": "string", "required": true, "description": "扩展字段", "example": "str" } ] }, { "name": "Unit", "type": "string", "required": false, "description": "包装单位", "example": "个" }, { "name": "SceneCode", "type": "integer", "required": false, "description": "场景值", "example": "1" } ] }, { "name": "CustomId", "type": "string", "required": false, "description": "码规则ID, 和CodeParts二选一必填", "example": "customidx" }, { "name": "CodeParts", "type": "array", "required": false, "description": "码段配置，和CustomId二选一必填", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "码段名称", "example": "码段" }, { "name": "Type", "type": "string", "required": true, "description": "码段类型", "example": "0" }, { "name": "Value", "type": "string", "required": true, "description": "码段内容", "example": "20250219" }, { "name": "Length", "type": "integer", "required": true, "description": "码段长度", "example": "10" }, { "name": "Ext", "type": "string", "required": true, "description": "扩展字段", "example": "str" } ] }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID，如果传了生码后会同时绑定批次，并激活码", "example": "id" }, { "name": "SerialType", "type": "integer", "required": false, "description": "是否有流水码 0:无 1:有", "example": "number" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品ID", "example": "grodcygelxn7364rmm" }, { "name": "RelateType", "type": "integer", "required": false, "description": "是否预生成码关系 0: 否, 1:是默认为1，仅对层级码有效", "example": "1" }, { "name": "SceneCode", "type": "integer", "required": false, "description": "场景值", "example": "1" } ], "required": [ "MerchantId" ] }, { "name": "CreateCustomRule", "description": "新建自定义码规则", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "规则名称", "example": "规则名称" }, { "name": "MerchantId", "type": "string", "required": true, "description": "商户ID", "example": "MerchantId" }, { "name": "CodeLength", "type": "integer", "required": true, "description": "码长度", "example": "36" }, { "name": "CodeParts", "type": "array", "required": true, "description": "码段配置", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "码段名称", "example": "码段" }, { "name": "Type", "type": "string", "required": true, "description": "码段类型", "example": "0" }, { "name": "Value", "type": "string", "required": true, "description": "码段内容", "example": "20250219" }, { "name": "Length", "type": "integer", "required": true, "description": "码段长度", "example": "10" }, { "name": "Ext", "type": "string", "required": true, "description": "扩展字段", "example": "str" } ] }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [ "Name", "MerchantId", "CodeLength", "CodeParts" ] }, { "name": "CreateMerchant", "description": "新建商户", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "商户名称", "example": "商户名称" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "CodeType", "type": "integer", "required": false, "description": "码包来源 0:自建, 1:第三方", "example": "1" }, { "name": "CodeUrl", "type": "string", "required": false, "description": "码包前缀地址第三方码包时必填", "example": "https://anxin.m.qq.com" } ], "required": [ "Name" ] }, { "name": "CreateProduct", "description": "新建商品", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "商品名称", "example": "商品名称" }, { "name": "MerchantId", "type": "string", "required": true, "description": "商户ID", "example": "eqdmnz7020bmtvi9" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "MerchantName", "type": "string", "required": false, "description": "商户名称", "example": "商户名称" }, { "name": "Specification", "type": "string", "required": false, "description": "商品规格", "example": "100ml" }, { "name": "Logo", "type": "array", "required": false, "description": "商品图片", "example": "[\"http://cdn.com/1.png\"]", "item_type": "string" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "Ext", "type": "object", "required": false, "description": "预留字段", "example": "无" } ], "required": [ "Name", "MerchantId" ] }, { "name": "CreateTraceChain", "description": "上链溯源信息", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "TraceId", "type": "string", "required": false, "description": "溯源ID", "example": "9cz33jTOBIcKir4glzAS" } ], "required": [] }, { "name": "CreateTraceCodes", "description": "批量绑定指定批次并激活二维码，只支持平台发的码，且只会激活没有使用过的码", "status": "online", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "批次ID", "example": "07wa9ed1l4yl" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "Codes", "type": "array", "required": false, "description": "码", "example": "无", "item_type": "object", "children": [ { "name": "Code", "type": "string", "required": false, "description": "无", "example": "https://anxin.mtest.qq.com/qr/eqdmnz7020bmtvi9_02135114982303292" } ] }, { "name": "CodeType", "type": "integer", "required": false, "description": "码绑定激活策略，默认 0 0: 传什么码就激活什么码 1: 层级码 + 层级子码", "example": "0" }, { "name": "CheckType", "type": "integer", "required": false, "description": "错误检查类型，默认 0 0: 没有新导入码时正常返回 1: 没有新导入码时报错，并返回没有导入成功的原因", "example": "0" } ], "required": [ "BatchId" ] }, { "name": "CreateTraceCodesAsync", "description": "异步导入激活码包，如果是第三方码包，需要域名跟配置的匹配", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID", "example": "batchid" }, { "name": "FileKey", "type": "string", "required": false, "description": "上传文件Key，仅支持 csv 或者 zip 类型", "example": "anxin/filename.zip" } ], "required": [] }, { "name": "CreateTraceData", "description": "新增溯源信息", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID", "example": "07wa9ed1l4yl" }, { "name": "TaskId", "type": "string", "required": false, "description": "任务ID", "example": "1" }, { "name": "Phase", "type": "integer", "required": false, "description": "溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源", "example": "1" }, { "name": "PhaseName", "type": "string", "required": false, "description": "溯源阶段名称", "example": "名称" }, { "name": "ChainStatus", "type": "integer", "required": false, "description": "[无效] 上链状态", "example": "1" }, { "name": "Type", "type": "integer", "required": false, "description": "[无效] 码类型 0: 批次, 1: 码, 2: 生产任务, 3: 物流信息", "example": "1" }, { "name": "TraceId", "type": "string", "required": false, "description": "[无效] 溯源ID", "example": "9cz33jTOBIcKir4glzAS" }, { "name": "TraceItems", "type": "array", "required": false, "description": "溯源信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "商品名称2" }, { "name": "Value", "type": "string", "required": true, "description": "字段值", "example": "demo" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型", "example": "text" }, { "name": "Values", "type": "array", "required": true, "description": "多个值", "example": "url1,url2", "item_type": "string" }, { "name": "ReadOnly", "type": "boolean", "required": false, "description": "只读", "example": "false" }, { "name": "Hidden", "type": "boolean", "required": false, "description": "扫码展示", "example": "false" }, { "name": "Key", "type": "string", "required": false, "description": "类型标识", "example": "ID" }, { "name": "Ext", "type": "string", "required": false, "description": "扩展字段", "example": "custom" }, { "name": "Attrs", "type": "array", "required": false, "description": "额外属性", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "商品名称2" }, { "name": "Value", "type": "string", "required": true, "description": "字段值", "example": "demo" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型", "example": "text" }, { "name": "Values", "type": "array", "required": true, "description": "多个值", "example": "url1,url2", "item_type": "string" }, { "name": "ReadOnly", "type": "boolean", "required": false, "description": "只读", "example": "false" }, { "name": "Hidden", "type": "boolean", "required": false, "description": "扫码展示", "example": "false" }, { "name": "Key", "type": "string", "required": false, "description": "类型标识", "example": "ID" }, { "name": "Ext", "type": "string", "required": false, "description": "扩展字段", "example": "custom" }, { "name": "Attrs", "type": "array", "required": false, "description": "额外属性", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "商品名称2" }, { "name": "Value", "type": "string", "required": true, "description": "字段值", "example": "demo" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型", "example": "text" }, { "name": "Values", "type": "array", "required": true, "description": "多个值", "example": "url1,url2", "item_type": "string" }, { "name": "ReadOnly", "type": "boolean", "required": false, "description": "只读", "example": "false" }, { "name": "Hidden", "type": "boolean", "required": false, "description": "扫码展示", "example": "false" }, { "name": "Key", "type": "string", "required": false, "description": "类型标识", "example": "ID" }, { "name": "Ext", "type": "string", "required": false, "description": "扩展字段", "example": "custom" }, { "name": "Attrs", "type": "array", "required": false, "description": "额外属性", "example": "无", "item_type": "string" }, { "name": "List", "type": "array", "required": false, "description": "子页面，只读", "example": "无", "item_type": "string" } ] }, { "name": "List", "type": "array", "required": false, "description": "子页面，只读", "example": "无", "item_type": "object", "children": [ { "name": "TraceId", "type": "string", "required": true, "description": "溯源ID", "example": "VyKxxkmi_myRD6ulG6HFo" }, { "name": "CorpId", "type": "integer", "required": true, "description": "企业ID", "example": "10" }, { "name": "Type", "type": "integer", "required": true, "description": "码类型 0: 批次, 1: 码, 2: 生产任务", "example": "码类型" }, { "name": "Code", "type": "string", "required": true, "description": "码值，跟码类型一一对应", "example": "xfetmgoiky2nms6nk8" }, { "name": "Rank", "type": "integer", "required": true, "description": "排序，在Phase相同情况下，值越小排名靠前", "example": "1" }, { "name": "Phase", "type": "integer", "required": true, "description": "溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源", "example": "0" }, { "name": "PhaseName", "type": "string", "required": true, "description": "溯源环节名称", "example": "环节名称" }, { "name": "TraceTime", "type": "string", "required": true, "description": "溯源时间", "example": "2021-12-03T02:58:48.000Z" }, { "name": "CreateTime", "type": "string", "required": true, "description": "创建时间", "example": "2021-12-06T09:20:57.000Z" }, { "name": "ChainStatus", "type": "integer", "required": true, "description": "上链状态 0: 未上链 1: 上链中 2: 已上链 -1: 异常", "example": "2" }, { "name": "ChainTime", "type": "string", "required": true, "description": "上链时间", "example": "2021-12-06T09:20:57.000Z" }, { "name": "ChainData", "type": "object", "required": true, "description": "上链数据", "example": "无" }, { "name": "PhaseData", "type": "object", "required": true, "description": "溯源阶段配置", "example": "无" }, { "name": "Status", "type": "integer", "required": true, "description": "溯源阶段状态 0: 无效, 1: 有效", "example": "1" }, { "name": "TraceItems", "type": "array", "required": false, "description": "无", "example": "无", "item_type": "string" } ] } ] }, { "name": "List", "type": "array", "required": false, "description": "子页面，只读", "example": "无", "item_type": "object", "children": [ { "name": "TraceId", "type": "string", "required": true, "description": "溯源ID", "example": "VyKxxkmi_myRD6ulG6HFo" }, { "name": "CorpId", "type": "integer", "required": true, "description": "企业ID", "example": "10" }, { "name": "Type", "type": "integer", "required": true, "description": "码类型 0: 批次, 1: 码, 2: 生产任务", "example": "码类型" }, { "name": "Code", "type": "string", "required": true, "description": "码值，跟码类型一一对应", "example": "xfetmgoiky2nms6nk8" }, { "name": "Rank", "type": "integer", "required": true, "description": "排序，在Phase相同情况下，值越小排名靠前", "example": "1" }, { "name": "Phase", "type": "integer", "required": true, "description": "溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源", "example": "0" }, { "name": "PhaseName", "type": "string", "required": true, "description": "溯源环节名称", "example": "环节名称" }, { "name": "TraceTime", "type": "string", "required": true, "description": "溯源时间", "example": "2021-12-03T02:58:48.000Z" }, { "name": "CreateTime", "type": "string", "required": true, "description": "创建时间", "example": "2021-12-06T09:20:57.000Z" }, { "name": "ChainStatus", "type": "integer", "required": true, "description": "上链状态 0: 未上链 1: 上链中 2: 已上链 -1: 异常", "example": "2" }, { "name": "ChainTime", "type": "string", "required": true, "description": "上链时间", "example": "2021-12-06T09:20:57.000Z" }, { "name": "ChainData", "type": "object", "required": true, "description": "上链数据", "example": "无", "children": [ { "name": "BlockHash", "type": "string", "required": false, "description": "区块hash", "example": "0xfc7f37ba117bb01afd237c6949f7d6a0b0d4a4c785b3fb90cd9004e0335a9d" }, { "name": "BlockHeight", "type": "string", "required": false, "description": "区块高度", "example": "28102" }, { "name": "BlockTime", "type": "string", "required": false, "description": "区块时间", "example": "2021" } ] }, { "name": "PhaseData", "type": "object", "required": true, "description": "溯源阶段配置", "example": "无", "children": [ { "name": "HeadEnabled", "type": "boolean", "required": false, "description": "启用头", "example": "false" }, { "name": "HeadTitle", "type": "string", "required": false, "description": "标题", "example": "标题" }, { "name": "Key", "type": "string", "required": false, "description": "标识符", "example": "product" }, { "name": "AppId", "type": "string", "required": false, "description": "小程序AppId", "example": "AppId" }, { "name": "AppPath", "type": "string", "required": false, "description": "小程序AppPath", "example": "AppPath" }, { "name": "AppName", "type": "string", "required": false, "description": "小程序名称AppName", "example": "AppName" } ] }, { "name": "Status", "type": "integer", "required": true, "description": "溯源阶段状态 0: 无效, 1: 有效", "example": "1" }, { "name": "TraceItems", "type": "array", "required": false, "description": "无", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "商品名称2" }, { "name": "Value", "type": "string", "required": true, "description": "字段值", "example": "demo" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型", "example": "text" }, { "name": "Values", "type": "array", "required": true, "description": "多个值", "example": "url1,url2", "item_type": "string" }, { "name": "ReadOnly", "type": "boolean", "required": false, "description": "只读", "example": "false" }, { "name": "Hidden", "type": "boolean", "required": false, "description": "扫码展示", "example": "false" }, { "name": "Key", "type": "string", "required": false, "description": "类型标识", "example": "ID" }, { "name": "Ext", "type": "string", "required": false, "description": "扩展字段", "example": "custom" }, { "name": "Attrs", "type": "array", "required": false, "description": "额外属性", "example": "无", "item_type": "string" }, { "name": "List", "type": "array", "required": false, "description": "子页面，只读", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "Status", "type": "integer", "required": false, "description": "溯源状态 0: 无效, 1: 有效", "example": "1" }, { "name": "PhaseData", "type": "object", "required": false, "description": "环节数据", "example": "无", "children": [ { "name": "HeadEnabled", "type": "boolean", "required": false, "description": "启用头", "example": "false" }, { "name": "HeadTitle", "type": "string", "required": false, "description": "标题", "example": "标题" }, { "name": "Key", "type": "string", "required": false, "description": "标识符", "example": "product" }, { "name": "AppId", "type": "string", "required": false, "description": "小程序AppId", "example": "AppId" }, { "name": "AppPath", "type": "string", "required": false, "description": "小程序AppPath", "example": "AppPath" }, { "name": "AppName", "type": "string", "required": false, "description": "小程序名称AppName", "example": "AppName" } ] } ], "required": [] }, { "name": "DeleteCodeBatch", "description": "删除批次", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID", "example": "20121212000001" } ], "required": [] }, { "name": "DeleteMerchant", "description": "删除商户", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户标识码", "example": "awai9jd37ng3de7p3t" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [ "MerchantId" ] }, { "name": "DeleteProduct", "description": "删除商品，如果商品被使用，则不可删除", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "商品ID", "example": "u0wa46ggyvtgzoen6r" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [ "ProductId" ] }, { "name": "DeleteTraceData", "description": "删除溯源信息，如果已经上链则不可删除", "status": "online", "parameters": [ { "name": "TraceId", "type": "string", "required": true, "description": "溯源ID", "example": "u0wa46ggyvtgzoen6r" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "0" } ], "required": [ "TraceId" ] }, { "name": "DescribeAgentCorps", "description": "查询渠道企业列表", "status": "online", "parameters": [ { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量", "example": "7999" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数", "example": "7999" }, { "name": "AgentId", "type": "integer", "required": false, "description": "渠道ID", "example": "1" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [] }, { "name": "DescribeCodeBatchById", "description": "查询批次信息", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID", "example": "ccc" } ], "required": [] }, { "name": "DescribeCodeBatches", "description": "查询批次列表", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": false, "description": "查询商户ID", "example": "eqdmnz7020bmtvi9" }, { "name": "ProductId", "type": "string", "required": false, "description": "查询商品ID", "example": "tz6jpscwky41u23o9b" }, { "name": "Keyword", "type": "string", "required": false, "description": "查询关键字", "example": "关键字" }, { "name": "PageSize", "type": "integer", "required": false, "description": "条数", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数", "example": "1" }, { "name": "BatchType", "type": "string", "required": false, "description": "批次类型 0:溯源 1:营销", "example": "0" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "Status", "type": "integer", "required": false, "description": "批次状态 0: 未激活 1: 已激活 -1: 已冻结", "example": "1" } ], "required": [] }, { "name": "DescribeCodeBatchs", "description": "查询批次列表旧版接口已经弃用，新业务请使用新版的接口 DescribeCodeBatches", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": false, "description": "查询商户ID", "example": "商户ID" }, { "name": "ProductId", "type": "string", "required": false, "description": "查询商品ID", "example": "商品ID" }, { "name": "Keyword", "type": "string", "required": false, "description": "查询关键字", "example": "关键字" }, { "name": "PageSize", "type": "integer", "required": false, "description": "条数", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数", "example": "1" }, { "name": "BatchType", "type": "string", "required": false, "description": "批次类型 0:溯源 1:营销", "example": "0" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "Status", "type": "integer", "required": false, "description": "批次状态", "example": "1" } ], "required": [] }, { "name": "DescribeCodePackStatus", "description": "查询码包状态", "status": "online", "parameters": [ { "name": "PackId", "type": "string", "required": true, "description": "码包ID", "example": "PackId" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" } ], "required": [ "PackId" ] }, { "name": "DescribeCodePackUrl", "description": "查询码包地址", "status": "online", "parameters": [ { "name": "PackId", "type": "string", "required": true, "description": "码包ID", "example": "PackId" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" } ], "required": [ "PackId" ] }, { "name": "DescribeCodePacks", "description": "查询码包列表", "status": "online", "parameters": [ { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数", "example": "1" }, { "name": "Keyword", "type": "string", "required": false, "description": "查询关键字", "example": "安心" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "SerialType", "type": "integer", "required": false, "description": "是否有流水码 0:无 1:有", "example": "0" }, { "name": "ResType", "type": "string", "required": false, "description": "资源类型 batch:批次, order_in 入库, order_out: 出入", "example": "batch" }, { "name": "ResId", "type": "string", "required": false, "description": "资源ID ResType是 batch 时对应是批次ID, 是 order_in, order_out时，则是订单ID", "example": "20121212000001" }, { "name": "SceneCode", "type": "integer", "required": false, "description": "应用场景", "example": "1" }, { "name": "Status", "type": "string", "required": false, "description": "码包状态", "example": "done" } ], "required": [] }, { "name": "DescribeCodesByPack", "description": "查询码包的二维码列表，上限 3 万", "status": "online", "parameters": [ { "name": "PackId", "type": "string", "required": true, "description": "码包ID", "example": "码包ID" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [ "PackId" ] }, { "name": "DescribeCorpQuotas", "description": "查询渠道商下属企业额度使用情况", "status": "online", "parameters": [ { "name": "AgentId", "type": "integer", "required": false, "description": "渠道商ID，不要传", "example": "1000" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量", "example": "20" }, { "name": "Keyword", "type": "string", "required": false, "description": "搜索企业ID", "example": "10000" } ], "required": [] }, { "name": "DescribeCustomRuleById", "description": "查自定义码规则", "status": "online", "parameters": [ { "name": "CustomId", "type": "string", "required": true, "description": "码规则ID", "example": "xxxxid" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [ "CustomId" ] }, { "name": "DescribeCustomRules", "description": "查自定义码规则列表", "status": "online", "parameters": [ { "name": "Keyword", "type": "string", "required": false, "description": "搜索关键字", "example": "关键字" }, { "name": "PageSize", "type": "integer", "required": false, "description": "条数", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数", "example": "1" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "0" }, { "name": "Status", "type": "integer", "required": false, "description": "码规则状态 0:未生效 1:已生效 -1:已失效", "example": "1" }, { "name": "MerchantId", "type": "string", "required": false, "description": "商户ID", "example": "商户ID" } ], "required": [] }, { "name": "DescribeJobFileUrl", "description": "获取异步任务的输出地址", "status": "online", "parameters": [ { "name": "JobId", "type": "integer", "required": true, "description": "调度ID", "example": "1000" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" } ], "required": [ "JobId" ] }, { "name": "DescribeMerchantById", "description": "查询商户信息", "status": "online", "parameters": [ { "name": "MerchantId", "type": "string", "required": true, "description": "商户标识码", "example": "eqdmnz7020bmtvi9" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [ "MerchantId" ] }, { "name": "DescribeMerchants", "description": "查询商户列表", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "搜索商户名称", "example": "关键字" }, { "name": "PageSize", "type": "integer", "required": false, "description": "条数", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数", "example": "1" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "CodeType", "type": "integer", "required": false, "description": "码来源类型 0:自建, 1:第三方", "example": "1" } ], "required": [] }, { "name": "DescribePlanQRCodeScanRecords", "description": "查询安心计划二维码扫码记录", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2023-05-29" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2023-06-29" }, { "name": "PageNo", "type": "integer", "required": true, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "页大小", "example": "10" } ], "required": [ "StartTime", "EndTime", "PageNo", "PageSize" ] }, { "name": "DescribePlanQRCodes", "description": "查询安心计划二维码列表", "status": "online", "parameters": [ { "name": "PlanId", "type": "integer", "required": true, "description": "计划ID", "example": "100" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2023-05-29" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2023-06-29" }, { "name": "PageNo", "type": "integer", "required": true, "description": "页码", "example": "1" }, { "name": "PageSize", "type": "integer", "required": true, "description": "页大小", "example": "10" } ], "required": [ "PlanId", "StartTime", "EndTime", "PageNo", "PageSize" ] }, { "name": "DescribeProductById", "description": "查询商品信息", "status": "online", "parameters": [ { "name": "ProductId", "type": "string", "required": true, "description": "商品ID", "example": "eqdmnz7020bmtvie9" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [ "ProductId" ] }, { "name": "DescribeProducts", "description": "查询商品列表", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": false, "description": "商品名称", "example": "商品名称" }, { "name": "PageSize", "type": "integer", "required": false, "description": "条数", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数", "example": "1" }, { "name": "MerchantId", "type": "string", "required": false, "description": "商品ID", "example": "商品ID" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "CertState", "type": "integer", "required": false, "description": "认证状态", "example": "1" } ], "required": [] }, { "name": "DescribeRawScanLogs", "description": "支持增量查询扫码日志，通常提供给数据同步使用，调用时需要指定从哪一行开始查询数据", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID, 默认为当前企业如果有渠道权限，可以传 0 会查渠道下所有的企业", "example": "10000" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页数量，默认为 20，最大为 1000", "example": "100" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "当前分页，默认为 1", "example": "1" }, { "name": "AfterLogId", "type": "integer", "required": false, "description": "从哪个日志后查询即: LogId \u003e $AfterLogId", "example": "0" }, { "name": "StartTime", "type": "string", "required": false, "description": "开始时间 \u003e= StartTime", "example": "2021-12-06 00:00:00" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间 \u003c EndTime", "example": "2021-12-07 00:00:00" } ], "required": [] }, { "name": "DescribeScanLogs", "description": "查询扫码日志明细", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页数量", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "当前分页", "example": "1" }, { "name": "Code", "type": "string", "required": false, "description": "安心码", "example": "https://anxin.m.qq.com/qr/eqdmnz7020bmtvi9_00024381374200500" }, { "name": "Openid", "type": "string", "required": false, "description": "小程序用户ID", "example": "otcFg44LHRVsy" } ], "required": [] }, { "name": "DescribeScanStats", "description": "查询扫码的统计信息列表，支持按照商户ID，产品ID，批次ID，安心码筛选，筛选条件至少有一个没有被扫过的不会返回", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页数量", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "当前分页", "example": "1" }, { "name": "MerchantId", "type": "string", "required": false, "description": "商户ID", "example": "mid" }, { "name": "ProductId", "type": "string", "required": false, "description": "产品ID", "example": "pid" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID", "example": "bid" }, { "name": "Code", "type": "string", "required": false, "description": "安心码", "example": "https://anxin.m.qq.com/qr/eqdmnz7020bmtvi9_00024381374200500" } ], "required": [] }, { "name": "DescribeTmpToken", "description": "查询临时Token，主要用于上传接口", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [] }, { "name": "DescribeTraceCodeById", "description": "查询二维码信息", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "Code", "type": "string", "required": false, "description": "二维码", "example": "https://anxin.m.qq.com/qr/eqdmnz7020bmtvi9_00024381374200500" } ], "required": [] }, { "name": "DescribeTraceCodes", "description": "查询二维码列表", "status": "online", "parameters": [ { "name": "Keyword", "type": "string", "required": false, "description": "搜索关键字码标识，或者批次ID", "example": "code" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "条数", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "页码", "example": "1" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID，弃用", "example": "20241022112952826" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [] }, { "name": "DescribeTraceDataById", "description": "查询溯源ID查溯源信息，通常溯源信息跟生产批次绑定，即一个批次的所有溯源信息都是一样的", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "溯源ID", "example": "ccc" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" } ], "required": [ "Id" ] }, { "name": "DescribeTraceDataList", "description": "查询溯源信息，通常溯源信息跟生产批次绑定，即一个批次的所有溯源信息都是一样的", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID", "example": "ccc" }, { "name": "TaskId", "type": "string", "required": false, "description": "任务ID 用于外部溯源", "example": "1" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页数", "example": "1" }, { "name": "Code", "type": "string", "required": false, "description": "溯源码", "example": "xfetmgoiky2nms6nk8" }, { "name": "Phase", "type": "integer", "required": false, "description": "溯源阶段 0:商品 1:通用 2:内部溯源 3:外部溯源", "example": "0" }, { "name": "PageSize", "type": "integer", "required": false, "description": "数量", "example": "10" } ], "required": [] }, { "name": "EffectFeedback", "description": "接收客户反馈的各环节数据", "status": "online", "parameters": [ { "name": "BusinessSecurityData", "type": "object", "required": true, "description": "业务加密入参。", "example": "无", "children": [ { "name": "EncryptMethod", "type": "integer", "required": true, "description": "加密方式，0：AES加密；", "example": "1" }, { "name": "EncryptMode", "type": "integer", "required": true, "description": "加密算法中的块处理模式，1：CBC模式；目前只支持CBC模式", "example": "1" }, { "name": "PaddingType", "type": "integer", "required": true, "description": "填充模式，0：ZeroPadding；1：PKCS5Padding；2： PKCS7Padding。", "example": "1" }, { "name": "EncryptData", "type": "string", "required": true, "description": "加密数据，将AuthorizedData结构体数组（数组最大长度不超过20）序列化成JSON字符串，对得到的字符串加密并填充到该字段。", "example": "051pk8tyhgc9" }, { "name": "IsAuthorized", "type": "integer", "required": false, "description": "用户是否授权，本接口取值：1，已授权。", "example": "1" } ] } ], "required": [ "BusinessSecurityData" ] }, { "name": "ModifyCodeBatch", "description": "修改批次", "status": "online", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "批次ID", "example": "20121212000001" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "Status", "type": "integer", "required": false, "description": "状态 0: 未激活 1: 已激活 -1: 已冻结", "example": "1" }, { "name": "MpTpl", "type": "string", "required": false, "description": "模板ID，或者活动ID", "example": "模板ID" }, { "name": "MerchantId", "type": "string", "required": false, "description": "商户ID", "example": "eqdmnz7020bmtvi9" }, { "name": "ProductId", "type": "string", "required": false, "description": "商品ID", "example": "tz6jpscwky41u23o9b" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "BatchCode", "type": "string", "required": false, "description": "批次编码，业务字段不判断唯一性", "example": "202210" }, { "name": "ValidDate", "type": "string", "required": false, "description": "有效期", "example": "2022-11-12" }, { "name": "ProductionDate", "type": "string", "required": false, "description": "生产日期", "example": "2022-05-12" } ], "required": [ "BatchId" ] }, { "name": "ModifyCustomRule", "description": "修改自定义码规则", "status": "online", "parameters": [ { "name": "CustomId", "type": "string", "required": true, "description": "码规则ID", "example": "CustomId" }, { "name": "Name", "type": "string", "required": true, "description": "规则名称", "example": "规则名称" }, { "name": "CodeLength", "type": "integer", "required": true, "description": "码长度", "example": "36" }, { "name": "CodeParts", "type": "array", "required": true, "description": "码段配置", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "码段名称", "example": "码段" }, { "name": "Type", "type": "string", "required": true, "description": "码段类型", "example": "0" }, { "name": "Value", "type": "string", "required": true, "description": "码段内容", "example": "20250219" }, { "name": "Length", "type": "integer", "required": true, "description": "码段长度", "example": "10" }, { "name": "Ext", "type": "string", "required": true, "description": "扩展字段", "example": "str" } ] }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" } ], "required": [ "CustomId", "Name", "CodeLength", "CodeParts" ] }, { "name": "ModifyCustomRuleStatus", "description": "更新自定义码规则状态", "status": "online", "parameters": [ { "name": "CustomId", "type": "string", "required": true, "description": "码规则ID", "example": "CustomId" }, { "name": "Status", "type": "integer", "required": true, "description": "码规则状态 0:未生效 1:已生效 -1:已失效", "example": "1" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" } ], "required": [ "CustomId", "Status" ] }, { "name": "ModifyMerchant", "description": "编辑商户", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "商户名称", "example": "商户名称" }, { "name": "MerchantId", "type": "string", "required": true, "description": "商户标识码", "example": "商户标识码" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "CodeType", "type": "integer", "required": false, "description": "码包来源 0:自建, 1:第三方码包，暂不支持修改", "example": "0" }, { "name": "CodeUrl", "type": "string", "required": false, "description": "码包前缀地址第三方码包时必填", "example": "https://anxin.m.qq.com" } ], "required": [ "Name", "MerchantId" ] }, { "name": "ModifyProduct", "description": "编辑商品", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "商品名称", "example": "商品名称" }, { "name": "ProductId", "type": "string", "required": true, "description": "商品ID", "example": "85tfp1sn78r9m1568i" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "备注" }, { "name": "Specification", "type": "string", "required": false, "description": "商品规格", "example": "100ml" }, { "name": "Logo", "type": "array", "required": false, "description": "商品图片", "example": "[\"http://xxx.xxx.com/logo.png\"]", "item_type": "string" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "10000" }, { "name": "Ext", "type": "object", "required": false, "description": "预留字段", "example": "无" } ], "required": [ "Name", "ProductId" ] }, { "name": "ModifyTraceCode", "description": "冻结或者激活二维码，所属的批次的冻结状态优先级大于单个二维码的状态，即如果批次是冻结的，那么该批次下二维码的状态都是冻结的", "status": "online", "parameters": [ { "name": "Code", "type": "string", "required": true, "description": "二维码", "example": "https://anxin.m.qq.com/qr/eqdmnz7020bmtvi9_00024381374200500" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "Status", "type": "integer", "required": false, "description": "状态 0: 冻结 1: 激活", "example": "0" } ], "required": [ "Code" ] }, { "name": "ModifyTraceCodeUnlink", "description": "解绑溯源码和批次的关系，让溯源码重置为未关联的状态，以便关联其他批次注意：溯源码必须属于指定的批次才会解绑", "status": "online", "parameters": [ { "name": "BatchId", "type": "string", "required": true, "description": "批次ID", "example": "20220114161517935" }, { "name": "Codes", "type": "array", "required": true, "description": "溯源码列表", "example": "[\"xxx\"]", "item_type": "string" }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" } ], "required": [ "BatchId", "Codes" ] }, { "name": "ModifyTraceData", "description": "修改溯源信息", "status": "online", "parameters": [ { "name": "TraceId", "type": "string", "required": false, "description": "溯源ID", "example": "VyKxxkmi_myRD6ulG6HFo" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID", "example": "20220114161517935" }, { "name": "TaskId", "type": "string", "required": false, "description": "生产溯源任务ID", "example": "1" }, { "name": "TraceItems", "type": "array", "required": false, "description": "溯源信息", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "商品名称2" }, { "name": "Value", "type": "string", "required": true, "description": "字段值", "example": "demo" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型", "example": "text" }, { "name": "Values", "type": "array", "required": true, "description": "多个值", "example": "url1,url2", "item_type": "string" }, { "name": "ReadOnly", "type": "boolean", "required": false, "description": "只读", "example": "false" }, { "name": "Hidden", "type": "boolean", "required": false, "description": "扫码展示", "example": "false" }, { "name": "Key", "type": "string", "required": false, "description": "类型标识", "example": "ID" }, { "name": "Ext", "type": "string", "required": false, "description": "扩展字段", "example": "custom" }, { "name": "Attrs", "type": "array", "required": false, "description": "额外属性", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "商品名称2" }, { "name": "Value", "type": "string", "required": true, "description": "字段值", "example": "demo" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型", "example": "text" }, { "name": "Values", "type": "array", "required": true, "description": "多个值", "example": "url1,url2", "item_type": "string" }, { "name": "ReadOnly", "type": "boolean", "required": false, "description": "只读", "example": "false" }, { "name": "Hidden", "type": "boolean", "required": false, "description": "扫码展示", "example": "false" }, { "name": "Key", "type": "string", "required": false, "description": "类型标识", "example": "ID" }, { "name": "Ext", "type": "string", "required": false, "description": "扩展字段", "example": "custom" }, { "name": "Attrs", "type": "array", "required": false, "description": "额外属性", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "商品名称2" }, { "name": "Value", "type": "string", "required": true, "description": "字段值", "example": "demo" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型", "example": "text" }, { "name": "Values", "type": "array", "required": true, "description": "多个值", "example": "url1,url2", "item_type": "string" }, { "name": "ReadOnly", "type": "boolean", "required": false, "description": "只读", "example": "false" }, { "name": "Hidden", "type": "boolean", "required": false, "description": "扫码展示", "example": "false" }, { "name": "Key", "type": "string", "required": false, "description": "类型标识", "example": "ID" }, { "name": "Ext", "type": "string", "required": false, "description": "扩展字段", "example": "custom" }, { "name": "Attrs", "type": "array", "required": false, "description": "额外属性", "example": "无", "item_type": "string" }, { "name": "List", "type": "array", "required": false, "description": "子页面，只读", "example": "无", "item_type": "string" } ] }, { "name": "List", "type": "array", "required": false, "description": "子页面，只读", "example": "无", "item_type": "object", "children": [ { "name": "TraceId", "type": "string", "required": true, "description": "溯源ID", "example": "VyKxxkmi_myRD6ulG6HFo" }, { "name": "CorpId", "type": "integer", "required": true, "description": "企业ID", "example": "10" }, { "name": "Type", "type": "integer", "required": true, "description": "码类型 0: 批次, 1: 码, 2: 生产任务", "example": "码类型" }, { "name": "Code", "type": "string", "required": true, "description": "码值，跟码类型一一对应", "example": "xfetmgoiky2nms6nk8" }, { "name": "Rank", "type": "integer", "required": true, "description": "排序，在Phase相同情况下，值越小排名靠前", "example": "1" }, { "name": "Phase", "type": "integer", "required": true, "description": "溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源", "example": "0" }, { "name": "PhaseName", "type": "string", "required": true, "description": "溯源环节名称", "example": "环节名称" }, { "name": "TraceTime", "type": "string", "required": true, "description": "溯源时间", "example": "2021-12-03T02:58:48.000Z" }, { "name": "CreateTime", "type": "string", "required": true, "description": "创建时间", "example": "2021-12-06T09:20:57.000Z" }, { "name": "ChainStatus", "type": "integer", "required": true, "description": "上链状态 0: 未上链 1: 上链中 2: 已上链 -1: 异常", "example": "2" }, { "name": "ChainTime", "type": "string", "required": true, "description": "上链时间", "example": "2021-12-06T09:20:57.000Z" }, { "name": "ChainData", "type": "object", "required": true, "description": "上链数据", "example": "无" }, { "name": "PhaseData", "type": "object", "required": true, "description": "溯源阶段配置", "example": "无" }, { "name": "Status", "type": "integer", "required": true, "description": "溯源阶段状态 0: 无效, 1: 有效", "example": "1" }, { "name": "TraceItems", "type": "array", "required": false, "description": "无", "example": "无", "item_type": "string" } ] } ] }, { "name": "List", "type": "array", "required": false, "description": "子页面，只读", "example": "无", "item_type": "object", "children": [ { "name": "TraceId", "type": "string", "required": true, "description": "溯源ID", "example": "VyKxxkmi_myRD6ulG6HFo" }, { "name": "CorpId", "type": "integer", "required": true, "description": "企业ID", "example": "10" }, { "name": "Type", "type": "integer", "required": true, "description": "码类型 0: 批次, 1: 码, 2: 生产任务", "example": "码类型" }, { "name": "Code", "type": "string", "required": true, "description": "码值，跟码类型一一对应", "example": "xfetmgoiky2nms6nk8" }, { "name": "Rank", "type": "integer", "required": true, "description": "排序，在Phase相同情况下，值越小排名靠前", "example": "1" }, { "name": "Phase", "type": "integer", "required": true, "description": "溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源", "example": "0" }, { "name": "PhaseName", "type": "string", "required": true, "description": "溯源环节名称", "example": "环节名称" }, { "name": "TraceTime", "type": "string", "required": true, "description": "溯源时间", "example": "2021-12-03T02:58:48.000Z" }, { "name": "CreateTime", "type": "string", "required": true, "description": "创建时间", "example": "2021-12-06T09:20:57.000Z" }, { "name": "ChainStatus", "type": "integer", "required": true, "description": "上链状态 0: 未上链 1: 上链中 2: 已上链 -1: 异常", "example": "2" }, { "name": "ChainTime", "type": "string", "required": true, "description": "上链时间", "example": "2021-12-06T09:20:57.000Z" }, { "name": "ChainData", "type": "object", "required": true, "description": "上链数据", "example": "无", "children": [ { "name": "BlockHash", "type": "string", "required": false, "description": "区块hash", "example": "0xfc7f37ba117bb01afd237c6949f7d6a0b0d4a4c785b3fb90cd9004e0335a9d" }, { "name": "BlockHeight", "type": "string", "required": false, "description": "区块高度", "example": "28102" }, { "name": "BlockTime", "type": "string", "required": false, "description": "区块时间", "example": "2021" } ] }, { "name": "PhaseData", "type": "object", "required": true, "description": "溯源阶段配置", "example": "无", "children": [ { "name": "HeadEnabled", "type": "boolean", "required": false, "description": "启用头", "example": "false" }, { "name": "HeadTitle", "type": "string", "required": false, "description": "标题", "example": "标题" }, { "name": "Key", "type": "string", "required": false, "description": "标识符", "example": "product" }, { "name": "AppId", "type": "string", "required": false, "description": "小程序AppId", "example": "AppId" }, { "name": "AppPath", "type": "string", "required": false, "description": "小程序AppPath", "example": "AppPath" }, { "name": "AppName", "type": "string", "required": false, "description": "小程序名称AppName", "example": "AppName" } ] }, { "name": "Status", "type": "integer", "required": true, "description": "溯源阶段状态 0: 无效, 1: 有效", "example": "1" }, { "name": "TraceItems", "type": "array", "required": false, "description": "无", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "字段名称", "example": "商品名称2" }, { "name": "Value", "type": "string", "required": true, "description": "字段值", "example": "demo" }, { "name": "Type", "type": "string", "required": true, "description": "字段类型 text:文本类型, longtext:长文本类型, banner:单图片类型, image:多图片类型, video:视频类型, mp:小程序类型", "example": "text" }, { "name": "Values", "type": "array", "required": true, "description": "多个值", "example": "url1,url2", "item_type": "string" }, { "name": "ReadOnly", "type": "boolean", "required": false, "description": "只读", "example": "false" }, { "name": "Hidden", "type": "boolean", "required": false, "description": "扫码展示", "example": "false" }, { "name": "Key", "type": "string", "required": false, "description": "类型标识", "example": "ID" }, { "name": "Ext", "type": "string", "required": false, "description": "扩展字段", "example": "custom" }, { "name": "Attrs", "type": "array", "required": false, "description": "额外属性", "example": "无", "item_type": "string" }, { "name": "List", "type": "array", "required": false, "description": "子页面，只读", "example": "无", "item_type": "string" } ] } ] } ] }, { "name": "PhaseName", "type": "string", "required": false, "description": "溯源阶段名称", "example": "名称" }, { "name": "PhaseData", "type": "object", "required": false, "description": "环节数据", "example": "无", "children": [ { "name": "HeadEnabled", "type": "boolean", "required": false, "description": "启用头", "example": "false" }, { "name": "HeadTitle", "type": "string", "required": false, "description": "标题", "example": "标题" }, { "name": "Key", "type": "string", "required": false, "description": "标识符", "example": "product" }, { "name": "AppId", "type": "string", "required": false, "description": "小程序AppId", "example": "AppId" }, { "name": "AppPath", "type": "string", "required": false, "description": "小程序AppPath", "example": "AppPath" }, { "name": "AppName", "type": "string", "required": false, "description": "小程序名称AppName", "example": "AppName" } ] }, { "name": "Status", "type": "integer", "required": false, "description": "溯源状态 0: 无效, 1: 有效", "example": "1" }, { "name": "Rank", "type": "integer", "required": false, "description": "排序", "example": "1" }, { "name": "Type", "type": "integer", "required": false, "description": "[无效] 类型", "example": "1" }, { "name": "Code", "type": "string", "required": false, "description": "[无效] 溯源码", "example": "xfetmgoiky2nms6nk8" }, { "name": "Phase", "type": "integer", "required": false, "description": "[无效] 溯源阶段 0:商品 1:通用 2:生产溯源 3:销售溯源", "example": "1" }, { "name": "TraceTime", "type": "string", "required": false, "description": "[无效] 溯源时间", "example": "2021-12-03T02:58:48.000Z" }, { "name": "CreateTime", "type": "string", "required": false, "description": "[无效] 创建时间", "example": "2021-12-03T02:58:48.000Z" }, { "name": "ChainStatus", "type": "integer", "required": false, "description": "[无效] 上链状态", "example": "1" }, { "name": "ChainTime", "type": "string", "required": false, "description": "[无效] 上链时间", "example": "2021-12-03T02:58:48.000Z" }, { "name": "ChainData", "type": "object", "required": false, "description": "[无效] 上链数据", "example": "无", "children": [ { "name": "BlockHash", "type": "string", "required": false, "description": "区块hash", "example": "0xfc7f37ba117bb01afd237c6949f7d6a0b0d4a4c785b3fb90cd9004e0335a9d" }, { "name": "BlockHeight", "type": "string", "required": false, "description": "区块高度", "example": "28102" }, { "name": "BlockTime", "type": "string", "required": false, "description": "区块时间", "example": "2021" } ] }, { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" } ], "required": [] }, { "name": "ModifyTraceDataRanks", "description": "修改溯源信息的排序", "status": "online", "parameters": [ { "name": "CorpId", "type": "integer", "required": false, "description": "企业ID", "example": "1000" }, { "name": "BatchId", "type": "string", "required": false, "description": "批次ID", "example": "97zu51y30awe" }, { "name": "TaskId", "type": "string", "required": false, "description": "生产任务ID", "example": "1" }, { "name": "TraceIds", "type": "array", "required": false, "description": "溯源ID", "example": "['abc']", "item_type": "string" } ], "required": [] }, { "name": "ReportBatchCallbackStatus", "description": "接收离线筛选包回执，用于效果统计和分析。", "status": "online", "parameters": [ { "name": "BusinessSecurityData", "type": "object", "required": true, "description": "业务加密入参。", "example": "无", "children": [ { "name": "EncryptMethod", "type": "integer", "required": true, "description": "加密方式，0：AES加密；", "example": "1" }, { "name": "EncryptMode", "type": "integer", "required": true, "description": "加密算法中的块处理模式，1：CBC模式；目前只支持CBC模式", "example": "1" }, { "name": "PaddingType", "type": "integer", "required": true, "description": "填充模式，0：ZeroPadding；1：PKCS5Padding；2： PKCS7Padding。", "example": "1" }, { "name": "EncryptData", "type": "string", "required": true, "description": "加密数据，将AuthorizedData结构体数组（数组最大长度不超过20）序列化成JSON字符串，对得到的字符串加密并填充到该字段。", "example": "051pk8tyhgc9" }, { "name": "IsAuthorized", "type": "integer", "required": false, "description": "用户是否授权，本接口取值：1，已授权。", "example": "1" } ] } ], "required": [ "BusinessSecurityData" ] } ] }