1.前言
1.1业务背景
本文档为第三方平台与海带开放平台SDK对接技术实现方案。其中主要内容为技术接口说明。
注：每个接口请求都需要appkey、accountId、memberId、url、secreat字段
1.2接口调用流程说明
2.对接说明
2.1接口地址
测试地址
正式地址
2.2SDK调用
调用SDK时，必须传入必填参数和对应的应用级参数，必填参数，用于合法性校验。
必填参数
| 字段 | 类型 | 描述 | 备注 | 是否必须 |
|---|---|---|---|---|
| accountId | String | 用户账号 | 是 | |
| memberId | String | 用户编号 | 是 | |
| url | String | 访问域名 | 是 | |
| appkey | String | 唯一标识 | 海带分配 | 是 |
| secret | String | 唯一标识 | 海带分配 | 是 |
3.核心接口
3.1商品发货接口
| 地址： | /api/v2/order/shipping | ||
|---|---|---|---|
| 描述： | 商品发货 | ||
| 输入参数 | |||
| 字段名 | 字段类型 | 是否必选 | 说明 |
| accountId | 字符串类型 | Y | 账号编号 |
| dlyCodes | 字符串类型 | Y | 物流公司（例：shentong）,多个以逗号分隔 |
| memberId | 字符串类型 | Y | 用户编号 |
| orderSn | 字符串类型 | Y | 订单编号 |
| shipNos | 字符串类型 | Y | 运单号，多个以逗号分隔 |
| itemBatchRefList | 数组类型 | Y | 商品批次号列表信息，例如： [ { “accountId”: “c4f2e8147b794fd9bc56cfe269ca19b9”, “batchNo”: “8686858585”, “goodsId”: “072baf853dfb4587945689af3416307c”, “goodsSn”: “YB32142247988”, “id”: null, “orderId”: “a1dd538239c442f78a744956e39c4d83”, “orderItemId”: “3f1726bc3da84703a1c3f1f60c4b0b34” }] 字段补充说明：orderItemId：订单列表id , batchNo： 批次号 |
| ***输出参数 *** | |||
| 成功返回 | |||
| 返回内容说明 | |||
| { “code”: “”, “data”: “”, “message”: “商品发货成功”, “result”: 1, “success”: true} | |||
| 失败返回 | |||
| 返回内容说明 | 包含处理失败的代码和失败原因提示 | ||
| { “code”: “”, “data”: “”, “message”: “商品发货失败”, “result”: 0, “success”: false} |
3.2退单接口
| 地址： | DeliverGoods.class#batchAddExceptionReply() | ||
|---|---|---|---|
| 描述： | 批量退单 | ||
| 输入参数 | |||
| 字段名 | 字段类型 | 是否必选 | 说明 |
| accountId | 字符串 | Y | 账号编号 |
| memberId | 字符串 | Y | 用户编号 |
| orderSns | 字符串 | Y | 订单编号 |
| returnDes | 字符串 | N | 描述 |
| returnReason | 数值型 | Y | 退单原因code***，参考下面的***id |
| 输出参数 | |||
| 成功返回 | |||
| 返回内容说明 | |||
| { “code”: “”, “data”: { “alreadyReturnOrderIds”: “”（已经退单的订单号）, “errorOrderIds”: “”（错误订单编号）, “noGoods”: “”（没商品订单号）, “notAllowOrderIds”: “”（不允许的订单号）, “unOrderIds”: “”（非订单号的订单号） }, “message”: “”, “result”: 1, “success”: true} | |||
| 失败返回 | |||
| 返回内容说明 | 包含处理失败的代码和失败原因提示 | ||
| { “code”: “”, “data”: “”, “message”: “退单失败”, “result”: 1, “success”: true} | |||
| 数据字典 | |||
| 退单原因列表（中文原因，字符要求完全一致）：1 身份证重复2 地址异常：地址中不能出现关于超市、母婴店、药店等类似的字眼3 地址超过购买限额4 联系方式有误5 报关失败6 收件人信息重复7 单证审核不通过8 身份证海关封号10 身份证号码错误20 身份证号码与姓名不对应30 身份验证失败40 地址不详50 地址重复60 联系方式超过购买限额70 身份信息超过购买限额80 订单商品缺货90 物流配送无法联系到收货人95 其它96 未上传身份证照片 |