燕文开放平台

-简要描述

尾程业务-新增预报（方法名称：express.overseas.manifest.create）

-公共参数

请求地址

环境	HTTP请求地址
正式环境	https://open.yw56.com.cn/api/order
测试环境	https://open-fat.yw56.com.cn/api/order

账号信息

环境	账号	秘钥 apitoken
正式环境	贵司在我司客户号；	登录我司客户中心系统-账号管理-制单账号管理信息下查看秘钥；
测试环境	99000015	E33A3973221DB08128F8FF436EFDB8F4

公共请求参数

参数	类型	是否必填	描述
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)
生成签名示例：

E33A3973221DB08128F8FF436EFDB8F499000015{}jsonexpress.overseas.manifest.create1655798809414V1.0E33A3973221DB08128F8FF436EFDB8F4

注：a.data 参数为body请求参数为json格式，并且使用压缩格式 b.MD5加密方式为32位小写；

加密后结果：b5846d9240e0d649266d3cc3d7ed81a2

4.请求URL示例

https://open-fat.yw56.com.cn/api/order?user_id=99000015&method=express.overseas.manifest.create&format=json&timestamp=1655798809414&sign=b5846d9240e0d649266d3cc3d7ed81a2&version=V1.0

注：user_id,method,format,version,timestamp要和生成签名时使用的参数一致。sign为生成参数签名步骤生成的md5加密后得到的

-请求参数

参数	类型	是否必填	长度	描述
batchCode	String	是	50	客户批次标识
channelId	Integer	是		产品编号
companyCode	String	是	10	仓库代码
predictArriveDate	String	是		预计到达日期
transportWay	String	否	50	运输方式
mawbNo	String	否	50	主单号
etd	Integer	否	50	预计起飞时间 yyyy-MM-dd HH:mm:ss
eta	String	否	50	预计到达时间 yyyy-MM-dd HH:mm:ss
timeZone	String	否	10	时区 +08:00
pol	String	否	10	始发港
pod	String	否	10	目的港
detailsInfo	Array	是	35	批次详情
-bagNo	String	是	100	大包号
-parcels	Array	是	35	小件详情
--waybillNumber	String	是	50	运单号

-响应参数

参数	类型	描述
success	Boolean	是否成功 true:成功 false:失败
code	String	消息编码 0:成功 >0:失败 <0:系统异常
message	String	消息内容
data	Object	实体信息

-请求参数示例

{
	"batchCode": "batchTest202505150001",
	"predictArriveDate": "2025-05-15",
	"channelId": "1615",
	"companyCode": "LAX01",
	"transportWay": "空运",
	"mawbNo": "batchTest202505150001-M",
	"etd": "2025-05-15 12:23:56",
	"eta": "2025-05-15 12:23:56",
	"timeZone": "+8",
	"pol": "LHR",
	"pod": "LAX",
	"detailsInfo": [{
		"bagNo": "BagTest202505150001",
		"parcels": [{
				"waybillNumber": "YWPHX010004739593"
			},
			{
				"waybillNumber": "YWPHX010004739594"
			}
		]
	}]
}

-返回示例

{
    "success": true,
    "code": "0",
    "message": "操作成功",
    "data": null
}

尾程业务-新增预报

-简要描述

-公共参数

请求地址

账号信息

公共请求参数

-请求参数

-响应参数

-请求参数示例

-返回示例