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

请求参数

名称	类型	是否必须	示例值	描述
orderInfo	String	N
orderId	String	Y	101231241541	订单编号
orderItemId	String	N	1234562112	订单行号（指单个处方药商品对应的子订单ID）
supplierInfo	String	N
supplierCode	String	Y	70057518	商家编码

响应参数

名称	类型	示例值	描述
orderInfo	String
orderId	String	1234564	订单编号
supplierCode	String	70057518	商家ID
onlineHospitalCode	String	124578522	互联网医院代码（在服务市场入驻后生成的编码）
isPrescription	String	true	是否包含处方药 true-是，false-否
orderItemList	String
orderItemId	String	1234562112	订单行号（指单个处方药商品对应的子订单ID）
itemCounts	String	3	订单行号数量
rxNo	String	5200000011011SS	处方单
orderLineStatus	String	20	订单行项目状态。0:订单取消；5:等待支付；10=待发货；15:发货中；20=已发货；30=交易成功
returnStatusValue	String	1	退款状态 1：退款待处理；2：已拒绝退款；3 待买家发货；4 待商家收货；5 退款失败；6 退款处理中；7 退款关闭；8 退款成功；
userInfo	String
useDrugName	String	张三	患者姓名
phoneNumber	String	12345678910	手机号码
identityType	String	1234	证件类型
identityNumber	String	123456789	证件号码
birthday	String	2000-01-01	出生日期
sex	String	12	性别
weight	String	1234	体重
pregnancyOption	String	0	备孕妊娠信息 0-无，1-备孕，2-怀孕/妊娠， 3-哺乳期
description	String	肚子疼	主诉
picInfo	String
picUrl	String	https://www.suning.com	用户上传图片信息
diseaseInfo	String
diseaseType	String	1	确诊疾病类型
diseaseName	String	过敏	确诊疾病名
previousDiseasesHistory	String
diseasesFlag	String	0	过往疾病史的标识 0 无;1 有
userRemark	String	过敏	自定义过往病史
diseasesList	String
diseaseType	String	1	病史类型
diseaseName	String	病史名称	病史名称
allergyHistory	String
diseasesFlag	String	0	过敏史的标识 0- 无，1 -有
userRemark	String	自定义过敏史	自定义过敏史
diseasesList	String
diseaseType	String	1	病史类型
diseaseName	String	病史名称	病史名称
familialDiseasesHistory	String
diseasesFlag	String	1	家族病史的标识 0- 无，1 -有
userRemark	String	自定义家族病史	自定义家族病史
diseasesList	String
diseaseType	String	1	病史类型
diseaseName	String	病史名称	病史名称
liverFunction	String
diseasesFlag	String	1	肝功能是否正常
userRemark	String	自定义肝功能信息	自定义肝功能信息
diseasesList	String
diseaseType	String	1	病史类型
diseaseName	String	病史名称	病史名称
renalFunction	String
diseasesFlag	String	1	肾功能是否正常
userRemark	String	1	自定义肾功能信息
diseasesList	String
diseaseType	String	1	病史类型
diseaseName	String	病史名称	病史名称
drugsInfo	String
cmmdtyName	String	感冒药	商品名
commonName	String	感冒灵	通用名
spec	String	150克	规格
manufacturer	String	生产厂家	生产厂家
barCode	String	条形码	条形码
lotNumber	String	批准文号	批准文号
productUnit	String	商品单位	商品单位
saleQty	String	购买量	购买量
orderItemId	String	1234562112	订单行号（指单个处方药商品对应的子订单ID）
prescriptionFlag	String	Y	是否处方药行,Y是，N，空值为否

请求示例

XML示例
JSON示例

复制全部代码

                                
<sn_request>
  <sn_body>
    <prescriptionParams>
      <orderInfo>
        <orderId>101231241541</orderId>
        <orderItemId>1234562112</orderItemId>
      </orderInfo>
      <supplierInfo>
        <supplierCode>70057518</supplierCode>
      </supplierInfo>
    </prescriptionParams>
  </sn_body>
</sn_request>

                                
{
  "sn_request": {
    "sn_body": {
      "prescriptionParams": {
        "orderInfo": {
          "orderId": "101231241541",
          "orderItemId": "1234562112"
        },
        "supplierInfo": {
          "supplierCode": "70057518"
        }
      }
    }
  }
}

响应示例

XML示例
JSON示例

复制全部代码

                              
<sn_responseContent>
  <sn_body>
    <prescriptionInfos>
      <userInfo>
        <birthday>2000-01-01</birthday>
        <pregnancyOption>0</pregnancyOption>
        <phoneNumber>12345678910</phoneNumber>
        <useDrugName>张三</useDrugName>
        <identityNumber>123456789</identityNumber>
        <identityType>1234</identityType>
        <sex>12</sex>
        <description>肚子疼</description>
        <weight>1234</weight>
      </userInfo>
      <previousDiseasesHistory>
        <userRemark>过敏</userRemark>
        <diseasesList>
          <diseaseName>病史名称</diseaseName>
          <diseaseType>1</diseaseType>
        </diseasesList>
        <diseasesFlag>0</diseasesFlag>
      </previousDiseasesHistory>
      <allergyHistory>
        <userRemark>自定义过敏史</userRemark>
        <diseasesList>
          <diseaseName>病史名称</diseaseName>
          <diseaseType>1</diseaseType>
        </diseasesList>
        <diseasesFlag>0</diseasesFlag>
      </allergyHistory>
      <liverFunction>
        <userRemark>自定义肝功能信息</userRemark>
        <diseasesList>
          <diseaseName>病史名称</diseaseName>
          <diseaseType>1</diseaseType>
        </diseasesList>
        <diseasesFlag>1</diseasesFlag>
      </liverFunction>
      <picInfo>
        <picUrl>https://www.suning.com</picUrl>
      </picInfo>
      <drugsInfo>
        <commonName>感冒灵</commonName>
        <orderItemId>1234562112</orderItemId>
        <cmmdtyName>感冒药</cmmdtyName>
        <lotNumber>批准文号</lotNumber>
        <productUnit>商品单位</productUnit>
        <prescriptionFlag>Y</prescriptionFlag>
        <saleQty>购买量</saleQty>
        <spec>150克</spec>
        <barCode>条形码</barCode>
        <manufacturer>生产厂家</manufacturer>
      </drugsInfo>
      <orderInfo>
        <onlineHospitalCode>124578522</onlineHospitalCode>
        <orderId>1234564</orderId>
        <orderItemList>
          <itemCounts>3</itemCounts>
          <rxNo>5200000011011SS</rxNo>
          <returnStatusValue>1</returnStatusValue>
          <orderItemId>1234562112</orderItemId>
          <orderLineStatus>20</orderLineStatus>
        </orderItemList>
        <isPrescription>true</isPrescription>
        <supplierCode>70057518</supplierCode>
      </orderInfo>
      <familialDiseasesHistory>
        <userRemark>自定义家族病史</userRemark>
        <diseasesList>
          <diseaseName>病史名称</diseaseName>
          <diseaseType>1</diseaseType>
        </diseasesList>
        <diseasesFlag>1</diseasesFlag>
      </familialDiseasesHistory>
      <renalFunction>
        <userRemark>1</userRemark>
        <diseasesList>
          <diseaseName>病史名称</diseaseName>
          <diseaseType>1</diseaseType>
        </diseasesList>
        <diseasesFlag>1</diseasesFlag>
      </renalFunction>
      <diseaseInfo>
        <diseaseName>过敏</diseaseName>
        <diseaseType>1</diseaseType>
      </diseaseInfo>
    </prescriptionInfos>
  </sn_body>
</sn_responseContent>

                              
{
  "sn_responseContent": {
    "sn_body": {
      "prescriptionInfos": {
        "userInfo": {
          "birthday": "2000-01-01",
          "pregnancyOption": "0",
          "phoneNumber": "12345678910",
          "useDrugName": "张三",
          "identityNumber": "123456789",
          "identityType": "1234",
          "sex": "12",
          "description": "肚子疼",
          "weight": "1234"
        },
        "previousDiseasesHistory": {
          "userRemark": "过敏",
          "diseasesList": [
            {
              "diseaseName": "病史名称",
              "diseaseType": "1"
            }
          ],
          "diseasesFlag": "0"
        },
        "allergyHistory": {
          "userRemark": "自定义过敏史",
          "diseasesList": [
            {
              "diseaseName": "病史名称",
              "diseaseType": "1"
            }
          ],
          "diseasesFlag": "0"
        },
        "liverFunction": {
          "userRemark": "自定义肝功能信息",
          "diseasesList": [
            {
              "diseaseName": "病史名称",
              "diseaseType": "1"
            }
          ],
          "diseasesFlag": "1"
        },
        "picInfo": [
          {
            "picUrl": "https://www.suning.com"
          }
        ],
        "drugsInfo": [
          {
            "commonName": "感冒灵",
            "orderItemId": "1234562112",
            "cmmdtyName": "感冒药",
            "lotNumber": "批准文号",
            "productUnit": "商品单位",
            "prescriptionFlag": "Y",
            "saleQty": "购买量",
            "spec": "150克",
            "barCode": "条形码",
            "manufacturer": "生产厂家"
          }
        ],
        "orderInfo": [
          {
            "onlineHospitalCode": "124578522",
            "orderId": "1234564",
            "orderItemList": [
              {
                "itemCounts": "3",
                "rxNo": "5200000011011SS",
                "returnStatusValue": "1",
                "orderItemId": "1234562112",
                "orderLineStatus": "20"
              }
            ],
            "isPrescription": "true",
            "supplierCode": "70057518"
          }
        ],
        "familialDiseasesHistory": {
          "userRemark": "自定义家族病史",
          "diseasesList": [
            {
              "diseaseName": "病史名称",
              "diseaseType": "1"
            }
          ],
          "diseasesFlag": "1"
        },
        "renalFunction": {
          "userRemark": "1",
          "diseasesList": [
            {
              "diseaseName": "病史名称",
              "diseaseType": "1"
            }
          ],
          "diseasesFlag": "1"
        },
        "diseaseInfo": [
          {
            "diseaseName": "过敏",
            "diseaseType": "1"
          }
        ]
      }
    }
  }
}

异常示例

XML示例
JSON示例

复制全部代码


  
  	API异常码
  	异常码中文描述

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

业务异常码

异常码	错误描述	解决方案
biz.custom.queryprescriptionorder.missing-parameter:*	参数必填	请检查此参数的值,*号表示参数字段名
biz.handler.data-get:no-result	查询没结果	请检查查询参数
isp.sys.service.unavailable.moms	服务不可用	请联系苏宁技术人员

公共异常码

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