--- title: DMS-B2B-产品文档-对外接口 description: 文本抽取：知识库/03-批发经销采购场景/DMS-B2B-产品文档-对外接口 updated: 2026-11-04 tags: [原始文档, 抽取, 知识库] source: 知识库/03-批发经销采购场景/DMS-B2B-产品文档-对外接口 source_type: txt source_hash: 59388dc37777 extracted_at: 2026-11-04 quality: ok --- --- source: 知识库/03-批发经销采购场景/DMS-B2B-产品文档-对外接口.pdf type: pdf size_kb: 3148 category: 03-批发经销采购场景 quality: ok --- ## Page 1 BB-产品⽂档-对外接⼝ 开放平台说明 接⼝签名 请求参数 请求示例 店铺/商户-基础信息上传-未开放 请求参数 请求示例 响应示例 店铺/商户-扩展店铺分类上传-未开放 请求参数 请求示例 响应示例 商品类⽬-上传 请求参数 请求示例 响应示例 品牌信息-上传 请求参数 请求示例 响应示例 商品信息-上传 请求参数 请求示例 响应示例 商品信息-价格上传 请求参数 请求示例 响应示例 1 ## Page 2 商品信息-状态同步 请求参数 请求示例 响应示例 交易订单-订单创建-未开放 请求参数 请求示例 响应示例 交易订单-状态同步 请求参数 请求示例 响应示例 交易订单-订单取消 请求参数 请求示例 响应示例 售后订单-状态同步 请求参数 请求示例 响应示例 库存数据-上传 请求参数 请求示例 响应示例 会员信息-会员等级上传 请求参数 请求示例 响应示例 会员/客户信息-基础信息上传 请求参数 请求示例 响应示例 2 ## Page 3 会员信息-收货地址上传 请求参数 请求示例 响应示例 基础信息-⾏政区域(省市区)地址库上传 请求参数 请求示例 响应示例 基础信息-系统参数配置-不对外 系统参数编码 系统参数属性值 ：QQ登录参数配置 ：微信开放平台登录参数配置 ：微信公众号登录参数配置 ：三⽅接⼝-发票对接参数 ：三⽅接⼝-WMS对接参数 ：三⽅接⼝-商派OMS对接 ：三⽅接⼝-物流对接参数 ：三⽅接⼝-OSS配置 ：三⽅接⼝-客服平台 ：三⽅接⼝-客服电话 ：邮箱配置 ：短信配置 ：设置-基本设置 ：设置-交易/售后设置 ：设置-签到 ：设置-积分 ：设置-消息提醒 ：设置-注册 ：多语⾔-静态⽂件地址 公共参数-说明补充 3 ## Page 4 开放平台说明 接⼝签名 开发者可以通过开放平台中 签名 功能接⼝进⾏加签操作。⽣成 签名（sign）后，开发者可与⾃⼰代码中请求⽣成的信息进 ⾏对⽐，了解数据是否正确 加签原理/步骤 1. 获取所有开放平台的 post 内容，不包括字节类型参数，如⽂件、字节流。 2. 剔除 sign,signType 字段，剔除值为空的参数； 3. 参数排序，按照第⼀个字符的键值 ASCII 码递增排序（字⺟升序排序），如果遇到相同字符则按照第⼆个字符的键值 ASCII 码递增排序，以此类推； 4. 将排序后的参数与其对应值，组合成 参数=参数值 的格式，并且把这些参数⽤ & 字符连接起来，此时⽣成的字符串为待 签名字符串。 5. 将第3步⽣成的待签名字符串与开放平台提供的私钥信息进⾏RSA2加密处理，⽣成系统参数sign对应的签名结果 请求参数 参数 类型 是否必填 示例 描述 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过10 03:07:50 分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 4 ## Page 5 bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "appId": "2014072300007141", 3 "bizParam": "{\"tradeState\": 20,\"tradeId\": \"O100001\",\"logisticsCod e\":\"L10000\", \"logisticsComCode\":\"SF\",\"remark\":\"备注信息\"}", 4 "charset": "UTF-8", 5 "format": "json", 6 "method": "open.trade.cancel", 7 "sign": "rRj+PkfIc4V0z3l6k61EF+Jq3Pe7couikRLVcXQ5bUTtBLcEPDB9oVNq0sX45iM EWRp0fwbD4Ng1LHT5D5QsZi4mcAsmj1ObtvHvDulK7GSsBcN5qCrkFYTaQ1Qln1Rt9ovq2qaVh wBxdAFVHP6CQnkMigtGa/4Br2yK3awzcu8=", 8 "signType": "RSA2", 9 "timestamp": "2022-02-24 03:07:50", 10 "version": "1.0" 11 } 源码示例-参数过滤处理(java) 5 ## Page 6 Plain Text 复制代码 1 package com.gs.khxx.base.utils; 2 3 import cn.hutool.core.codec.Base64; 4 import cn.hutool.core.util.CharsetUtil; 5 import cn.hutool.crypto.SecureUtil; 6 import cn.hutool.crypto.asymmetric.Sign; 7 import cn.hutool.crypto.asymmetric.SignAlgorithm; 8 import java.util.*; 9 10 /** 11 * 对外接⼝参数签名校验 12 */ 13 public class OpenSignUtil { 14 15 private static final String FILTER_SIGN = "sign"; 16 private static final String FILTER_SIGN_TYPE = "signType"; 17 18 /** 19 * 签名校验 20 * 21 * @return 22 */ 23 public static final boolean verifySign(String rsaPubBase64, String rsa PriBase64, Map sourceMap, String base64SignValue) { 24 String initSignLinkStr = createParamLink(sourceMap); 25 byte[] data = initSignLinkStr.getBytes(CharsetUtil.CHARSET_UTF_8); 26 Sign sign = SecureUtil.sign(SignAlgorithm.SHA256withRSA, rsaPriBas e64, rsaPubBase64); 27 return sign.verify(data, base64SignValue.getBytes(CharsetUtil.CHAR SET_UTF_8)); 28 } 29 30 /** 31 * 签名操作 32 * 33 * @param rsaPubBase64 34 * @param rsaPriBase64 35 * @param sourceMap 36 * @return 37 */ 38 public static final String sign(String rsaPubBase64, String rsaPriBase 64, Map sourceMap) { 39 String initSignLinkStr = createParamLink(sourceMap); 40 byte[] data = initSignLinkStr.getBytes(CharsetUtil.CHARSET_UTF_8); 41 6 ## Page 7 Sign sign = SecureUtil.sign(SignAlgorithm.SHA256withRSA, rsaPriBas 42 e64, rsaPubBase64); 43 byte[] signed = sign.sign(data); 44 return Base64.encode(signed); 45 } 46 47 48 /** 49 * 请求参数过滤 50 * 过滤掉sign参数和参数结果为空的数据 51 * 52 * @return 53 */ private static final Map filterReqParam(Map sourceMap) { 55 Map retObj = new HashMap<>(); 56 if (sourceMap.isEmpty()) { 57 return retObj; 58 } 59 for (Map.Entry entry : sourceMap.entrySet()) { if (StrUtil.isEmpty(entry.getValue()) || FILTER_SIGN.equals(en 60 try.getKey()) || FILTER_SIGN_TYPE.equals(entry.getKey())) { 61 continue; 62 } 63 retObj.put(entry.getKey(), entry.getValue()); 64 } 65 return retObj; 66 } 67 68 /** 69 * 参数key排序升序排列 70 * 请求参数整合为 param=ParamValue¶m=ParamValue格式 71 * 72 * @return 73 */ private static final String createParamLink(Map source 74 Map) { 75 Map sourceFilterMap = filterReqParam(sourceMap); 76 StringBuffer retStr = new StringBuffer(""); 77 if (sourceFilterMap.isEmpty()) { 78 return retStr.toString(); 79 } List keyList = new ArrayList(sourceFilterMap.keySe 80 t()); 81 Collections.sort(keyList); 82 for (String key : keyList) { retStr.append("&").append(key).append("=").append(sourceFilter 83 Map.get(key)); 7 ## Page 8 84 } 85 return retStr.substring(1); 86 } } 签名示例(Java) Plain Text 复制代码 1 1.参数转换为Map对象,此处⼿动逐个参数赋值，也可以借助辅助⼯具类转换 2 Map paramMap=new HashMap<>(); 3 paramMap.put("appId","2014072300007141"); 4 paramMap.put("bizParam","{\"tradeState\": 20,\"tradeId\": \"O100001\",\"lo gisticsCode\":\"L10000\",\"logisticsComCode\":\"SF\",\"remark\":\"备注信息 \"}"); 5 paramMap.put("charset","UTF-8"); 6 paramMap.put("format","json"); 7 paramMap.put("method","open.trade.cancel"); 8 paramMap.put("sign","rRj+PkfIc4V0z3l6k61EF+Jq3Pe7couikRLVcXQ5bUTtBLcEPDB9o VNq0sX45iMEWRp0fwbD4Ng1LHT5D5QsZi4mcAsmj1ObtvHvDulK7GSsBcN5qCrkFYTaQ1Qln1R t9ovq2qaVhwBxdAFVHP6CQnkMigtGa/4Br2yK3awzcu8="); 9 paramMap.put("signType","RSA2"); 10 paramMap.put("timestamp","2022-02-24 03:07:50"); 11 paramMap.put("version","1.0"); 12 2.剔除参数名/参数值前后的空格 13 3.剔除sign,signType参数 14 4.参数排序 15 5.排序后的参数进⾏编码 16 排序编码后的字符串示例： 17 appId=2014072300007141&bizParam={"tradeState": 20,"tradeId": "O10000 1","logisticsCode":"L10000","logisticsComCode":"SF","remark":"备注信息"}&ch arset=UTF-8&format=json&method=open.trade.cancel×tamp=2022-02-24 03:0 7:50&version=1.0 18 6.对参数进⾏RSA2加密处理,⽣成参数sign的参数值 19 String rsaPriBase64="商城提供签名私钥"; 20 String rsaPubBase64="商城提供签名公钥"; 21 String signResult= sign(rsaPubBase64,rsaPriBase64,paramMap); 签名示例(.NET) 8 ## Page 9 Plain Text 复制代码 1 //密钥转换 2 public static string RSAPrivateKeyJava2DotNet(string privateKey){ 3 RsaPrivateCrtKeyParameters privateKeyParam = (RsaPrivateCrtKeyParamete rs)PrivateKeyFactory.CreateKey(Convert.FromBase64String(privateKey)); 4 return string.Format("{0}{1}

{2}

{3}{4}{5}{6}{7}", 5 Convert.ToBase64String(privateKeyParam.Modulus.ToByteArrayUnsigned ()), 6 Convert.ToBase64String(privateKeyParam.PublicExponent.ToByteArrayU nsigned()), 7 Convert.ToBase64String(privateKeyParam.P.ToByteArrayUnsigned()), 8 Convert.ToBase64String(privateKeyParam.Q.ToByteArrayUnsigned()), 9 Convert.ToBase64String(privateKeyParam.DP.ToByteArrayUnsigned()), 10 Convert.ToBase64String(privateKeyParam.DQ.ToByteArrayUnsigned()), 11 Convert.ToBase64String(privateKeyParam.QInv.ToByteArrayUnsigned ()), 12 Convert.ToBase64String(privateKeyParam.Exponent.ToByteArrayUnsigne d())); 13 } 14 //签名参数拼接过滤参考java版本 15 //签名操作 16 public static string Sign(string contentForSign, string privateKey) { 17 //转换成适⽤于.Net的秘钥 18 var netKey = RSAPrivateKeyJava2DotNet(privateKey); 19 var rsa = new RSACryptoServiceProvider(); 20 rsa.FromXmlString(netKey); 21 //创建⼀个空对象 22 var rsaClear = new RSACryptoServiceProvider(); 23 var paras = rsa.ExportParameters(true); 24 rsaClear.ImportParameters(paras); 25 //签名返回 26 using (var sha256 = new SHA256CryptoServiceProvider()){ 27 var signData = rsa.SignData(Encoding.UTF8.GetBytes(contentForSig n), sha256); 28 return BytesToHex(signData); 29 } 30 } 31 public static string BytesToHex(byte[] data){ 32 StringBuilder sbRet = new StringBuilder(data.Length * 2); 33 for (int i = 0; i < data.Length; i++){ 34 sbRet.Append(Convert.ToString(data[i], 16).PadLeft(2, '0')); 35 } 36 return sbRet.ToString(); 37 } 9 ## Page 10 38 //调⽤ 39 string rsaSecret = @"MIIBUwIBADANBgkqhkiG9w0BAQEFAASCAT0wggE5AgEAAkEAjdAhD uqzKCzaYyrrxFLdWVoR7wwmSdbVHBSZ/lpILvN/vPaohbi0NChwAEXYbvIXrFQ7zQyuqKazoEb vvXRNKQ......."; 40 string signDataString = Sign("签名字符串", rsaSecret); 店铺/商户-基础信息上传-未开放 外部系统将商品类⽬数据同步致商城 ● URL： /api/open ● Method： post 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过10 03:07:50 分钟,yyyy-MM-dd HH:mm:ss method String 是 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 参数 类型 是否必填 示例 描述 categoryAlias String 商品类别-别名 categoryIcon String 商品类别Icon 10 ## Page 11 gsCategoryAppNam String 商品类别-⼩程序别名 e gsCategoryFee bigdecimal(10,2 商品类别服务费率(只有三级有) ) gsCategoryLevel Integer 商品类别级别,1:⼀级类⽬,2:⼆级类 ⽬,3:三级类⽬ gsCategoryLogo String 商品类别logo gsCategoryMoney bigdecimal(10,2 商品类别平台使⽤费(只有⼀级有) ) gsCategoryName String 商品类别名称 idx Integer 排序 parentId String 商品类别⽗id showType Integer 默认展示模式 taxCode String 商品税收类型编码，只需要设置⼀ 级类型，其⼦集默认赋值处理 usefiled Integer 显示范围 请求示例 可以仅传递部分请求参数。 11 ## Page 12 JSON 复制代码 1 { 2 "categoryAlias": "", 3 "categoryIcon": "", 4 "gsCategoryAppName": "", 5 "gsCategoryFee": 0, 6 "gsCategoryLevel": 0, 7 "gsCategoryLogo": "", 8 "gsCategoryMoney": 0, 9 "gsCategoryName": "", 10 "idx": 0, 11 "parentId": "", 12 "showType": 0, 13 "taxCode": "", 14 "usefiled": 0 15 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 店铺/商户-扩展店铺分类上传-未开放 外部系统将商品类⽬数据同步致商城 ● URL： /api/open ● Method： post 请求参数 公共请求参数 参数 类型 是否必填 示例 描述 12 ## Page 13 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过10 03:07:50 分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 请求参数 参数 类型 是否必填 示例 描述 categoryAlias String 商品类别-别名 categoryIcon String 商品类别Icon gsCategoryAppNam String 商品类别-⼩程序别名 e gsCategoryFee bigdecimal(10,2 商品类别服务费率(只有三级有) ) gsCategoryLevel Integer 商品类别级别,1:⼀级类⽬,2:⼆级类 ⽬,3:三级类⽬ gsCategoryLogo String 商品类别logo gsCategoryMoney bigdecimal(10,2 商品类别平台使⽤费(只有⼀级有) ) gsCategoryName String 商品类别名称 idx Integer 排序 parentId String 商品类别⽗id 13 ## Page 14 showType Integer 默认展示模式 taxCode String 商品税收类型编码，只需要设置⼀ 级类型，其⼦集默认赋值处理 usefiled Integer 显示范围 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "categoryAlias": "", 3 "categoryIcon": "", 4 "gsCategoryAppName": "", 5 "gsCategoryFee": 0, 6 "gsCategoryLevel": 0, 7 "gsCategoryLogo": "", 8 "gsCategoryMoney": 0, 9 "gsCategoryName": "", 10 "idx": 0, 11 "parentId": "", 12 "showType": 0, 13 "taxCode": "", 14 "usefiled": 0 15 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 商品类⽬-上传 14 ## Page 15 ● URL： /api/open ● Method： post ● 说明：外部系统将商品类⽬数据同步⾄商城,根据cateId判断新增/编辑操作，当记录标记为删除(delFlag=20)时，除 cateId参数外其余相关参数允许为空 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过10 03:07:50 分钟,yyyy-MM-dd HH:mm:ss method String 是 open.goods.update 接⼝名称 Cate bizParam String 是 详⻅请求示例 请求参数集合,jsonArray格式字符 串 bizParam说明 cateId String 是 类别编码 cateAlias String 是 商品类别-别名 cateIcon String 是 商品类别Icon Url cateAppName String 是 商品类别-⼩程序别名 cateServiceFee bigdecimal(10,2) 否 商品类别服务费率(只有三级有)， 默认为 15 ## Page 16 cateLevel Integer 是 商品类别级别,1:⼀级类⽬,2:⼆级类 ⽬,3:三级类⽬ cateLogo String 否 商品类别logoUrl catePlatFee bigdecimal(10,2) 否 商品类别平台使⽤费(只有⼀级 有)，默认为0 cateName String 是 商品类别名称 idx Integer 否 排序,默认为0 parentId String 是 商品类别⽗id，⼀级⽬录⽗节点为 0 taxCode String 否 商品税收类型编码，只需要设置⼀ 级类型，其⼦集默认赋值处理 delFlag String 是 删除标志：10是20否 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 [{ 2 "cateId":"1542449607206801410", 3 "cateAlias": "", 4 "cateIcon": "", 5 "cateAppName": "", 6 "cateServiceFee": 0, 7 "cateLevel": 0, 8 "cateLogo": "", 9 "catePlatFee": 0, 10 "cateName": "电脑", 11 "idx": 0, 12 "parentId": "", 13 "taxCode": "" 14 }] 响应示例 16 ## Page 17 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 品牌信息-上传 ● URL： /api/open ● Method： post ● 说明：外部系统将商品品牌数据同步⾄商城,根据brandId判断新增/编辑操作，当记录标记为删除(delFlag=20)时，除 brandId参数外其余相关参数允许为空 请求参数 公共请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过10 03:07:50 分钟,yyyy-MM-dd HH:mm:ss method String 是 open.goods.update 接⼝名称 Brand 17 ## Page 18 bizParam String 是 详⻅请求示例 请求参数集合,jsonArray格式字符 串 bizParam说明 brandId String 否 品牌编码 brandAlias String 是 品牌别名 brandLogo String 是 品牌logo brandName String 是 品牌名称 brandRemark String 是 品牌描述 firstLettler String 是 ⾸字⺟⼤写 groupLettler String 是 所属字⺟分组 idx String 否 0 顺序 spellLettler String 是 字⺟简拼 delFlag String 是 删除标志：10是20否 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "id":"", 3 "brandAlias": "", 4 "brandLogo": "", 5 "brandName": "", 6 "brandRemark": "", 7 "firstLettler": "", 8 "groupLettler": "", 9 "idx": 0, 10 "spellLettler": "" 11 } 响应示例 18 ## Page 19 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 商品信息-上传 ● URL： /api/open ● Method： post ● 说明：外部系统将商品数据同步⾄商城,根据goodsNo判断新增/编辑操作，当记录标记为删除(delFlag=20)时，除 goodsNo参数外其余相关参数允许为空 请求参数 公共请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过10 03:07:50 分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,jsonArray格式字符 串 19 ## Page 20 bizParam说明 shopId String 店铺编码 brandId String 品牌编码 categoryId String 类⽬编码 goodsNo String 商品编号 goodsName String 商品名称 goodsTitle String 商品标题 taxRate String 税率 batchNo String 商品批次号 singleFlag String 单规格标志:10是20否 skuItemList String sku商品列表 delFlag String 是 删除标志：10是20否 skuItemList说明 specsKey String 规格名称 specsValue String 规格值 skuGoodsNo String sku商品货号 barcode String 条形码 skuStock String sku库存 priceParam String 商品价格 priceParam说明 salePrice String 商品售价：2位⼩数 oldPrice String 商品原价：2位⼩数 costPrice String 商品成本价：2位⼩数 supplierSettlePrice String 平台与供应商结算价格 memberPriceList String 商品会员价格集合 20 ## Page 21 stepPriceList String 商品阶梯价格集合 stepPriceList说明 startNum String 区间值：起始值 endNum String 区间值：结束值 price String 价格数值，2位⼩数 scale String 价格百分⽐， 0-1之间的⼩数,2位⼩数 priceMethod String 价格类型: 10直接填写数值 20填写百分⽐值,默认10 memberPriceList说明 memType String 会员类型 memLevel String 会员等级 price String 价格：2位⼩数 discount String 价格折扣：2位⼩数 请求示例 可以仅传递部分请求参数。 21 ## Page 22 JSON 复制代码 1 { 2 "categoryAlias": "", 3 "categoryIcon": "", 4 "gsCategoryAppName": "", 5 "gsCategoryFee": 0, 6 "gsCategoryLevel": 0, 7 "gsCategoryLogo": "", 8 "gsCategoryMoney": 0, 9 "gsCategoryName": "", 10 "idx": 0, 11 "parentId": "", 12 "showType": 0, 13 "taxCode": "", 14 "usefiled": 0 15 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 商品信息-价格上传 ● URL： /api/open ● Method： post ● 说明：外部系统将商品价格数据同步⾄商城 请求参数 参数 类型 是否必填 示例 描述 公共参数 22 ## Page 23 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过10 03:07:50 分钟,yyyy-MM-dd HH:mm:ss method String 是 open.goods.update 接⼝名称 Price bizParam String 是 详⻅请求示例 请求参数集合,jsonArray格式字符 串 bizParam说明 goodsNo String 是 商品编号 goodsSkuNo String 是 商品Sku编号 salePrice String 是 商品售价：2位⼩数 oldPrice String 是 商品原价：2位⼩数 costPrice String 是 商品成本价：2位⼩数 supplierSettlePrice String 是 平台与供应商结算价格 preSellPrice String 预售价格：2位⼩数 memberPriceList String 商品会员价格集合 memberPriceEdit String 是 会员价格更新标志,10更新(会员价 格集合为空则删除对应会员价 格)20不更新 stepPriceList String 商品阶梯价格集合 stepPriceEdit String 是 阶梯价格更新标志，10更新(阶梯价 格集合为空则删除对应会员价 格)20不更新 23 ## Page 24 stepPriceList说明 startNum String 区间值：起始值 endNum String 区间值：结束值 price String 价格数值，2位⼩数 scale String 价格百分⽐， 0-1之间的⼩数,2位⼩数 priceMethod String 价格类型: 10直接填写数值 20填写百分⽐值,默认10 memberPriceList说明 memType String 会员类型 memLevel String 会员等级 price String 价格：2位⼩数 discount String 价格折扣：2位⼩数 请求示例 可以仅传递部分请求参数。 24 ## Page 25 JSON 复制代码 1 { 2 "categoryAlias": "", 3 "categoryIcon": "", 4 "gsCategoryAppName": "", 5 "gsCategoryFee": 0, 6 "gsCategoryLevel": 0, 7 "gsCategoryLogo": "", 8 "gsCategoryMoney": 0, 9 "gsCategoryName": "", 10 "idx": 0, 11 "parentId": "", 12 "showType": 0, 13 "taxCode": "", 14 "usefiled": 0 15 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 商品信息-状态同步 ● URL： /api/open ● Method： post ● 说明：外部系统将通过接⼝完成商品上架/下架操作 请求参数 参数 类型 是否必填 示例 描述 25 ## Page 26 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过10 03:07:50 分钟,yyyy-MM-dd HH:mm:ss method String 是 open.goods.update 接⼝名称 State bizParam String 是 详⻅请求示例 请求参数集合,jsonArray格式字符 串 bizParam说明 goodsNoList List 是 商品编号集合 goodsState String 是 商品状态：10下架，20,上架 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "goodsState": "10", 3 "goodsNo": ["123","456"] 4 } 响应示例 26 ## Page 27 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 交易订单-订单创建-未开放 ● URL： /api/open ● Method： post ● 说明：外部系统通过接⼝完成下单操作 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过10 03:07:50 分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 27 ## Page 28 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "categoryAlias": "", 3 "categoryIcon": "", 4 "gsCategoryAppName": "", 5 "gsCategoryFee": 0, 6 "gsCategoryLevel": 0, 7 "gsCategoryLogo": "", 8 "gsCategoryMoney": 0, 9 "gsCategoryName": "", 10 "idx": 0, 11 "parentId": "", 12 "showType": 0, 13 "taxCode": "", 14 "usefiled": 0 15 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 交易订单-状态同步 外部系统将商品类⽬数据同步致商城 ● URL： /api/open ● Method： post ● 说明：外部系统将订单状态同步到商城 28 ## Page 29 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过 03:07:50 10分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.upda 接⼝名称 teState bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 bizParam说明 tradeId String 是 订单编号 tradeState String 是 订单状态 remark String 备注说明 logisticsCode String 物流单号(订单状态为已发 货,必填字段) logisticsComCo String 物流公司编码(订单状态为已 de 发货,必填字段) checkPhoneNo String 电话号码验证(收发件⼈，订 单状态为已发货,必填字段) 请求示例 29 ## Page 30 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 3 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "success": true 5 } 交易订单-订单取消 ● URL： /api/open ● Method： post ● 说明：外部系统通过接⼝取消订单 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 30 ## Page 31 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过 03:07:50 10分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 bizParam说明 tradeId String 订单流⽔编号 reasonType String 订单取消原因类型 remark String 备注说明 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "appId": "2014072300007141", 3 "bizParam": "{\"reasonType\": 10,\"remark\": \"测试订单取消\",\"tradeId \": \"O100001\"}", 4 "charset": "UTF-8", 5 "format": "json", 6 "method": "open.trade.cancel", 7 "sign": "rRj+PkfIc4V0z3l6k61EF+Jq3Pe7couikRLVcXQ5bUTtBLcEPDB9oVNq0sX45 iMEWRp0fwbD4Ng1LHT5D5QsZi4mcAsmj1ObtvHvDulK7GSsBcN5qCrkFYTaQ1Qln1Rt9ovq2qa VhwBxdAFVHP6CQnkMigtGa/4Br2yK3awzcu8=", 8 "signType": "RSA2", 9 "timestamp": "2022-02-24 03:07:50", 10 "version": "1.0" 11 } 响应示例 31 ## Page 32 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 售后订单-状态同步 ● URL： /api/open ● Method： post ● 说明：外部系统将售后单状态同步到商城,如售后退换货操作时,仓库进⾏发货/收货动作 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过 03:07:50 10分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.upda 接⼝名称 teTradeRightSta te bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 32 ## Page 33 bizParam说明 tradeId String 是 交易订单编号 tradeRightId String 是 售后单编号 tradeRightState String 是 售后单状态 logisticsCode bigdecimal(10,2) 退换货物流单号 logisticsComCod Integer 退换货物流公司编码 e remark String 备注说明 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "appId": "2014072300007141", 3 "bizParam": "{\"logisticsCode\": \"L100001\",\"logisticsComCode\": \"S F\", \"remark\": \"备注说明\",\"tradeId\": \"O100001\",\"tradeRightId\": \"TR100001\",\"tradeRightState\":10}", 4 "charset": "UTF-8", 5 "format": "json", 6 "method": "open.trade.updateTradeRightState", 7 "sign": "rRj+PkfIc4V0z3l6k61EF+Jq3Pe7couikRLVcXQ5bUTtBLcEPDB9oVNq0sX45 iMEWRp0fwbD4Ng1LHT5D5QsZi4mcAsmj1ObtvHvDulK7GSsBcN5qCrkFYTaQ1Qln1Rt9ovq2qa VhwBxdAFVHP6CQnkMigtGa/4Br2yK3awzcu8=", 8 "signType": "RSA", 9 "timestamp": "2022-02-24 03:07:50", 10 "version": "1.0" 11 } 响应示例 33 ## Page 34 条件：请求参数合法，并且⽤户身份校验通过。 状态码： 200 OK 响应示例：响应会将修改后的⽤户信息数据返回，⼀个 id 为 1234 的⽤户设置他们的姓名后将会返 回： 库存数据-上传 ● URL： /api/open ● Method： post ● 说明：外部系统将商品库存数据同步到商城 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过 03:07:50 10分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 bizParam说明 34 ## Page 35 goodsNo String 商品商品编码 skuNo String 商品SKU编码 quantity String 数量 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "appId": "2014072300007141", 3 "bizParam": "[{\"goodsNo\": \"G100001\",\"quantity\": 20, \"skuNo\": \"SKU100001\"}]", 4 "charset": "UTF-8", 5 "format": "json", 6 "method": "open.stock.updateStock", 7 "sign": "rRj+PkfIc4V0z3l6k61EF+Jq3Pe7couikRLVcXQ5bUTtBLcEPDB9oVNq0sX45 iMEWRp0fwbD4Ng1LHT5D5QsZi4mcAsmj1ObtvHvDulK7GSsBcN5qCrkFYTaQ1Qln1Rt9ovq2qa VhwBxdAFVHP6CQnkMigtGa/4Br2yK3awzcu8=", 8 "signType": "RSA", 9 "timestamp": "2022-02-24 03:07:50", 10 "version": "1.0" 11 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 会员信息-会员等级上传 35 ## Page 36 ● URL： /api/open ● Method： post ● 说明：外部系统(如会员系统)将会员等级数据同步⾄商城 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过 03:07:50 10分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 请求示例 可以仅传递部分请求参数。 36 ## Page 37 JSON 复制代码 1 { 2 "categoryAlias": "", 3 "categoryIcon": "", 4 "gsCategoryAppName": "", 5 "gsCategoryFee": 0, 6 "gsCategoryLevel": 0, 7 "gsCategoryLogo": "", 8 "gsCategoryMoney": 0, 9 "gsCategoryName": "", 10 "idx": 0, 11 "parentId": "", 12 "showType": 0, 13 "taxCode": "", 14 "usefiled": 0 15 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 会员/客户信息-基础信息上传 ● URL： /api/open ● Method： post ● 说明：外部系统(如会员系统)将会员基础数据同步⾄商城 请求参数 参数 类型 是否必填 示例 描述 公共参数 37 ## Page 38 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过 03:07:50 10分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 请求参数 参数 类型 是否必填 示例 描述 String 客户编号-登录名 String 客户名称 String 记录类型 bigdecimal(10, 渠道编码 2) Integer 开始⽇期 String 结束⽇期 bigdecimal(10, 地域标志 2) String 创建⽤户 Integer 创建⽇期 String 修改⽤户 Integer 修改⽇期 38 ## Page 39 String 登录密码 Integer 会员等级 关联系统⽤户 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "categoryAlias": "", 3 "categoryIcon": "", 4 "gsCategoryAppName": "", 5 "gsCategoryFee": 0, 6 "gsCategoryLevel": 0, 7 "gsCategoryLogo": "", 8 "gsCategoryMoney": 0, 9 "gsCategoryName": "", 10 "idx": 0, 11 "parentId": "", 12 "showType": 0, 13 "taxCode": "", 14 "usefiled": 0 15 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 会员信息-收货地址上传 39 ## Page 40 ● URL： /api/open ● Method： post ● 说明：外部系统(如会员系统)将会员的收货地址数据同步⾄商城 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过 03:07:50 10分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,json格式字符串 请求参数 参数 类型 是否必填 示例 描述 String 地址编码 String 地址信息 String 许可客户编码 bigdecimal(10, 城市代码 2) Integer 开始⽇期 40 ## Page 41 String 结束⽇期 bigdecimal(10, 地域标志 2) String 创建⽤户 Integer 创建⽇期 String 修改⽤户 Integer 修改⽇期 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "categoryAlias": "", 3 "categoryIcon": "", 4 "gsCategoryAppName": "", 5 "gsCategoryFee": 0, 6 "gsCategoryLevel": 0, 7 "gsCategoryLogo": "", 8 "gsCategoryMoney": 0, 9 "gsCategoryName": "", 10 "idx": 0, 11 "parentId": "", 12 "showType": 0, 13 "taxCode": "", 14 "usefiled": 0 15 } 响应示例 条件：请求参数合法，并且⽤户身份校验通过。 状态码： 200 OK 响应示例：响应会将修改后的⽤户信息数据返回，⼀个 id 为 1234 的⽤户设置他们的姓名后将会返 回： 41 ## Page 42 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 基础信息-⾏政区域(省市区)地址库上传 ● URL： /api/open ● Method： post ● 说明：外部系统(如WMS)将地址库数据信息同步⾄商城 请求参数 参数 类型 是否必填 示例 描述 公共参数 appId String 是 2014072300007141 商城分配的应⽤ID format String 是 json 固定值：json charset String 是 UTF-8 编码格式，固定值：UTF-8 version String 是 1.0 系统版本,固定值1.0 signType String 是 RSA2 签名算法类型,固定值，RSA2 sign String 是 详⻅签名示例 请求参数签名 timestamp String 是 2022-02-24 发送请求时间，⽹络时差不超过 03:07:50 10分钟,yyyy-MM-dd HH:mm:ss method String 是 open.trade.cancel 接⼝名称 bizParam String 是 详⻅请求示例 请求参数集合,jsonArray格式字符 串 bizParam说明 42 ## Page 43 parentCode String 是 上级编号，中国00 regionName String 是 名字 regionCode String 是 编号 level Integer 是 层级：0国家1省份2城市3乡镇 delFlag String 是 删除标志：10是20否 请求示例 可以仅传递部分请求参数。 JSON 复制代码 1 { 2 "id": "", 3 "parentCode": "", 4 "regionName": "", 5 "regionCode": 0, 6 "level": 0 7 } 响应示例 JSON 复制代码 1 { 2 "code": 0, 3 "message": "", 4 "data": true 5 } 基础信息-系统参数配置-不对外 系统参数编码 43 ## Page 44 1000：QQ登录参数配置 1001：微信开放平台登录参数配置 1002：微信公众号登录参数配置 3001：三⽅接⼝-发票对接参数 3002：三⽅接⼝-WMS对接参数 3003：三⽅接⼝-商派OMS对接 3004：三⽅接⼝-物流对接参数 3005：三⽅接⼝-OSS配置 3006：三⽅接⼝-客服平台 3007：三⽅接⼝-客服电话 4001：邮箱配置 5001：短信配置 6001：设置-基本设置 6002：设置-交易/售后设置 6003：设置-签到 6004：设置-积分 6005：设置-消息提醒 6006：设置-注册 6007：多语⾔-静态⽂件地址 系统参数属性值 1000：QQ登录参数配置 1001：微信开放平台登录参数配置 1002：微信公众号登录参数配置 3001：三⽅接⼝-发票对接参数 44 ## Page 45 3002：三⽅接⼝-WMS对接参数 3003：三⽅接⼝-商派OMS对接 3004：三⽅接⼝-物流对接参数 3005：三⽅接⼝-OSS配置 { "serviceProviderCode": "服务提供商编码： 10腾讯云,20阿⾥云"， "settingParam": {"Json格式参数配置" } } 腾讯云： { "bucketName": "存储桶", "fileHost": "⽂件⽬录", "regionId": "地域列表", "secretId": "API 密钥管理:安全凭证为密钥secretId", "secretKey": "API 密钥管理:安全凭证为密钥SecretKey" } 3006：三⽅接⼝-客服平台 3007：三⽅接⼝-客服电话 4001：邮箱配置 45 ## Page 46 { "from": "发件⼈", "host": "邮件服务器的SMTP地址", "pass": "密码", "port": "邮件服务器的SMTP端⼝", "sslEnable": "使⽤SSL安全连接:10是20否", "starttlsEnable": "使⽤ STARTTLS安全连接，STARTTLS是对纯⽂本通信协议的扩展:10是20否", "user": "⽤户名，默认为发件⼈邮箱前缀" } 5001：短信配置 { "serviceProviderCode": "服务提供商编码： 10⾏业云,20阿⾥云，30摩字，40腾讯云"， "defaultSmsCode": "默认短信验证码,正式环境该参数这是为空", "aliYun": { "mchApiKey": "", "mchApiSecret": "", "signName": "签名名称" }, "hangYeYun": { "mchApiKey": "", "mchApiSecret": "", "mchId": "", "signName": "签名名称" } } 6001：设置-基本设置 46 ## Page 47 6002：设置-交易/售后设置 6003：设置-签到 6004：设置-积分 6005：设置-消息提醒 6006：设置-注册 6007：多语⾔-静态⽂件地址 公共参数-说明补充 1. 取消原因类型 10：地址信息填写错误 20：不想要了 30：价格有点贵 40：商品错选或多选 50：商品⽆货 60：其他 2. 订单状态 47 ## Page 48 10：待⽀付 20：待发货-⽤户已⽀付 25：待发货-仓库拣货 29：部分发货 30：待收货-仓库发货 40：已完成 50：已取消 55：待评价 60：正在审核-线下⽀付审核 70：退款处理中 3. ⽀付类型 5：在线0元⽀付-不对外展示 10：⽀付宝⽹⻚扫码 20：⽀付宝APP 25：⽀付宝⼿机⽹站 30：微信扫码 40：微信公众号 50：微信APP⽀付 60：微信⼩程序⽀付 65：微信H5⽀付 70：银联PC 80：银联移动 85：Paypal⽀付 90：线下⽀付 95：授信⽀付 96：预存款⽀付 4. 售后单类型 48 ## Page 49 10：换货 20：仅退款 30：退货退款 40：取消订单 5. 售后单状态 10：⽤户申请 20：商家审核-驳回 30：商家审核-通过 40：⽤户已退货 45：商家收到退货(退款⾦额未确认) 50：商家收到退货(退款⾦额已确认) 60：退款操作商家审核通过后等待平台执⾏退款,退货操作商家退款确认之后等待平台执⾏退款 65：退款中-等待银⾏回执 70：退款完成-银⾏退款回调成功/平台操作确认 80：换货操作-等待商家发货 90：换货操作-商家已发货 91：换货操作-⽤户确认收货 95：换货/退款/退货-⽤户取消 96：平台处理投诉关闭售后 99：完成 6. 接⼝状态码-Http状态code说明 200：接⼝正常处理 300：授权/鉴权异常 500：系统定义异常 其他数值：系统异常 7. 接⼝状态码-接⼝消息code说明 49 ## Page 50 0：接⼝正常 其他数值：接⼝异常,异常描述查看msg字段 8. 快递公司编码 50