17飞在线下单api接口说明
一、测试案例：
以http请求使用JSON的格式传入如下参数来进行17飞在线下单:
请求链接：http://{请求地址}/eship-api/v1/orders
{
"apiName": "apiName",
"apiToken": "apiToken",
"apiOrders":[
{
"productName": "欧洲商务包裹",
"productCode": "EUBP-SH",
"destinationNo": "GB",
"takeAwayType": "ESHIP",
"referenceNo": "a101010",
"orderFromType": "API",
"goods": [
{
"nameEn": "apple",
"name": "苹果",
"quantity": 1,
"reportPrice": 10,
"boxWeight": 0.1,
"boxLength": 1,
"boxWidth": 1,
"boxHeight": 1,
"boxCount": 2
},
{
"nameEn": "apple2",
"name": "苹果2",
"quantity": 1,
"reportPrice": 10,
"boxWeight": 0.1,
"boxLength": 1,
"boxWidth": 1,
"boxHeight": 1,
"boxCount": 1
}
],
"deliveryAddress":{
"consignee":"TOM J",
"province":"province",
"city":"city",
"address":"Block F Second Floor Room F218c",
"postcode":"B29 6GH",
"cellphoneNo":"07935562900"
},
"senderAddress":{
"sender":"小三",
"province":"湖北省",
"city":"武汉市",
"address":"光谷大道总部国际",
"postcode":"535300",
"cellphoneNo":"1236547893",
"countryCode":"CN"
}
}
]
}
注意：
1.api中的goods节点不是箱子里面的单个商品，是指一批箱子
2.一票一件：如果是一个箱子有多件货物，应该这么写【goods数组里只有一个对象】：
“goods”: [
{
“nameEn”: “apple,ipad”, //多件商品拼在一起
“name”: “苹果,平板”,
“quantity”: 1, //箱子内商品的总数量
“reportPrice”: 10, //多件商品的申报价值总和
“boxWeight”: 0.1, //单个箱子的重量
“boxLength”: 1,
“boxWidth”: 1,
“boxHeight”: 1,
“boxCount”: 1 //这里这种尺寸的箱子个数，一件就是1
}
]
3.一票多件：
情况1：goods里面可以有多个对象
情况2：可以用boxCount控制件数
二、传入参数说明
"apiName":（字符串类型 必填） 认证的API的名称。
"apiToken": （字符串类型 必填） 认证的API的名称对应的token。
## 注意：获取apiName和apiToken请登录系统中（个人中心）进行查看。
apiOrders:（数组类型 必填）表示支持多个订单进行下单。
productName:（字符串类型 必填）表示产品(物流服务类型)的名称。
productCode:（字符串类型 必填）表示产品的code。
destinationNo:（字符串类型 必填）表示目的地的国家二字简码。
insideNumber:（字符串类型 非必填）表示17飞的内单号。
vatNo:（字符串类型 非必填）当物流线路是自有VAT类型时的VAT单号
eoriNo:（字符串类型 非必填）当物流线路是自有VAT类型时的eoriNo单号
deliveryNumber:（派送贴单号 非必填）国外的派送单号
takeAwayType:（枚举类型 必填）表示取件方式简单的将就是您已哪种方式将货物送往17飞仓库。可用值：
EXPRESS("国内邮寄"), SELF("自己送货"), ESHIP("上门取货");
domesticExpressNo:(国内快递单号)当取件方式为国内邮寄时，必填
referenceNo:(字符串 必填)表示 参考号，如果你们当前存在系统，那么通常表示你们系统的业务号。
orderFromType:(枚举)表示订单类型，可用值：
SINGLE("单件"),BATCH("批量"),API("API"),BIAOJU("镖局"),
TONGTU("通途"),EMMIS("钮门"),DIANXIAOMI("店小秘"),
PUYUAN("普源"),MANGGUO("芒果");
goods:（数组类型）表示所有物品的列举
nameEn:（字符串 必填）英文名
name:（字符串 必填）中文名
quantity:（数字整形 必填>0） 该类型的货物的数量
reportPrice:（数字浮点型 必填）申报价值 (单位：美元)
boxWeight:（数字浮点型 必填）箱子的重量(单位：kg)
boxLength:（数字整形 必填） 箱子的长 单位厘米(cm)
boxWidth:（数字整形 必填） 箱子的宽 单位厘米(cm)
boxHeight: （数字整形 必填） 箱子的高 单位厘米(cm)
boxCount:（数字整形 必填） 箱子的数量 单位厘米(cm)
deliveryAddress:对象类型 表示寄送的地址信息
"consignee":（字符串 必填）派送地址中的收货人不能为空
"province":（字符串）,派送地址中的地区/州/省
"city":（字符串 必填）,派送地址中的城市不能为空
"address":（字符串 必填）派送地址中的地址不能为空
"postcode":（字符串 必填）派送地址中的邮编
"cellphoneNo":（字符串 必填）派送地址中的电话
"houseNo":（字符串）门牌号(看情况，非必填，如德国必填)
senderAddress:
"sender":（字符串 必填）寄件地址中的寄件人不能为空,
"province":（字符串 必填）寄件地址中的(地区/省/州)不能为空,
"city":（字符串 必填）寄件地址中的(城市)不能为空,
"address":（字符串 必填）寄件地址中的(地址必填)不能为空,
"postcode":（字符串 必填）寄件地址中的(邮编)不能为空,
"cellphoneNo":（字符串 必填）寄件地址中的(联系电话)不能为空,
"countryCode":（字符串 必填）寄件地址中的(国家二字吗)不能为空
三、响应结果集
{
"msg": null,
"flag": false,
"total": 2,
"success": 1,
"fail": 1,
"successOrders": [
{
"insideNumber": "FEIUK1700004564YQ",
"referenceNo": "a1010111",
"pdfPath": "http://api.17feia.com/eship-api/v1/apiSearch/pdfFile?requestParams={\"apiName\":\"apiname\",\"orderNumber\":\"FEIUK1700004564YQ\",\"apiToken\":\"apitoken\"}",
"deliveryNumber": null,
"id": "2c93ece065cd89ab0165ebdc79e778d3",
"supplyItemId": "4028882962482f9e01624ba66d56000e"
}
],
"failOrders": [
{
"referenceNo": "a1010110",
"errorMessage": "当前系统存在参考号`（a1010110）`重复"
}
]
}
四、响应参数说明
msg:系统返回的信息。
flag:请求结果标识。true 表示返回成功. false 表示请求失败。
total:当前请求的总单数可以理解为传入apiOrders的长度。
success:表示此次请求下单正确的订单数。
fail:表示此次请求失败的订单数。
successOrders: 返回成功的信息对象
"insideNumber"：17飞的内单号
"referenceNo"：参考号
"pdfPath"：pdf的请求路径
"deliveryNumber"：派送单号
"id"：订单在17飞系统的id号
"supplyItemId"：派送供应商的id
failOrders:返回失败的信息对象
"referenceNo"：参考号
"errorMessage"：改单的错误信息提示