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

请求参数

名称	类型	是否必须	示例值	描述
activityName	String	Y	0元购	活动名称
startTime	String	Y	2015-06-18 00:00:00	活动开始时间。结束时间 > 开始时间 >= 当前时间+系统处理时间（此处为10分钟）
endTime	String	Y	2015-07-18 00:00:00	活动结束时间。活动开始时间≤活动结束时间≤活动开始时间+180天
channelInfo	String	Y	1,2	活动渠道。31-PC、32-移动、34-电销渠道、41-微店渠道、43-小海狮43（仅支持海外购商户），可多选，用英文逗号隔开
activityProductType	String	Y	1	活动商品类型。参与活动商品的类型，，1，代表全店铺商品；2，代表指定商品；3排除某部分商品
couponProductType	String	N	1	券使用商品类型。返券能够买的商品集合，1，代表全店铺商品；2，代表指定商品；3排除某部分商品
returnCouponType	String	N	1	返券总量类型。1，不超过多少元；2，不超过多少张
returnCouponValue	String	N	10000	返券总量阀值（元/张）。返券总金额，不得超过 999999999元/返券总张数，不得超过 999999999张
activityLimit	String	N	1	活动限制类型。1，限制；2，不限制，当优惠方式为2，订单返券，必填
activityTimesLimit	String	N	100	用户限制总次数。限制用户参加活动的总次数。当活动类型为1时，总次数和每天次数必填其一
peopleActivityTimesLimit	String	N	10	用户每天限制的次数。限制用户每天参加活动的次数。当活动类型为1时，总次数和每天次数必填其一
effectDays	String	N	30	券有效天数。只能到天，最多30天，当优惠方式为2，订单返券，必填
baseQuantifierType	String	Y	1	优惠条件单位。1：元，2：件数
rewardType	String	Y	1	优惠方式。当优惠条件单位为1时，1：满元减元，2：订单满元返券，3：订单满元包邮；当优惠条件单位为2时，3：订单满件包邮，4：订单满件打折，5：订单满件减件；商户类型为线上联营优惠方式3订单满元包邮、3订单满减包邮无效。
areaCode	String	N	0012	不包邮区域。省份代码，可以从城市代码获取接口里面获取，如有多个英文逗号隔开。商户类型为线上联营优惠方式3订单满元包邮、3订单满减包邮无效。
booleanCap	String	N	1	是否上不封顶。当优惠方式为1，订单直降时，且优惠层级为1时，必填。1代表是，2代表否。
floor	String	N	1	层级。最多5个层级，优惠方式为3时可以不填
discountValue	String	N	100	返券用券条件。单笔订单满多少元才能使用返的券，必须大于返券金额当优惠方式为2，订单返券，必填
rewardAmount	String	N	5	返券面额。返券的金额，高层级返券的金额必须比低层级要高，最高层级的返券金额不得大于返券总额，当优惠方式为2，订单返券，必填
baseAmount	String	Y	100	阀值。满多少件，或者满多少钱，产生优惠，高层级的优惠条件阀值要高于低层级的优惠条件阀值
discountThreshold	String	N	2	打折阀值。打多少折，优惠方式折扣阀值只可输入0.01~9.99，小数点精确两位，当优惠方式为4、订单打折时，必填。高层级的打折阀值要比底层及的打折阀值要高
cutAmount	String	N	20	直降金额。到达优惠阀值后，直降的金额，当优惠方式为1，订单直降时，必填。
reduceLimit	String	N	2	减件阀值。只可以输入正整数，优惠方式为5时必填，需要小于满件的阀值数值，高层级的减件阀值要比底层及的减件阀值要高
couponProductCode	String	N	100021342	苏宁商品编码（券使用商品）。苏宁商品编码，只能填写苏宁通码或者单一商品的商品编码，最多添加200个商品。当券使用商品类型=2或者3时必填。
activityProductCode	String	N	100021342	苏宁商品编码（活动商品）。苏宁商品编码，只能填写苏宁通码或者单一商品的商品编码，最多添加200个商品。当活动商品类型=2或者3时必填。

响应参数

名称	类型	示例值	描述
activityCode	String	10045073	促销活动ID。

请求示例

XML示例
JSON示例

复制全部代码

                                

      	
<sn_request>
	<sn_body>
		<addOrderCoupon>
			<activityName>0元购</activityName>
			<startTime>2015-06-18 00:00:00</startTime>
			<endTime>2015-07-18 00:00:00</endTime>
			<channelInfo>31</channelInfo>
			<activityProductType>1</activityProductType>
			<couponProductType>1</couponProductType>
			<returnCouponType>1</returnCouponType>
			<returnCouponValue>10000</returnCouponValue>
			<activityLimit>1</activityLimit>
			<activityTimesLimit>100</activityTimesLimit>
			<peopleActivityTimesLimit>10</peopleActivityTimesLimit>
			<effectDays>30</effectDays>
			<baseQuantifierType>1</baseQuantifierType>
			<rewardType>3</rewardType>
			<areaCode>0012</areaCode>
			<booleanCap>1</booleanCap>
			<rewardList>
				<floor>1</floor>
				<discountValue>2</discountValue>
				<rewardAmount>5</rewardAmount>
				<baseAmount>100</baseAmount>
				<discountThreshold>2</discountThreshold>
				<cutAmount>20</cutAmount>
				<reduceLimit>2</reduceLimit>
			</rewardList>
			<rewardList>
				<floor>1</floor>
				<discountValue>2</discountValue>
				<rewardAmount>5</rewardAmount>
				<baseAmount>100</baseAmount>
				<discountThreshold>2</discountThreshold>
				<cutAmount>20</cutAmount>
				<reduceLimit>2</reduceLimit>
			</rewardList>
			<couponProductList>
                <couponProductCode>100021342</couponProductCode>
           </couponProductList>
		   <couponProductList>
                <couponProductCode>100021340</couponProductCode>
           </couponProductList>
		   <activityProductList>
                <activityProductCode>10002133</activityProductCode>
            </activityProductList>
			<activityProductList>
                <activityProductCode>10002130</activityProductCode>
            </activityProductList>
		</addOrderCoupon>
	</sn_body>
</sn_request>

                                

      	
{
  "sn_request": {
    "sn_body": {
      "addOrderCoupon": {
        "activityName": "0元购",
        "startTime": "2015-06-18 00:00:00",
        "endTime": "2015-07-18 00:00:00",
        "channelInfo": "31",
        "activityProductType": "1",
        "couponProductType": "1",
        "returnCouponType": "1",
        "returnCouponValue": "10000",
        "activityLimit": "1",
        "activityTimesLimit": "100",
        "peopleActivityTimesLimit": "10",
        "effectDays": "30",
        "baseQuantifierType": "1",
        "rewardType": "3",
        "areaCode": "0012",
        "booleanCap": "1",
        "rewardList": [
          {
            "floor": "1",
            "discountValue": "2",
            "rewardAmount": "5",
            "baseAmount": "100",
            "discountThreshold": "2",
            "cutAmount": "20",
		    "reduceLimit":"2"
          },
          {
            "floor": "1",
            "discountValue": "2",
            "rewardAmount": "5",
            "baseAmount": "100",
            "discountThreshold": "2",
            "cutAmount": "20",
		    "reduceLimit":"2"
          }
        ],
        "couponProductList": [
          { "couponProductCode": "100021342" },
          { "couponProductCode": "100021340" }
        ],
        "activityProductList": [
          { "activityProductCode": "10002133" },
          { "activityProductCode": "10002130" }
        ]
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              

      	
<sn_responseContent>
	<sn_body>
		<addOrderCoupon>
			<activityCode>10045073</activityCode>
		</addOrderCoupon>
	</sn_body>
	<sn_head/>
</sn_responseContent>

                              

      	
{
  "sn_responseContent": {
    "sn_body": {
      "addOrderCoupon": { "activityCode": "10045073" }
    },
	"sn_head":{
	}
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.custom.addordercoupon.missing-parameter:*	请求字段为空，*表示对于的业务请求字段（字段驼峰）	请输入正确参数。
biz.custom.addordercoupon.format-error:*	请求字段格式错误，*表示对于的业务请求字段（字段驼峰）	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:100	活动开始时间小于当前时间报错	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:101	活动结束时间小于活动开始时间报错	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:102	活动开始时间和活动结束时间相隔超过180天	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:103	满返条件下返券阈值、券面额、用券条件为空	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:104	满返条件下用券条件小于返券阈值	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:105	满返条件下返券阈值小于券面额	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:106	满返条件下第二层级返券阈值小于第一层级返券阈值	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:107	满返条件下第二层级券面额小于第一层级券面额	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:108	满返条件下第二层级用券条件小于第一层级用券条件	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:109	地区编码不存在或存在错误	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:110	打折阈值不存在	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:111	打折阈值字段类型不符合要求	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:112	直降金额不存在	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:113	直降金额字段类型不符合要求	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:114	是否上不封顶可选值错误	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:115	优惠维度可选值错误	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:116	用户限制总次数不是数字或者大于200	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:117	用户每天限制的次数不是数字或者大于200	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:118	券使用商品编码不符合该商家的商品编码要求	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:119	参加活动商品编码不符合该商家的商品编码要求	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:120	该创建活动与已有活动存在活动互斥	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:121	满返条件下满返层级错误	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:122	券使用商品全店铺时存在商品集合	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:123	活动商品范围为全店铺时存在商品集合	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:124	满返集合不能为空	请输入正确参数。
biz.custom.addordercoupon.enumeration-error:couponProductType	券使用商品类型可选值错误	请输入正确参数。
biz.custom.addordercoupon.enumeration-error:activityProductType	活动商品类型可选值错误	请输入正确参数。
biz.custom.addordercoupon.enumeration-error:returnCouponType	返券总量类型可选值错误	请输入正确参数。
isp.sys.service.unavailable.mpms	服务不可用（系统异常）	请联系苏宁技术人员。
biz.custom.addordercoupon.enumeration-error:channelInfo	活动渠道可选值错误	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:125	券面额总金额大小要大于层级券面额金额大小	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:126	活动限制类型为1时，活动总限制次数要大于活动每人限制次数	请输入正确参数。
biz.custom.addordercoupon.length-overlong:activityName	活动名称长度过长	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:127	返券模式为每返，每返只允许一个层级	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:128	活动商品集合存在子码商品	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:129	券活动商品集合存在子码商品	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:130	活动商品数量大于200	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:131	券商品数量大于200	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:132	优惠方式可选值错误	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:133	券有效天数不存在	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:134	券有效天数字段类型不符合要求	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:135	优惠方式与优惠维度类型不匹配	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:136	上不封顶时活动层级不能大于1	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:137	当优惠方式为返券时，返券总量类型不能为空	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:138	当优惠方式为返券时，返券总量阈值不能为空	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:139	订单满减中用券条件小于直降金额	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:140	订单满减中第二层级直降金额小于上一层级直降金额	请输入正确参数。
biz.custom.addordercoupon.invalid-biz:141	订单满减中第二层级打折阈值小于上一层级打折阈值	请输入正确参数。
biz.fourps.addordercoupon.invalid-biz:142	活动限制标志编码不符合要求	请输入正确参数。
biz.fourps.addordercoupon.invalid-biz:143	非返券活动时存在券商品标志位以及券商品编码	请输入正确参数。
biz.fourps.addordercoupon.invalid-biz:144	非返券活动下存在返券限制条件以及返券阈值	请输入正确参数。
biz.fourps.addordercoupon.invalid-biz:145	减件阀值为空	请输入正确参数。
biz.fourps.addordercoupon.invalid-biz:146	减件阀值输入非数字	请输入正确参数。
biz.fourps.addordercoupon.invalid-biz:147	减件阀值输入了小于1或大于99的值	请输入正确参数。
biz.fourps.addordercoupon.invalid-biz:148	减件阀值大于了优惠条件阀值	请输入正确参数。
biz.fourps.addordercoupon.invalid-biz:149	rewardType为4时，高层级阀值需要小于低层级	请输入正确参数。

公共异常码

异常码	错误描述	解决方案
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：通过此接口可订单优惠活动创建