接口文档?在这里为您解答!
最新修订:2025-03-13 v10.0.1.1215 作者:Eyf
请遵循以下交互设计原则 :
1) 安全性
对于远程交互,安全第一,需要避免数据在传输过程中被篡改,避免接口被其他方调用,保证数据的隔离性。
2) 稳定性
接口交互需要稳定性保证,避免不稳定导致的异常流程发生,对于异常流程有些很难控制,并且很容易对客户产生影响。
3) 扩展性
物流业务会存在较多的变化,特别是对于增值服务、运输方式、运输范围等,对于可能的变化,接口设计的尽量兼容。
4) 高性能
电子商务发展很快,好的产品用户使用量和使用频繁度肯定直线上升,需要交互的接口性能高,并且支持批量处理。
订单创建(inn.order.new)、订单修改(inn.order.edit)、订单取消(inn.order.cancel)
快件跟踪(inn.order.tracking)、电子面单(inn.order.eric)
绑定货代提货单(inn.order.ladingno)、提货单实时更新(inn.ladingno.tracking)
1)交互图
2)请求地址:https://exp.yfuuk.com/eyfapi
3)请求头部:
Content-Type :application/x-www-form-urlencoded;charset=UTF-8
4)请求参数:
字段
类型
是否必传
说明
method
string
是
传值:
>订单创建:inn.order.new、>订单修改:inn.order.edit
>订单取消:inn.order.cancel、>快件跟踪:inn.order.tracking
>电子面单:inn.order.eric、>绑定货代提货单:inn.order.ladingno
>提货单实时更新:inn.ladingno.tracking
appid
string
是
用户ID,传固定值:【SYSID】
ts
string
是
当前的时间戳(10位)
sign
string
是
32位的md5签名(md5(appid + method + ts + apikey))
Apikey,传固定值:【SYSIDKEY】
data
JSON
是
JSON类型的业务请求参数。具体看业务参数
参数【SYSID】和【SYSIDKEY】请联系Eyf_半字节科技客服提供 参数data:JSON格式如下:
5.1)订单创建:
字段
类型
是否必传
说明
platname
string
是
下单平台:如:taobao
logisticid
string
是
订单编号(唯一)
company
string
否
快递品牌(指定物流/快递公司情况下,则必填)
network
string
否
发货营业网点(指定发货网点情况下,则必填)
goodsname
string
是
品名
totalpcs
string
否
总件数
totalweight
string
否
总重量(单位:KG,保留3位小数)
totalvolume
string
否
总体积(单位:m3,保留3位小数)
totalprice
string
否
总价格(单位:,保留3位小数)
shippingMethod string 否 运输方式:air空运,sea海运,land陆运 shippingType string 否 送货方式:自提,派送 packageType string 否 包装类型 paytype string 否 支付方式 codvalue string 否 代收货款 codprice string 否 货款手续费 insurancevalue string 否 保价金额 insuranceprice string 否 保价费 deliverytypeprice string 否 送货费 vistreceiveprice string 否 接货费 remark string 否 备注 shipper-->name string 是 发货-姓名 shipper-->lastName string 否 发货-姓氏(海外版用到) shipper-->phone string 是 发货-电话 shipper-->address string 是 发货-地址 shipper-->zipCode string 否 发货-邮编 shipper-->province string 是 发货-省 shipper-->city string 是 发货-市 shipper-->area string 是 发货-区县 consignee-->name string 是 收货-姓名 consignee-->lastName string 否 收货-姓氏(海外版用到) consignee-->phone string 是 收货-电话 consignee-->address string 是 收货-地址 consignee-->zipCode string 否 收货-邮编 consignee-->province string 是 收货-省 consignee-->city string 是 收货-市 consignee-->area string 是 收货-区县 consignee-->homePhone string 否 收货-家庭电话 consignee-->idType string 否 收货-证件类型 consignee-->idCode string 否 收货-证件号码 items-->description string 是 品名 items-->sku string 是 SKU items-->salePrice Float 否 售价 items-->pics int 否 件数,正整数 items-->weight Float 否 重量,单位KG Response:{state:0, msg:"ok", data:{wayBillCode:"Eyf01234567899"}}
字段
类型
说明
state int 请求结果:成功=0,失败=1 msg String 成功=“ok”,否则返回错误信息 data Object 返回运单编号:wayBillCode 5.2)订单修改:(参数与订单创建一致)
Response:{state:0, msg:"ok", data:null}
字段
类型
说明
state int 请求结果:成功=0,失败=1 msg String 成功=“ok”,否则返回错误信息 data Object null 5.3)订单取消:
字段
类型
是否必传
说明
logisticid
string
是
订单编号(唯一)
Response:{state:0, msg:"ok", data:null}
字段
类型
说明
state int 请求结果:成功=0,失败=1 msg String 成功=“ok”,否则返回错误信息 data Object null 5.4)快件跟踪:
字段
类型
是否必传
说明
logisticid
string
两者必传其一
订单编号(唯一)
wayBillCode string 运单编号 Response:{state:0, msg:"ok", data:Object}
字段
类型
说明
state int 请求结果:成功=0,失败=1 msg String 成功=“ok”,否则返回错误信息 data List<Bill> 运单数组 List<Bill>:
字段
类型
说明
billcode String 运单编号 status String 轨迹当前状态,如:0在途,1揽收,2疑难,3签收,4退签,5派件,6退回,7转单,10待清关,11清关中,12已清关,13清关异常,14收件人拒签等 content List<Info> 运单数组 List<Info>:
字段
类型
说明
time String 操作时间 context String 描述 timezone String 时差 示例
{ "state": "0", "msg": "ok", "data": [ { "billcode": "EYF012345678911", "status": "签收", "content": [ { "time": "2018-04-29 16:31:48", "context": "站点【退货部】进行了【货物退回客户扫描】操作", "timezone": "", "state": "" } ] }, { "billcode": "EYF012345678922", "status": "签收", "content": [ { "time": "2018-04-29 16:31:48", "context": "站点【退货部】进行了【货物退回客户扫描】操作", "timezone": "", "state": "" } ] } ]}
5.5)电子面单:
字段
类型
是否必传
说明
wayBillCode
string
是
运单编号
Response:{state:0, msg:"ok", data:{url:"https://......"}}
字段
类型
说明
state int 请求结果:成功=0,失败=1 msg String 成功=“ok”,否则返回错误信息 data JSON 例如:{url:"电子面单调用路径"} 5.6)绑定货代提货单:
字段
类型
是否必传
说明
wayBillCode
string
是
运单编号
billOfLadingNo string 是 提货单号 shippingMethod string 是 运输方式:air空运,sea海运,land陆运 Response:{state:0, msg:"ok", data:null}
字段
类型
说明
state int 请求结果:成功=0,失败=1 msg String 成功=“ok”,否则返回错误信息 data Object null 5.7)提货单实时更新:
字段
类型
是否必传
说明
wayBillCode
string
是
运单编号
billOfLadingNo string 是 提货单号 time string 是 时间(24小时制):格式:2025-01-01 08:10:10 context string 是 描述 status string 是 状态 timezone string 是 时差 Response:{state:0, msg:"ok", data:null}
字段
类型
说明
state int 请求结果:成功=0,失败=1 msg String 成功=“ok”,否则返回错误信息 data Object null