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

请求参数

名称	类型	是否必须	示例值	描述
requestSeialNum	String	N	133333333	每张发票的发票请求唯一流水号无重复，业务单号不传，则流水号必传
pageNum	String	N	1	第几页，默认1
platformCoding	String	Y	C111111	商户编码
orderNum	String	N	0111222	消费端系统订购商品产生的订单号，须保证同一系统来源下唯一，流水号不传则业务单号必传
pageRow	String	N	10	每页数量，默认10

响应参数

名称	类型	示例值	描述
returnCode	String	0000	0000：下发成功、9999：下发失败
returnMessage	String	下发失败描述具体原因	查询结果描述-下发失败描述具体原因
pageSum	String	1	总页数
total	String	1	总条数
pageNum	String	1	当前页
invItems	String
requestSeialNum	String	222222	发票请求唯一流水号-每张发票的发票请求唯一流水号无重复
clientName	String	购方名称	购方名称
clientTaxNum	String	14200A	购方税号
ticketSecurityCode	String	SW111111	校验码
ticketCode	String	3211111	发票代码
ticketNum	String	4211111	发票号码
ticketDate	String	2019-07-24	开票日期
ticketType	String	1 -1	开票类型-1 蓝票、-1红票
oldInvoiceCode	String	3210000	原发票代码-开票类型-1时，传红票对应的原蓝票发票代码
redMark	String	0.-1	红冲标识-0未红冲，1已红冲
oldInvoiceNum	String	420000	原发票号码-开票类型-1时，传红票对应的原蓝票发票号码
invoiceAmount	String	23.33	开票金额
ticketNoTaxAmount	String	23.33	不含税金额
pdfUrl	String	http//	PDF下载路

请求示例

XML示例
JSON示例

复制全部代码

                                <sn_request>
  <sn_body>
    <queryInvoice>
      <requestSeialNum>133333333</requestSeialNum>
      <pageRow>10</pageRow>
      <platformCoding>C111111</platformCoding>
      <orderNum>0111222</orderNum>
      <pageNum>1</pageNum>
    </queryInvoice>
  </sn_body>
</sn_request>

                                {
  "sn_request": {
    "sn_body": {
      "queryInvoice": {
        "requestSeialNum": "133333333",
        "pageRow": "10",
        "platformCoding": "C111111",
        "orderNum": "0111222",
        "pageNum": "1"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              <sn_responseContent>
  <sn_body>
    <queryInvoice>
      <invItems>
        <clientTaxNum>14200A</clientTaxNum>
        <clientName>购方名称</clientName>
        <oldInvoiceCode>3210000</oldInvoiceCode>
        <invoiceAmount>23.33</invoiceAmount>
        <ticketType>1 -1</ticketType>
        <ticketSecurityCode>SW111111</ticketSecurityCode>
        <requestSeialNum>222222</requestSeialNum>
        <pdfUrl>http//</pdfUrl>
        <ticketNoTaxAmount>23.33</ticketNoTaxAmount>
        <ticketNum>4211111</ticketNum>
        <redMark>0.-1</redMark>
        <oldInvoiceNum>420000</oldInvoiceNum>
        <ticketCode>3211111</ticketCode>
        <ticketDate>2019-07-24</ticketDate>
      </invItems>
      <returnCode>0000</returnCode>
      <total>1</total>
      <pageSum>1</pageSum>
      <returnMessage>下发失败描述具体原因</returnMessage>
      <pageNum>1</pageNum>
    </queryInvoice>
  </sn_body>
</sn_responseContent>

                              {
  "sn_responseContent": {
    "sn_body": {
      "queryInvoice": {
        "invItems": [
          {
            "clientTaxNum": "14200A",
            "clientName": "购方名称",
            "oldInvoiceCode": "3210000",
            "invoiceAmount": "23.33",
            "ticketType": "1 -1",
            "ticketSecurityCode": "SW111111",
            "requestSeialNum": "222222",
            "pdfUrl": "http//",
            "ticketNoTaxAmount": "23.33",
            "ticketNum": "4211111",
            "redMark": "0.-1",
            "oldInvoiceNum": "420000",
            "ticketCode": "3211111",
            "ticketDate": "2019-07-24"
          }
        ],
        "returnCode": "0000",
        "total": "1",
        "pageSum": "1",
        "returnMessage": "下发失败描述具体原因",
        "pageNum": "1"
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.custom.queryinvoice.missing-parameter:*	参数必填	请检查此参数的值,*号表示参数字段名
biz.custom.queryinvoice.length-overlong:*	参数的值超过规定长度	请检查此参数的值,*号表示参数字段名
biz.handler.data-get:no-result	查询没结果	请检查查询参数
isp.sys.service.unavailable.iips	服务不可用	请联系苏宁技术人员
biz.custom.queryinvoice.invalid-biz:100	销方信息不存在	销方信息不存在，请确认是否订购该业务
biz.custom.queryinvoice.invalid-biz:101	发票信息不存在	发票信息不存在，请核实发票号

公共异常码

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