创建运单(方法名称:express.order.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.order.create1655798809414V1.0E33A3973221DB08128F8FF436EFDB8F4
注:a.data 参数为body请求参数为json格式,并且使用压缩格式 b.MD5加密方式为32位小写;
加密后结果:1a4187d5e55337e2383b041bfb5a532f
4.请求URL示例
https://open-fat.yw56.com.cn/api/order?user_id=99000015&method=express.order.create&format=json×tamp=1655798809414&sign=1a4187d5e55337e2383b041bfb5a532f&version=V1.0
注:user_id,method,format,version,timestamp要和生成签名时使用的参数一致。sign为生成参数签名步骤生成的md5加密后得到的
| 参数 | 类型 | 是否必填 | 描述 | |
|---|---|---|---|---|
| channelId | String | 是 | 10 | 产品编码(产品Id) |
| orderSource | String | 否 | 20 | 订单来源 |
| orderNumber | String | 是 | 50 | 订单号 |
| transactionNumber | String | 50 | 平台交易号 | |
| dateOfReceipt | Date | 收款到账日期 格式yyyy-MM-dd | ||
| companyCode | String | 10 | 交货仓/仓库代码 美国(必填):LAX01,NJC01,ORD01,MIA01,DFW01,SFO01,ATL01 |
|
| remark | String | 200 | 拣货单信息(打印标签选择“打印拣货单”显示此字段信息) | |
| salesPlatform | String | 50 | 销售平台 | |
| -receiverInfo | object | 收件人信息 | ||
| name | String | 是 | 50 | 收件人姓名 |
| phone | String | 50 | 收件人电话 | |
| String | 100 | 收件人邮箱 | ||
| company | String | 100 | 收件人公司 | |
| country | String | 是 | 10 | 目的国id或目的国二字码 |
| state | String | 50 | 收件人州(省) | |
| city | String | 50 | 收件人城市 | |
| zipCode | String | 50 | 收件人邮编 | |
| houseNumber | String | 50 | 收件人门牌号 | |
| address | String | 是 | 200 | 收件人地址 |
| taxNumber | String | 50 | 收件人税号 | |
| finflNumber | String | 50 | FINFL号码 | |
| -parcelInfo | object | 包裹信息 | ||
| hasBattery | Integer | 是 | 是否带电 1:是 0:否 | |
| currency | String | 是 | 10 | 币种; USD,EUR,GBP; |
| totalPrice | Decimal | 是 | (18,2) | 申报总价值 |
| totalQuantity | Integer | 是 | 申报总数量 | |
| totalWeight | Integer | 是 | 总重量(单位:g) | |
| height | Integer | 包裹高(单位:cm) | ||
| width | Integer | 包裹宽(单位:cm) | ||
| length | Integer | 包裹长(单位:cm) | ||
| ioss | String | 50 | IOSS号 | |
| -productList | object | 商品信息 | ||
| goodsNameCh | String | 是 | 200 | 中文品名 |
| goodsNameEn | String | 是 | 200 | 英文品名 |
| price | Decimal | 是 | (18,2) | 申报单价 |
| hscode | String | 50 | 商品海关编码 | |
| url | String | 2000 | 商品链接 | |
| material | String | 500 | 商品材质 | |
| quantity | Integer | 是 | 单票数量 | |
| weight | Integer | 是 | 单品重量(单位:g) | |
| sku | String | 100 | 商品sku | |
| imei | String | 50 | IMEI编码 | |
| -senderInfo | object | 发件人信息 | ||
| name | String | 50 | 发件人姓名 | |
| phone | String | 50 | 发件人电话 | |
| String | 100 | 发件人邮箱 | ||
| company | String | 100 | 发件人公司 | |
| country | String | 10 | 发件人国家 | |
| state | String | 50 | 发件人州(省) | |
| city | String | 50 | 发件人城市 | |
| zipCode | String | 50 | 发件人邮编 | |
| houseNumber | String | 50 | 发件人门牌号 | |
| address | String | 200 | 发件人地址 | |
| taxNumber | String | 50 | 发件人税号 | |
| -poPStation | object | 自提网点信息 | ||
| pointId | String | 50 | 自提点ID | |
| 参数 | 类型 | 描述 |
|---|---|---|
| success | Boolean | 是否请求成功 |
| code | String | 响应码 |
| message | String | 响应文本 |
| - data | object | 实体信息 |
| waybillNumber | String | 运单号 |
| orderNumber | String | 订单号 |
{
"channelId": "1615",
"orderSource": "portal",
"userId": "账号",
"companyCode":"LAX01",
"orderNumber": "KI1000000001A",
"dateOfReceipt": "2026-02-02",
"remark": "拣货单信息",
"receiverInfo": {
"name": "glassware",
"phone": "18231730588",
"email": "529932298@qq.com",
"company": "yanwen",
"country": "115",
"state": "he bei sheng",
"city": "cang zhou shi",
"zipCode": "10110",
"houseNumber": "#4501124",
"address": "he fang jie cang zhou kai fa qu",
"taxNumber": "qwer123",
"finflNumber": "finflNumber"
},
"parcelInfo": {
"productList": [
{
"goodsNameCh": "爱立信T18sc",
"goodsNameEn": "Ericsson T18sc",
"price": "12.5",
"hscode": "8400000001",
"url": "http://www.aliexpress.com/item//32681820727.html",
"material": "material",
"quantity": "10",
"weight": "1000",
"imei": "520027-19-012435-8-05"
},
{
"goodsNameCh": "杯子",
"goodsNameEn": "CUP",
"price": "12.5",
"hscode": "8400000001",
"url": "http://www.aliexpress.com/item//32681820727.html",
"material": "material",
"quantity": "10",
"weight": "1000",
"imei": ""
}
],
"hasBattery": 1,
"currency": "USD",
"totalQuantity": "10",
"totalWeight": "243",
"height": "10",
"width": "10",
"length": "10",
"ioss": "123456"
},
"senderInfo": {
"name": "glassware",
"phone": "18231730588",
"email": "529932298@qq.com",
"company": "yanwen",
"country": "115",
"state": "he bei sheng",
"city": "cang zhou shi",
"zipCode": "101110",
"houseNumber": "#4501124",
"address": "he fang jie cang zhou kai fa qu",
"taxNumber": "qwer123"
},
"poPStation": {
"pointId": "1001"
}
}
{
"success": true,
"code": "0",
"message": "操作成功",
"data": {
"waybillNumber": "LW236917165CN",
"orderNumber": "KI1000000001A"
}
}