开放服务-API列表

通过此接口可批量获取三个月内的退货信息。
1、开始时间与结束时间间隔不超过30天；
2、页码和每页条数必须同时填写方可生效，否则将默认返回第1页、10条内容；
3、返回结果分页展示，通过请求参数的页码可以定位到具体第几页，每页条数控制每页返回的条数；
4、返回的苏宁商品编码为商品在苏宁产品库对应的苏宁商品编码，商品编码可依据苏宁商品编码，通过平台业务-商品服务-获取我的商品库信息接口获取；
5、返回物流公司代码，物流公司名称可通过平台业务-交易服务-获取物流公司代码接口对应获取；

公共参数

名称	类型	是否必须	示例值	描述
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-10-20 00:00:00	查询退货状态修改开始时间。格式：yyyy-MM-dd HH:mm：ss
endTime	String	Y	2013-10-26 00:00:00	查询退货状态修改结束时间。格式：yyyy-MM-dd HH:mm：ss
pageSize	String	Y	10	每页条数
pageNo	String	Y	2	页码

响应参数

名称	类型	示例值	描述
orderCode	String	null	B2C订单号
productCode	String	null	苏宁商品编码
customer	String	null	买家帐号
dealMoney	String	null	交易金额
returnMoney	String	null	实际退款金额
applyTime	String	null	申请时间,格式：yyyy-MM-dd HH:mm：ss
statusPassTime	String	null	倒计时时间,格式：yyyy-MM-dd HH:mm：ss
statusDesc	String	null	订单状态。 1-退款待处理； 2-已拒绝退款； 3-待买家发货； 4-待商家收货； 5-退款失败； 6-退款处理中； 7-退款关闭； 8-退款成功。
returnReason	String	null	退货原因
expressCompanyCode	String	null	物流公司代码
expressNo	String	null	物流公司运单号
returntype	String	null	2表示货未发、3表示货已发未收、4表示货已收
refundtype	String	null	空表示退货、1表示仅退款

请求示例

XML示例
JSON示例

复制全部代码

                                <sn_request> 
  <sn_body> 
    <batchQueryRejected> 
      <startTime>2013-10-20 00:00:00</startTime>  
      <endTime>2013-10-26 00:00:00</endTime>  
      <pageNo>1</pageNo>  
      <pageSize>2</pageSize> 
    </batchQueryRejected> 
  </sn_body> 
</sn_request>

                                {
  "sn_request": {
    "sn_body": {
      "batchQueryRejected": {
        "startTime": "2013-10-20 00:00:00",
        "endTime": "2013-10-26 00:00:00",
        "pageNo": "1",
        "pageSize": "2"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              <sn_responseContent> 
  <sn_head> 
    <pageNo>1</pageNo>  
    <pageTotal>3</pageTotal>  
    <returnMessage>biz.handler.data-get:success</returnMessage> 
  </sn_head>  
  <sn_body> 
    <batchQueryRejected> 
      <orderCode>2000532010</orderCode>  
      <productCode>102609934</productCode>  
      <customer>17817800005</customer>  
      <dealMoney>188.00</dealMoney>  
      <returnMoney>188.00</returnMoney>  
      <applyTime>2013-10-21 11:02:35</applyTime>  
      <statusPassTime>2013-10-28 11:18:31</statusPassTime>  
      <statusDesc>卖家不同意协议, 等待买家投诉</statusDesc>  
      <returnReason>发票问题</returnReason>  
      <expressCompanyCode>A01</expressCompanyCode>  
      <expressNo>ssssssss</expressNo>
      <returntype>2</returntype>
      <refundtype>1</refundtype> 
    </batchQueryRejected>  
    <batchQueryRejected> 
      <orderCode>2000532016</orderCode>  
      <productCode>102609934</productCode>  
      <customer>17817800005</customer>  
      <dealMoney>188.00</dealMoney>  
      <returnMoney>188.00</returnMoney>  
      <applyTime>2013-10-21 11:36:03</applyTime>  
      <statusPassTime>2013-10-28 11:40:23</statusPassTime>  
      <statusDesc>卖家不同意协议, 等待买家投诉</statusDesc>  
      <returnReason>其他</returnReason>  
      <expressCompanyCode>A01</expressCompanyCode>  
      <expressNo>111111111</expressNo>
      <returntype>2</returntype>
      <refundtype>1</refundtype>  
    </batchQueryRejected> 
  </sn_body> 
</sn_responseContent>

                              {
  "sn_responseContent": {
    "sn_head": {
      "pageNo": "1",
      "pageTotal": "3",
      "returnMessage": "biz.handler.data-get:success"
    },
    "sn_body": {
      "batchQueryRejected": [
        {
          "orderCode": "2000532010",
          "productCode": "102609934",
          "customer": "17817800005",
          "dealMoney": "188.00",
          "returnMoney": "188.00",
          "applyTime": "2013-10-21 11:02:35",
          "statusPassTime": "2013-10-28 11:18:31",
          "statusDesc": "卖家不同意协议, 等待买家投诉",
          "returnReason": "发票问题",
          "expressCompanyCode": "A01",
          "expressNo": "ssssssss",
          "returntype":"2",
          "refundtype":"1"
        },
        {
          "orderCode": "2000532016",
          "productCode": "102609934",
          "customer": "17817800005",
          "dealMoney": "188.00",
          "returnMoney": "188.00",
          "applyTime": "2013-10-21 11:36:03",
          "statusPassTime": "2013-10-28 11:40:23",
          "statusDesc": "卖家不同意协议, 等待买家投诉",
          "returnReason": "其他",
          "expressCompanyCode": "A01",
          "expressNo": "111111111",
          "returntype":"2",
          "refundtype":"1"
        }
      ]
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
sys.check.query-time:error	时间错误	传入正确的时间
sys.check.query-time:outofrange	时间超过设置范围	开始时间与结束时间间隔不超过30天
biz.orderquery.startTime-format:error	查询开始时间格式不对	使用正确的时间格式，如 2012-06-20 00:00:00
biz.queryBatchReturnServer.endTime-format error	查询结束时间格式不对	使用正确的时间格式，如 2012-06-20 00:00:00
biz.orderquery.time-value:outofrange	查询日期超过接口范围	请检查输入的日期，需在三个月内
sys.check.starttime-value:null	交易开始时间为空	时间必填
sys.check.endtime-value:null	交易结束时间为空	时间必填

公共异常码

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