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

请求参数

名称	类型	是否必须	示例值	描述
invCity	String	Y	000001000173	填代码，通过城市代码获取接口可以获取。例：（对应为南京市）。
invContact	String	Y	陈聪	姓名（不能超过64个字符）。
invProvince	String	Y	100	填代码，通过城市代码获取接口可以获取。例：100（对应为江苏省），如果为四大直辖市，省份字段值写市。
invRegion	String	Y	00000001	填代码，通过城市代码获取接口可以获取。例：00000001（对应为玄武区）。
streetAddress	String	Y	王庄湖B栋	精确到门牌号（不超过256个字符）。
zipCode	String	Y	226408	仓库所在地编码。
telePhone	String	Y	18651662631	11位数字。
phoneNum	String	N	025-66996699	固定电话号码。
invName	String	N	某某公司某地仓库	仓库名称（不超过64个字符）。
remark	String	N	备注	备注信息（不超过500个字符）。

响应参数

名称	类型	示例值	描述
result	String	null	Y/N Y成功 N失败。

请求示例

XML示例
JSON示例

复制全部代码

                                <sn_request>
	<sn_body>
		<invaddress>
			<invContact>陈聪</invContact>
			<invProvince>100</invProvince>
			<invCity>000001000173</invCity>
			<invRegion>00000001</invRegion>
			<streetAddress>王庄湖B栋</streetAddress>
			<zipCode>226408</zipCode>
			<telePhone>18651662631</telePhone>
			<phoneNum>025-66996699</phoneNum>
			<invName>某某公司某地仓库</invName>
			<remark>备注</remark>
		</invaddress>
	</sn_body>
</sn_request>

                                {
  "sn_request": {
    "sn_body": {
      "invaddress": {
        "invContact": "陈聪",
        "invProvince": "100",
        "invCity": "000001000173",
        "invRegion": "00000001",
        "streetAddress": "王庄湖B栋",
        "zipCode": "226408",
        "telePhone": "18651662631",
        "phoneNum": "025-66996699",
        "invName": "某某公司某地仓库",
        "remark": "备注"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              <sn_responseContent>
	<sn_body>
		<invaddress>
			<result>Y</result>
		</invaddress>
	</sn_body>
</sn_responseContent>

                              {
  "sn_responseContent": {
    "sn_body": {
      "invaddress": {
        "result": "Y"
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.custom.invaddress.invProvince-length:overlong	仓库所在地区省长度过长	仓库所在地区省长度为3位的数字
biz.custom.invaddress.invalid-biz:invProvince	仓库所在地区省代码不存在	检查传输的仓库所在地区省代码
biz.custom.invaddress.invalid-biz:invCity	仓库所在地区市代码不存在	检查传输的仓库所在地区市代码
biz.custom.invaddress.invalid-biz:invRegion	仓库所在地区区代码不存在	检查传输的仓库所在地区区代码
biz.custom.invaddress.invalid-biz:district not match	省市区从属关系错误，请检查	检查传输的省市区从属关系
biz.custom.invaddress.invalid-biz: telePhone	手机号码格式错误	检查传输的手机号码格式
biz.custom.invaddress.invContact-format:error	仓库联系人格式错误	检查传输的仓库联系人是否包含特殊字符
biz.custom.invaddress.invName-format:error	仓库名称格式错误	检查传输的仓库名称是否包含特殊字符
biz.custom.invaddress.invContact-length:overlong	仓库联系人名称长度过长	仓库联系人名称长度不能超过64个字符
biz.custom.invaddress.invName-length:overlong	仓库名称长度过长	仓库名称长度不能超过64个字符
biz.custom.invaddress.invProvince-format:error	仓库所在地区省格式错误	必须为数字，参考城市代码获取接口取得的数据
biz.custom.invaddress.invCity-format:error	仓库所在地区市格式错误	必须为数字，参考城市代码获取接口取得的数据
biz.custom.invaddress.invCity-length:overlong	仓库所在地区市长度过长	仓库所在地区市长度为不超过12位的数字
biz.custom.invaddress.invRegion-format:error	仓库所在地区区格式错误	必须为数字，参考城市代码获取接口取得的数据
biz.custom.invaddress.invRegion-length:overlong	仓库所在地区区长度过长	仓库所在地区区长度为不超过8位的数字
biz.custom.invaddress.streetAddress-length:overlong	街道地址长度过长	街道地址长度不能超过256个字符
biz.custom.invaddress.remark-length:overlong	备注长度过长	备注长度不能超过500个字符
biz.custom.invaddress.invalid-biz:operate failed,retry later	仓库暂时无法新增，请稍后重试	仓库暂时无法新增，请稍后重试
biz.invaddress.missing-parameter:*	*为必填字段，缺失	检查是否缺少必填字段值

公共异常码

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