运价试算(方法名称:calc.list)
此接口需要联系燕文销售申请权限;
| 环境 | HTTP请求地址 |
|---|---|
| 正式环境 | https://open.yw56.com.cn/api/order |
| 测试环境 | https://open-fat.yw56.com.cn/api/order |
| 环境 | 账号 | 秘钥 apitoken |
|---|---|---|
| 正式环境 | 贵司在我司客户号; | 登录我司客户中心系统-账号管理-制单账号管理信息下查看秘钥; |
| 测试环境 | 100000 | D6140AA383FD8515B09028C586493DDB |
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| user_id | String | 是 | 客户号 |
| format | String | 是 | 报文格式 默认为json格式,可选值:json |
| method | String | 是 | api名称; |
| timestamp | Long | 是 | 时间戳(毫秒级) 有效期为5分钟 |
| version | String | 是 | api版本号 可选 V1.0 |
| sign | String | 是 | 签名(根据动态规则生成) |
| data | String | 是 | 报文内容(body请求参数,放在请求体中,使用json格式) |
1.请求方式 所有接口使用 POST 方式请求,没有特殊说明 所有字符编码为utf-8; Content-Type: application/json;
2.公共请求参数放在url后面,使用&连接
3.签名规则
第一步:按字典序排列将参数拼接。具体顺序为 user_id+data+format+method+timestamp+version
第二步:将apiToken拼接到第一步的字符串的头部和尾部 apitoken+user_id+data+format+method+timestamp+version+apitoken
第三步:将第二步的结果进行md5加密; MD5(apitoken+user_id+data+format+method+timestamp+version+apitoken)
生成签名示例:
D6140AA383FD8515B09028C586493DDB100000{}jsoncommon.country.getlist1655798809414V1.0D6140AA383FD8515B09028C586493DDB
注:a.data 参数为body请求参数为json格式,并且使用压缩格式 b.MD5加密方式为32位小写;
加密后结果:bc5f1792e30936c72fa2a35efead8d73
4.请求URL示例
https://open-fat.yw56.com.cn/api/order?user_id=100000&method=common.country.getlist&format=json×tamp=1655798809414&sign=bc5f1792e30936c72fa2a35efead8d73&version=V1.0
注:user_id,method,format,version,timestamp要和生成签名时使用的参数一致。sign为生成参数签名步骤生成的md5加密后得到的
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| cityId | string | 是 | 出发仓ID; 小包专线业务(必填):【小包专线-查询交货仓列表】接口获取; 海外派业务(必填):美国:【查询海外交货地】接口获取;法国:可不传 |
| countryId | string | 是 | 目的国ID、二字码取值:【小包专线-查询通达国家列表】; |
| productAttributes | string | 否 | 货品类型 字段编码:【1】普货;【2】特货;【3】敏感货;【4】特品 |
| productTypeList | List<string> | 否 | 产品类型 字段编码:【3】燕文专线;【2】燕文挂号;【1】燕文经济;【26】中邮挂号;【19】外邮产品;【17】商业快递 |
| weight | number | 是 | 重量(g) |
| high | number | 否 | 高(cm) |
| length | number | 否 | 长(cm) |
| width | number | 否 | 宽(cm) |
| postCode | string | 否 | 邮编--海外派必填 |
| 参数 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否请求成功 |
| code | String | 响应码 |
| message | String | 响应文本 |
| - data | array | 数据 |
| basicFreight | number | 基础运费(小包专线默认币种RMB,其它业务为报价单币种) |
| trunkFreight | number | 干线费(小包默认RMB)---小包专线字段 |
| fuelCost | number | 燃油费(小包默认RMB)--小包专线字段 |
| additionalCharge | number | 附加费(小包专线默认币种RMB,其它业务为报价单币种) |
| rmbTotalMoney | number | 资费(RMB) |
| totalMoney | number | 资费(报价单币种) |
| currency | string | 报价单币种 |
| productNumber | string | 产品号 |
| productName | string | 产品名称 |
| referAging | string | 预计时效 |
| zone | string | 分区--美国海外派字段 |
{
"cityId": "01",
"countryId": "163",
"productAttributes": "1",
"productTypeList": [
"3",
"2",
"1"
],
"weight": 100,
"high": 100,
"length": 100,
"width": 100,
"postCode": "98842"
}
{
"code": "200",
"data": [
{
"basicFreight": 122,
"trunkFreight": 0,
"fuelCost": 0,
"additionalCharge": 0,
"exceedLengthMoney": 0,
"rmbTotalMoney": 122,
"totalMoney": 122,
"currency": "CNY",
"productNumber": "484",
"productName": "燕文专线追踪-特货",
"referAging": null
},
{
"basicFreight": 174,
"trunkFreight": 0,
"fuelCost": 0,
"additionalCharge": 0,
"exceedLengthMoney": 0,
"rmbTotalMoney": 174,
"totalMoney": 174,
"currency": "CNY",
"productNumber": "557",
"productName": "燕文专线快递-特货",
"referAging": null
}
],
"success": true,
"message": "操作成功"
}