开放服务-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授权方式为必填参数

请求参数

名称	类型	是否必须	示例值	描述
startTime	String	Y	2013-12-20 00:00:00	查询修改开始时间(修改时间跨度不能大于一天)。格式:yyyy-MM-dd HH:mm:ss
endTime	String	Y	2013-12-27 00:00:00	查询修改结束时间，必须大于修改开始时间(修改时间跨度不能大于一天)，格式:yyyy-MM-dd HH:mm:ss。
orderLineStatus	String	N	C040	C030:客户申请退货;C040:商家同意退货;C041:商家拒绝退货;C050:商家同意退款;C051:商家拒绝退款;C055:商家延期退款;C060:客户寄货;C070:系统关闭退货请求;C075:客服关闭退货;C080:客服叫停;C110:自动退款;C130:退款成功;C131:退款失败
pageNo	String	N	1	当前页码，1到99999之间，当前页码或者每页数量其中一个不填则当前页码默认1，每页数量默认为10
pageSize	String	N	10	每页数量，1到100之间，当前页码或者每页数量其中一个不填则当前页码默认1，每页数量默认为10

响应参数

名称	类型	示例值	描述
orderCode	String		B2C订单号
orderLineNumber	String		订单行项目号
productCode	String		苏宁商品编码
itemCode	String		商家商品编码
customer	String		买家帐号
dealMoney	String		订单付款金额
returnMoney	String		实际退款金额
applyTime	String		申请时间。格式：yyyy-MM-dd HH:mm：ss。
statusPassTime	String		倒计时时间。格式：yyyy-MM-dd HH:mm：ss。
orderStatusChangeTime	String		订单状态变更时间。格式：yyyy-MM-dd HH:mm：ss。
statusDesc	String		订单行项目状态
returnReason	String		退货原因
expressCompanyCode	String		物流公司代码
expressNo	String		运单号
returntype	String	null	2表示货未发、3表示货已发未收、4表示货已收
refundtype	String	null	空表示退货、1表示仅退款

请求示例

XML示例
JSON示例

复制全部代码

                                <sn_request> 
  <sn_body> 
    <batchQueryRejected> 
      <startTime>2014-03-06 04:22:22</startTime>  
      <endTime>2014-03-06 06:22:22</endTime>  
      <orderLineStatus>C040</orderLineStatus>
      <pageNo/>  
      <pageSize/> 
    </batchQueryRejected> 
  </sn_body> 
</sn_request>

                                {
  "sn_request": {
    "sn_body": {
      "batchQueryRejected": {
        "startTime": "2014-03-06 04:22:22",
        "endTime": "2014-03-06 06:22:22",
        "orderLineStatus": "C040",
        "pageNo": "",
        "pageSize": ""
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              <sn_responseContent> 
  <sn_head> 
    <pageNo>1</pageNo>  
    <pageTotal>1</pageTotal>  
    <returnMessage>biz.handler.data-get:success</returnMessage> 
  </sn_head>  
  <sn_body> 
    <batchQueryRejected> 
      <orderCode>2006573302</orderCode>  
      <orderLineNumber>00007503671601</orderLineNumber>
      <productCode>104460520</productCode>  
      <itemCode/>
      <customer>zjlyl@163.com</customer>  
      <dealMoney>0.04</dealMoney>  
      <returnMoney>0.04</returnMoney>  
      <applyTime>2014-03-06 05:46:57</applyTime>  
      <statusPassTime>2014-03-13 05:47:39</statusPassTime>  
      <orderStatusChangeTime>2014-03-06 05:47:39</orderStatusChangeTime>  
      <statusDesc>C040</statusDesc>  
      <returnReason>商品错发/漏发</returnReason>  
      <expressCompanyCode/>  
      <expressNo/> 
      <returntype>2</returntype>
      <refundtype>1</refundtype>
    </batchQueryRejected>  
    <batchQueryRejected> 
      <orderCode>2006573302</orderCode>  
      <orderLineNumber>00007503671601</orderLineNumber>
      <productCode>104460520</productCode>  
      <itemCode/>
      <customer>zjlyl@163.com</customer>  
      <dealMoney>0.04</dealMoney>  
      <returnMoney>0.04</returnMoney>  
      <applyTime>2014-03-06 05:46:57</applyTime>  
      <statusPassTime>2014-03-13 05:47:39</statusPassTime>  
      <orderStatusChangeTime>2014-03-06 05:47:39</orderStatusChangeTime>  
      <statusDesc>C040</statusDesc>  
      <returnReason>商品错发/漏发</returnReason>  
      <expressCompanyCode/>  
      <expressNo/> 
      <returntype>2</returntype>
      <refundtype>1</refundtype>
    </batchQueryRejected>   
  </sn_body> 
</sn_responseContent>

                              {
  "sn_responseContent": {
    "sn_head": {
      "pageNo": "1",
      "pageTotal": "1",
      "returnMessage": "biz.handler.data-get:success"
    },
    "sn_body": {
      "batchQueryRejected": [
        {
          "orderCode": "2006573302",
          "orderLineNumber": "00007503671601",
          "productCode": "104460520",
          "customer": "zjlyl@163.com",
          "dealMoney": "0.04",
          "returnMoney": "0.04",
          "applyTime": "2014-03-06 05:46:57",
          "statusPassTime": "2014-03-13 05:47:39",
          "orderStatusChangeTime": "2014-03-06 05:47:39",
          "statusDesc": "C040",
          "returnReason": "商品错发/漏发",
          "returntype":"2",
          "refundtype":"1"
        },
        {
          "orderCode": "2006573302",
          "orderLineNumber": "00007503671601",
          "productCode": "104460520",
          "customer": "zjlyl@163.com",
          "dealMoney": "0.04",
          "returnMoney": "0.04",
          "applyTime": "2014-03-06 05:46:57",
          "statusPassTime": "2014-03-13 05:47:39",
          "orderStatusChangeTime": "2014-03-06 05:47:39",
          "statusDesc": "C040",
          "returnReason": "商品错发/漏发",
          "returntype":"2",
          "refundtype":"1"
        }
      ]
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.batchQueryRejected.missing-parameter:startTime	开始时间不能为空	检查开始时间字段值
biz.batchQueryRejected.missing-parameter:endTime	结束时间不能为空	检查结束时间字段值
biz.custom.order.invalid-biz:startTime	1.开始时间格式有误，格式应为yyyy-MM-dd HH:mm:ss 2.开始时间应在当前时间之前的三个月内	检查开始时间字段值
biz.custom.order.invalid-biz:endTime	1.结束时间格式有误，格式应为yyyy-MM-dd HH:mm:ss 2.开始时间与结束时间间隔不能超过1天 3.开始时间晚于结束时间	检查结束时间字段值
biz.custom.order.invalid-biz:orderLineStatus	订单行项目状态未输入指定的值。（C030:客户申请退货;C040:商家同意退货;C041:商家拒绝退货;C050:商家同意退款;C051:商家拒绝退款;C055:商家延期退款;C060:客户寄货;C070:系统关闭退货请求;C075:客服关闭退货;C080:客服叫停;C110:自动退款;C130:退款成功;C131:退款失败）	检查订单行项目状态字段值
biz.handler.data-get:no-result	查询无结果	查询无结果

公共异常码

异常码	错误描述	解决方案
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