华为云用户手册

  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 code String 返回码 最小长度:1 最大长度:50 message String 响应消息 最小长度:1 最大长度:100 data data object 批次列表数据 表6 data 参数 参数类型 描述 pageNum Integer 页数 pageSize Integer 每页数量 total Integer 总数 pages Integer 总页数 record Array of record objects 批次信息 表7 record 参数 参数类型 描述 gmtCreate String 创建时间 gmtModified String 修改时间 productName String 商品名称 最小长度:1 最大长度:100 productCode String 商品码 最小长度:1 最大长度:100 batchCode String 批次码 最小长度:1 最大长度:100 batchName String 批次名称 merchant String 商户ID 最小长度:1 最大长度:100 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Success { "code" : 200, "message" : "操作成功!", "data" : { "pageNum" : 1, "pageSize" : 10, "total" : 1, "pages" : 1, "record" : [ { "gmtCreate" : "2022-02-24 01:00:07", "gmtModified" : "2022-02-24 01:00:07", "productName" : "测试", "productCode" : "测试", "batchCode" : "889af5124bfe4e4fbae7cc9aa9b3d786", "batchName" : "批次1", "merchant" : "1748189792481312769" } ] } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 merchant 是 String 商户ID 最小长度:1 最大长度:100 query 是 Query object 分页参数 表4 Query 参数 是否必选 参数类型 描述 current 否 Integer 当前页 最小值:1 最大值:2147483647 缺省值:1 size 否 Integer 每页的数量 最小值:1 最大值:2147483647 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 返回码 message String 响应消息 最小长度:1 最大长度:100 data String 任务ID 最小长度:1 最大长度:100 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 labelQuantity 是 Long 溯源码数量 最小值:1 最大值:100000 level 是 Long 所在层级,当前支持1级 最小值:1 最大值:3 merchant 是 String 商户ID packageId 否 String 溯源码套餐包Id 最小长度:1 最大长度:36
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 batchCode 是 String 批次码 最小长度:1 最大长度:100 linkName1 是 String 环节名称1 最小长度:1 最大长度:20 linkSeq1 是 Integer 环节顺序1 最小值:0 最大值:50 linkName2 是 String 环节名称2 最小长度:1 最大长度:100 linkSeq2 是 Integer 环节顺序2 最小值:0 最大值:50 merchant 是 String 商户ID 最小长度:1 最大长度:100
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 batchName 是 String 批次名称 最小长度:1 最大长度:255 productCode 是 String 商品码 最小长度:1 最大长度:255 traceabilityLevels 是 Integer 溯源层级数,1,2,3,当前只支持1级溯源码 枚举值: 1 2 3 merchant 是 String 商户ID 最小长度:1 最大长度:100 productBatchUnits 是 Array of productBatchUnits objects 层级信息列表 表4 productBatchUnits 参数 是否必选 参数类型 描述 level 是 Integer 溯源层级数,当前只支持1级溯源码 枚举值: 1 2 3 unitName 否 String 单位名称 最小长度:1 最大长度:50
  • 请求示例 { "productCode" : " qfftest2201", "batchName" : "批次02202", "traceabilityLevels" : "1", "productBatchUnits" : [ { "level" : "1", "unitName" : "圆通" } ], "merchant" : " 1754386705866125313" }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 code String 返回码 最小长度:1 最大长度:20 message String 返回描述 最小长度:1 最大长度:255 data data object data 表6 data 参数 参数类型 描述 batchCode String 批次码 batchName String 批次名称 productCode String 商品码 merchant String 商户ID 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Success { "code" : "200", "message" : "操作成功!", "data" : { "batchCode" : "2024021753347601", "batchName" : "香蕉第一批次", "productCode" : "banana", "merchant" : "1752329807713542146" } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 productCode 否 String 产品编码(productCode和productName不能同时为空) 最小长度:1 最大长度:255 productName 否 String 产品名称(productCode和productName不能同时为空) 最小长度:1 最大长度:13 merchant 是 String 商户ID
  • 响应示例 状态码: 200 Success { "code" : 200, "message" : "操作成功!", "data" : { "gmtCreate" : "2022-02-24 17:28:13", "gmtModified" : "2022-02-24 17:28:13", "productName" : "apple", "batchCode" : "962cc65f20674ebeb67b765f83bcaa24", "isUse" : 0, "itemCode" : "k5bDlzw5yU", "traceabilityStatus" : "0", "productTraceUrl" : "https://xxx.xxx.xxx.xxx/#/?itemCode=k5bDlzw5yU", "latestActionsDate" : "xxx", "latestActions" : "xxx", "isSupportTrace" : "1" } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 itemCode 是 String 溯源码 最小长度:1 最大长度:100 batchCode 否 String 批次码 最小长度:1 最大长度:100 merchant 是 String 商户ID 最小长度:1 最大长度:100 query 否 query object 查询参数 表4 query 参数 是否必选 参数类型 描述 current 否 Integer 当前页 最小值:1 最大值:2147483647 缺省值:1 size 否 Integer 每页的数量 最小值:1 最大值:2147483647 缺省值:10
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 code String 返回码 message String 返回描述 data data object 详情 表6 data 参数 参数类型 描述 pageNum Integer 页数 pageSize Integer 每页展示的数量 total Integer 总数 pages Integer 总页数 record Array of record objects 溯源码信息 表7 record 参数 参数类型 描述 gmtCreate String 创建时间 gmtModified String 修改时间 productName String 商品名称 batchCode String 批次码 isUse String 是否使用,0 未使用,1 已使用 itemCode String 一级溯源码 traceabilityStatus String 溯源状态,0 正常,1 禁用 productTraceUrl String 商品溯源url latestActionsDate String 最近溯源信息变化时间 latestActions String 最近溯源信息 isSupportTrace String 是否支持溯源,0 不支持,1 支持 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code Integer 返回码 最小值:1 最大值:50 message String 响应消息 最小长度:1 最大长度:100 data String 上传的文件链接 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 返回码 message String 响应消息 最小长度:1 最大长度:100 data String 下载任务ID 最小长度:1 最大长度:100 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Success { "code" : 200, "message" : "操作成功!", "data" : { "gmtCreate" : "2022-02-24 17:53:07", "gmtModified" : "2022-02-24 17:53:22", "productName" : "测试产品", "productCode" : "测试", "batchCode" : "462d61980ad140549b3ac9080ce04861", "batchName" : "批次", "merchant" : "1748189792481312769", "level1Count" : 0, "level2Count" : 0, "level3Count" : 0, "productBatchUnitRespList" : [ { "level" : 0, "unitName" : "单位" } ] } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 返回码 最小长度:1 最大长度:20 message String 返回消息 最小长度:1 最大长度:255 data data object 批次详情数据 表5 data 参数 参数类型 描述 gmtCreate String 创建时间 gmtModified String 更新时间 productName String 商品名称 productCode String 商品码 batchCode String 批次码 batchName String 批次名称 merchant String 商户ID level1Count Integer 一级码数量 level2Count Integer 二级码数量 level3Count Integer 三级码数量 productBatchUnitRespList Array of productBatchUnitRespList objects 层级信息列表 表6 productBatchUnitRespList 参数 参数类型 描述 level Integer 所在层级 unitName String 单位名称 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 code Integer 返回码 最小值:1 最大值:100 message String 响应消息 最小长度:1 最大长度:100 data Boolean 环节内容是否修改成功 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 请求示例 { "merchant" : "1748189792481312769", "batchCode" : "962cc65f20674ebeb67b765f83bcaa24", "linkName" : "清风", "batchLinkContentList" : [ { "contentUrl" : "url", "contentType" : "0", "contentName" : "测试", "contentText" : "String", "sweepCodeDisplay" : "1", "contentId" : 1456460643218268200 } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 merchant 是 String 商户ID 最小长度:1 最大长度:100 batchCode 是 String 批次码 最小长度:1 最大长度:100 linkName 是 String 环节名称 最小长度:1 最大长度:20 batchLinkContentList 是 Array of BatchLinkContentList objects 环节内容 表4 BatchLinkContentList 参数 是否必选 参数类型 描述 contentUrl 否 String 对于图片、PDF等存储url 最小长度:1 最大长度:250 contentType 是 String 溯源内容类型(0.图片、1.PDF、2.文本) 枚举值: 0 1 2 contentName 是 String 溯源内容名称 最小长度:1 最大长度:100 contentText 否 String 对于文本,直接存储文本内容 最小长度:1 最大长度:250 sweepCodeDisplay 是 String 扫码展示方式:0 不展示,1 展示 枚举值: 0 1 contentId 是 String 环节内容ID
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 productCode 是 String 商品码 最小长度:1 最大长度:100 batchCode 是 String 批次码,不可修改 最小长度:1 最大长度:255 batchName 是 String 批次名称 最小长度:1 最大长度:255 traceabilityLevels 是 String 溯源层级数,1,2,3,当前只支持一级溯源码 枚举值: 1 2 3 productBatchUnits 否 Array of productBatchUnits objects 层级信息列表 merchant 是 String 商户ID,不可修改 最小长度:1 最大长度:100 表4 productBatchUnits 参数 是否必选 参数类型 描述 level 是 String 所在层级 unitName 否 String 单位名称
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 FormData参数 参数 是否必选 参数类型 描述 merchant 是 String 商户ID 最小长度:1 最大长度:100 batchCode 是 String 批次码 最小长度:1 最大长度:100 file 是 File 文件,支持文件后缀为xlsx,xls
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 返回码 message String 信息 data data object 返回数据 表5 data 参数 参数类型 描述 taskId String 任务ID batchCode String 批次码 merchant String 商户ID 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Success { "code" : "200", "message" : "操作成功!", "data" : { "taskId" : "547d2f7cdcb149fca8a2bb499762b43a", "batchCode" : "1c403af577ec4b369140c95327b17aed", "merchant" : "1754386705866125313" } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 返回码 最小长度:1 最大长度:20 message String 返回描述 最小长度:1 最大长度:255 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 productCode 否 String 产品编码(productCode和productName不能同时为空) 最小长度:1 最大长度:13 productName 否 String 产品名称(productCode和productName不能同时为空) 最小长度:1 最大长度:255 merchant 是 String 商户ID 最小长度:1 最大长度:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 返回码 message String 响应消息 data data object 商品详情 表5 data 参数 参数类型 描述 productCode String 商品码 productName String 商品名称 productPhotoUrl String 商品溯源url bannerUrl String 横幅url productOrigin String 商品产地 sweepcodeStatisticsSwitch String 商品溯源扫码统计开关(0:关闭;1 打开) merchant String 商户ID 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Success { "code" : "200", "message" : "操作成功!", "data" : { "productCode" : "77", "productName" : "7711", "productPhotoUrl" : "https://xxx.xxx.xxx.xxx/petaltrace/6BF050A8AA19BB2F0BFA9F2F0529991C.jpg", "bannerUrl" : "https://xxx.xxx.xxx.xxx/petaltrace/6BF050A8AA19BB2F0BFA9F2F0529991C.jpg", "productOrigin" : "bj", "sweepcodeStatisticsSwitch" : "1", "merchant" : "1759540612045058049" } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 total_count Integer 总数 tde_seals_image Array of tde_seals_image objects 表3 tde_seals_image 参数 参数类型 描述 image_id String 图片ID img_name String 图片名称 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:20 error_msg String 错误描述 最小长度:1 最大长度:512
共100000条