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

请求参数

名称	类型	是否必须	示例值	描述
pxCardId	String	Y	10000011	蟹云卡券ID
pxCardNo	String	Y	22223334	蟹云卡券编码
orderItemId	String	Y	00120485973301	订单行项目
deliveryDate	String	N	2020-05-26 17:00:00	客户要求的发货日期
pickupMode	String	Y	1	发货类型 1.自提 2.送货
address	String	N	XX省XX市XX区XX地方	收货地址
phoneNum	String	N	02588888888	收货电话
name	String	N	XXX	收货人姓名
pxCardStatus	String	Y	01	蟹卡状态01、已预约；02、发货；03、签收； 04、拒收；05、失效；
expressCompanyCode	String	N	顺丰物流	物流公司名称
expressNo	String	N	SF9994588556	物流运单号

响应参数

名称	类型	示例值	描述
returnCode	String	Y	返回结果Y成功

请求示例

XML示例
JSON示例

复制全部代码

                                
<sn_request>
  <sn_body>
    <receivePxcardstatus>
      <pxCardStatus>01</pxCardStatus>
      <pxCardId>10000011</pxCardId>
      <address>XX省XX市XX区XX地方</address>
      <expressNo>SF9994588556</expressNo>
      <orderItemId>00120485973301</orderItemId>
      <pickupMode>1</pickupMode>
      <name>XXX</name>
      <expressCompanyCode>顺丰物流</expressCompanyCode>
      <pxCardNo>22223334</pxCardNo>
      <phoneNum>02588888888</phoneNum>
      <deliveryDate>2020-05-26 17:00:00</deliveryDate>
    </receivePxcardstatus>
  </sn_body>
</sn_request>

                                
{
  "sn_request": {
    "sn_body": {
      "receivePxcardstatus": {
        "pxCardStatus": "01",
        "pxCardId": "10000011",
        "address": "XX省XX市XX区XX地方",
        "expressNo": "SF9994588556",
        "orderItemId": "00120485973301",
        "pickupMode": "1",
        "name": "XXX",
        "expressCompanyCode": "顺丰物流",
        "pxCardNo": "22223334",
        "phoneNum": "02588888888",
        "deliveryDate": "2020-05-26 17:00:00"
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              
<sn_responseContent>
  <sn_body>
    <receivePxcardstatus>
      <returnCode>Y</returnCode>
    </receivePxcardstatus>
  </sn_body>
</sn_responseContent>

                              
{
  "sn_responseContent": {
    "sn_body": {
      "receivePxcardstatus": {
        "returnCode": "Y"
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.custom.receivepxcardstatus.missing-parameter:*	参数必填	请检查此参数的值,*号表示参数字段名
isp.sys.service.unavailable.moms	服务不可用	请联系苏宁技术人员
biz.custom.receivepxcardstatus.invalid-biz:100	卡券ID和卡券编码不存在	输入正确的卡券ID和卡券编码
biz.custom.receivepxcardstatus.invalid-biz:101	订单行项目不存在	输入正确的订单行项目
biz.custom.receivepxcardstatus.invalid-biz:102	订单行项目与蟹卡信息关系不存在	输入正确的订单行项目
biz.custom.receivepxcardstatus.invalid-biz:103	蟹卡状态已完结	下发蟹卡状态不对

公共异常码

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