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

请求参数

名称	类型	是否必须	示例值	描述
activityCode	String	Y	AT230828115210000109	招商活动编码

响应参数

名称	类型	示例值	描述
activityCode	String	AT230828115210000109	活动编码
activityType	String	65	活动类型： 65-品牌券
activityName	String	双十一南京大区品牌券招商	活动名称
activityStatus	String	01	活动状态： 00-报名未开始； 01-报名中；02-报名结束；03-报名取消
activityStatusDesc	String	报名结束	活动状态字段对应的中文描述
activityStartTime	String	2022-08-01 00:00:00	活动开始时间：yyyy-mm-dd hh:mm:ss
activityEndTime	String	2022-08-01 00:00:00	活动结束时间：yyyy-mm-dd hh:mm:ss
registryStartTime	String	2022-08-01 00:00:00	报名开始时间：yyyy-mm-dd hh:mm:ss
registryEndTime	String	2022-08-01 00:00:00	报名结束时间：yyyy-mm-dd hh:mm:ss
couponActPlayRule	String
actZoneList	String
regionCode	String	10001	大区编码
regionName	String	南京大区	大区名称
storeCode	String	70IE	门店编码
storeName	String	玄武徐庄店	门店名称
effectZoneList	String
regionCode	String	10001	大区编码
regionName	String	南京大区	大区名称
storeCode	String	70IE	门店编码
storeName	String	玄武徐庄店	门店名称
rewardProvideType	String	3	券领取方式： 3-免费领券； 38-店+发券
couponType	String	10002	券类型： 10002-平台云券； 10005-平台易券
startTime	String	2022-08-01 00:00:00	领券开始时间：yyyy-mm-dd hh:mm:ss
endTime	String	2022-08-01 00:00:00	领券结束时间：yyyy-mm-dd hh:mm:ss
effectStartTime	String	2022-08-01 00:00:00	使用开始时间：yyyy-mm-dd hh:mm:ss
effectEndTime	String	2022-08-01 00:00:00	使用结束时间：yyyy-mm-dd hh:mm:ss
rewardAmount	String	999	券面额
preferentialDistinct	String	满1000元用20元	券使用规则描述
activityTimesLimit	String	99	总次数
dayTimesLimit	String	99	每天活动次数
peopleDayTimesLimit	String	99	每会员每天次数
peopleActivityTimesLimit	String	99	每会员活动期间次数

请求示例

XML示例
JSON示例

复制全部代码

                                <sn_request>
  <sn_body>
    <getUlplatformactivity>
      <activityCode>AT230828115210000109</activityCode>
    </getUlplatformactivity>
  </sn_body>
</sn_request>

                                {
  "sn_request": {
    "sn_body": {
      "getUlplatformactivity": {
        "activityCode": "AT230828115210000109"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              <sn_responseContent>
  <sn_body>
    <getUlplatformactivity>
      <activityCode>AT230828115210000109</activityCode>
      <activityEndTime>2022-08-01 00:00:00</activityEndTime>
      <activityStatusDesc>报名结束</activityStatusDesc>
      <registryStartTime>2022-08-01 00:00:00</registryStartTime>
      <activityName>双十一南京大区品牌券招商</activityName>
      <activityStatus>01</activityStatus>
      <couponActPlayRule>
        <effectStartTime>2022-08-01 00:00:00</effectStartTime>
        <dayTimesLimit>99</dayTimesLimit>
        <effectEndTime>2022-08-01 00:00:00</effectEndTime>
        <actZoneList>
          <regionCode>10001</regionCode>
          <regionName>南京大区</regionName>
          <storeName>玄武徐庄店</storeName>
          <storeCode>70IE</storeCode>
        </actZoneList>
        <rewardProvideType>3</rewardProvideType>
        <preferentialDistinct>满1000元用20元</preferentialDistinct>
        <peopleDayTimesLimit>99</peopleDayTimesLimit>
        <peopleActivityTimesLimit>99</peopleActivityTimesLimit>
        <couponType>10002</couponType>
        <activityTimesLimit>99</activityTimesLimit>
        <startTime>2022-08-01 00:00:00</startTime>
        <endTime>2022-08-01 00:00:00</endTime>
        <rewardAmount>999</rewardAmount>
        <effectZoneList>
          <regionCode>10001</regionCode>
          <regionName>南京大区</regionName>
          <storeName>玄武徐庄店</storeName>
          <storeCode>70IE</storeCode>
        </effectZoneList>
      </couponActPlayRule>
      <activityStartTime>2022-08-01 00:00:00</activityStartTime>
      <registryEndTime>2022-08-01 00:00:00</registryEndTime>
      <activityType>65</activityType>
    </getUlplatformactivity>
  </sn_body>
</sn_responseContent>

                              {
  "sn_responseContent": {
    "sn_body": {
      "getUlplatformactivity": {
        "activityCode": "AT230828115210000109",
        "activityEndTime": "2022-08-01 00:00:00",
        "activityStatusDesc": "报名结束",
        "registryStartTime": "2022-08-01 00:00:00",
        "activityName": "双十一南京大区品牌券招商",
        "activityStatus": "01",
        "couponActPlayRule": [
          {
            "effectStartTime": "2022-08-01 00:00:00",
            "dayTimesLimit": "99",
            "effectEndTime": "2022-08-01 00:00:00",
            "actZoneList": [
              {
                "regionCode": "10001",
                "regionName": "南京大区",
                "storeName": "玄武徐庄店",
                "storeCode": "70IE"
              }
            ],
            "rewardProvideType": "3",
            "preferentialDistinct": "满1000元用20元",
            "peopleDayTimesLimit": "99",
            "peopleActivityTimesLimit": "99",
            "couponType": "10002",
            "activityTimesLimit": "99",
            "startTime": "2022-08-01 00:00:00",
            "endTime": "2022-08-01 00:00:00",
            "rewardAmount": "999",
            "effectZoneList": [
              {
                "regionCode": "10001",
                "regionName": "南京大区",
                "storeName": "玄武徐庄店",
                "storeCode": "70IE"
              }
            ]
          }
        ],
        "activityStartTime": "2022-08-01 00:00:00",
        "registryEndTime": "2022-08-01 00:00:00",
        "activityType": "65"
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.custom.getulplatformactivity.missing-parameter:*	参数必填	请检查此参数的值,*号表示参数字段名
biz.custom.getulplatformactivity.format-error:*	参数格式错误	请检查此参数的值,*号表示参数字段名
biz.handler.data-get:no-result	查询没结果	请检查查询参数
isp.sys.service.unavailable.dmas	服务不可用	请联系苏宁技术人员

公共异常码

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