开放服务-API列表

商户云钻活动进行中，但云钻余额即将不足时，为保证活动的正常进行，商户追加活动云钻额度。
1.   活动申请成功后，只能对活动额度进行追加，其他不可修改。
2.   商户会员账号是否锁定，不影响活动额度的追加。且追加不影响活动的状态，即活动仍能正常进行。
3.   只要活动存在且未下架，均可对活动额度进行追加。
4.   根据商户会员编号、活动类型、活动编码，检查活动存在性。如果活动不存在，那么提示“活动不存在”。
5.   检查活动状态，只有未开始、进行中的活动可修改活动额度，已下架的活动不可。如果检查活动已下架，那么提示“活动已下架，不可追加额度”。
6.   支持同一个活动额度多次追加。
7.   商户云钻账户余额是否足够的检查。如果追加额>商户云钻余额，那么提示“商户云钻账户余额不足”。
8.   商户云钻账户余额充足时，扣除商户云钻账户额度，再增加商户对应活动的额度，并分别记录商户云钻变化明细、活动云钻变化明细返回成功。活动有效期保持不变。
9.   支持未生效活动，修改失效日期。
10.   仅活动是未生效状态，且修改时间距离活动生效时间10分钟以上，才可修改活动失效日期。
11.   若活动非未生效状态，或修改时间距离活动生效时间10分钟以内，那么报错“仅支持活动生效前10分钟，修改未生效活动！”

公共参数

名称	类型	是否必须	示例值	描述
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授权方式为必填参数

请求参数

名称	类型	是否必须	示例值	描述
amountAdd	String	N	10000	追加额度（正整数）
endDate	String	N	1571019600000	失效时间(时间戳，仅当活动未生效时可以修改失效时间，活动生效后不能填写)
remarks	String	N	追加云钻10000个	活动说明
activityCode	String	Y	428556070773030941	活动编码（活动创建时返回的编码）

响应参数

名称	类型	示例值	描述
status	String	COMPLETE	服务状态

请求示例

XML示例
JSON示例

复制全部代码

                                
<sn_request>
  <sn_body>
    <addSupplieractivity>
      <activityCode>428556070773030941</activityCode>
      <amountAdd>10000</amountAdd>
      <endDate>1571019600000</endDate>
      <remarks>追加云钻10000个</remarks>
    </addSupplieractivity>
  </sn_body>
</sn_request>

                                
{
  "sn_request": {
    "sn_body": {
      "addSupplieractivity": {
        "activityCode": "428556070773030941",
        "amountAdd": "10000",
        "endDate": "1571019600000",
        "remarks": "追加云钻10000个"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              
<sn_responseContent>
  <sn_body>
    <addSupplieractivity>
      <status>COMPLETE</status>
    </addSupplieractivity>
  </sn_body>
</sn_responseContent>

                              
{
  "sn_responseContent": {
    "sn_body": {
      "addSupplieractivity": {
        "status": "COMPLETE"
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.custom.addsupplieractivity.missing-parameter:*	参数必填	请检查此参数的值,*号表示参数字段名
isp.sys.service.unavailable.qqs	服务不可用	请联系苏宁技术人员
biz.custom.addsupplieractivity.invalid-biz:101	活动不存在	活动不存在
biz.custom.addsupplieractivity.invalid-biz:102	活动已下架	活动已下架
biz.custom.addsupplieractivity.invalid-biz:103	处理失败	处理失败
biz.custom.addsupplieractivity.invalid-biz:104	商户云钻账户余额不足	商户云钻账户余额不足
biz.custom.addsupplieractivity.invalid-biz:105	参数{0}格式不正确	参数{0}格式不正确
biz.custom.addsupplieractivity.invalid-biz:106	参数{0}不能为空	参数{0}不能为空
biz.custom.addsupplieractivity.invalid-biz:107	入参请求共{0}行，超过允许的最大行数	入参请求共{0}行，超过允许的最大行数
biz.custom.addsupplieractivity.invalid-biz:108	活动失效时间不能在生效时间之前	活动失效时间不能在生效时间之前
biz.custom.addsupplieractivity.invalid-biz:109	参数:{0},格式不正确。该字段长度固定为：{1}位，实际入参长度：{2}位	参数:{0},格式不正确。该字段长度固定为：{1}位，实际入参长度：{2}位
biz.custom.addsupplieractivity.invalid-biz:110	参数:{0},格式不正确。该字段只能为数字	参数:{0},格式不正确。该字段只能为数字
biz.custom.addsupplieractivity.invalid-biz:111	参数:{0},格式不正确。该字段只能为数字、字母	参数:{0},格式不正确。该字段只能为数字、字母
biz.custom.addsupplieractivity.invalid-biz:112	参数:{0},格式不正确。该字段不能小于1	参数:{0},格式不正确。该字段不能小于1
biz.custom.addsupplieractivity.invalid-biz:113	参数:{0},格式不正确。该字段不能大于{1}	参数:{0},格式不正确。该字段不能大于{1}
biz.custom.addsupplieractivity.invalid-biz:114	参数:{0},格式不正确。该字段只能为正整数	参数:{0},格式不正确。该字段只能为正整数
biz.custom.addsupplieractivity.invalid-biz:115	参数:{0},格式不正确。该字段最大长度为：{1}位，实际入参长度：{2}位	参数:{0},格式不正确。该字段最大长度为：{1}位，实际入参长度：{2}位
biz.custom.addsupplieractivity.invalid-biz:116	参数:{0},格式不正确。该字段长度范围为：{1}位-{2}位，实际入参长度：{3}位	参数:{0},格式不正确。该字段长度范围为：{1}位-{2}位，实际入参长度：{3}位

公共异常码

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