开放服务-API列表

名称	类型	是否必须	示例值	描述
appMethod	String	Y	suning.custom.category.query	方法名
appRequestTime	String	Y	2012-04-25 20:23:30	时间戳，格式为yyyy-MM-dd HH:mm:ss，例如：2012-04-25 20:23:30。API服务端允许客户端请求时间误差为10分钟。
format	String	N	XML	默认xml,可指定格式为xml,json
appKey	String	Y	b0c332a133c102765f39de**********	分配给应用的访问令牌
versionNo	String	Y	v1.2	API的版本，目前为v1.2版本
signInfo	String	Y	460d7ff15b073e463125b4**********	appSecret,appMethod ,appRequestTime, appKey, versionNo, 请求报文base64加密后的数据顺序MD5(32位小写)，其中appSecret为appKey对应的密钥
access_token	String	N	a1c5c62b08df3a3cbf7efd**********	采用OAuth授权方式为必填参数

请求参数

名称	类型	是否必须	示例值	描述
pageNo	String	Y	1	页码
pageSize	String	Y	10	每页条数
supplierCode	String	Y	10000020	商家编码
exchangeStatus	String	N	WAIT_SELLER_AGREE	换货状态
startTime	String	N	2018-12-12 12:00:00	开始时间
endTime	String	N	2018-12-12 12:00:00	开始时间

响应参数

名称	类型	示例值	描述
orderCode	String	2005421502	B2C订单号
omsOrderItemNo	String	00005196454302	销售订单行号(OMS行号)
workordernum	String	S000041982	换货请求号
exchangeStatus	String	WAIT_SELLER_AGREE	换货状态值
exchangeStatusDesc	String	换货待处理	换货状态描述
createTime	String	2018-12-12 12:00:00	换货申请时间
countDownTime	String	2018-12-12 12:00:00	倒计时截止时间
updateTime	String	2018-12-12 12:00:00	状态修改时间
exchangereason	String	缺货	换货原因
exchangenum	String	1	换货数量
changeType	String	1	换异型标识1：同型 2：异型
exchangecmmdtyName	String	老板消毒柜ZTD100B-810五重净化消毒	换货商品名称
suningCmmdtyCode	String	101721351	换货申请中的苏宁商品编码
exchangecmmdtyCode	String	101721351	换货商家商品编码
saleqty	String	1	交易数量
cmmdtyName	String	老板消毒柜ZTD100B-810五重净化消毒	原销售商品名称
cmmdtyCode	String	101721351	原销售苏宁商品编码
supplierCmmdtyCode	String	101721351	原销售商家商品编码
status	String	10	10 待发货；40 已发货； 45 已代顾客确认收货；50 顾客已收货
customername	String	张	收件人姓名
custmobphone	String	12345678901	收件人电话
returnAddress	String	南京市	收件人地址
expressCompanyName	String	德邦	退货快递公司
expressCompanyCode	String	D01	退货快递编码
userName	String	买家昵称	买家昵称
expressNo	String	1111111	物流单号

请求示例

XML示例
JSON示例

复制全部代码

                                
<sn_request>
  <sn_body>
    <queryExchangegoods>
      <exchangeStatus>WAIT_SELLER_AGREE</exchangeStatus>
      <pageNo>1</pageNo>
      <pageSize>10</pageSize>
      <startTime>2018-12-12 12:00:00</startTime>
      <endTime>2018-12-12 12:00:00</endTime>
      <supplierCode>10000020</supplierCode>
    </queryExchangegoods>
  </sn_body>
</sn_request>

                                
{
  "sn_request": {
    "sn_body": {
      "queryExchangegoods": {
        "exchangeStatus": "WAIT_SELLER_AGREE",
        "pageNo": "1",
        "pageSize": "10",
        "startTime": "2018-12-12 12:00:00",
        "endTime": "2018-12-12 12:00:00",
        "supplierCode": "10000020"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              
<sn_responseContent>
  <sn_head>
    <totalSize>1</totalSize>
    <pageTotal>1</pageTotal>
    <pageNo>1</pageNo>
    <returnMessage>biz.handler.data-get:success</returnMessage>
  </sn_head>
  <sn_body>
    <queryExchangegoods>
      <custmobphone>12345678901</custmobphone>
      <expressNo>1111111</expressNo>
      <cmmdtyCode>101721351</cmmdtyCode>
      <expressCompanyCode>D01</expressCompanyCode>
      <omsOrderItemNo>00005196454302</omsOrderItemNo>
      <exchangecmmdtyName>老板消毒柜ZTD100B-810五重净化消毒</exchangecmmdtyName>
      <countDownTime>2018-12-12 12:00:00</countDownTime>
      <returnAddress>南京市</returnAddress>
      <exchangereason>缺货</exchangereason>
      <suningCmmdtyCode>101721351</suningCmmdtyCode>
      <exchangeStatus>WAIT_SELLER_AGREE</exchangeStatus>
      <workordernum>S000041982</workordernum>
      <saleqty>1</saleqty>
      <customername>张</customername>
      <supplierCmmdtyCode>101721351 </supplierCmmdtyCode>
      <exchangenum>1</exchangenum>
      <changeType>1</changeType>
      <cmmdtyName>老板消毒柜ZTD100B-810五重净化消毒</cmmdtyName>
      <updateTime>2018-12-12 12:00:00</updateTime>
      <userName>买家昵称</userName>
      <exchangecmmdtyCode>101721351</exchangecmmdtyCode>
      <expressCompanyName>德邦</expressCompanyName>
      <exchangeStatusDesc>换货待处理</exchangeStatusDesc>
      <createTime>2018-12-12 12:00:00</createTime>
      <orderCode>2005421502</orderCode>
      <status>10</status>
    </queryExchangegoods>
  </sn_body>
</sn_responseContent>

                              
{
  "sn_responseContent": {
    "sn_head": {
      "totalSize": "1",
      "pageTotal": "1",
      "pageNo": "1",
      "returnMessage": "biz.handler.data-get:success"
    },
    "sn_body": {
      "queryExchangegoods": [
        {
          "custmobphone": "12345678901",
          "expressNo": "1111111",
          "cmmdtyCode": "101721351",
          "expressCompanyCode": "D01",
          "omsOrderItemNo": "00005196454302",
          "exchangecmmdtyName": "老板消毒柜ZTD100B-810五重净化消毒",
          "countDownTime": "2018-12-12 12:00:00",
          "returnAddress": "南京市",
          "exchangereason": "缺货",
          "suningCmmdtyCode": "101721351",
          "exchangeStatus": "WAIT_SELLER_AGREE",
          "workordernum": "S000041982",
          "saleqty": "1",
          "customername": "张",
          "supplierCmmdtyCode": "101721351 ",
          "exchangenum": "1",
          "changeType": "1",
          "cmmdtyName": "老板消毒柜ZTD100B-810五重净化消毒",
          "updateTime": "2018-12-12 12:00:00",
          "userName": "买家昵称",
          "exchangecmmdtyCode": "101721351",
          "expressCompanyName": "德邦",
          "exchangeStatusDesc": "换货待处理",
          "createTime": "2018-12-12 12:00:00",
          "orderCode": "2005421502",
          "status": "10"
        }
      ]
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

{
  "sn_responseContent": {
    "sn_error": {
      "error_code": "API异常码",
      "error_msg": "异常码中文描述"
    }
  }
}

业务异常码

异常码	错误描述	解决方案
biz.selfmarket.queryexchangegoods.missing-parameter:*	参数必填	请检查此参数的值,*号表示参数字段名
biz.handler.data-get:no-result	查询没结果	请检查查询参数
isp.sys.service.unavailable.somp	服务不可用	请联系苏宁技术人员
biz.selfmarket.queryexchangegoods.invalid-biz:100	查询无结果	请检查查询条件
biz.selfmarket.queryexchangegoods.invalid-biz:101	供应商编码不能为空.	请检查查询条件
biz.selfmarket.queryexchangegoods.invalid-biz:102	页数不能为空.	请检查查询条件
biz.selfmarket.queryexchangegoods.invalid-biz:103	每页数量不能为空.	请检查查询条件
biz.selfmarket.queryexchangegoods.invalid-biz:104	开始时间格式不符合yyyy-MM-dd HH:mm:ss.	请检查查询条件
biz.selfmarket.queryexchangegoods.invalid-biz:105	结束时间格式不符合yyyy-MM-dd HH:mm:ss.	请检查查询条件
biz.selfmarket.queryexchangegoods.invalid-biz:106	换货状态不是枚举值中的一个.	请确认状态是否是WAIT_SELLER_AGREE,WAIT_BUYER_RETURN_GOODS,WAIT_SELLER_DELIVER_GOODS,WAIT_BUYER_CONFIRM_GOODS,SELLER_REFUSED,SUCCESS,CLOSED中的一个
biz.selfmarket.queryexchangegoods.format-error:*	参数格式错误	请检查此参数的值,*号表示参数字段名
biz.selfmarket.queryexchangegoods.invalid-biz:107	开始时间结束时间只能同时存在或者都不存在.	请确认开始时间和结束时间.

公共异常码

异常码	错误描述	解决方案
sys.check.user-permission:inexistence	访问令牌不存在	更换访问令牌
sys.check.user-permission:overdue	访问令牌已过期	请使用刷新令牌刷新
sys.check.api-permission:inexistence	Api方法不存在	请参考帮助中心
sys.check.api-permission:overdue	Api方法已过期	请参考帮助中心
sys.check.method-permission:authority	无权操作此api	确认是否有访问该方法权限
sys.auth.vendor-request:errory	无权操作此供应商	请确认供应商编码是否正确
sys.controller.api-request:limit	Api请求受控	超过请求次数
sys.check.app-time:error	请求参数错误api请求时间误差大	参考帮助中心
sys.check.request-params:error	请求报文结构错误	参考帮助中心、日期格式等
sys.check.starttime-format:error	请求开始时间错误	参考帮助中心、日期格式等
biz.handler.data-get:success	业务数据查询成功	无
biz.handler.data-get:fail	业务数据查询失败	检查请求条件
biz.handler.data-get:no-result	业务数据结果为空	无
sys.check.pageno-format:error	pageNo格式错误，只允许1到99999之间的整数	检查pageNo输入是否有误
sys.check.pagesize-format:error	pageSize格式错误，只允许1到50之间的整数(订单相关是1到100)	检查pageSize输入是否有误
sys.check.page-param:error	pageNo或者pageSize不在要求范围内，pageNo只允许1到99999之间的整数，pageSize只允许1到50之间的整数(订单相关是1到100)	检查pageNo和pageSize输入是否有误
sys.check.miss-time:starttime	不存在开始时间(节点)	检查输入
sys.check.miss-time:endtime	不存在结束时间(节点)	检查输入
sys.check.starttime-value:null	开始时间为空(值)	检查输入
sys.check.endtime-value:null	结束时间为空(值)	检查输入
sys.check.starttime-format:error	校验开始时间不合法，格式yyyy-MM-dd HH:mm:ss	检查时间格式
sys.check.endtime-format:error	校验结束时间不合法，格式yyyy-MM-dd HH:mm:ss	检查时间格式
sys.check.query-time:error	开始时间是否小于结束时间	检查开始和结束时间大小
sys.check.query-time:outofrange	时间查询是否超出指定范围	检查时间范围
sys.check.app-sign:null	签名信息为空	检查签名信息
sys.check.app-sign:error	签名信息错误	检查签名信息
sys.check.missing-parameter:apiversion	API版本号未指定	检查API版本号
sys.check.missing-parameter:appRequestTime	请求时间丢失	检查请求时间
sys.check.missing-nestElement:sn_body	缺少sn_body节点	检查sn_body是否存在
sys.check.user-permission:inexistence	用户key不存在	检查用户key是否存在
biz.handler.batch-handler:no-support	非查询类API不支持批量操作	检查API类型
biz.handler.request-message:error	查询类API输入多个业务节点	检查业务节点
sys.check.header-param:null	header参数为空	请检查header参数
sys.controller.api-access:limit	访问限制	无
sys.controller.api-frequency:limit	访问频率限制	无
sys.error.network:failure	网络异常	无
sys.error.network-status:?	响应失败 ?为状态码	无
sys.check.snunionid.length.is.not:48	混淆会员编码长度不是48位	使用转换器转换混淆会员编码规定要求混淆会员编码48位

API工具

API TOOLS 在线测试工具异常码查询工具 SDK调用示例 SDK下载

FAQ