以下是eship开放平台API接口规范：
1、获取派送单号和派送帖
资源地址：http://{请求地址}/eship-api/v1/apiSearch/requestPdfUrl
HTTP方法：POST
数据交换格式：json
功能描述
在开放平台中通过订单号获取PDF,支持一次获取多个。
注意：下完单，获取派送单号和派送贴是异步的；刚下完单可能还没获取到，需要特殊处理；例如：每10秒一次、获取6次；在界面添加功能手动点击获取
输入参数
JSON示例：{“orderNumbers”:[“FEIEU1700000004YQ”],”apiName”:”111″,”apiToken”:”222″}
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| orderNumbers | String[] | 必填 | 物流订单号,可以同时查多个订单 | |
| apiName | String | 必填 | 验证用户 | |
| apiToken | String | 必填 | 验证token |
输出参数
JSON示例：
{
“msg”: null,
“flag”: true,
“pdfUrls”: [
{
“url”:”http://static.eship.com:88/ex-label/Ups/2018/07/31/1ZX112W26892884990.pdf”,
“orderNumber”: “FEIEU1700003879YQ”,
“deliveryNumber”:”1ZX112W26892884990″,
“msg”: null
}
]
}
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| pdfUrls | ApiPdf[] | 返回的PDF对象 | ||
| flag | Boolean | 是否获取到PDF | ||
| msg | String | 返回查询信息 |
ApiPdf 对象
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| url | String | 返回的PDF地址 | ||
| orderNumber | String | 订单号 | ||
| msg | String | 返回查询信息 |
2、请求订单追踪信息
资源地址：http://{请求地址}/eship-api/v1/apiSearch/requestTrackInfo
HTTP方法：POST
数据交换格式：json
功能描述
在开放平台中通过订单号获取追踪信息,支持一次获取多个订单追踪信息。
输入参数
JSON示例：{“orderNumbers”:[“FEIEU1700000004YQ”],”apiName”:”111″,”apiToken”:”222″}
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| orderNumbers | String[] | 必填 | 物流订单号,可以同时查多个订单 | |
| apiName | String | 必填 | 验证用户 | |
| apiToken | String | 必填 | 验证token |
输出参数
JSON示例：
{
“msg”: null,
“flag”: true,
“trackingInformations”: [
{
“trackingInfoDetails”: [
{
“insideNumber”: “FEIEU1700003879YQ”,
“createTime”: “2018-07-31 13:00:14”,
“location”: null,
“description”: “Shipment received at origin depot.”,
“trackingStatus”: “TAKE_DELIVERY”,
“deliveryNumber”: null,
“deliveryCompany”: “UPS”
}
],
“orderNumber”: “FEIEU1700003879YQ”
}
]
}
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| msg | String | 返回查询信息 | ||
| flag | Boolean | 查询状态 | ||
| trackingInformations | TrackingInformation[] | 返回查询信息 |
TrackingInformation 对象
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| orderNumber | String | 订单号 | ||
| trackingInfoDetails | TrackingInfoDetail[] | 订单信息详情 |
TrackingInfoDetail对象
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| insideNumber | String | 订单内单号 | ||
| createTime | Date | 创建时间 | ||
| location | String | 位置信息 | ||
| description | String | 描述 | ||
| trackingStatus | String | 追踪状态：
NO_RESULT(“查询不到”), TAKE_DELIVERY(“仓库收货”), IN_TRANSIT(“运输途中”), WAIT_TO_PICKUP(“到达待取”), DELIVERY_FAILED(“投递失败”), SIGNING_SUCCESS(“成功签收”), POSSIBLE_ABNORMALITY(“可能异常”), LONG_TRANSPORT(“运输过久”), TAKE_OFF(“飞机起飞”), LANDING(“飞机落地”), CLEARANCE(“清关中”) |
||
| deliveryNumber | String | 派送单号 | ||
| deliveryCompany | 派送公司 |
3、请求订单详情
资源地址：http://{请求地址}/eship-api/v1/apiSearch/orderDetailSearch
HTTP方法：POST
数据交换格式：json
功能描述
在开放平台中通过订单号获取订单详情,支持查询多个订单。
输入参数
JSON示例：{“orderNumbers”:[“FEIEU1700000004YQ”],”apiName”:”111″,”apiToken”:”222″}
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| orderNumbers | String[] | 必填 | 物流订单号,可以同时查多个订单 | |
| apiName | String | 必填 | 验证用户 | |
| apiToken | String | 必填 | 验证token |
输出参数
JSON示例：
{
“msg”: null,
“flag”: true,
“orderDetails”: [
{
“msg”: null,
“orderId”: “4028882964ee17b80164ee51a6000005”,
“insideNumber”: “FEIEU1700003879YQ”,
“deliveryNumber”: “1ZX112W26892884990”,
“deliveryCompany”: “UPS”,
“productName”: “欧洲商务包裹”,
“actualWeight”: 1,
“volumeWeight”: 0,
“chargedWeight”: 1,
“status”: “SIGN”,
“destinationNo”: “GB”,
“originNo”: “Shanghai”,
“originName”: “上海市”,
“destinationName”: “英国”,
“createTime”: “2018-07-31 11:11:25”,
“scanTime”: “2018-07-31 13:00:14”,
“signed”: null,
“referenceNo”: “”,
“vatNo”: null,
“eoriNo”: null,
“remakr”: null,
“deliveryTime”: null,
“deliveryAddress”: {
“consignee”: “guodada”,
“companyName”: null,
“province”: “松江区”,
“city”: “上海市”,
“address”: “盛龙路8号”,
“address2”: null,
“postcode”: “20000”,
“cellphoneNo”: “18887766666”,
“email”: “”,
“houseNo”: “”
},
“senderAddress”: {
“sender”: null,
“companyName”: null,
“province”: null,
“city”: null,
“address”: null,
“postcode”: null,
“cellphoneNo”: null,
“countryCode”: null
},
“goods”: [
{
“nameEn”: “clothes”,
“name”: “衣服”,
“sku”: “sku0002”,
“quantity”: 2,
“reportPrice”: 10,
“boxWeight”: 1,
“boxLength”: 1,
“boxWidth”: 1,
“boxHeight”: 1,
“boxCount”: 1
}
]
}
]
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| orderDetails | OrderDetail[] | 返回详情对象数组 | ||
| flag | Boolean | 查询状态 | ||
| msg | String | 返回查询信息 |
OrderDetail对象
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| msg | String | 查询信息 | ||
| orderId | String | 订单ID | ||
| insideNumber | String | 订单号 | ||
| deliveryNumber | String | 派送单号 | ||
| deliveryCompany | String | 派送公司 | ||
| productName | String | |||
| actualWeight | Float | 实重 | ||
| volumeWeight | Float | 体积重 | ||
| chargedWeight | Float | 计费重 | ||
| status | enum | 订单状态对象,具体枚举：
CREATED(“客户待发货”), SIGN(“物流商已收货”), WEIGH_PASS(“称重验货通过”), WAIT_DELIVE(“等待发货”), PACKAGE_COMPLETED(“打包完成”),DELIVERED(“物流商已发货”), COMPLETED(“已签收”),GIVE_UP(“弃件”), CANCELED(“已取消”) |
||
| destinationNo | String | 目的地编码 | ||
| originNo | String | 出发地编码 | ||
| originName | String | 出发地 | ||
| destinationName | String | 目的地 | ||
| createTime | Date | 创建时间 | ||
| scanTime | Date | 验货称重扫描时间 | ||
| signed | Boolean | 订单是否已签收 | ||
| referenceNo | String | 参考号 | ||
| vatNo | String | VAT快递类别 编号 | ||
| eoriNo | String | VAT快递类别 税号 | ||
| remakr | String | 订单描述 | ||
| deliveryTime | Date | 收货时间 | ||
| deliveryAddress | ApiDeliveryAddress | 收货人信息对象 | ||
| senderAddress | ApiSenderAddress | 发送人信息对象 | ||
| goods | ApiGoods[] | 商品信息数组对象 |
ApiDeliveryAddress对象
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| consignee | String | 收货人 | ||
| companyName | String | 公司名称 | ||
| province | String | 地区/州/省 | ||
| city | String | 城市 | ||
| address | String | 地址 | ||
| address2 | String | 地址2 | ||
| postcode | String | 邮编 | ||
| cellphoneNo | String | 联系电话 | ||
| String | 电子邮件 | |||
| houseNo | String | 门牌号 |
ApiSenderAddress对象
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| sender | String | 发货人 | ||
| companyName | String | 公司名称 | ||
| province | String | 地区/州/省 | ||
| city | String | 城市 | ||
| address | String | 地址 | ||
| postcode | String | 邮编 | ||
| cellphoneNo | String | 联系电话 | ||
| countryCode | String | 国家二字编码 |
ApiGoods对象
| 参数名称 | 类型 | 长度 | 约束 | 说明 |
| name | String | 商品中文名 | ||
| nameEn | String | 商品英文名 | ||
| sku | String | 客户商品配货信息 | ||
| quantity | Integer | 商品数量 | ||
| reportPrice | Float | 申报价值 | ||
| boxWeight | Float | 单箱重量(千克) | ||
| boxLength | Integer | 单箱长度(厘米) | ||
| boxWidth | Integer | 单箱宽(厘米) | ||
| boxHeight | Integer | 单箱高(厘米) | ||
| boxCount | Integer | 箱子数量 |