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

请求参数

名称	类型	是否必须	示例值	描述
couponStatusCode	String	N	0	店铺券状态编码（0全部状态；1处理中；2领取中；3领取结束；4未生效）
endTime	String	N	2014-07-20 21:12:21	查询结束时间。格式：yyyy-MM-dd HH:mm:ss，若输入则开始时间和结束时间必须同时出现，开始时间和结束时间间隔不大于90天, 如果时间不输入，则默认查询当前时间前三天的数据
startTime	String	N	2014-07-19 21:12:22	查询开始时间。格式：yyyy-MM-dd HH:mm:ss，若输入则开始时间和结束时间必须同时出现，开始时间和结束时间间隔不大于90天, 如果时间不输入，则默认查询当前时间前三天的数据
timeType	String	N	1	时间类型（1：创建时间；2：用券时间）

响应参数

名称	类型	示例值	描述
coupCreateTime	String	2015-10-01 08:10:18	店铺券创建时间，格式：yyyy-MM-dd HH:mm:ss
couponId	String	11111111	店铺券ID
couponName	String	国庆优惠券	店铺券名称
couponStatus	String	处理中	店铺券状态（1处理中；2领取中；3领取结束；4未生效；若不输入值则默认查询所有）
useEndTime	String	2015-10-03 23:00:00	结束用券时间，格式：yyyy-MM-dd HH:mm:ss
useStartTime	String	2015-10-01 10:00:00	开始用券时间，格式：yyyy-MM-dd HH:mm:ss

请求示例

XML示例
JSON示例

复制全部代码

                                
<sn_request>
  <sn_body>
    <queryShopCoupon>
      <startTime>2014-07-19 21:12:22</startTime>
      <endTime>2014-07-20 21:12:21</endTime>
      <timeType>1</timeType>
      <couponStatusCode>0</couponStatusCode>
    </queryShopCoupon>
  </sn_body>
</sn_request>

                                
{
  "sn_request": {
    "sn_body": {
      "queryShopCoupon": {
        "startTime": "2014-07-19 21:12:22",
        "endTime": "2014-07-20 21:12:21",
        "timeType": "1",
        "couponStatusCode": "0"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              
<sn_responseContent>
  <sn_body>
    <queryShopCoupon>
      <couponName>国庆优惠券</couponName>
      <couponStatus>处理中</couponStatus>
      <useEndTime>2015-10-03 23:00:00</useEndTime>
      <useStartTime>2015-10-01 10:00:00</useStartTime>
      <coupCreateTime>2015-10-01 08:10:18</coupCreateTime>
      <couponId>11111111</couponId>
    </queryShopCoupon>
  </sn_body>
  <sn_head>
    <pageTotal>1</pageTotal>
    <pageNo>1</pageNo>
    <totalSize>1</totalSize>
    <returnMessage>biz.handler.data-get:success</returnMessage>
  </sn_head>
</sn_responseContent>

                              
{
  "sn_responseContent": {
    "sn_head": {
      "pageTotal": "1",
      "pageNo": "1",
      "totalSize": "1",
      "returnMessage": "biz.handler.data-get:success"
    },
    "sn_body": {
      "queryShopCoupon": {
        "couponName": "国庆优惠券",
        "couponStatus": "处理中",
        "useStartTime": "2015-10-01 10:00:00",
        "useEndTime": "2015-10-03 23:00:00",
        "coupCreateTime": "2015-10-01 08:10:18",
        "couponId": "11111111"
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.custom.queryshopcoupon.format-error:*	格式错误,*表示字段名	请输入正确参数。
biz.custom.queryshopcoupon.missing-parameter:*	缺少必填参数,*表示字段名	请输入正确参数。
isp.sys.service.unavailable.sel	服务不可用（系统异常）	请联系苏宁技术人员。

公共异常码

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

Q：店铺优惠券活动批量查询接口如何使用？

A：通过此接口可对店铺优惠券活动批量查询